Skip to Content
RéférenceLots de piècesL’objet

Lots de pièces

Les dossiers de pièces des feuilles d’un même lot, envoyés au point d’accueil SCOR, puis accusés.

Le cycle de vie et les pièges : Pièces justificatives.

Événements : supporting_document_batch.*.

Routes

RouteEffet
GET /v1/supporting-document-batches/{supportingDocumentBatch}Lire un lot de pièces
GET /v1/supporting-document-batchesLister les lots de pièces

L’objet

  • idtexte

    L'identifiant de l'objet, préfixé par son type.

  • objecttexte

    Le nom du type d'objet.

  • statusénumération

    created : préparé, pas encore parti ; sent ; acknowledged ; failed : refusé, ses pièces repartent ou sont redemandées.

    createdsentacknowledgedfailed

  • nametexte

    Le nom du lot, <numéro de facturation>-<compostage>, que l'accusé cite.

  • batchtexteou null

    Le lot de factures que ces pièces suivent.

  • practitionertexte
  • sequenceentier

    Son rang parmi les lots de pièces de ce lot de factures, et leur nombre.

  • sequence_countentier
  • dossier_countentier
  • document_countentier
  • recipienttexteou null

    La boîte du point d'accueil destinataire.

  • file_nametexteou null
  • size_bytesentierou null
  • retransmissionbooléen

    Second envoi de ses dossiers, après un accusé négatif.

  • failure_codetexteou null

    Le code de l'accusé négatif.

  • failure_labeltexteou null
  • sent_atentierou null
  • acknowledged_atentierou null
  • failed_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": "supporting_document_batch", "status": "created", "name": "Accueil", "batch": null, "practitioner": "…", "sequence": 0, "sequence_count": 0, "dossier_count": 0, "document_count": 0, "recipient": null, "file_name": null, "size_bytes": null, "retransmission": true, "failure_code": null, "failure_label": null, "sent_at": null, "acknowledged_at": null, "failed_at": null, "livemode": false, "created": 1793970000 }
Mis à jour le