Lots et fichiers

Les factures d’un même envoi vers une même caisse, regroupées par Ophelix à l’heure d’envoi du praticien.

Le cycle de vie et les pièges : Lots et fichiers.

Événements : batch.*.

Routes

Route	Effet
`GET /v1/batches/{batch}`	Lire un lot
`GET /v1/batches`	Lister les lots
`GET /v1/batches/upcoming`	Voir le prochain envoi
`POST /v1/batches/send`	Envoyer maintenant
`POST /v1/batches/{batch}/rebuild`	Reconstituer un lot refusé

L’objet

idtexte
L'identifiant de l'objet, préfixé par son type.
objecttexte
Le nom du type d'objet.
statusénumération
createdsentacknowledgedfailed
numbertexte
La référence du lot : 001 à 999 pour la FSE, AAA à ZZZ pour la DRE, par situation de facturation.
kindénumération
Le genre de facture.
fsedre
modeénumération
Le mode de sécurisation commun à ses factures.
secureddegradedsesam_sans_vitale
third_partybooléen
Ses factures sont en tiers payant : la caisse règle le praticien.
practitioneridentifiant ou objet
L'identifiant du praticien, ou l'objet avec expand[]=practitioner.
practice_situationtexteou null
regime_codetexteou null
Le régime de l'organisme destinataire.
fund_codetexteou null
La caisse de l'organisme destinataire.
transmissionidentifiant ou objetou null
Le fichier qui l'a porté, ou l'objet avec expand[]=transmission. Null avant l'envoi.
claim_countentier
amount_centsentierou null
Le total de ses factures, en centimes. Null si l'une n'a pas de montant.
failure_codetexteou null
Le code de traitement de l'accusé négatif, tel que l'organisme le donne (1001, 2004…).
failure_labeltexteou null
Le libellé de ce traitement, tel que la traduction de l'accusé le rend.
retransmissionbooléen
Lot reconstitué après un accusé négatif : il ne repart qu'une fois.
rebuilt_fromtexteou null
Le lot refusé dont celui-ci est la reconstitution.
rebuildablebooléen
Le lot refusé peut se reconstituer : POST /v1/batches/{id}/rebuild.
sent_atentierou null
acknowledgment_expectedbooléen
Faux pour un lot de FSE dégradées : l'organisme n'en accuse pas réception, le lot s'archive une fois envoyé.
acknowledgment_due_atentierou null
L'instant où, sans accusé, le lot sera en retard : 48 heures après l'envoi.
overdue_atentierou null
Signalé en retard : envoyé, toujours sans accusé passé le délai.
acknowledged_atentierou null
failed_atentierou null
rebuilt_atentierou null
livemodebooléen
true en production, false en mode test.
createdentierou null
La création de l'objet, en secondes Unix.
updatedentierou null
La dernière modification, en secondes Unix.

L'objet


{
  "id": "obj_…",
  "object": "batch",
  "status": "created",
  "number": "…",
  "kind": "fse",
  "mode": "secured",
  "third_party": true,
  "practitioner": "…",
  "practice_situation": null,
  "regime_code": null,
  "fund_code": null,
  "transmission": "…",
  "claim_count": 0,
  "amount_cents": 0,
  "failure_code": null,
  "failure_label": null,
  "retransmission": true,
  "rebuilt_from": null,
  "rebuildable": true,
  "sent_at": null,
  "acknowledgment_expected": true,
  "acknowledgment_due_at": null,
  "overdue_at": null,
  "acknowledged_at": null,
  "failed_at": null,
  "rebuilt_at": null,
  "livemode": false,
  "created": 1793970000,
  "updated": null
}