Accusés de réception

Ce que l’organisme destinataire dit d’un lot : pris, ou refusé avec son code. Il se rattache au lot qu’il désigne.

Le cycle de vie et les pièges : Retours des caisses.

Routes

Route	Effet
`POST /v1/acknowledgments`	Déposer un fichier d’accusés
`GET /v1/acknowledgments/{acknowledgment}`	Lire un accusé de réception
`GET /v1/acknowledgments`	Lister les accusés de réception

L’objet

idtexte
L'identifiant de l'objet, préfixé par son type.
objecttexte
Le nom du type d'objet.
resulténumération
positivenegative
batchidentifiant ou objetou null
Le lot qu'il acquitte, ou l'objet avec expand[]=batch. Null : aucun lot en attente ne lui correspond.
matchedbooléen
Rattaché à un lot envoyé. Sinon, il reste gardé pour analyse.
codetexteou null
Le code de traitement d'un accusé négatif, tel que l'organisme le donne.
labeltexteou null
Le libellé du traitement, tel que la traduction le rend.
claimtexteou null
La facture que le code désigne, quand il en désigne une.
invoice_numbertexteou null
Le numéro de cette facture, lu dans le libellé.
emittertexteou null
L'émetteur du lot : le numéro de facturation de la situation.
recipienttexteou null
L'organisme destinataire du lot.
batch_numbertexteou null
batch_datetexteou null
La date du lot, AAAA-MM-JJ.
sourceénumération
filesimulator
file_nametexteou null
received_atentierou null
livemodebooléen
true en production, false en mode test.
createdentierou null
La création de l'objet, en secondes Unix.

L'objet


{
  "id": "obj_…",
  "object": "acknowledgment",
  "result": "positive",
  "batch": "…",
  "matched": true,
  "code": null,
  "label": null,
  "claim": null,
  "invoice_number": null,
  "emitter": null,
  "recipient": null,
  "batch_number": null,
  "batch_date": null,
  "source": "file",
  "file_name": null,
  "received_at": null,
  "livemode": false,
  "created": 1793970000
}