Le contenu d'une restitution

GET

/v1/entreprises/{entreprise}/restitutions/{restitution}

const url = 'https://passerelle.teneur.exemple/v1/entreprises/example/restitutions/example';
const options = {
  method: 'GET',
  headers: {'Correlation-Id': 'example', 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://passerelle.teneur.exemple/v1/entreprises/example/restitutions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Correlation-Id: example'

Les valeurs de la restitution, arrêtées à sa période et servies telles qu’elles ont été arrêtées — un chiffre de restitution ne se recalcule pas à la lecture. La même restitution servie deux fois est identique.

Autorisations

jetonPartenaire

Paramètres

Paramètres (path)

entreprise

required

string

>= 1 characters

L’identifiant publié de l’entreprise chez ce teneur de compte. Il désigne la ressource ; un identifiant d’entreprise dans une URL ne vaut jamais autorisation.

restitution

required

string

>= 1 characters

La référence de la restitution, telle que le catalogue la publie.

Paramètres (header)

Correlation-Id

required

string

>= 1 characters <= 128 characters

L’identifiant que le teneur de compte donne à l’échange dans son journal. Obligatoire : notre trace dit qui a lu quoi, jamais pour qui, et ce champ est la seule jointure entre les deux journaux. Il est restitué dans la réponse.

Réponses

200

La restitution et ses valeurs.

application/json

object

restitution

required

string

type

required

Le vocabulaire clos des restitutions servies. Ce que chaque type contient dépend de la convention de tenue de compte de l’entreprise.

string

Allowed values: CAMPAGNE ENCOURS FRAIS

libelle

required

string

periode

required

object

debut

required

string format: date

fin

Absente pour une période encore ouverte.

string format: date

arretee_le

required

string format: date-time

valeurs

required

Les valeurs arrêtées, chacune avec son libellé et son unité. La forme reste volontairement plate : la composition d’une restitution dépend de la convention, et la figer en schéma reviendrait à imposer une convention unique.

Array<object>

object

libelle

required

string

unite

required

QUANTITE_INSTRUMENT désigne une quantité dans l’unité de l’instrument, publiée par le référentiel des instruments : une restitution d’encours porte aujourd’hui des quantités, sa valorisation en euros attendant la projection de valorisation courante de la tenue de compte.

string

Allowed values: CENTIME_EURO NOMBRE QUANTITE_INSTRUMENT

valeur_entiere

La valeur

integer

instrument

L’instrument concerné

string

dispositif

Le dispositif concerné

string

Example

{
  "type": "CAMPAGNE",
  "valeurs": [
    {
      "unite": "CENTIME_EURO"
    }
  ]
}

Headers

Correlation-Id

string

>= 1 characters <= 128 characters

L’identifiant de corrélation reçu, restitué tel quel — la jointure entre le journal du teneur et le nôtre.

401

401 — aucune identité présentée, ou jeton invalide : signature, émetteur, dates, tenant, ou audience obtenue pour une autre surface. La réponse porte WWW-Authenticate: Bearer error="invalid_token".

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

Headers

WWW-Authenticate

string

Le défi d’authentification, au format des jetons porteurs.

403

403 — le cas d’usage n’est pas dans le périmètre souscrit de ce client. La réponse ne dit jamais si la ressource existe.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

404

404 — inconnu de ce teneur de compte. Une entreprise, un dispositif ou une opération relevant d’un autre teneur est inexistant, jamais interdit : la muraille de Chine ne laisse pas fuir une existence.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

409

409 — la restitution existe mais son contenu est retenu : le nombre de porteurs derrière l’agrégat est sous le plancher d’agrégation du teneur, et le servir approcherait le patrimoine d’une personne. Ce n’est ni une erreur du portail ni un droit qui manque — c’est une protection, et elle se lève quand la population s’étoffe. Le motif est destiné à être affiché tel quel.

application/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}