optima-rest-api

n8n node for Comarch Optima REST API integration

Package Information

Downloads: 230 weekly / 863 monthly
Latest Version: 1.1.1
Author: POKASH.PL Sp. z o. o.

Available Nodes

Optima REST API icon
Optima REST API
Interact with Comarch Optima ERP via REST API

Documentation

n8n-nodes-optima-rest-api

Node n8n do integracji z Comarch Optima ERP poprzez REST API Gateway.

Instalacja

Community Node (n8n Cloud lub Self-hosted)

W n8n przejdź do Settings > Community Nodes i zainstaluj:

n8n-nodes-optima-rest-api

Manualna instalacja (Development)

  1. Przejdź do folderu z custom nodes:

    cd ~/.n8n/custom

  2. Sklonuj lub skopiuj ten folder

  3. Zainstaluj zależności:

    npm install

  4. Zbuduj projekt:

    npm run build

  5. Zrestartuj n8n

Konfiguracja

Credentials

Utwórz credentials typu Optima REST API:

  • Gateway URL: URL adres serwera Gateway (np. http://localhost:5000)
  • Username: Nazwa użytkownika Optima
  • Password: Hasło użytkownika
  • Company: Kod firmy w Optima (np. FIRMA01)
  • Modules: Moduły Optima (np. KP dla księgowości, CDN dla handlu)

Dostępne operacje

Customer (Kontrahent)

  • Get: Pobierz kontrahenta po ID
  • Get All: Pobierz wszystkich kontrahentów
  • Create: Utwórz nowego kontrahenta
  • Update: Zaktualizuj kontrahenta
  • Delete: Usuń kontrahenta

Document (Dokument)

  • Create Invoice: Utwórz fakturę sprzedaży lub zakupu

Product (Towar)

  • Get: Pobierz towar po ID
  • Get All: Pobierz wszystkie towary

Print (Wydruk)

  • Print Document: Wygeneruj PDF dokumentu

Przykłady użycia

Utworzenie kontrahenta

{
  "akronim": "KLIENT01",
  "nazwa": "Firma Example Sp. z o.o.",
  "nip": "1234567890",
  "ulica": "Główna 1",
  "kod": "00-001",
  "miasto": "Warszawa"
}

Utworzenie faktury sprzedaży

{
  "platnik": {
    "akronim": "KLIENT01"
  },
  "pozycje": [
    {
      "kod": "PROD01",
      "ilosc": 2,
      "cena": 100.00
    }
  ]
}

Wydruk dokumentu do PDF

Parametry:

  • Document ID: 123 (ID dokumentu w Optima)
  • Format ID: 1 (ID formatu wydruku z Optima)

Alternatywnie można użyć SQL Filter:

TrN_TrnId = 123

Development

Build

npm run build

Watch mode

npm run dev

Linting

npm run lint
npm run lintfix

Format code

npm run format

Licencja

MIT

Autor

POKASH.PL Sp. z o. o. (hello@pokash.cloud)

Links

Discussion