La fiche d'un CRE

GET

/cre/{identifiant}

const url = 'https://example.com/cre/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/cre/example \
  --header 'Authorization: Bearer <token>'

Le minimum dû au producteur d’un CRE : savoir ce qu’il est devenu. Les effets ne sont présents que pour une comptabilisation ; la cause n’est servie que pour un blocage ou un rejet.

Autorisations

authentification
tenue-de-compte:consultation

Paramètres

Paramètres (path)

identifiant

required

string

>= 1 characters

L’identifiant du CRE (celui du producteur amont).

Réponses

200

La fiche du CRE.

application/json

object

identifiant

required

string

type

required

Le code du type (catalogue des types de CRE).

string

version_type

required

La version du schéma de charge utile.

string

producteur

Le domaine autorité du fait (operations, carnet-ordres, banque-flux-financiers…). Facultatif : le nom du producteur se déclare type par type au catalogue des types de CRE, que la tenue de compte ne détient pas — l’enveloppe reçue ne le porte pas.

string

statut

required

L’état du cycle de vie, tel que le livre le prononce. « Rejeté » est un terminus ; « bloqué » se reprend. Les états intermédiaires (reçu, validé, interprété) se consultent ici ; ils ne se publient pas sur le bus.

string

Allowed values: recu valide interprete comptabilise bloque rejete extourne

cle_idempotence

required

string

date_fait_generateur

required

string format: date

date_valeur

required

string format: date

comptabilise_le

Présent après comptabilisation.

string format: date-time

periode

La période comptable d’inscription, présente après comptabilisation.

string

schema_applique

La version du schéma comptable appliquée (piste d’audit), présente après interprétation.

string

cause

Pour un blocage ou un rejet : le motif précis conservé — période close, entreprise incompatible avec le rattachement, lot insuffisant, réservation expirée, conflit de version d’un état lu en amont…

string

reference_extourne

Le CRE extourné, sur un CRE compensateur.

string

effets

required

Le décompte des effets inscrits, par famille.

object

ecritures

required

Array<object>

object

identifiant

required

L’identifiant déterministe — le CRE qui l’a produite et son rang (« cre/rang »).

string

compte

required

string

sens

required

string

Allowed values: debit credit

quantite

required

La quantité mue — un entier, l’unité est celle de l’instrument.

integer

instrument

required

string

date_comptable

required

La date comptable de l’écriture (verrou de période).

string format: date

date_valeur

Présente quand elle diffère (comptes espèces).

string format: date

contrepassee_par

La marque de correction : l’identifiant du miroir qui a contrepassé cette écriture — absente si l’écriture n’a pas été corrigée.

string

nombre_mouvements_lots

integer

nombre_ajustements_fiscaux

integer

nombre_affectations

integer

Example

{
  "statut": "recu",
  "effets": {
    "ecritures": [
      {
        "sens": "debit"
      }
    ]
  }
}

401

Aucune identité présentée.

403

L’identité présentée n’a pas la famille tenue-de-compte:consultation.

404

Le CRE est inconnu du livre de ce tenant.