Docs
EN

Choose a language

eurinvoice.com
Docs
EN

Choose a language

Get a received invoice's state and documents

  • In the sandbox
GET
/received/{id}

Since 0.35.0. Another client's received invoice, or an id of an invoice the client sends, answers 404.

Authorization

apiKey
headerAuthorizationBearer <token>

Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.

Path parameters

id*string

The service's id for a received invoice (returned by POST /received).

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

Response body

The received invoice.

application/json
  1. response

Since 0.35.0. An invoice the client received through a route, as POST /received took it. Like Invoice, it carries no invoice content: no seller, buyer or amounts.

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

The file's own invoice number (BT-1; FA(3) Fa/P_2), else the rail_id, else the id.

invoice_number?string
route*Route

The country route. The same values as country_route in status events.

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

The route's own id for the document, as given on POST /received.

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

Only on POST /received, when the document was already held for the client and route.

links?
errors?array<>
documents?array<>
created_at*string
Formatdate-time
updated_at*string
Formatdate-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"}

The client records, by partner GET

Since 0.24.0 (C14). The operator's key or the read-only operator key; since 0.25.0 a partner key, which gets its own partner's list (naming another partner answers 403). The records set with PUT /clients/{client}/profile, by client id in byte order, 500 at a time. When truncated is true, next is the last id of the page, and after= that id reads the next page. partner narrows the list to one partner's clients. A client with keys but no record is not listed.

Download a received file or its check GET

Since 0.35.0. The ETag is the SHA-256 of the file.