Aller au contenu

La position d'un compte, courante ou à une date comptable donnée.

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

Sans paramètre de date, la position courante ; avec une date, l’état du livre à cette date, y compris dans le passé (un déblocage anticipé s’apprécie à la date du fait générateur). La réponse porte toujours la date effectivement servie. Lecture sans effet de bord.

tenant
required
string
>= 1 characters

Le teneur de compte — la muraille de Chine, aucune consultation ne la franchit.

compte
required
string
>= 1 characters

L’identifiant public du compte chez ce tenant.

date
string format: date

La date comptable de consultation (AAAA-MM-JJ). Absente, la position courante est servie.

La position du compte à la date servie.

Media typeapplication/json
object
tenant
required

Le teneur de compte.

string
compte
required

L’identifiant public du compte.

string
date
required

La date comptable effectivement servie — la vérité se rapporte à elle.

string format: date
gele
required

Le compte est gelé sur ordre de la Conformité — le gel prime tout : quand il est vrai, toute quantité consommable est zéro. (Le canal du gel n’étant pas encore réalisé, la valeur reste fausse en attendant — notice, §2.)

boolean
lignes
required

Une ligne par instrument détenu à la date servie (les positions nulles ne sont pas servies).

Array<object>
object
instrument
required

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

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 (des centimes pour la devise, des millionièmes de part pour un fonds…).

integer
consommable
required

Ce qu’un rachat peut mobiliser à la date servie — l’écrêtement déjà fait par la tenue de compte (indisponible, gelé, contraintes retranchés). Même unité que la quantité.

integer
ventilation
required

Le détail par échéance de disponibilité et origine d’avoir — la somme des quantités égale la quantité détenue.

Array<object>
object
echeance
required

La date de disponibilité de cette part de la position.

string format: date
compartiment

Le compartiment fiscal (nomenclature de ventilation), s’il est porté.

string
origine
required

L’origine d’avoir (participation, intéressement, abondement, versement volontaire…), en identifiant de la nomenclature.

string
quantite
required

La quantité de cette ligne — même unité que la position.

integer
disponible
required

L’échéance est échue à la date servie (avant écrêtement du gel et des contraintes).

boolean
Examplegenerated
{
"tenant": "example",
"compte": "example",
"date": "2026-04-15",
"gele": true,
"lignes": [
{
"instrument": "example",
"quantite": 1,
"consommable": 1,
"ventilation": [
{
"echeance": "2026-04-15",
"compartiment": "example",
"origine": "example",
"quantite": 1,
"disponible": true
}
]
}
]
}

La demande est irrecevable (date mal formée, par exemple) — 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’exigence d’authentification est du contrat, son mécanisme de l’assemblage).

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"
}