Fakturnia Developers Szybki start Dokumentacja API English

Dokumentacja API

Pełna dokumentacja API REST Fakturnia, generowana z OpenAPI: endpointy, parametry, treści żądań, odpowiedzi i schematy.

Base URL: https://prod.api.fakturnia.pl/external/v1

documents

  • GET /documents/ Pobierz listę dokumentów
  • POST /documents/ Utwórz nowy dokument
  • GET /documents/{id} Pobierz szczegóły dokumentu
  • PUT /documents/{id} Pełna aktualizacja istniejącego dokumentu
  • PATCH /documents/{id} Częściowa aktualizacja pola lub pól dokumentu
  • DELETE /documents/{id} Usuń dokument
  • GET /documents/{id}/download Pobierz dokument
  • POST /documents/validate Walidacja próbna danych dokumentu (bez zapisu do bazy danych)
  • PATCH /documents/{id}/payment-status Zaktualizuj status płatności dokumentu
  • PATCH /documents/{id}/external-reference Powiąż dokument z zewnętrznym numerem zamówienia
  • DELETE /documents/{id}/external-reference Usuń powiązanie z zewnętrznym zamówieniem z dokumentu
  • PATCH /documents/{id}/margin-purchases Ustaw kwoty nabycia pozycji w procedurze marży
  • POST /documents/{id}/send-to-ksef Wyślij dokument do KSeF
  • GET /documents/{id}/ksef-status Pobierz status wysyłki dokumentu do KSeF
  • GET /documents/{id}/history Pobierz historię dokumentu

clients

  • GET /clients/ Pobierz listę klientów
  • POST /clients/ Utwórz nowego klienta
  • GET /clients/{id} Pobierz szczegóły klienta
  • PUT /clients/{id} Zaktualizuj istniejącego klienta
  • DELETE /clients/{id} Usuń klienta

products

  • GET /products/ Pobierz listę produktów
  • POST /products/ Utwórz nowy produkt
  • GET /products/{id} Pobierz szczegóły produktu
  • PUT /products/{id} Zaktualizuj istniejący produkt
  • DELETE /products/{id} Usuń produkt

dictionaries

  • GET /dictionaries/ Pobierz słowniki statyczne (typy dokumentów, metody płatności itp.)

ksef

  • GET /ksef/connection Pobierz status połączenia z KSeF
  • POST /ksef/connection Utwórz lub zaktualizuj połączenie z KSeF (token albo certyfikat)
  • DELETE /ksef/connection Dezaktywuj połączenie z KSeF
  • POST /ksef/connection/test Przetestuj autoryzację i uprawnienia połączenia z KSeF

webhooks

  • GET /webhooks/ Lista webhooków
  • POST /webhooks/ Utwórz webhook
  • POST /webhooks/initial Utwórz początkowy webhook wtyczki (wszystkie zdarzenia)
  • GET /webhooks/{id} Pobierz webhook
  • PATCH /webhooks/{id} Zaktualizuj webhook
  • DELETE /webhooks/{id} Usuń webhook
  • POST /webhooks/{id}/rotate-secret Rotuj sekret podpisujący webhooka
  • GET /webhooks/{id}/deliveries Lista ostatnich dostaw webhooka
  • POST /webhooks/{id}/test Wyślij dostawę testową do webhooka

settings

  • GET /settings/ Pobierz ustawienia ogólne i ustawienia numeracji
  • PATCH /settings/general Zaktualizuj ustawienia ogólne (format daty, newsletter)
  • PATCH /settings/numbering Zaktualizuj ustawienia numeracji (typ, format, symbole)

company

  • GET /company/nip-lookup Wyszukaj dane firmy w GUS po numerze NIP

warehouse

  • GET /warehouse/ Pobierz listę magazynów
  • POST /warehouse/ Utwórz magazyn (wymaga planu MAX)
  • GET /warehouse/stock Pobierz raport stanów (suma ruchów per produkt/magazyn)
  • GET /warehouse/movements Lista ruchów magazynowych
  • POST /warehouse/adjustments Utwórz ręczną korektę stanu (ruch INW)
  • POST /warehouse/wz-from-invoice/{id} Utwórz dokument WZ z faktury sprzedaży (tylko pozycje towarowe)
  • POST /warehouse/documents/validate Walidacja dokumentu magazynowego bez zapisu
  • POST /warehouse/documents Wystawienie dokumentu magazynowego (WZ, PZ, PW, RW, MM)
  • GET /warehouse/{id} Pobierz magazyn
  • PUT /warehouse/{id} Zaktualizuj magazyn
  • DELETE /warehouse/{id} Usuń magazyn (zablokowane, gdy ma ruchy magazynowe)

employees

  • GET /employees/permissions Pobierz rejestr dostępnych uprawnień pracowniczych
  • GET /employees/ Pobierz listę kont pracowniczych
  • POST /employees/ Utwórz konto pracownicze
  • GET /employees/{id} Pobierz konto pracownicze
  • PUT /employees/{id} Zaktualizuj konto pracownicze (dane, uprawnienia, aktywacja, hasło)
  • DELETE /employees/{id} Usuń konto pracownicze (miękkie usunięcie, jego adres e-mail wraca do puli)
  • GET /employees/{id}/activity Pobierz aktywność pracownika

recurring-rules

  • GET /recurring-rules/ Pobierz listę reguł dokumentów cyklicznych
  • GET /recurring-rules/{id}/history Pobierz historię generacji reguły cyklicznej
  • GET /recurring-rules/{id} Pobierz szczegóły reguły cyklicznej
  • PATCH /recurring-rules/{id}/toggle Wstrzymaj lub wznów regułę cykliczną

email-accounts

  • GET /email-accounts/ Lista kont pocztowych
  • GET /email-accounts/{id} Pobierz konto pocztowe

activity

  • GET /activity/ Pobierz aktywność konta

auth

  • GET /auth/me Pobierz informacje o aktualnym koncie