Docs
EN

Choose a language

eurinvoice.com
Docs
EN

Choose a language

API reference

Every operation a partner can call, generated from the OpenAPI file.

  • In the sandboxbuilt operations
  • Plannedplanned operations

In plain words

Every call a partner can make, generated from the API's OpenAPI file. The base address of the sandbox is https://api-sandbox-eu.eurinvoice.com.

Each page below is generated from the OpenAPI file, version 0.19.3, which the service is tested against. Where a recorded answer is shown, it comes from the service and is dated on its page. The pages in section 3 explain the calls in plain words.

Operations the service has

CallWhat it doesStatus
GET /invoicesList and search invoicesIn the sandbox
POST /invoicesSubmit an invoice or credit note as canonical JSONIn the sandbox
POST /invoices/xmlSubmit a finished UBL or CII document (pass-through)In the sandbox
GET /invoices/seriesInvoices received and rejected per day and routeIn the sandbox
GET /invoices/{id}Get an invoice's current stateIn the sandbox
POST /invoices/{id}/cancelStop an invoice that has not been submitted yetIn the sandbox
GET /invoices/{id}/eventsList the status events of one invoiceIn the sandbox
GET /invoices/{id}/documents/{kind}Download a generated document or the route's receiptIn the sandbox
POST /validateBuild and check a document without sending itIn the sandbox
GET /webhookGet the webhook settings (the operator's, or with a client's admin key that client's own)In the sandbox
PUT /webhookSet the webhook URL, or rotate its secretIn the sandbox
POST /webhook/testSend a signed test event to the webhook URLIn the sandbox
GET /catalogue/{code}Look up an error or reason codeIn the sandbox
GET /healthService healthIn the sandbox
GET /careThe care list: rejected and dead-lettered invoices with the catalogue code and who actsIn the sandbox
POST /care/{id}/handledMark an invoice's care rows handledIn the sandbox
GET /care/{id}/evidenceThe stored files of a care-list invoice with their SHA-256In the sandbox
GET /credentialsStored credentials, without their valuesIn the sandbox
POST /credentialsStore a credential, encrypted; the value is never returnedIn the sandbox
GET /credentials/{id}One credential, without its valueIn the sandbox
POST /credentials/{id}Replace the value (and expiry) of a live credentialIn the sandbox
POST /credentials/{id}/revokeRevoke a credential; the record stays for the audit trailIn the sandbox
GET /keysList API keys (the operator sees all; a client's admin key sees its own)In the sandbox
POST /keysMint an API key for a client; the key is shown onceIn the sandbox
POST /keys/{id}/revokeRevoke an API key; it stops working at onceIn the sandbox

Operations that are planned

The OpenAPI file lists these. The service does not have them yet, so they get no page and no request sample.

CallWhat it will doStatus
POST /invoices/{id}/statusesPost a seller-side status (France only)Planned

Ask the docs

Search the docs in plain words.

List API keys (the operator sees all; a client's admin key sees its own) GET

Next

On this page

Operations the service hasOperations that are planned