Docs

Dokumentacja referencyjna API

Wszystkie operacje, które może wywołać partner, wygenerowane z pliku OpenAPI.

  • W sandboxiezbudowane operacje
  • Planowaneplanowane operacje

Prostymi słowami

Wszystkie wywołania, które może wykonać partner, wygenerowane z pliku OpenAPI API. Adres bazowy sandboxa to https://api-sandbox-eu.eurinvoice.com.

Każda strona poniżej jest generowana z pliku OpenAPI w wersji 0.19.3, względem którego testowana jest usługa. Tam, gdzie pokazano zarejestrowaną odpowiedź, pochodzi ona z usługi i jest opatrzona datą na swojej stronie. Strony w sekcji 3 wyjaśniają wywołania prostymi słowami.

Operacje dostępne w usłudze

WywołanieCo robiStatus
GET /invoicesLista i wyszukiwanie fakturW sandboxie
POST /invoicesPrzesłanie faktury lub noty kredytowej jako kanonicznego JSONW sandboxie
POST /invoices/xmlPrzesłanie gotowego dokumentu UBL lub CII (przekazanie bez zmian)W sandboxie
GET /invoices/seriesFaktury odebrane i odrzucone według dnia i kanałuW sandboxie
GET /invoices/{id}Pobranie bieżącego stanu fakturyW sandboxie
POST /invoices/{id}/cancelZatrzymanie faktury, która nie została jeszcze przesłanaW sandboxie
GET /invoices/{id}/eventsLista zdarzeń statusu jednej fakturyW sandboxie
GET /invoices/{id}/documents/{kind}Pobranie wygenerowanego dokumentu lub potwierdzenia z kanałuW sandboxie
POST /validateZbudowanie i sprawdzenie dokumentu bez jego wysyłaniaW sandboxie
GET /webhookPobranie ustawień webhooka (operatora albo, z kluczem administratora klienta, tego klienta)W sandboxie
PUT /webhookUstawienie adresu URL webhooka albo rotacja jego sekretuW sandboxie
POST /webhook/testWysłanie podpisanego zdarzenia testowego na adres URL webhookaW sandboxie
GET /catalogue/{code}Wyszukanie kodu błędu lub przyczynyW sandboxie
GET /healthStan usługiW sandboxie
GET /careLista do obsługi: faktury odrzucone i dead letter z kodem z katalogu i wskazaniem, kto działaW sandboxie
POST /care/{id}/handledOznaczenie wierszy obsługi faktury jako obsłużonychW sandboxie
GET /care/{id}/evidenceZapisane pliki faktury z listy do obsługi wraz z ich SHA-256W sandboxie
GET /credentialsZapisane dane dostępowe, bez ich wartościW sandboxie
POST /credentialsZapisanie danych dostępowych w postaci zaszyfrowanej; wartość nigdy nie jest zwracanaW sandboxie
GET /credentials/{id}Jedne dane dostępowe, bez ich wartościW sandboxie
POST /credentials/{id}Zastąpienie wartości (i ważności) aktywnych danych dostępowychW sandboxie
POST /credentials/{id}/revokeCofnięcie danych dostępowych; zapis pozostaje w śladzie audytuW sandboxie
GET /keysLista kluczy API (operator widzi wszystkie; klucz administratora klienta widzi własne)W sandboxie
POST /keysWydanie klucza API dla klienta; klucz jest pokazywany razW sandboxie
POST /keys/{id}/revokeCofnięcie klucza API; przestaje działać natychmiastW sandboxie

Operacje planowane

Wymienia je plik OpenAPI. Usługa ich jeszcze nie ma, więc nie mają strony ani przykładowego żądania.

WywołanieCo będzie robićStatus
POST /invoices/{id}/statusesZgłoszenie statusu po stronie sprzedawcy (tylko Francja)Planowane

Na tej stronie