Docs
PL

Wybierz język

eurinvoice.com
Docs
PL

Wybierz język

Lista do obsługi: faktury odrzucone i dead letter z kodem z katalogu i wskazaniem, kto działa

  • W sandboxie

Prostymi słowami

Wymienia faktury odrzucone i przeniesione do dead letter, z kodem z katalogu i wskazaniem, kto działa.
GET
/care

Od 0.15.0 klucz klienta z zakresem read odczytuje wiersze własnego klienta, więc firma widzi własne odrzucone faktury. Klucz klienta dostaje najwyżej 200 najnowszych wierszy w żądanym status, z truncated: true, gdy jest ich więcej; od 0.18.2 status jest stosowany najpierw, więc stary otwarty wiersz nigdy nie jest ukryty za nowszymi obsłużonymi. Może on wywoływać listę 30 razy na minutę (powyżej tego 429). Klucz operatora widzi wiersze wszystkich klientów albo jednego klienta po podaniu client.

Autoryzacja

apiKey
headerAuthorizationBearer <token>

Klucz należy wysyłać jako token typu bearer: Authorization: Bearer <your-api-key>. Wywołanie stanu usługi jest jedynym, które nie wymaga klucza.

Parametry zapytania

status?string

open (jeszcze nieobsłużone), handled lub all. Domyślnie all, jak przed 0.8.0.

Domyślnie"all"
Wartość spośród"open""handled""all"
client?string

Filtr operatora do jednego klienta. Klucz klienta może podać tylko własnego klienta; każdy inny daje odpowiedź 404. Inny kształt daje odpowiedź 400.

Wzorzec^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

Treść odpowiedzi

data: jeden wiersz na fakturę i kod.

application/json
  1. response
data*array<>
truncated?boolean

Obecne i równe true, gdy lista klucza klienta została ucięta do 200 najnowszych wierszy, przed filtrem statusu.

curl -X GET "https://example.com/care" \  -H "Authorization: Bearer <your-api-key>"
{  "data": [    {      "invoice_id": "string",      "catalogue_code": "string",      "who_acts": "us",      "age_seconds": 0,      "handled": true,      "handled_at": "2019-08-24T14:15:22Z",      "route": "PEPPOL",      "client": "string",      "invoice_ref": "string",      "deadline_at": "2019-08-24T14:15:22Z",      "field": "string",      "fix_hint": "string"    }  ],  "truncated": true}

Zapisane pliki faktury z listy do obsługi wraz z ich SHA-256 GET

Od 0.15.0 klucz klienta z zakresem read odczytuje dowody faktur własnego klienta, 10 razy na minutę. Faktura innego klienta daje odpowiedź 404, tak samo jak faktura, której nie ma na liście do obsługi. Pliki o łącznym rozmiarze ponad 8 MiB dają odpowiedź 413 (evidence-too-large) dla każdego klucza; należy czytać je pojedynczo przez GET /invoices/{id}/documents/{kind}.

Oznaczenie wierszy obsługi faktury jako obsłużonych POST

Tylko klucz operatora. Obsługa wiersza jest zadaniem Obsługi odrzuceń (Rejection Care), więc klucz klienta dostaje 403.