Docs

Référence de l’API

Toutes les opérations qu’un intégrateur peut appeler, générées à partir du fichier OpenAPI.

  • Dans le bac à sableopérations développées
  • Prévuopérations prévues

En termes simples

Chaque appel qu’un intégrateur peut faire, généré à partir du fichier OpenAPI de l’API. L’adresse de base du bac à sable est https://api-sandbox-eu.eurinvoice.com.

Chaque page ci-dessous est générée à partir du fichier OpenAPI, version 0.19.3, par rapport auquel le service est testé. Quand une réponse enregistrée est montrée, elle provient du service et est datée sur sa page. Les pages de la section 3 expliquent les appels en termes simples.

Opérations dont dispose le service

AppelCe qu’il faitStatut
GET /invoicesLister et rechercher des facturesDans le bac à sable
POST /invoicesSoumettre une facture ou un avoir en JSON canoniqueDans le bac à sable
POST /invoices/xmlSoumettre un document UBL ou CII fini (transmission directe)Dans le bac à sable
GET /invoices/seriesFactures reçues et rejetées par jour et par canalDans le bac à sable
GET /invoices/{id}Obtenir l’état actuel d’une factureDans le bac à sable
POST /invoices/{id}/cancelArrêter une facture qui n’a pas encore été transmiseDans le bac à sable
GET /invoices/{id}/eventsLister les événements de statut d’une factureDans le bac à sable
GET /invoices/{id}/documents/{kind}Télécharger un document généré ou l’accusé du canalDans le bac à sable
POST /validateConstruire et contrôler un document sans l’envoyerDans le bac à sable
GET /webhookObtenir les paramètres du webhook (ceux de l’opérateur, ou, avec la clé d’administration d’un client, ceux de ce client)Dans le bac à sable
PUT /webhookDéfinir l’URL du webhook, ou renouveler son secretDans le bac à sable
POST /webhook/testEnvoyer un événement de test signé à l’URL du webhookDans le bac à sable
GET /catalogue/{code}Consulter un code d’erreur ou de motifDans le bac à sable
GET /healthÉtat du serviceDans le bac à sable
GET /careLa liste de suivi : factures rejetées ou en échec définitif, avec le code du catalogue et qui agitDans le bac à sable
POST /care/{id}/handledMarquer comme traitées les lignes de suivi d’une factureDans le bac à sable
GET /care/{id}/evidenceLes fichiers stockés d’une facture de la liste de suivi, avec leur SHA-256Dans le bac à sable
GET /credentialsIdentifiants d’accès stockés, sans leurs valeursDans le bac à sable
POST /credentialsStocker un identifiant d’accès, chiffré ; la valeur n’est jamais renvoyéeDans le bac à sable
GET /credentials/{id}Un identifiant d’accès, sans sa valeurDans le bac à sable
POST /credentials/{id}Remplacer la valeur (et l’expiration) d’un identifiant d’accès actifDans le bac à sable
POST /credentials/{id}/revokeRévoquer un identifiant d’accès ; l’enregistrement reste pour la piste d’auditDans le bac à sable
GET /keysLister les clés d’API (l’opérateur voit tout ; la clé d’administration d’un client voit les siennes)Dans le bac à sable
POST /keysCréer une clé d’API pour un client ; la clé n’est affichée qu’une foisDans le bac à sable
POST /keys/{id}/revokeRévoquer une clé d’API ; elle cesse de fonctionner aussitôtDans le bac à sable

Opérations prévues

Le fichier OpenAPI les liste. Le service ne les a pas encore : elles n’ont donc ni page ni exemple de requête.

AppelCe qu’il feraStatut
POST /invoices/{id}/statusesEnvoyer un statut côté vendeur (France uniquement)Prévu

Sur cette page