Docs

Lire l’état et les documents d’une facture reçue

  • Dans le bac à sable
GET
/received/{id}

Depuis la 0.35.0. La facture reçue d’un autre client, ou l’identifiant d’une facture que le client envoie, répond 404.

Autorisation

apiKey
headerAuthorizationBearer <token>

Envoyez votre clé sous forme de jeton bearer : Authorization: Bearer <your-api-key>. L’état du service est le seul appel qui ne nécessite pas de clé.

Paramètres de chemin

id*string

L’identifiant du service pour une facture reçue (renvoyé par POST /received).

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

Corps de la réponse

La facture reçue.

application/json
  1. response

Depuis la 0.35.0. Une facture que le client a reçue par un canal, telle que POST /received l’a prise. Comme Invoice, elle ne porte aucun contenu de facture : ni vendeur, ni acheteur, ni montants.

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

Le numéro de facture propre au fichier (BT-1 ; FA(3) Fa/P_2), sinon le rail_id, sinon l’identifiant.

invoice_number?string
route*Route

Le canal du pays. Les mêmes valeurs que country_route dans les événements de statut.

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

L’identifiant propre du canal pour le document, tel que donné sur POST /received.

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

Uniquement sur POST /received, quand le document était déjà conservé pour le client et le canal.

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"}