Facturen tonen en zoeken
- In de sandbox
In gewone woorden
Een sleutel van een eindklant ziet de facturen van die eindklant; de beheerder ziet die van alle eindklanten, of van één eindklant met client. De rijen bevatten wat GET /invoices/{id} bevat, zonder documents, en geen factuurinhoud: geen koper of bedragen,
en geen uitgiftedatum (voor Roemenië en Polen volgt de deadline_at daaruit, tot op enkele dagen nauwkeurig). Een onbekende parameter geeft 400.
apiKeyAuthorizationBearer <token>Stuur uw sleutel als bearer-token: Authorization: Bearer <your-api-key>. De health-aanroep is de enige aanroep die geen sleutel vereist.
q?stringEen deel van de invoice_ref of het factuurnummer, zonder hoofdlettergevoeligheid. Hoogstens 100 tekens.
length <= 100route?array<>Een of meer verzendkanalen, gescheiden door komma's.
state?array<>Een of meer statussen, gescheiden door komma's.
client?stringHet filter van de beheerder op één eindklant. Een sleutel van een eindklant mag alleen de eigen eindklant noemen; elke andere geeft 404. Een andere vorm geeft 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$received_from?stringEerste UTC-dag waarop de factuur is ontvangen, inclusief.
datereceived_to?stringLaatste UTC-dag waarop de factuur is ontvangen, inclusief.
datesort?stringOp ontvangsttijd. Bij gelijke tijd beslist de id, zodat een pagina tussen aanroepen niet verspringt.
"newest""newest""oldest"page?integer1 <= value1page_size?integer252550100200Een pagina met resultaten.
application/json- response
data*array<>total*integerResultaten vóór de paginering.
page*integerDe teruggegeven pagina. Een pagina voorbij het einde wordt teruggebracht tot de laatste.
page_size*integercounts_by_state*Resultaten per status met alle filters behalve state. Een status zonder resultaten wordt weggelaten.
curl -X GET "https://example.com/invoices" \ -H "Authorization: Bearer <your-api-key>"{ "data": [ { "id": "string", "invoice_ref": "string", "invoice_number": "string", "route": "PEPPOL", "environment": "sandbox", "state": "received", "legal_id": "string", "buyer_status": "string", "document_sha256": "string", "attempts": [ { "id": "string", "state": "received", "created_at": "2019-08-24T14:15:22Z" } ], "errors": [ { "code": "string", "source": "string", "message": "string", "field": "string", "fix_hint": "string", "who_fixes": "us", "related": [ { "code": "string", "source": "string" } ] } ], "documents": [ { "kind": "string", "sha256": "string", "href": "string" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deadline_at": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "page_size": 0, "counts_by_state": { "property1": 0, "property2": 0 }}Ontvangen en afgewezen facturen per dag en verzendkanaal GET
Bij elke aanroep berekend uit de opslag. received telt facturen per UTC-dag van aankomst; rejected telt facturen die nu zijn afgewezen, per UTC-dag van hun laatste wijziging. Een dag zonder facturen heeft nullen, zodat een grafiek geen gaten heeft. Met hetzelfde bereik als GET /invoices.
Een factuur of creditnota als canonieke JSON indienen POST
De dienst controleert het document tegelijk tegen het canonieke model en de voorafgaande controles, en antwoordt 422 als een van beide faalt. Alles daarna verloopt asynchroon (opbouw, officiële validatie, verzending naar het verzendkanaal, statussen) en wordt gemeld via statusberichten. Een gecorrigeerde nieuwe indiening van een afgewezen factuur gebruikt dezelfde invoice_ref en een nieuwe Idempotency-Key; de dienst koppelt de pogingen. In productie wordt een ERP-export alleen gelezen als de connectorinstellingen van de eindklant hun eigen verkoper en betaling bevatten, niet het voorbeeld van de mapping: anders volgt 422 connector-settings-missing, met de naam van wat ontbreekt. Een sandbox leest hem met het voorbeeld, zoals eerder.