La fiche d'un compte

GET

/comptes/{compte}

const url = 'https://example.com/comptes/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/comptes/example \
  --header 'Authorization: Bearer <token>'

Le type, le sous-type et le cadre légal viennent du compte général du plan ; le rattachement vient de l’ouverture ; les positions courantes viennent du livre.

Autorisations

authentification
tenue-de-compte:consultation

Paramètres

Paramètres (path)

compte

required

string

>= 1 characters

L’identifiant public du compte chez ce tenant.

Réponses

200

La fiche du compte.

application/json

object

compte

required

string

libelle

required

string

compte_general

Le numéro du compte général du plan.

string

type

required

Le type, tenu du compte général du plan : ce que le compte enregistre. Il détermine les instruments admis, le rattachement exigé et la politique temporelle.

string

Allowed values: parts-epargnant especes titres mixte droits-contractuels

sous_type

required

Le sous-type, tenu du compte général : l’entité que le compte reflète.

string

Allowed values: epargnant entreprise fonds societe-de-gestion banque organisme erreurs

cadre_legal

Le cadre légal, dérivé du compte général — il se décide au plan, jamais au compte ; absent pour un compte hors cadre (banque, organisme, erreurs). Le compte-titres d’un plan d’épargne retraite relève d’un compte général propre par la loi (L. 224-1) — jamais une dérogation ; un compte de droits contractuels est toujours en cadre plan-epargne-retraite.

string

Allowed values: epargne-salariale plan-epargne-retraite

politique_temporelle

required

La politique DÉCOULE du type, un paramétrage ne la choisit pas.

string

Allowed values: bitemporelle double-axe-de-solde position-courante observations-attestees

statut

required

string

Allowed values: en-preparation ouvert suspendu en-cloture clos abandonne

rattachement_cle

La clé du rattachement — l’entité dont le compte porte les avoirs ou qu’il reflète (EPG épargnant, ENT entreprise, FDS fonds, SGP société de gestion, BNK compte bancaire reflété, ORG organisme) ; absente pour un poste sans entité propre (suspens, collectif).

string

Allowed values: EPG ENT FDS SGP BNK ORG

rattachement_ref

La référence du rattachement — un identifiant publié, immuable.

string

origine_cle

La clé du second couple — comptes de parts d’épargnant seulement.

string

Allowed values: ENT

origine_ref

L’entreprise d’origine des avoirs, immuable : les avoirs de deux entreprises ne coexistent dans aucun compte.

string

justification_separation

Le motif documenté d’un compte de parts supplémentaire pour le même couple dans le même cadre légal ; absent pour un compte unique.

string

dispositifs_presents

Les identifiants publiés des dispositifs portés par des lots vivants du compte. Vide pour un compte jamais alimenté.

Array<string>

positions

required

Les positions courantes, par instrument (les positions nulles ne sont pas servies).

Array<object>

object

instrument

required

string

quantite

required

Un entier, l’unité est celle de l’instrument — jamais de flottant.

integer

Example

{
  "type": "parts-epargnant",
  "sous_type": "epargnant",
  "cadre_legal": "epargne-salariale",
  "politique_temporelle": "bitemporelle",
  "statut": "en-preparation",
  "rattachement_cle": "EPG",
  "origine_cle": "ENT"
}

401

Aucune identité présentée.

403

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

404

Le compte est inconnu de ce tenant.