Docs

Zoznam a vyhľadávanie prijatých faktúr

  • V sandboxe
GET
/received

Od 0.35.0. Rovnaké parametre a odpoveď ako GET /invoices, len pre prijaté faktúry; state je received, validated alebo validation_failed. Kľúč klienta vidí faktúry vlastného klienta; operátor všetkých klientov alebo jedného klienta cez client.

Autorizácia

apiKey
headerAuthorizationBearer <token>

Kľúč posielajte ako token typu Bearer: Authorization: Bearer <your-api-key>. Stav služby je jediné volanie, ktoré nevyžaduje kľúč.

Parametre dotazu

q?string
Dĺžkalength <= 100
route?array<>
state?array<>
client?string
Zhoda^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
received_from?string
Formátdate
received_to?string
Formátdate
sort?string
Predvolené"newest"
Hodnota z"newest""oldest"
page?integer
Rozsah1 <= value
Predvolené1
page_size?integer
Predvolené25
Hodnota z2550100200

Telo odpovede

Jedna strana zhôd.

application/json
  1. response
data*array<>
total*integer
page*integer
page_size*integer
counts_by_state*
curl -X GET "https://example.com/received" \  -H "Authorization: Bearer <your-api-key>"
{  "data": [    {      "id": "string",      "invoice_ref": "string",      "invoice_number": "string",      "route": "PEPPOL",      "client": "string",      "environment": "sandbox",      "state": "received",      "direction": "in",      "rail_id": "string",      "document_sha256": "string",      "duplicate_of": "string",      "links": {        "self": "string",        "events": "string"      },      "errors": [        {          "code": "string"        }      ],      "documents": [        {          "kind": "received-xml",          "sha256": "string",          "href": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "page_size": 0,  "counts_by_state": {    "property1": 0,    "property2": 0  }}

Zoznam stavových udalostí jednej prijatej faktúry GET

Od 0.35.0. Rovnaké udalosti, aké doručuje webhook, v poradí podľa sekvencie, každá s direction in.

Odovzdanie faktúry, ktorú klient prijal cez kanál POST

Od 0.35.0 (17. okt. 2026). Telo je XML presne tak, ako ho kanál doručil (UBL, CII alebo FA(3)); nič sa nemení a nič sa neodosiela. Súbor sa najprv uloží, zapečatený dátovým kľúčom klienta, pretože podľa práva je už prijatý; potom ho skontrolujú validátory kanála, ako pri priamom odovzdaní, a výsledok príde ako stavová udalosť (received, potom validated alebo validation_failed, s direction: in) na webhook klienta a na GET /received/{id}/events. Súbor, ktorý nespĺňa pravidlá, sa uchová a má stav validation_failed s chybami; nikdy sa nezahodí. Súbor, ktorý nie je faktúrou na uchovanie, sa odmietne s 422 a nič sa neuloží, ako pri POST /invoices/xml: DOCTYPE (EI-XML-DTD, nikdy sa nespracúva), XML, ktoré nie je dobre utvorené (EI-XML-SYNTAX), alebo dokument, ktorý nie je faktúrou známou kanálu (EI-XML-TYPE). Kontrola, ktorú sa nepodarilo spustiť (validátor nedostupný), sa zopakuje a po poslednom pokuse faktúra skončí v zozname na riešenie a zostane received. Klient odovzdá najviac 120 dokumentov za minútu a 2 000 za deň, bez ohľadu na kľúč (429, neukladá sa pod Idempotency-Key). Súbor sa vráti ako stiahnutie (Content-Disposition: attachment). Jeden dokument kanála je pre klienta jedna prijatá faktúra: podľa rail_id, ak je uvedené, inak podľa SHA-256 súboru. Ten istý dokument znova odpovie 202 s duplicate_of; rovnaké rail_id s inými bajtmi odpovie 409 received-id-conflict a nič sa neuloží. Prijaté faktúry sú oddelené od faktúr, ktoré klient odosiela: nie sú v GET /invoices, v číselnom rade, v metrikách ani v mesačnom prehľade a nikdy neblokujú odoslanie toho istého súboru. Prijatá faktúra sa maže spolu s retenciou klienta, keď na nej nie je nič otvorené (jej kontrola skončila alebo jej riadok na riešenie vybavila osoba), a je v exporte klienta pod received/. Rozsah submit; kľúč klienta koná len za vlastného klienta.