Docs

API-referentie

Elke operatie die een partner kan aanroepen, gegenereerd uit het OpenAPI-bestand.

  • In de sandboxgebouwde operaties
  • Geplandgeplande operaties

In gewone woorden

Elke aanroep die een partner kan doen, gegenereerd uit het OpenAPI-bestand van de API. Het basisadres van de sandbox is https://api-sandbox-eu.eurinvoice.com.

Elke pagina hieronder is gegenereerd uit het OpenAPI-bestand, versie 0.19.3, waartegen de dienst wordt getest. Waar een vastgelegd antwoord wordt getoond, komt het van de dienst en staat de datum op de pagina zelf. De pagina’s in sectie 3 leggen de aanroepen in gewone woorden uit.

Operaties die de dienst heeft

AanroepWat het doetStatus
GET /invoicesFacturen tonen en zoekenIn de sandbox
POST /invoicesEen factuur of creditnota als canonieke JSON indienenIn de sandbox
POST /invoices/xmlEen afgewerkt UBL- of CII-document indienen (doorgifte)In de sandbox
GET /invoices/seriesOntvangen en afgewezen facturen per dag en verzendkanaalIn de sandbox
GET /invoices/{id}De actuele status van een factuur opvragenIn de sandbox
POST /invoices/{id}/cancelEen factuur stoppen die nog niet is ingediendIn de sandbox
GET /invoices/{id}/eventsDe statusberichten van één factuur tonenIn de sandbox
GET /invoices/{id}/documents/{kind}Een gegenereerd document of het ontvangstbewijs van het verzendkanaal downloadenIn de sandbox
POST /validateEen document opbouwen en controleren zonder het te verzendenIn de sandbox
GET /webhookDe webhookinstellingen opvragen (die van de beheerder, of met de beheerderssleutel van een eindklant die van die eindklant)In de sandbox
PUT /webhookDe webhook-URL instellen, of het geheim vernieuwenIn de sandbox
POST /webhook/testEen ondertekend testbericht naar de webhook-URL sturenIn de sandbox
GET /catalogue/{code}Een fout- of redencode opzoekenIn de sandbox
GET /healthStatus van de dienstIn de sandbox
GET /careDe opvolgingslijst: afgewezen facturen en facturen in de dead-letterlijst, met de cataloguscode en wie handeltIn de sandbox
POST /care/{id}/handledDe opvolgingsrijen van een factuur als afgehandeld markerenIn de sandbox
GET /care/{id}/evidenceDe bewaarde bestanden van een factuur op de opvolgingslijst met hun SHA-256In de sandbox
GET /credentialsBewaarde toegangsgegevens, zonder hun waardenIn de sandbox
POST /credentialsToegangsgegevens versleuteld bewaren; de waarde wordt nooit teruggegevenIn de sandbox
GET /credentials/{id}Eén set toegangsgegevens, zonder waardeIn de sandbox
POST /credentials/{id}De waarde (en de vervaldatum) van geldige toegangsgegevens vervangenIn de sandbox
POST /credentials/{id}/revokeToegangsgegevens intrekken; het record blijft voor het auditspoorIn de sandbox
GET /keysAPI-sleutels tonen (de beheerder ziet alle; een beheerderssleutel van een eindklant ziet de eigen)In de sandbox
POST /keysEen API-sleutel voor een eindklant aanmaken; de sleutel wordt eenmalig getoondIn de sandbox
POST /keys/{id}/revokeEen API-sleutel intrekken; hij werkt meteen niet meerIn de sandbox

Geplande operaties

Het OpenAPI-bestand vermeldt deze operaties. De dienst heeft ze nog niet, dus ze krijgen geen pagina en geen voorbeeldverzoek.

AanroepWat het zal doenStatus
POST /invoices/{id}/statusesEen status van de verkoper melden (alleen Frankrijk)Gepland

Op deze pagina