Les occurrences de valorisation en transverse

GET

/echeances-de-valorisation

curl --request GET \
  --url 'https://example.com/echeances-de-valorisation?statut=prevue&sort=recue&page=1&taille=50' \
  --header 'Authorization: Bearer <token>'

Toutes les occurrences du tenant sur une période, avec leur SORT SERVI : reçue, attendue, ou en retard — le seuil du retard est une règle du domaine, jamais un calcul du consommateur.

Autorisations

• authentification
  instruments:consultation

Paramètres

Paramètres (query)

du

string format: date

au

string format: date

La borne de fin, exclue.

instrument

string

>= 1 characters

statut

string

Allowed values: prevue confirmee reportee annulee suspendue

sort

string

Allowed values: recue attendue en_retard

societe_de_gestion

string

>= 1 characters

page

integer

default: 1 >= 1

La page demandée, à partir de 1.

taille

integer

default: 50 >= 1 <= 500

Le nombre de lignes par page.

Réponses

200

La page demandée, dans l’ordre des dates puis des instruments.

Media typeapplication/json

object

lignes

required

Array

object

occurrence

required

L’identifiant stable de l’occurrence — la date ne change jamais sous lui.

string

>= 1 characters

date_valorisation

required

string format: date

heure_limite

required

string

/^([01][0-9]|2[0-3]):[0-5][0-9]$/

fuseau

required

Le fuseau IANA de l’heure limite.

string

>= 1 characters

date_publication_prevue

string format: date

date_reglement_prevue

string format: date

statut

required

string

Allowed values: prevue confirmee reportee annulee suspendue

motif

Obligatoire au sens métier pour un report, une annulation, une suspension.

string

occurrence_remplacante

L’occurrence nouvelle qui porte la date reportée — présente pour un report : jamais de modification en place.

string

lignage

Les versions de règles et de calendriers utilisées — l’explicabilité du calcul.

object

instrument

required

string

sort

required

Le sort SERVI de l’échéance — une valeur y répond (reçue), rien encore (attendue), rien au-delà du seuil de retard du domaine (en retard).

string

Allowed values: recue attendue en_retard

valeur_recue_le

L’instant de la publication de la valeur qui répond, quand le sort est « reçue ».

string format: date-time

total

required

integer | null

Example

{
  "lignes": [
    {
      "statut": "prevue",
      "sort": "recue"
    }
  ]
}

400

La demande est irrecevable (date mal formée, bornes incohérentes…) — le motif nomme le champ.

Media typeapplication/json

object

motif

required

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

string

Example^generated

{
  "motif": "example"
}

401

Aucune identité présentée (l’exigence est du contrat, le mécanisme de l’assemblage).

403

L’identité présentée n’a pas la famille d’accès instruments:consultation.