Docs

Ontvangen facturen weergeven en doorzoeken

  • In de sandbox
GET
/received

Sinds 0.35.0. Dezelfde parameters en hetzelfde antwoord als GET /invoices, alleen voor ontvangen facturen; state is received, validated of validation_failed. Een sleutel van een eindklant ziet die van de eigen eindklant; de beheerder die van elke eindklant, of van één eindklant met client.

Autorisatie

apiKey
headerAuthorizationBearer <token>

Stuur uw sleutel als bearer-token: Authorization: Bearer <your-api-key>. De health-aanroep is de enige aanroep die geen sleutel vereist.

Queryparameters

q?string
Lengtelength <= 100
route?array<>
state?array<>
client?string
Patroon^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
received_from?string
Formaatdate
received_to?string
Formaatdate
sort?string
Standaard"newest"
Waarde in"newest""oldest"
page?integer
Bereik1 <= value
Standaard1
page_size?integer
Standaard25
Waarde in2550100200

Body van het antwoord

Eén pagina met treffers.

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  }}

De statusberichten van één ontvangen factuur weergeven GET

Sinds 0.35.0. Dezelfde berichten die de webhook bezorgt, in volgorde van reeksnummer, elk met direction in.

Een factuur aanleveren die de eindklant via een verzendkanaal heeft ontvangen POST

Sinds 0.35.0 (17 okt. 2026). De body is de XML precies zoals het verzendkanaal hem heeft bezorgd (UBL, CII of FA(3)); er wordt niets gewijzigd en niets verzonden. Het bestand wordt eerst opgeslagen, verzegeld onder de gegevenssleutel van de eindklant, omdat het wettelijk al ontvangen is; daarna controleren de eigen validators van het verzendkanaal het, zoals bij een pass-through-verzending, en het resultaat komt aan als statusbericht (received, dan validated of validation_failed, met direction: in) op de webhook van de eindklant en op GET /received/{id}/events. Een bestand dat de regels niet haalt, wordt bewaard en staat op validation_failed met de fouten; het wordt nooit weggegooid. Een bestand dat geen factuur is die bewaard moet worden, wordt met 422 geweigerd en er wordt niets opgeslagen, zoals bij POST /invoices/xml: een DOCTYPE (EI-XML-DTD, nooit verwerkt), XML die niet welgevormd is (EI-XML-SYNTAX), of een document dat geen factuur is die het verzendkanaal kent (EI-XML-TYPE). Een controle die niet kon draaien (een validator is niet bereikbaar) wordt opnieuw geprobeerd, en na de laatste poging komt de factuur op de opvolgingslijst en blijft received. Een eindklant levert ten hoogste 120 documenten per minuut en 2.000 per dag aan, welke sleutel hij ook gebruikt (429, niet bewaard onder de Idempotency-Key). Het bestand wordt teruggegeven als download (Content-Disposition: attachment). Eén document van het verzendkanaal is voor de eindklant één ontvangen factuur: op rail_id als die is opgegeven, op de SHA-256 van het bestand als dat niet zo is. Hetzelfde document opnieuw geeft 202 met duplicate_of; dezelfde rail_id met andere bytes geeft 409 received-id-conflict, en er wordt niets opgeslagen. Ontvangen facturen worden gescheiden gehouden van de facturen die de eindklant verzendt: ze staan niet in GET /invoices, de reeks, de metrics of het maandrapport, en ze blokkeren nooit de verzending van hetzelfde bestand. Een ontvangen factuur wordt verwijderd met de bewaartermijn van de eindklant zodra er niets meer openstaat (de controle is afgerond, of een persoon heeft de opvolgingsrij afgehandeld), en staat in de export van de eindklant onder received/. De scope submit; een sleutel van een eindklant werkt alleen voor die eigen eindklant.