Aller au contenu

La position d'un compte

GET
/comptes/{compte}/position
curl --request GET \
--url 'https://example.com/comptes/example/position?lots=false' \
--header 'Authorization: Bearer <token>'

Sans paramètre, la position courante. Avec date_reference, la meilleure reconstitution d’aujourd’hui à cette date d’effet — un déblocage anticipé s’apprécie à la date du fait générateur.

compte
required
string
>= 1 characters

L’identifiant public du compte chez ce tenant.

date_reference
string format: date

La date d’effet de la consultation (AAAA-MM-JJ). Absente, la position courante.

connu_au
string format: date-time

L’instant de connaissance : la position telle qu’elle était représentée à cet instant, corrections tardives exclues. Exige une date_reference.

lots
boolean

Vrai pour recevoir les lots de droits de chaque ligne (comptes-titres d’épargnant).

La position du compte aux axes servis.

Media typeapplication/json
object
compte
required
string
date_reference
required

La date d’effet effectivement servie — la vérité se rapporte à elle.

string format: date
connu_au

L’instant de connaissance servi ; absent = la meilleure reconstitution d’aujourd’hui.

string format: date-time
restrictions
required

Les restrictions en vigueur dont la portée touche ce compte — à cible et à effet gradué, remplaçant le booléen gele. Le tableau vide signifie « aucune restriction » ; l’effet sur une opération donnée s’apprécie par l’évaluation des avoirs, jamais par le consommateur.

Array<object>
object
mesure
required

L’identifiant publié de la mesure ordonnée par la Conformité. Le motif ne circule jamais.

string
nature
required

La nature de la mesure (nomenclature du canal conformite.mesure — GEL_AVOIRS, BLOCAGE_OPERATIONS…).

string
cible_type
required

Ce que la cible désigne — une restriction peut viser un seul lot sans viser le compte.

string
Allowed values: COMPTE INSTRUMENT LOT COMPARTIMENT ORIGINE OPERATION
cible
required

L’identifiant de la cible (le compte, l’instrument, le lot…).

string
depuis

La date d’effet de la mesure.

string format: date-time
lignes
required

Une ligne par instrument détenu aux axes servis (les positions nulles ne sont pas servies).

Array<object>
object
instrument
required

L’identifiant public de l’instrument (le fonds, le titre, la devise).

string
quantite
required

La quantité détenue — toujours un entier, jamais de flottant ; l’unité est celle de l’instrument, publiée par le référentiel des instruments.

integer
lots

Sur demande (lots=true) : les lots de droits vivants de la ligne, aux axes servis. La somme des quantités restantes se rapproche de la quantité détenue, aux réserves explicitement justifiées près. La ventilation par échéance, origine ou compartiment est une lecture que le consommateur recompose des lots — elle n’est plus servie de plein droit.

Array<object>
object
lot
required

L’identifiant du lot chez la tenue de compte.

string
dispositif
required

L’identifiant publié du dispositif.

string
dispositif_version
required

La version du paramétrage qui a fondé l’échéance — reçue avec le fait, jamais ré-résolue : c’est elle qui rend l’échéance rejouable.

string
compartiment

Le compartiment (nomenclature des dimensions de lot), s’il est porté.

string
origine
required

L’origine d’avoir (nomenclature des dimensions de lot).

string
echeance

La date à laquelle les droits cessent d’être indisponibles ; absente pour des droits sans échéance datée (retraite).

string format: date
date_acquisition
required
string format: date
quantite_initiale
required

Même unité que la position.

integer
quantite_restante
required
integer
qualite_donnee
required

La qualité de la donnée d’un lot repris — une donnée non démontrée bloque les opérations exigeant une précision indisponible.

string
Allowed values: PROUVEE PARTIELLE INCERTAINE
entreprise_origine
required

L’entreprise d’origine du lot — contrôlée contre le rattachement du compte.

string
Example
{
"restrictions": [
{
"cible_type": "COMPTE"
}
],
"lignes": [
{
"lots": [
{
"qualite_donnee": "PROUVEE"
}
]
}
]
}

Demande irrecevable (connu_au sans date_reference, date mal formée…) — le motif nomme le champ.

Media typeapplication/json
object
motif
required

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

string
Examplegenerated
{
"motif": "example"
}

Aucune identité présentée.

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

Le compte est inconnu de ce tenant.

Media typeapplication/json
object
motif
required

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

string
Examplegenerated
{
"motif": "example"
}