Docs

De status en de documenten van een ontvangen factuur ophalen

  • In de sandbox
GET
/received/{id}

Sinds 0.35.0. Een ontvangen factuur van een andere eindklant, of een id van een factuur die de eindklant verzendt, geeft 404.

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.

Padparameters

id*string

De id van de dienst voor een ontvangen factuur (teruggegeven door POST /received).

Patroon^rcv_[0-9a-f]{24}$

Body van het antwoord

De ontvangen factuur.

application/json
  1. response

Sinds 0.35.0. Een factuur die de eindklant via een verzendkanaal heeft ontvangen, zoals POST /received haar aannam. Net als Invoice bevat ze geen factuurinhoud: geen verkoper, koper of bedragen.

id*string
Patroon^rcv_[0-9a-f]{24}$
invoice_ref*string

Het eigen factuurnummer van het bestand (BT-1; FA(3) Fa/P_2), anders de rail_id, anders de id.

invoice_number?string
route*Route

Het verzendkanaal van het land. Dezelfde waarden als country_route in statusberichten.

Waarde in"PEPPOL""PL-KSEF""RO-EFACTURA""FR-PA""DE-XRECHNUNG"
client*string
environment*string
Waarde in"sandbox""production"
state*string
Waarde in"received""validated""validation_failed"
direction*"in"
Waarde in"in"
rail_id?string

De eigen id van het verzendkanaal voor het document, zoals opgegeven bij POST /received.

document_sha256*string
Patroon^[a-f0-9]{64}$
duplicate_of?string

Alleen bij POST /received, wanneer het document al voor de eindklant en het verzendkanaal aanwezig was.

links?
errors?array<>
documents?array<>
created_at*string
Formaatdate-time
updated_at*string
Formaatdate-time
curl -X GET "https://example.com/received/string" \  -H "Authorization: Bearer <your-api-key>"
{  "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"}