Entités
Enumérations
Types

Entités

ActiviteProfessionnelle

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant
customIdString
Identifiant externe
Identifiant personnalisé
professionTypeProfessionType
Profession
Code décrivant la profession (artisan, commerçant, libéral, salarié) - obligatoire
professionProfessionCategory
deprecated Profession
Code décrivant la profession (artisan, commerçant, libéral, salarié) - obligatoire
sousProfessionProfessionSubCategory
deprecated Sous-profession
Code décrivant la sous-profession, obligatoire pour les libéraux et salariés
revenusProfessionnelsList<RevenuProfessionnel>
Revenus professionnels
Revenu tiré de l'activité, de 1 à 3 selon l'activité (1 divers pour les sans professions et retraités, 3 pour les 'dirigeants', 1 divers et 1 travail pour les autres
ActiviteProfessionnelleInitializer

PropriétéTypeDescription
customIdString
Identifiant externe
Identifiant personnalisé
professionTypeProfessionType
Profession
Code décrivant la profession (artisan, commerçant, libéral, salarié). Obligatoire.
professionProfessionCategory
deprecated Profession
Code décrivant la profession (artisan, commerçant, libéral, salarié). Obligatoire si professionType n'est pas spécifié. Interdit si professionType est spécifié.
sousProfessionProfessionSubCategory
deprecated Sous-profession
Code décrivant la sous-profession. Obligatoire pour les libéraux et salariés si professionType n'est pas spécifié. Interdit si professionType est spécifié.
revenusProfessionnelsList<RevenuProfessionnelInitializer>
Revenus professionnels
Revenus de l'activité. 1 revenu DIVERS doit être présent pour les sans professions et retraités. 1 revenu DU_CAPITAL doit être présent pour les dirigeants accompagné de 1 revenu DU_TRAVAIL éventuellement et 1 revenu DIVERS éventuellement. 1 revenu DU_TRAVAIL et éventuellement un revenu DIVERS pour les autres.
ActiviteProfessionnellePatch

PropriétéTypeDescription
profession *ProfessionType
Profession
Type de profession, a renseigner en fonction de la caisse de retraite prévue. Peut être omis, mais la valeur doit être non-nulle si fournie.
customIdString
Identifiant externe
Identifiant personnalisé
revenusProfessionnelsList<RevenuProfessionnelInitializer>
Revenus professionnels
Revenu tiré de l'activité, de 1 à 3 selon l'activité (1 divers pour les sans professions et retraités, 3 pour les 'dirigeants', 1 divers et 1 travail pour les autres
ApprochePlacement

saisie et calcul du profil investisseur pour 1 membre du foyer

PropriétéTypeDescription
personne *RattachementPersonneSimpleType
Personne questionnée
Personne (particulier, conjoint) qui répond au questionnaire
objectifsProfilInvestisseur *List<ObjectifProfilInvestisseur>
Objectifs
Liste des objectifs/projets du profil investisseur de' la personne
questionsPondereesint
deprecated Nombre questions pondérées
Ne plus utiliser du tout. Sera supprimé en Janvier 2021
scoreTotal *Scoring
Score total
Score total du profil investisseur, avec application des pondérations
questionsProfilInvestisseur *List<ConnaissanceReponseQuestion>
Questions
Liste des questions du profil investisseur d'une personne
profilInvestisseurEvalueCode *String
Profil investisseur proposé
Proposition de profil investisseur en fonction du questionnaire et des horizons de placement
ApprochePlacementInitializer

Définition du profil investisseur du foyer

PropriétéTypeDescription
personne *RattachementPersonneSimpleType
Personne questionnée
Personne (particulier, conjoint) qui répond au questionnaire
questionsProfilInvestisseur *List<ConnaissanceReponseQuestionInitializer>
Questions-réponses
Liste des questions et réponses à alimenter pour le questionnaire de connaissances financières de cette personne
ApprochePlacementInitializerList

Définition du profil investisseur du foyer

PropriétéTypeDescription
approchesPlacementList<ApprochePlacementInitializer>
Approches placement
Approches placement à mettre à jour. Remplacent intégralement les approches placement existantes. Si par exemple le conjoint n'est pas fourni et que dans le dossier le questionnaire profil investisseur a été renseigné, il sera supprimé. La structure est identique à celle utilisée pour la création d'un dossier.
CompteTitres

Compte titres

Compte titres, ie un compte bancaire sur lequel on a des titres financiers/valeurs mobilières

PropriétéTypeDescription
idlong
Identifiant
Indentifiant unique
uid *UUID
Identifiant unique
Identifiant universel unique
customIdString
Identifiant personnalisé
Identifiant d'un compte titres dans le CRM client
foyerIdlong
Identifiant foyer
Relation vers le foyer qui détient ce compte titres
type *CompteTitresType
Type de compte titres
Type de compte titres. Désormais un enum en base de données aussi avec le nom du type en clair.
souscripteur *PossesseurType
Souscripteur
Souscripteur ou titulaire du compte. Pour un COMPTE_INSTRUMENTS_FINANCIERS peut être le principal, le conjoint ou le couple. Pour les PEA_CLASSIQUE et PEA_PME_ETI cela ne peut être que le principal ou le conjoint (le couple est interdit).
fractions *Fractions
Fractions
Fractions entre le principal, le conjoint, le couple. La somme doit toujours être égale à 1.
interneboolean
Interne
Valeur par défaut : true
Placement interne à la société
autreOrganismeString
Autre organisme
Organisme détenteur hors liste proposée
libelleString
Libellé
Libellé choisi par l'utilisateur ou placé automatiquement selon le mode dans lequel le compte titres aura été créé.
dateSouscriptionLocalDate
Date souscription
Date d'ouverture du compte titres
dateEcheanceLocalDate
Date échéance
Date d'échéance. Doit être supérieure à la date de souscription si la date de souscription est spécifiée.
detentionMode *DetentionMode
Mode détention
Valeur par défaut : PLEINE_PROPRIETE
Mode de détention
societeAcquetboolean
Société d'acquêts
Valeur par défaut : false
Dans le cadre d'un dossier couple avec séparation de biens ayant une société d'acquets consitutée, ce champ permet de savoir si le compte titres est intégré à cette société d'acquêts.
usufruitDureeTypeUsufruitDuree
Type de durée d'un usufruit ou d'une nue propriété
Valable uniquement si le mode de détention est nue-propriété ou usufruit. Détermine si on est en viager ou un usufruit temporaire.
usufruitTemporaireAnneeFinYear
Année fin usufruit temporaire
Année de fin de l'usufruit temporaire d’un placement détenu en nue-propriété temporaire ou fin de l’usufruit temporaire sur un placement. Si null, pas de fin.
usufruitViagerUsufruitierAnneeNaissanceYear
Usufruit temporaire date naissance usufruitier
Année de naissance de l'usufruitier d'un usufruit viager d’un placement détenu en usufruit. Null si en pleine propriété ou si la détention est USUFRUIT
collecteurPlacementsAutoboolean
Collecteur Automatique
Valeur par défaut : false
Permet de savoir si le compte titres est un collecteur automatique de placement. Si ce champ est à true, alors il sert à collecter tous les placements qui devraient être dans un compte titres mais dont on ne sait pas où les mettre.
CompteTitresInitializer

PropriétéTypeDescription
transientIdUUID
transientId
Identifiant temporaire de compte titres. Permet de spécifier temporairement un identifiant pour un compte titres au format UUID (v4), alors même que le dossier n'est pas encore créé. Ne doit JAMAIS être fourni dans l'API POST Compte Titres (une erreur sera levée), sert uniquement à l'API de création de dossier.
type *CompteTitresType
type
Type de compte titres.
libelleString
Libellé
Libellé du compte titre.
customIdString
Identifiant externe
Identifiant personnalisé
souscripteurPossesseurType
Souscripteur
Souscripteur titulaire du compte. Attention, selon les types de compte-titres, des restrictions s'appliquent sur les souscripteurs possibles. Consulter la documentation de CompteTitreType pour savoir si la valeur COUPLE est autorisée. Pour un dossier d'une personne seule, doit toujours être à PRINCIPAL.
organismeDetenteurOrganismeDetenteur
Organisme détenteur
Indique si le compte titres a été conclu en interne ou auprès d'un autre organisme. Si non spécifé, sera externe par défaut.
fractionsFractions
Fractions
Fractions détenues par les membres du foyer
dateSouscriptionLocalDate
Date souscription
Date de souscription à ce compte titres. Uniquement dans le cadre d'un PEA. Ignorée dans les autres cas. Si non fournie dans le cadre d'un PEA, sera par défaut mise à la date du jour.
dateEcheanceLocalDate
Date d'échéance
Date d'échéance du compte titres. Uniquement dans le cadre d'un PEA, ignorée dans le cadre des autres types de compte titres. Si fournie, elle doit être supérieure à la date de souscription (ou la date du jour à défaut). Si non fournie dans le cadre d'un PEA, sera automatiquement recalculée sur la base de la date de souscription.
detentionDetailDetention Détail
Détention
Mode de détention du compte titres. Si non spécifié sera par défaut en pleine propriété.
CompteTitresPatch

PropriétéTypeDescription
libelleString
Libellé
Libellé du compte titre. Sera null si aucun libellé n'est fourni.
customIdString
Identifiant externe
Identifiant personnalisé. Sera null si aucun customId n'a été fourni.
souscripteur *PossesseurType
Souscripteur
Souscripteur titulaire du compte. Attention, selon les types de compte-titres, des restrictions s'appliquent sur les souscripteurs possibles.
organismeDetenteur *OrganismeDetenteur
Organisme détenteur
Indique si le compte titres a été conclu en interne ou auprès d'un autre organisme.
fractions *Fractions
Fractions
Fractions détenues par les membres du foyer
dateSouscription *LocalDate
Date souscription
Date de souscription à ce compte titres. Uniquement dans le cadre d'un PEA, sera null pour les autres types de compte titres
dateEcheance *LocalDate
Date d'échéance
Date d'échéance du compte titres. Toujours spécifié dans le cadre d'un PEA, null pour les autres types de compte titres.
detentionDetail *Detention Détail
Détention
Mode de détention du compte titres. Si non spécifié sera par défaut en pleine propriété.
ConnaissanceReponseQuestion

Décrit une question et la reponse faite au questionnaire de connaissances financières

PropriétéTypeDescription
customIdString
Identifiant externe question
Code de la question dans votre questionnaire.
reponseCustomId *String
Identifiant externe réponse
Code de la réponse choisie à la question au sein de la question.
scoreQuestionInteger
Score obtenu
Score obtenu à la question, égal à la valeur de la réponse choisie (sans application du scoring de la question)
id *String
deprecated Identifiant question (ne pas utiliser)
Code de la question. Uniquement présent pour des raisons de compatibilité, ne pas utiliser.
reponseQuestionInteger
deprecated Identifiant réponse (ne pas utiliser)
Identifiant de la réponse choisie à la question au sein de la question
libelle *String
deprecated Libellé (debug)
Libellé de la question. A été mis en place uniquement à des fins de débuggage pour un client. NE PAS UTILISER, sera enlevé sans préavis.
ConnaissanceReponseQuestionInitializer

Réponse à une question du questionnaire de connaissances financières

PropriétéTypeDescription
questionCustomId *CustomId
Code question
Code de la question dans votre questionnaire
reponseCustomIdCustomId
Code réponse
Code de la réponse à la question dans votre questionnaire. Si non spécifié, indique que l'utilisateur final n'a pas répondu à la question.
Coordonnees

PropriétéTypeDescription
domiciliationFiscaleDomiciliationFiscale
Domiciliation fiscale
Lieu de domiciliation fiscale (pour l'application de la fiscalité Française)
adresseString
Adresse
Numéro et nom de la voie
villeString
Ville
Nom de la commune. Format libre. Pas de vérification.
cpString
Code postal
Code postal. Format libre (non vérifié).
paysCountry
Pays
Il s'agit du code ISO du Pays sur 2 caractères. Votre dossier sera rejeté si ce code ne correspond à aucun Pays
telephonePhoneNumber
Téléphone
Téléphone. Format libre.
emailEmail
Email
Adresse email. Si transmis doit être un email valide.
preuveIdentiteTypePieceIdentiteType
Preuve d'identité type
Type de preuve d'identité fournie lors de l'entretien
preuveIdentiteAutreLabelString
Preuve d'identité, libellé autre pièce
Si la preuve d'identité est autre, il est possible de saisir un autre libellé.
CoordonneesInitializer

PropriétéTypeDescription
domiciliationFiscaleDomiciliationFiscale
Domiciliation fiscale
Lieu de domiciliation fiscale (pour l'application de la fiscalité Française)
adresseString
Adresse
Numéro et nom de la voie
villeString
Ville
Nom de la commune. Format libre. Pas de vérification.
cpString
Code postal
Code postal. Format libre (non vérifié).
paysCountry
Pays
Il s'agit du code ISO du Pays sur 2 caractères. Votre dossier sera rejeté si ce code ne correspond à aucun Pays
telephonePhoneNumber
Téléphone
Téléphone. Format libre.
emailEmail
Email
Adresse email. Si transmis doit être un email valide.
Country

Country

Code country ISO 3166-1. 2 lettres majuscules correspondant à la liste cca2

PropriétéTypeDescription
CustomId

CustomId

Identifiant personnalisé. Sont acceptés [A-Za-z0-9_]. Taille maximum 32

PropriétéTypeDescription
Detention Détail

PropriétéTypeDescription
detention *DetentionMode
Mode de détention
Décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété.
usufruitDureeTypeUsufruitDuree
Type de durée d'usufruit
Obligatoire si le mode de détention est NUE_PROPRIETE ou USUFRUIT. Null si PLEINE_PROPRIETE
usufruitViagerUsufruitierAnneeNaissanceYear
Année de naissance de l'usufruitier
Année de naissance de l'usufruitier dans le cadre d'une détention de type NUE PROPRIETE VIAGERE UNIQUEMENT. Est obligatoire si la détention est NUE_PROPRIETE, doit etre null dans tous les autres cas.
usufruitTemporaireAnneeFinYear
Année de fin d'usufruit temporaire INCLUE
Année de fin INCLUE d'une détention Usufruit ou NuePropriété temporaire (i.e. la derniere année). Est obligatoire si la détention est NUE_PROPRIETE + TEMPORAIRE ou USUFRUIT + TEMPORAIRE. Doit etre null dans tous les autres cas.
Dossier

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant universel du dossier
customIdString
Identifiant externe
Identifiant personnalisé du dossier s'il a été spécifié pour ce dossier
decouverteSimplifiee *boolean
Découverte simplifiée ?
Indique si le dossier est réalisé en découverte simplifiée - obligatoire
objectifs *Objectifs Foyer
Objectifs
Une série d'objectifs que le client se fixe pour son évaluation patrimoniale.
objectifsPersonnelsList<ObjectifPersonnelApiModel>
Autre(s) objectif(s)
Ensemble d'objectifs personnels
situationFamiliale *SituationFamiliale
Situation familiale
Situation familiale du foyer (marié, pacsé, célibataire, etc.) - obligatoire
regimeMatrimonialRegimeMatrimonial
Régime matrimonial
Régime matrimonial utilisé uniquement pour les couples mariés. Si non spécifié pour un couple marié, la valeur par défaut est COMMUNAUTE_LEGALE_ACTUELLE.
dateMariageLocalDate
Date de mariage
Date de mariage d'un couple marié - saisie uniquement en découverte approfondie
donationDernierVivantParticulierAConjointDonationDernierVivant
Donation dernier vivant vous à conjoint
Dans un couple marié, donation au dernier vivant du membre principal du foyer ('le particulier') à son conjoint
donationDernierVivantConjointAParticulierDonationDernierVivant
Donation dernier vivant du conjoint à vous
Dans un couple marié, donation au dernier vivant du conjoint au membre principal du foyer.
locataireBoolean
Locataire
Définit si le foyer est locataire de sa résidence principale.
personnes *List<PersonnePhysique>
Personnes
Liste des personnes faisant partie du dossier
coordonneesCoordonnees
Coordonnées
Coordonnées du client pour lequel on réalise le dossier
stocks *List<Stock>
Stocks
Liste des stocks
comptesTitres *List<CompteTitresApiModel>
Compte Titres
Liste des comptes titres
placements *List<Placement>
Placements
Liste des placements
emprunts *List<Emprunt>
Emprunts
Liste des emprunts
rentes *List<Rente>
Rentes
Liste des rentes
custom *Map<StringString>
Champs personnalisés
Succession de clefs/valeurs représentant des champs complémentaires liés au dossier. Les clefs et valeurs doivent être des chaînes de caractères.
resultatsResultatsInitializer
Résultats de calculs
Ensemble de résultats calculés par le budget et la projection, les diagnostics, etc.
approchePlacement *List<ApprochePlacement>
Profil investisseur
Données saisies et calculées du diagnostic 'profil investisseur' (réponse au questionnaire, scoring questionnaire, objectifs/projets, profils d'investissement déterminés pour chaque objectif, etc.
planActionRetraitePlanActionRetraite
Plan d'Action Retraite
Données saisies et calculées du plan d'action retraite
planActionretraitePlanActionRetraite
deprecated Plan action retraite (erroné)
Ne pas utiliser. Faute de frappe initiale dans l'API.
portfolioId *UUID
Identifiant du portfolio
Identifiant du portfolio auquel le dossier est rattaché.
redirectUrl *String
URL Redirection
URL de redirection où les utilisateurs doivent être basculés.
DossierPatch

Patch d'un dossier

PropriétéTypeDescription
customIdString
Identifiant externe
Identifiant personnalisé
portfolioId *UUID
Identifiant du portfolio
Identifiant du portfolio auquel rattacher le dossier. Dans le cadre de cette API permet de changer un dossier de portfolio.
objectifs *Objectifs Foyer
Objectifs
Une série d'objectifs que le client se fixe pour son évaluation patrimoniale.
situationFamilialeSituationFamiliale
Situation familiale
Situation familiale du foyer (marié, pacsé, célibataire, etc.). Peut être omis, mais la valeur doit être non-nulle si fournie.
regimeMatrimonialRegimeMatrimonial
Régime matrimonial
Régime matrimonial, obligatoire pour un couple marié.
dateMariageLocalDate
Date de mariage
Date de mariage d'un couple marié - saisie uniquement en découverte approfondie.
donationDernierVivantParticulierAConjointDonationDernierVivant
Donation dernier vivant vous à conjoint
Dans un couple marié, donation au dernier vivant du membre principal du foyer ('le particulier') à son conjoint
donationDernierVivantConjointAParticulierDonationDernierVivant
Donation dernier vivant du conjoint à vous
Dans un couple marié, donation au dernier vivant du conjoint au membre principal du foyer.
locataireboolean
Locataire
Définit si le foyer est locataire de sa résidence principale.
custom *Map<StringString>
Champs personnalisés
Succession de clefs/valeurs représentant des champs complémentaires liés au dossier. Les clefs et valeurs doivent être des chaînes de caractères.
rapportDernierePageTexteString
Rapport texte dernière page
Texte à insérer en fin de rapport, 4e de couverture zone centrale.
coordonnees *CoordonneesInitializer
Coordonnées
Si envoyées, remplacent intégralement les coordonnées précédentes.
DossierPostResp

PropriétéTypeDescription
id *UUID
id
Identifiant de l'objet créé
DossierPostRespOptional

PropriétéTypeDescription
id *UUID
id
Identifiant de l'objet créé ou null si l'instruction est ignorée pour des raisons de compatibilité d'API.
Email

Email

Email

PropriétéTypeDescription
Emprunt

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant
type *EmpruntAffectation
Type
Type d'emprunt - obligatoire
capitalEmprunte *MonetaryAmountEur
Capital emprunté
Capital emprunté - obligatoire
dateDebut *LocalDate
Date début
Date de début de l'emprunt - obligatoire
dateFin *LocalDate
deprecated Date fin
Date de fin de l'emprunt > à la date de début. Toujours présent. Attention amené à disparaitre dans une prochaine version. Calculé à partir de la date de début et la durée en mois.
dureeMois *long
Durée mois
Durée en mois de l'emprunt
taux *Rate
Taux
Taux de l'emprunt - obligatoire
possesseur *RattachementPersonneType
Possesseur
Souscripteur de l'emprunt - obligatoire
montantInFineMonetaryAmountEur
Montant In Fine
Montant versé à la fin dans le cas d'un emprunt 'in fine'
customIdString
Identifiant externe
Identifiant personnalisé.
organismeDetenteur *OrganismeDetenteur
Organisme détenteur
Organisme détenant le bien. Sur les emprunts ne supportant pas la notion, sera marqué interne.
EmpruntInitializer

PropriétéTypeDescription
type *EmpruntAffectation
Type
Type d'emprunt - obligatoire
capitalEmprunte *MonetaryAmountEur
Capital emprunté
Capital emprunté - obligatoire
dateDebut *LocalDate
Date début
Date de début de l'emprunt - obligatoire
dateFinLocalDate
Date fin
Date de fin de l'emprunt, > à la date de début. La date de fin de l'emprunt n'est pas obligatoire. Par contre elle doit être renseignée si la durée de l'emprunt (dureeMois) n'est pas renseignée.
dureeMoisLong
Duree mois
Durée d'un emprunt. Peut être non renseigné. Mais attention, dans ce cas, la date de fin de l'emprunt doit être renseignée. Si dureeMois est renseignée, elle ne peut pas être à 0 et La date de fin de l'emprunt ne doit pas être renseignée.
taux *Rate
Taux
Taux de l'emprunt - obligatoire
possesseur *RattachementPersonneType
Possesseur
Souscripteur de l'emprunt - obligatoire
montantInFineMonetaryAmountEur
Montant In Fine
Montant versé à la fin dans le cas d'un emprunt 'in fine'
customIdString
Identifiant externe
Identifiant personnalisé.
organismeDetenteurOrganismeDetenteur
Organisme détenteur
Indique si l'emprunt a été conclu en interne ou auprès d'un autre organisme. Si non spécifé, sera externe par défaut. N'aura aucun effet sur les types d'emprunt ne supportant pas cette notion.
EmpruntPatch

PropriétéTypeDescription
capitalEmprunte *MonetaryAmountEur
Capital emprunté
Capital emprunté. Peut être omis, mais la valeur doit être non-nulle si fournie.
dateDebut *LocalDate
Date début
Date de début de l'emprunt. Peut être omis, mais la valeur doit être non-nulle si fournie.
dateFinLocalDate
Date fin
Date de fin de l'emprunt, > à la date de début. La date de fin de l'emprunt n'est pas obligatoire." + " Par contre elle doit être renseignée si la durée de l'emprunt (dureeMois) n'est pas renseignée.
dureeMoisLong
Duree mois
Durée d'un emprunt. Peut être non renseigné. Mais attention, dans ce cas, la date de fin de l'emprunt doit être renseignée. Si dureeMois est renseignée, elle ne peut pas être à 0 et La date de fin de l'emprunt ne doit pas être renseignée.
taux *Rate
Taux
Taux de l'emprunt. Peut être omis, mais la valeur doit être non-nulle si fournie.
possesseurRattachementPersonneType
Possesseur
Souscripteur de l'emprunt. Peut être omis, mais la valeur doit être non-nulle si fournie.
montantInFine *MonetaryAmountEur
Montant In Fine
Montant versé à la fin dans le cas d'un emprunt 'in fine'.
customIdString
Identifiant externe
Identifiant personnalisé.
organismeDetenteur *OrganismeDetenteur
Organisme détenteur
EngineBilanSocialReq

Données en entrées pour le calcul du moteur bilan social.

PropriétéTypeDescription
situationFamiliale *SituationFamiliale
Situation familiale
Situation familiale du foyer (marié, pacsé, célibataire, etc.). Les prestations des régimes en dépendent.
budget *EngineBilanSocialReqBudget
Budget
Décrit le budget du foyer (dépenses, charges)
personnes *List<EngineBilanSocialReqPersonne>
Personnes
Décrit les personnes (adhérent, conjoint été enfants éventuels). Les prestations des régimes obligatoires dépendent de la situation familiale donc tous les membres du foyer doivent être envoyés. Pour les enfants, à minima la date de naissance au 01/01.
EngineBilanSocialReqActiviteProfessionnelle

Activité professionnelle. Fait partie des données en entrées dans le cadre du calcul du moteur bilan social.

PropriétéTypeDescription
professionType *ProfessionType
Profession
Code profession
caisseComplementaireCaisseComplementaireCode
Caisse complémentaire
Première caisse complémentaire, obligatoire si la profession est AUTRE_PROFESSION_LIBERALE
revenusProfessionnelsList<RevenuProfessionnelInitializer>
Caisse complémentaire
Revenu professionnel
EngineBilanSocialReqBudget

Elements de budget d'un foyer. Fait partie des données en entrées dans le cadre du calcul du moteur bilan social.

PropriétéTypeDescription
autreRevenusDuFoyerMonetaryAmountEur
Autres revenus
Autres revenus perçus par le foyer. Considéré comme zero si pas envoyé.
epargneMonetaryAmountEur
Epargne
Montant épargné annuellement. Calculé par défaut si pas envoyé en fonction des resources en appliquant un pourcentage par défaut (méthode interne)
depensesMonetaryAmountEur
Dépenses
Dépenses annuelles du foyer. Calculé par défaut si pas envoyé en fonction des resources en appliquant un pourcentage par défaut (méthode interne)
annuitesContreAssureesMonetaryAmountEur
Annuités contre-assurées
Annuités des crédits assurés du foyer. Considété comme zero si pas envoyé.
pourcentageAssureRate
Pourcentage assuré
Part (%) assurée sur la tête de principal. Considété comme zero si pas envoyé.
temposDecesMonetaryAmountEur
Tempo décès
Capitaux décès versés au conjoint (couple) ou aux enfants (personne seule) souscrits à titre privé.
EngineBilanSocialReqPersonne

Personne. Fait partie des données en entrées dans le cadre du calcul du moteur bilan social.

PropriétéTypeDescription
lienParente *LienParente
Lien parenté
Rôle de la personne dans le dossier.
sexeSexe
Sexe
Sexe de la personne (homme/femme) dont peuvent dépendre certaines majorations (grossesses des femmes par exemple). Nécéssaire pour le principal et le conjoint, non-obligatoire pour les autres membres de la famille. Si non spécifié, sera par défaut HOMME.
firstname *String
Prénom
Prénom de la personne.
lastname *String
Nom
Nom de famille de la personne.
dateNaissance *LocalDate
Date de naissance
Date de naissance de la personne.
activiteProfessionnelleList<EngineBilanSocialReqActiviteProfessionnelle>
Activité professionnelle
Obligatoire pour le principal. Ignorée pour les autres personnes dans le cadre de ce calcul.
personneAChargeBoolean
Personne à charge
Si non spécifié, sera true pour un enfant et false pour les autres personnes. Si spécifié, la valeur sera prise telle quelle.
customIdString
Identifiant externe
Identifiant de la personne dans votre système d'information.
EngineBilanSocialResp

Résultat de calcul du moteur bilan social.

PropriétéTypeDescription
assure *LienParente
Assuré
Personne pour laquelle on fait les calculs { PRINCIPAL, CONJOINT }
cumuls *List<EngineBilanSocialRespCumul>
Cumuls prestation
Cumuls de prestations par situation, il y a donc de 2 à 3 cumuls (pas d'étude "décès" si personne seule sans enfants)
ficheProfession *FicheProfession
Fiche profession
Relie une profession ou une caisse à sa fiche profession, Il est à noté que cette classe fournie aussi l'URL permettant de récupérer directement la fiche profession
besoinITT *EngineBilanSocialRespBesoinSiMaladieOuInvalidite
Besoin ITT
Détail du calcul du besoin en cas de maladie-accident
besoinIPT *EngineBilanSocialRespBesoinSiMaladieOuInvalidite
Besoin IPT
Détail du calcul du besoin en cas d'invalidité permanente totale
besoinDeces *List<EngineBilanSocialRespBesoinSiDeces>
Besoin décès
Détails des calculs de besoin en cas de décès (plusieurs calculs sur plusieurs durées).
couverturesCaisses *List<EngineBilanSocialRespCouvertureCaisse>
Couvertures caisses
Prestations théoriques et réelles versées par les régimes obligatoires (organismes sociaux).
EngineBilanSocialRespBesoinSiDeces

Besoins du foyer en cas de décès. Fait partie du résultat de calcul du moteur bilan social.

PropriétéTypeDescription
dureeint
Durée
Durée en années du calcul (3, 5, 10, 15 ou X années)
garantiesSociales *MonetaryAmountEur
Garanties sociales
Prestations sociales reçues
revenusActuels *MonetaryAmountEur
Revenus actuels
Revenus actuels de la personne
depensesEstimees *MonetaryAmountEur
Dépenses estimées
Dépenses estimées à couvrir
besoin *MonetaryAmountEur
Besoin
Besoin
capitalAAssurerMonetaryAmountEur
Capital à assurer
Besoin sur la période
capitauxDecesRecus *MonetaryAmountEur
Capitaux décès reçus
Capitaux décès reçus
besoinCapital *MonetaryAmountEur
Besoin net
Besoin net
EngineBilanSocialRespBesoinSiMaladieOuInvalidite

Situation à terme d'une personne en cas de décès, maladie ou invalidité. Fait partie du résultat de calcul du moteur bilan social.

PropriétéTypeDescription
garantiesSociales *MonetaryAmountEur
Garanties sociales
Prestations sociales reçues
revenusActuels *MonetaryAmountEur
Revenus actuels
Revenus actuels de la personne
depensesEstimees *MonetaryAmountEur
Dépenses estimées
Dépenses estimées à couvrir
besoin *MonetaryAmountEur
Besoin
Besoin
EngineBilanSocialRespCouvertureCaisse

Couverture d'une caisse, fait partie du résultat de calcul du moteur bilan social

PropriétéTypeDescription
caisseCode *String
Code caisse
Code technique de la caisse / de l'organisme social
caisseNom *String
Nom caisse
Libellé en clair de la caisse / de l'organisme social
caisseTypeCaisseRetraiteType
Type caisse
Type de caisse (de base ou complémentaire)
situationDeces *EngineBilanSocialRespSituation
Situation décès
Situation à terme en cas de décès
situationMaladie *EngineBilanSocialRespSituation
Situation maladie
Situation à terme en cas de maladie
situationInvalidite *EngineBilanSocialRespSituation
Situation invalidité
Situation à terme en cas d'invalidité
EngineBilanSocialRespCumul

Cumul de prestations versées par une caisse en cas de maladie, invalidité ou décès. Utilisé dans le cadre du résultat de calcul de bilan social.

PropriétéTypeDescription
situation *CumulSituationCode
Situation
Situation pour laquelle on affiche ce cumul (maladie, invalidité, décès)
totalIndemnitesJournalieres *MonetaryAmountEur
Total indemnités journalières
Total des indemnités journalières
totalRentes *MonetaryAmountEur
Total rentes
Total des rentes
totalRentesEducation *MonetaryAmountEur
Total rentes éducation
Total des rentes éducation
totalCapitaux *MonetaryAmountEur
Total capitaux
Total de capitaux
EngineBilanSocialRespGarantieMessage

GarantieMessage

Message de couverture théorique

PropriétéTypeDescription
EngineBilanSocialRespPrestation

Prestation réellement perçue par une personne. Utilisé dans le cadre du résultat de calcul de bilan social.

PropriétéTypeDescription
type *RenteSubType
Type
Type de prestation
montant *MonetaryAmountEur
Montant
Montant du capital ou montant annuel d'une rente ou montant journalier d'indemnités journalières
dateDebutLocalDate
Date de début
Date de début de versement. Pour indemnités journalières et rentes uniquement.
dateFinLocalDate
Date de fin
Date de fin de versement. Pour indemnités journalières et rentes uniquement.
personneCustomId *String
Personne customId
CustomId de la personne qui sera bénéficiaire de la prestation. Dépend de ce que vous avez mis en entrée dans le champ customId de chaque personne.
EngineBilanSocialRespPrestationsPoint

Point du graphe d'évolution de la situation d'une personne. Utilisé dans le cadre du résultat de calcul de bilan social.

PropriétéTypeDescription
x *String
x
Abscisse
y *MonetaryAmountEur
y
Ordonnée
EngineBilanSocialRespSituation

Situation à terme d'une personne en cas de décès, maladie ou invalidité. Fait partie du résultat de calcul du moteur bilan social.

PropriétéTypeDescription
couvertureTheorique *List<EngineBilanSocialRespGarantieMessage>
Couverture théorique
Prestation théorique versée pour la situation
couvertureReelle *List<EngineBilanSocialRespPrestation>
Couverture réelle
Prestations réellement perçues, elles vont dépendre de la composition de la cellule familiale
graphe *List<EngineBilanSocialRespPrestationsPoint>
Graphe
Utilisé uniquement pour la situation "ITT/maladie", séries du graphe
Fraction

Fraction

Fraction de quelquechose. Nombre décimal entre 0 et 1. Lorsque toutes les fractions d'une même chose sont additionnées, leur somme est égale à un.

PropriétéTypeDescription
Fractions

PropriétéTypeDescription
principal *Fraction
PRINCIPAL
Fraction du principal
couple *Fraction
COUPLE
Fraction du couple
conjoint *Fraction
CONJOINT
Fraction du conjoint
MonetaryAmountEur

Montant en centimes d'euros

Une valeur monétaire exprimée en centimes d'euros

PropriétéTypeDescription
ObjectifPersonnel

Objectif personnel

Un objectif écrit sous forme de texte, libre à l'utilisateur.

PropriétéTypeDescription
idlong
Identifiant
Identifiant en base de données
titre *String
Titre
Titre de l'objectif, sur une seule ligne
texteString
Texte
Texte de l'objectif. Peut être null.
prioritylong
Priorité d'affichage
Priorité d'affichage à l'écran (les plus petits en premier)
ObjectifProfilInvestisseur

décrit un objectif (projet) du module 'profil investisseur'

PropriétéTypeDescription
horizonint
deprecated N° d'horizon de placement
horizonCode *String
Code d'horizon de placement
description *String
Description de l'objectif/projet de 'profil investisseur'
montant *MonetaryAmountEur
Montant de l'objectif/projet du 'profil investisseur'
profilProposeint
deprecated Profil proposé pour l'objectif/projet du 'profil investisseur'
profilChoisiInteger
deprecated Profil choisi pour l'objectif/projet du 'profil investisseur'
profilProposeCode *String
Code du profil proposé pour l'objectif/projet du 'profil investisseur'
profilChoisiCodeString
Code du profil choisi pour l'objectif/projet du 'profil investisseur'
Objectifs Foyer

Objectifs patrimoniaux d'un foyer

Représente les objectifs d'un client vis à vis de sa situation patrimoniale

PropriétéTypeDescription
bilanPersonnaliseboolean
Bilan personnalisé
devenirProprietaireboolean
Devenir propriétaire
protegerFamilleboolean
Protéger sa famille
preparationEtudesEnfantsboolean
Préparation des études des enfants
preparerRetraiteboolean
Préparation sa retraite
completerRevenusboolean
Compléter ses revenus
preparerSuccessionboolean
Préparer sa succession
baisserPressionFiscaleboolean
Baisser la pression fiscale = investissement immobilier
diversifierPlacementsboolean
Diversifier ses placements
loisirsboolean
Loisirs
constituerUnCapitalboolean
Constituer un capital
OrganismeDetenteur

PropriétéTypeDescription
interne *boolean
Interne
Si true indique que vous détenez le produit associé. Indiquer false si le produit est détenu à la concurrence.
autreOrganismeLibelleString
Autre organisme libellé
Libellé de l'organisme détenant le produit s'il est connu. N'a d'effet que si interne est false.
Orgunit

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant unique
label *String
Libellé
Libellé
customIdCustomId
Identifiant personnalisé
Identifiant personnalisé pour synchronisation avec votre système d'information.
parentUUID
Unités parente
Identifiant de l'unité parente, si elle existe. Si l'unité n'a pas de parent, elle est considérée comme unité racine.
Orgunit initializer

PropriétéTypeDescription
label *String
Libellé
Libellé
customIdCustomId
Identifiant personnalisé
Identifiant personnalisé pour synchronisation avec votre système d'information.
parentUUID
Unités parente
Identifiant de l'unité parente, si elle existe. Si l'unité n'a pas de parent, elle est considérée comme unité racine.
Orgunit list

PropriétéTypeDescription
items *List<Orgunit>
Items
Elements renvoyés
totalint
Total
Nombre total d'orgunits
PersonnePhysique

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant
customIdString
Identifiant externe
Identifiant de la personne dans votre système d'information.
civiliteCivilite
Civilité
Civilité (ou genre) de la personne, saisie uniquement pour le particulier et son conjoint
firstname *String
Prénom
Prénom de la personne - obligatoire
lastname *String
Nom
Nom de famille de la personne - obligatoire
nomNaissanceString
Nom de naissance
Nom de naissance de la personne, saisi uniquement pour le particulier et son conjoint
villeNaissanceString
Ville de naissance
Ville de naissance de la personne, saisie uniquement pour le particulier et son conjoint
paysNaissanceCountry
Pays de naissance
Pays de naissance de la personne, saisi uniquement pour le particulier et son conjoint. Il s'agit du code ISO du Pays sur 2 caractères. Votre dossier sera rejeté si ce code ne correspond à aucun Pays
nationaliteTypeNationaliteType
Nationalité (simplifiée)
Nationalité (simplifiée) de la personne, saisie uniquement pour le particulier et son conjoint
numeroTINString
Numéro fiscal TIN
Pour un résident fiscal US, numéro fiscal ; saisi uniquement pour le particulier et son conjoint
dateNaissance *LocalDate
Date de naissance
Date de naissance de la personne, exacte ou au 1er janvier de l'année de naissance - obligatoire
dateIndependanceFinanciereLocalDate
Date d'indépendance financière
Date à laquelle un enfant quitte le foyer (devient indépendant financièrement), obligatoire pour un enfant à charge en découverte approfondie - ne doit pas être renseignée pour un enfant à charge en découverte simplifiée
lienParente *LienParenteCompatibiliteApi
Lien de parenté
Lien de parenté de la personne avec le dossier (rôle) - obligatoire
personneACharge *Boolean
Enfant à charge
Si non spécifié, sera true pour un enfant et false pour les autres personnes. Si spécifié, la valeur sera prise telle quelle.
rattachementTypeRattachementPersonneType
Personne à laquelle est rattaché un enfant
Décrit à quelle(s) personnes du foyer est lié un enfant (vous, le conjoint, le couple), obligatoire pour un enfant
invalideBoolean
Personne invalide
Indique si la personne est invalide (au sens fiscal)
decedeBoolean
Décédé
Indique si la personne est décédée
dateDecesLocalDate
Date de décès
Date de décès de la personne, renseignée si elle est décédée - uniquement pour les 'enfants' et les 'frères/soeurs', en découverte approfondie
chargePartageeBoolean
Charge partagée ?
Enfant fiscalement à charge partagée ?
fonctionPubliqueBoolean
Fonction publique excercée ?
Indique si la personne exerce une fonction publique (saisie uniquement pour 'vous' et 'le conjoint' dans le cadre des obligations MIF).
fonctionPubliqueLibelleString
Libellé de la fonction publique exercée
Si la personne exerce une fonction publique, libellé de cette fonction
fonctionPubliqueFamilleBoolean
Fonction publique exercée par un membre de la famille ?
Indique si un autre membre de la famille exerce une fonction publique (saisie uniquement pour 'vous' et 'le conjoint' dans le cadre des obligations MIF).
fonctionPubliqueFamilleLibelleString
Libellé de la fonction publique exercée par un membre de la famille
Si un autre membre de la famille exerce une fonction publique, libellé de cette fonction.
activiteProfessionnelleList<ActiviteProfessionnelle>
Profession(s) exercée(s) par la personne
Liste des activités professionnelles de la personne, renseignée uniquement pour 'vous' et 'le conjoint'
PersonnePhysiqueInitializer

PropriétéTypeDescription
customIdString
Identifiant externe
Identifiant de la personne dans votre système d'information.
civiliteCivilite
Civilité
Civilité (ou genre) de la personne, saisie uniquement pour le particulier et son conjoint
firstname *String
Prénom
Prénom de la personne - obligatoire
lastname *String
Nom
Nom de famille de la personne - obligatoire
nomNaissanceString
Nom de naissance
Nom de naissance de la personne, saisi uniquement pour le particulier et son conjoint
villeNaissanceString
Ville de naissance
Ville de naissance de la personne, saisie uniquement pour le particulier et son conjoint
paysNaissanceCountry
Pays de naissance
Pays de naissance de la personne, saisi uniquement pour le particulier et son conjoint. Il s'agit du code ISO du Pays sur 2 caractères. Votre dossier sera rejeté si ce code ne correspond à aucun Pays
nationaliteTypeNationaliteType
Nationalité (simplifiée)
Nationalité (simplifiée) de la personne, saisie uniquement pour le particulier et son conjoint
numeroTINString
Numéro fiscal TIN
Pour un résident fiscal US, numéro fiscal ; saisi uniquement pour le particulier et son conjoint
dateNaissance *LocalDate
Date de naissance
Date de naissance de la personne, exacte ou au 1er janvier de l'année de naissance - obligatoire
dateIndependanceFinanciereLocalDate
Date d'indépendance financière
Date à laquelle un enfant quitte le foyer (devient indépendant financièrement), obligatoire pour un enfant à charge en découverte approfondie - ne doit pas être renseignée pour un enfant à charge en découverte simplifiée
lienParente *LienParenteCompatibiliteApi
Lien de parenté
Lien de parenté de la personne avec le dossier (rôle) - obligatoire
personneACharge *Boolean
Enfant à charge
Si non spécifié, sera true pour un enfant et false pour les autres personnes. Si spécifié, la valeur sera prise telle quelle.
rattachementTypeRattachementPersonneType
Personne à laquelle est rattaché un enfant
Décrit à quelle(s) personnes du foyer est lié un enfant (vous, le conjoint, le couple), obligatoire pour un enfant
invalideBoolean
Personne invalide
Indique si la personne est invalide (au sens fiscal)
decedeBoolean
Décédé
Indique si la personne est décédée
dateDecesLocalDate
Date de décès
Date de décès de la personne, renseignée si elle est décédée - uniquement pour les 'enfants' et les 'frères/soeurs', en découverte approfondie
chargePartageeBoolean
Charge partagée ?
Enfant fiscalement à charge partagée ?
fonctionPubliqueBoolean
Fonction publique excercée ?
Indique si la personne exerce une fonction publique (saisie uniquement pour 'vous' et 'le conjoint' dans le cadre des obligations MIF).
fonctionPubliqueLibelleString
Libellé de la fonction publique exercée
Si la personne exerce une fonction publique, libellé de cette fonction
fonctionPubliqueFamilleBoolean
Fonction publique exercée par un membre de la famille ?
Indique si un autre membre de la famille exerce une fonction publique (saisie uniquement pour 'vous' et 'le conjoint' dans le cadre des obligations MIF).
fonctionPubliqueFamilleLibelleString
Libellé de la fonction publique exercée par un membre de la famille
Si un autre membre de la famille exerce une fonction publique, libellé de cette fonction.
activiteProfessionnelleList<ActiviteProfessionnelleInitializer>
Profession(s) exercée(s) par la personne
Liste des activités professionnelles de la personne, renseignée uniquement pour 'vous' et 'le conjoint'
PersonnePhysiquePatch

PropriétéTypeDescription
customIdString
Identifiant externe
Identifiant de la personne dans votre système d'information.
civiliteCivilite
Civilité
Civilité (ou genre) de la personne, saisie uniquement pour le particulier et son conjoint. Peut être omis, mais la valeur doit être non-nulle si fournie.
firstname *String
Prénom
Prénom de la personne. Peut être omis, mais la valeur doit être non-nulle si fournie.
lastname *String
Nom
Nom de famille de la personne. Cette donnée ne peut pas être patchée à null mais vous pouvez l'omettre dans le patch. Peut être omis, mais la valeur doit être non-nulle si fournie.
nomNaissanceString
Nom de naissance
Nom de naissance de la personne, saisi uniquement pour le particulier et son conjoint
villeNaissanceString
Ville de naissance
Ville de naissance de la personne, saisie uniquement pour le particulier et son conjoint
paysNaissanceCountry
Pays de naissance
Pays de naissance de la personne, saisi uniquement pour le particulier et son conjoint. Il s'agit du code ISO du Pays sur 2 caractères. Votre dossier sera rejeté si ce code ne correspond à aucun Pays
nationaliteTypeNationaliteType
Nationalité (simplifiée)
Nationalité (simplifiée) de la personne, saisie uniquement pour le particulier et son conjoint.
numeroTINString
Numéro fiscal TIN
Pour un résident fiscal US, numéro fiscal ; saisi uniquement pour le particulier et son conjoint.
dateNaissanceLocalDate
Date de naissance
Date de naissance de la personne, exacte ou au 1er janvier de l'année de naissance. Peut être omis, mais la valeur doit être non-nulle si fournie.
dateIndependanceFinanciereLocalDate
Date d'indépendance financière
Date à laquelle un enfant quitte le foyer (devient indépendant financièrement), obligatoire pour un enfant à charge en découverte approfondie - ne doit pas être renseignée pour un enfant à charge en découverte simplifiée
invalideboolean
Personne invalide
Indique si la personne est invalide (au sens fiscal)
decedeboolean
Décédé
Indique si la personne est décédée
dateDecesLocalDate
Date de décès
Date de décès de la personne, renseignée si elle est décédée - uniquement pour les 'enfants' et les 'frères/soeurs', en découverte approfondie
chargePartageeboolean
Charge partagée ?
Enfant fiscalement à charge partagée ?
fonctionPubliqueboolean
Fonction publique excercée ?
Indique si la personne exerce une fonction publique (saisie uniquement pour 'vous' et 'le conjoint' dans le cadre des obligations MIF).
fonctionPubliqueLibelleString
Libellé de la fonction publique exercée
Si la personne exerce une fonction publique, libellé de cette fonction
fonctionPubliqueFamilleboolean
Fonction publique exercée par un membre de la famille ?
Indique si un autre membre de la famille exerce une fonction publique (saisie uniquement pour 'vous' et 'le conjoint' dans le cadre des obligations MIF).
fonctionPubliqueFamilleLibelleString
Libellé de la fonction publique exercée par un membre de la famille
Si un autre membre de la famille exerce une fonction publique, libellé de cette fonction.
PhoneNumber

Numéro de téléphone

Numéro de téléphone. Format libre

PropriétéTypeDescription
Placement

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant
identPlacement *PlacementIdentifier
Identifiant de placement
Identifiant de placement (Sous-sous-type de placement)
montant *MonetaryAmountEur
Montant
Montant actuel du placement
revActMonetaryAmountEur
Revenu actuel
Revenu actuel du placement
libelleString
Libellé
Description du placement (saisie libre)
fractionCommuneFraction
Fraction commune
Dans un couple, fraction du placement détenue en commun
fractionPourMonsieurFraction
Fraction pour vous
Dans un couple, fraction détenue par le membre principal
fractionPourMadameFraction
Fraction pour le conjoint
Dans un couple, fraction détenue par le conjoint
detention *DetentionMode
Mode de détention
Décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété
detentionDetailDetention Détail
Détention
Décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété avec les détails de la détention
dateSouscriptionLocalDate
Date de souscription
Date de souscription ou d'ouverture ou d'investissement de certains placements
souscripteurPossesseurType
Souscripteur
Souscripteur d'une assurance-vie, PEP bancaire, contrat de capitalisation. Titulaire de valeurs mobilières
assurePossesseurType
Assuré d'une assurance-vie
Pour un contrat d'assurance-vie uniquement, assuré du contrat
customIdString
Identifiant externe
Identifiant personnalisé.
typeSupportTypeSupport
Type de support pour des valeurs mobilières
Indique si une valeur mobilière est détenue dans un compte titre ordinaire ou un PEA
compteTitresIdUUID
Compte titres
Si le placement est détenu dans un compte titres, l'identifiant du compte titres associé.
organismeDetenteur *OrganismeDetenteur
Organisme détenteur
Organisme détenant le bien. Toujours présent même si le bien ne supporte pas la notion. Dans ce cas, sera marqué interne.
PlacementInitializer

PropriétéTypeDescription
identPlacement *PlacementIdentifier
Type de placement
Type de placement
montant *MonetaryAmountEur
Montant
Montant actuel du placement
revActMonetaryAmountEur
Revenu actuel
Revenu actuel du placement
libelleString
Libellé
Libellé du placement (saisie libre)
fractionCommuneFraction
Fraction Couple
Dans un couple, fraction du placement détenue en commun
fractionPourMonsieurFraction
Fraction Principal
Dans un couple, fraction détenue par le membre principal
fractionPourMadameFraction
Fraction Conjoint
Dans un couple, fraction détenue par le conjoint
detentionDetentionMode
Mode de détention
Décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété
detentionDetailDetention Détail
Détention
Décrit en détail le mode de détention à appliquer.
dateSouscriptionLocalDate
Date de souscription
Date de souscription ou d'ouverture ou d'investissement de certains placements
souscripteurPossesseurType
Souscripteur
Souscripteur d'une assurance-vie, PEP bancaire, contrat de capitalisation. Titulaire de valeurs mobilières
assurePossesseurType
Assuré d'une assurance-vie
Pour un contrat d'assurance-vie uniquement, assuré du contrat
customIdString
Identifiant externe
Identifiant personnalisé.
typeSupportTypeSupport
Type de support pour des valeurs mobilières
Indique si une valeur mobilière est détenue dans un compte titre ordinaire ou un PEA. Ne peut pas être présent en même temps que compteTitresId.
compteTitresIdUUID
Identifiant d'un compte titres
Indique dans quel compte titres ajouter le placement. Ne doit être renseigné que pour les placements détenus sur un support (PEA, Compte Titres Ordinaire). Mutuellement exclusif avec typeSupport. Les deux ne peuvent pas être renseignés en même temps. Dans le cadre d'une création de dossier, ce sera une référence interne à un des compte titres fournis. Dans le cadre d'une création de placement, doit faire référence à un compte titres déjà existant.
organismeDetenteurOrganismeDetenteur
Organisme détenteur
Indique si l'emprunt a été conclu en interne ou auprès d'un autre organisme. Si non spécifé, sera externe par défaut. N'aura aucun effet sur les placements ne supportant pas cette notion.
PlacementPatch

PropriétéTypeDescription
montant *MonetaryAmountEur
Montant
Montant actuel du placement. Si envoyé doit être non-null.
revAct *MonetaryAmountEur
Revenu actuel
Revenu actuel du placement
libelleString
Libellé
Description du placement (saisie libre)
fractionCommuneFraction
Fraction commune
Dans un couple, fraction du placement détenue en commun. Si envoyée, doit être envoyée conjointement avec les autres fractions et la somme doit être égale à 1.
fractionPourMonsieurFraction
Fraction pour vous
Dans un couple, fraction détenue par le membre principal. Si envoyée, doit être envoyée conjointement avec les autres fractions et la somme doit être égale à 1.
fractionPourMadameFraction
Fraction pour le conjoint
Dans un couple, fraction détenue par le conjoint. Si envoyée, doit être envoyée conjointement avec les autres fractions et la somme doit être égale à 1.
detention *DetentionMode
Mode de détention
Décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété.
detentionDetail *Detention Détail
Détention
Décrit en détail le mode de détention à appliquer.
dateSouscriptionLocalDate
Date de souscription
Date de souscription ou d'ouverture ou d'investissement de certains placements.
souscripteurPossesseurType
Souscripteur
Souscripteur d'une assurance-vie, PEP bancaire, contrat de capitalisation. Titulaire de valeurs mobilières.
assurePossesseurType
Assuré d'une assurance-vie
Pour un contrat d'assurance-vie uniquement, assuré du contrat.
customIdString
Identifiant externe
Identifiant personnalisé.
organismeDetenteur *OrganismeDetenteur
Organisme détenteur
PlanActionRetraite

saisies du plan d'action retraite

PropriétéTypeDescription
actions *List<PlanActionRetraiteAction>
actions
Actions à mener
versementInitialAssuranceVieVousMonetaryAmountEur
deprecated versement Initial AssuranceVie Principal
versement initial sur assurance-vie pour VOUS
versementMensuelAssuranceVieVousMonetaryAmountEur
deprecated versement Mensuel AssuranceVie Principal
versement périodique mensuel sur assurance-vie pour VOUS
versementInitialPERPVousMonetaryAmountEur
deprecated versement Initial PERP Principal
versement initial sur PERP pour VOUS
versementMensuelPERPVousMonetaryAmountEur
deprecated versement Mensuel PERP Principal
versement périodique mensuel sur PERP pour VOUS
versementInitialMadelinVousMonetaryAmountEur
deprecated versement Initial Madelin Principal
versement initial sur MADELIN pour VOUS
versementMensuelMadelinVousMonetaryAmountEur
deprecated versement Mensuel Madelin Principal
versement périodique mensuel sur MADELIN pour VOUS
versementInitialPERVousMonetaryAmountEur
deprecated versement Initial PER Principal
versement initial sur PER pour VOUS
versementMensuelPERVousMonetaryAmountEur
deprecated versement Mensuel PER Principal
versement périodique mensuel sur PER pour VOUS
versementInitialAssuranceVieConjointMonetaryAmountEur
deprecated versement Initial AssuranceVie Conjoint
versement initial sur assurance-vie pour CONJOINT
versementMensuelAssuranceVieConjointMonetaryAmountEur
deprecated versement Mensuel AssuranceVie Conjoint
versement périodique mensuel sur assurance-vie pour CONJOINT
versementInitialPERPConjointMonetaryAmountEur
deprecated versement Initial PERP Conjoint
versement initial sur PERP pour CONJOINT
versementMensuelPERPConjointMonetaryAmountEur
deprecated versement Mensuel PERP Conjoint
versement périodique mensuel sur PERP pour CONJOINT
versementInitialMadelinConjointMonetaryAmountEur
deprecated versement Initial Madelin Conjoint
versement initial sur MADELIN pour CONJOINT
versementMensuelMadelinConjointMonetaryAmountEur
deprecated versement Mensuel Madelin Conjoint
versement périodique mensuel sur MADELIN pour CONJOINT
versementInitialPERConjointMonetaryAmountEur
deprecated versement Initial PER Conjoint
versement initial sur PER pour CONJOINT
versementMensuelPERConjointMonetaryAmountEur
deprecated versement Mensuel PER Conjoint
versement périodique mensuel sur PER pour CONJOINT
PlanActionRetraiteAction

Action à mener dans le cadre d'un plan d'action retraite

PropriétéTypeDescription
type *PlanActionRetraiteActionType
Type
Type d'action conseillée
rattachement *PlanActionRetraiteActionRattachment
Rattachement
Personne pour laquelle l'action est conseillée
versementInitial *MonetaryAmountEur
Versement initial
Versement initial conseillé
versementMensuel *MonetaryAmountEur
Versement mensuel
Versement mensuel conseillé
Portfolio

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant unique
tenantDefaultboolean
Portfolio par défaut
Indique si le portfolio est celui par défaut de votre compte client.
label *String
Libellé
Libellé du portefeuille client
customIdCustomId
Identifiant personnalisé
Identifiant personnalisé du portefeuille dans votre système d'information
managerUserLoginString
Responsable
Identifiant de l'utilisateur responsable du portefeuille s'il y en a un
orgunitIdUUID
Identifiant d'orgunit
Identifiant de l'Orgunit à laquelle rattacher ce portfolio, s'il y en a une.
Portfolio List

PropriétéTypeDescription
countint
Nombre renvoyé
totalint
Total
items *List<Portfolio>
Elements
Portfolio initializer

PropriétéTypeDescription
label *String
Libellé
Libellé du portefeuille client
managerUserLoginString
Responsable
Identifiant de l'utilisateur responsable du portefeuille s'il y en a un
orgunitIdUUID
Identifiant d'orgunit
Identifiant de l'Orgunit à laquelle rattacher ce portfolio, s'il y en a une.
Predossier

PropriétéTypeDescription
customId *String
Identifiant externe
Identifiant du dossier client dans le SI du client - obligatoire
decouverteSimplifieeboolean
deprecated Découverte simplifiée ?
Indique si le dossier est réalisé en découverte simplifiée - obligatoire
objectifsObjectifs Foyer
Objectifs
Une série d'objectifs que le client se fixe pour son évaluation patrimoniale.
objectifsPersonnelsList<ObjectifPersonnelApiModel>
Autre(s) objectif(s)
Ensemble d'objectifs personnels (maximum 3)
notesPersonnellesList<ObjectifPersonnelApiModel>
deprecated Autre(s) note(s)
Ensemble de notes personnelles (maximum 3)
situationFamiliale *SituationFamiliale
Situation familiale
Situation familiale du foyer (marié, pacsé, célibataire, etc.) - obligatoire
regimeMatrimonialRegimeMatrimonial
Régime matrimonial
Régime matrimonial, obligatoire pour un couple marié
dateMariageLocalDate
Date de mariage
Date de mariage d'un couple marié - saisie uniquement en découverte approfondie
donationDernierVivantParticulierAConjointDonationDernierVivant
Donation dernier vivant vous à conjoint
Dans un couple marié, donation au dernier vivant du membre principal du foyer ('le particulier') à son conjoint
donationDernierVivantConjointAParticulierDonationDernierVivant
Donation dernier vivant du conjoint à vous
Dans un couple marié, donation au dernier vivant du conjoint au membre principal du foyer.
locataireBoolean
Locataire
Définit si le foyer est locataire de sa résidence principale.
personnes *List<PersonnePhysiqueInitializer>
Personnes
Liste des personnes faisant partie du dossier
coordonneesCoordonneesInitializer
Coordonnées
Coordonnées du client pour lequel on réalise le dossier
stocksList<StockInitializer>
Stocks
Liste des stocks
placementsList<PlacementInitializer>
Placements
Liste des placements
comptesTitresList<CompteTitresInitializer>
Comptes titres
Liste des compte titres
empruntsList<EmpruntInitializer>
Emprunts
Liste des emprunts
rentesList<RenteInitializer>
Rentes
Liste des rentes
approchesPlacementList<ApprochePlacementInitializer>
Approches placement
Définit le profil investisseur d'une personne en remplissant un questionnaire de connaissances financières.
customMap<StringString>
Champs personnalisés
Succession de clefs/valeurs représentant des champs complémentaires liés au dossier. Les clefs et valeurs doivent être des chaînes de caractères.
rapportDernierePageTexteString
Rapport texte dernière page
Texte à insérer en fin de rapport, 4e de couverture zone centrale.
PredossierInitializerReq

PropriétéTypeDescription
createdForUser *ReferenceUtilisateur
Créé pour l'utilisateur
Définit pour quel utilisateur le pre-dossier sera créé. L'utilisateur doit exister au préalable dans edixit.
portfolioIdUUID
Portefeuille client
Indique dans quel portefeuille client le dossier devra être créé. Si le champ n'est pas renseigné, le dossier aura comme destination le portfolio par défaut de votre compte client.
parcoursIntegreboolean
Parcours intégré
L'entrée sur l'application se fait en mode parcours intégré
dossier *Predossier
Propriétés du dossier
Propriétés servant à alimenter le dossier.
PredossierInitializerResp

Predossier réponse

PropriétéTypeDescription
redirectUrl *String
URL Redirection
URL de redirection où les utilisateurs doivent être basculés.
uid *UUID
UID
Identifiant unique du predossier créé
dossierId *UUID
dossierId
Identifiant unique du dossier créé
Rapport

Rapport

Description Json d'un rapport

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant unique du rapport
mimeType *String
MimeType
Type mime du rapport, permet de distinguer les rapports générés en PDF des rapports générés en Word
type *RapportBirtType
Type de rapport
Type de rapport
businessKeyString
Clef métier
businessIdLong
Identifiant métier
createdDate *Instant
Date de création
RapportList

RapportList

Liste de rapports

PropriétéTypeDescription
Rate

Taux

Taux. Par exemple pour 15%, spécifier 0.15

PropriétéTypeDescription
ReferenceUtilisateur

PropriétéTypeDescription
idUUID
id
Identifiant unique d'un utilisateur
loginString
id
Login d'un utilisateur
Rente

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant
type *RenteType
Type
Type de rente (à verser, à recevoir, capital à recevoir) - obligatoire
sousType *RenteSubType
Sous-type
Sous-type de rente - obligatoire - doit être compatible avec le type de rente. Certaines rentes sont que à percevoir (par ex. RENTE_PERP) d'autres peuvent être à verser et à percevoir (par ex. PRESTATION_COMPENSATOIRE)
montant *MonetaryAmountEur
Montant
Montant de la rente - obligatoire et > 0
dateDebut *LocalDate
Date début
Date de début de versement de la rente OU date de versement du capital à recevoir - obligatoire
dateFinLocalDate
Date fin
Date de fin de versement de la rente - obligatoire si rente temporaire et > date de début
possesseur *PossesseurType
Type de possesseur
Débirentier d'une rente à verser ou bénéficiaire d'une rente à recevoir - obligatoire
versementType *RenteVersementType
Type de versement
Type de versement de la rente, temporaire ou viagère - obligatoire
dateNaissanceBeneficiaireLocalDate
Date de naissance
Date de naissance du bénéficiaire d'une rente viagère à verser - obligatoire si rente à verser viagère, doit être < date courante
customIdString
Identifiant externe
Identifiant personnalisé.
RenteInitializer

PropriétéTypeDescription
type *RenteType
Type
Type de rente (à verser, à recevoir, capital à recevoir) - obligatoire
sousType *RenteSubType
Sous-type
Sous-type de rente - obligatoire - doit être compatible avec le type de rente. Certaines rentes sont que à percevoir (par ex. RENTE_PERP) d'autres peuvent être à verser et à percevoir (par ex. PRESTATION_COMPENSATOIRE)
montant *MonetaryAmountEur
Montant
Montant de la rente - obligatoire et > 0
dateDebut *LocalDate
Date début
Date de début de versement de la rente OU date de versement du capital à recevoir - obligatoire
dateFinLocalDate
Date fin
Date de fin de versement de la rente - obligatoire si rente temporaire et > date de début
possesseur *PossesseurType
Type de possesseur
Débirentier d'une rente à verser ou bénéficiaire d'une rente à recevoir - obligatoire
versementType *RenteVersementType
Type de versement
Type de versement de la rente, temporaire ou viagère - obligatoire
dateNaissanceBeneficiaireLocalDate
Date de naissance
Date de naissance du bénéficiaire d'une rente viagère à verser - obligatoire si rente à verser viagère, doit être < date courante
customIdString
Identifiant externe
Identifiant personnalisé.
RentePatch

PropriétéTypeDescription
montant *MonetaryAmountEur
Montant
Montant de la rente. Peut être omis, mais la valeur doit être non-nulle si fournie. Si envoyé doit être strictement positif.
dateDebutLocalDate
Date début
Date de début de versement de la rente OU date de versement du capital à recevoir. Peut être omis, mais la valeur doit être non-nulle si fournie.
dateFinLocalDate
Date fin
Date de fin de versement de la rente. Si envoyé dans le cadre d'une rente temporaire, doit être non-null et supérieur à la date de début.
possesseur *PossesseurType
Type de possesseur
Débirentier d'une rente à verser ou bénéficiaire d'une rente à recevoir. Peut être omis, mais la valeur doit être non-nulle si fournie.
dateNaissanceBeneficiaireLocalDate
Date de naissance
Date de naissance du bénéficiaire d'une rente viagère à verser. Dans le cas d'une rente à verser viagère, si envoyé doit être non-null et avant à la date du jour
customIdString
Identifiant externe
Identifiant personnalisé.
ResultatsInitializer

ensemble de résultats de calculs

PropriétéTypeDescription
actifNet *MonetaryAmountEur
Actif net
Actif net = actif – passif, en €
presenceAssurancesVieboolean
Assurances-vie (présence)
Présence d’assurances-vie ?
autoFinancementMensuel *MonetaryAmountEur
Autofinacement
Autofinancement constaté mensuel pour la retraite
capaciteEngagement *MonetaryAmountEur
Capacité d'engagement
Capacité d’engagement (DINR + épargne) en €
capitauxEmpruntes *MonetaryAmountEur
Capitaux empruntés
Montant total des capitaux empruntés (y compris emprunts finis) des emprunts en cours en €
capitauxRestantsDus *MonetaryAmountEur
Capitaux restants dus
Montant total des capitaux restants dus des emprunts en cours en €
deficitPrevoyanceVous *MonetaryAmountEur
Déficit prévoyance Vous
Déficit prévoyance annuel de Vous
deficitprevoyanceConjoint *MonetaryAmountEur
Déficit prévoyance Conjoint
Déficit prévoyance annuel de Conjoint
deficitRetraite *MonetaryAmountEur
Déficit retraite
Déficit retraite
droitsSuccessionDecesVousPremier *MonetaryAmountEur
Droits décès vous premier
Droits succession si décès de Vous en 1er
droitsSuccessionDecesVousSecond *MonetaryAmountEur
Droits décès vous second
Droits succession si décès de Vous en 2eme
droitsSuccessionDecesConjointPremier *MonetaryAmountEur
Droits décès conjoint premier
Droits succession si décès de Conjoint en 1er
droitsSuccessionDecesConjointSecond *MonetaryAmountEur
Droits décès conjoint second
Droits succession si décès de Conjoint en 2eme
valeuEffetsPersonnels *MonetaryAmountEur
Effets personnels
Valeur actuelle des effets personnels en €
tauxEndettement *Rate
Endettement immédiat
Taux d’endettement immédiat constaté
epargneAnnuelle *MonetaryAmountEur
Epargne annuelle
Montant de l’épargne au budget en €/an
impots *MonetaryAmountEur
Impôts
Montant total des impôts (IR, ISF, taxes additionnelles) en €/an
montantIR *MonetaryAmountEur
Impôt sur le Revenu
Montant de l’impôt sur le revenu à l’année zéro
montantIFI *MonetaryAmountEur
Impôt sur la Fortune Immobilière
Montant de l’IFI à l’année zéro
mensualites *MonetaryAmountEur
Mensualités emprunts
Montant total des mensualités (y compris emprunts finis) des emprunts en cours en €
montantAssurancesVie *MonetaryAmountEur
Assurances-vies (montant)
Montants des assurances-vie en €
montantBiensProfessionnels *MonetaryAmountEur
Biens professionnels
Montant actuel des biens professionnels (actifs professionnels et entreprises) en €
montantPlacementDisponibilites *MonetaryAmountEur
Disponibilités
Montant des placements « disponibilités » en €
montantPlacementDivers *MonetaryAmountEur
Montant des placements divers
Montant des placements divers en €
montantEpargneSalariale *MonetaryAmountEur
Epargne Salariale
Montant actuel de l’épargne salariale en €
montantEpargneGarantie *MonetaryAmountEur
Epargne Garantie
Montant des placements « épargne garantie » en €
montantPlacementFoncier *MonetaryAmountEur
Foncier
Montant des placements fonciers en €
montantImmobilierDeRapport *MonetaryAmountEur
Immobilier de rapport
Montant total de l’immobilier de rapport en €
montantImmobilierDeRapportHorsSCPI *MonetaryAmountEur
Immobilier de rapport hors SCPI
Montant de l’immobilier de rapport en direct ou SCI en €
montantImmobilierSCPI *MonetaryAmountEur
Immobilier de rapport en SCPI
Montant de l’immobilier de rapport en SCPI en €
montantPlacementsLiquides *MonetaryAmountEur
Liquidités
Montant des placements « liquides » en €
montantTotalPlacements *MonetaryAmountEur
Total placements
Total des placements en €
montantPlacementFinanciers *MonetaryAmountEur
Placements financiers
Montant total des placements financiers (total sans immobilier de rapport) en €
tresorerie *MonetaryAmountEur
Trésorerie
Montant de trésorerie constaté en €
montantValeursMobilieres *MonetaryAmountEur
Valeurs mobilières
Montant des valeurs mobilières en €
montantPlacementsEstimesAuDepartEnRetraite *MonetaryAmountEur
Placements à la retraite
Placement estimé au seuil de la retraite
presencePlacementsMobiliersboolean
Placements mobiliers (présence)
Présence de placements mobiliers ?
valeurResidencePrincipale *MonetaryAmountEur
Résidence principale
Valeur actuelle de la résidence principale en €
valeurResidencesSecondaires *MonetaryAmountEur
Résidence(s) secondaire(s)
Valeur actuelle des résidences secondaires en €
totalRessourcesDuFoyer *MonetaryAmountEur
Ressources du foyer
Total des ressources du foyer (RESSOURCES) en €/an
totalRevenusImmobiliersDuFoyer *MonetaryAmountEur
Revenus immobiliers du foyer
Total des revenus de placements immobiliers (REVIMMODIST) en €/an
taxesAdditionnelles *MonetaryAmountEur
Taxes additionnelles
Montant des taxes additionnelles (CSG, RDS, PS, contribution exceptionnelle, contribution exceptionnelle hauts revenus) en €/an
tauxMoyenImposition *Rate
Taux Moyen d'Imposition du foyer
Taux marginal d’imposition
montantTotalPlacements1 *MonetaryAmountEur
Total placements (1)
= SUM(MONTANT) dans PLACEMENT
montantTotalStocks *MonetaryAmountEur
Total stocks
= SUM(MONTANT_ACTUEL) dans STOCK
actif *MonetaryAmountEur
Actif
Total de l’actif (placements + stocks) en €
totalImmobilier *MonetaryAmountEur
Immobilier du foyer
Montant total de l’immobilier en € (immobilier de jouissance et immobilier de rapport)
totalImmobilierPrive *MonetaryAmountEur
Immobilier privé du foyer
Valeur actuelle de l’immobilier privé (résidences) en €
passif *MonetaryAmountEur
Passif
Total du passif (impôts + capitaux restants dus) en €
tauxCouvertureRetraite *Rate
Couverture retraite
Taux de couverture de retraite constaté
valeurVehicules *MonetaryAmountEur
Véhicules privés
Valeur actuelle des véhicules en €
depensesCourantesAn *MonetaryAmountEur
Dépenses familiales
Valeur actuelle dépenses familiales annuelles en €
chargesFixesAn *MonetaryAmountEur
Charges fixes
Valeur actuelle des charges fixes annuelles en €
RevenuProfessionnel

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant
customIdString
Identifiant externe
Identifiant personnalisé
typeRevenuProfessionnelType
Type
Type de revenu professionnel (travail, capital ou divers). Peut être omis, mais la valeur doit être non-nulle si fournie.
montantActuelMonetaryAmountEur
Montant actuel
Montant actuel annuel du revenu professionnel, net de charges sociales, avant prélèvement à la source d'IR - obligatoire - doit être > 0 si le revenu est de type TRAVAIL. Peut être omis, mais la valeur doit être non-nulle si fournie.
dateDebutLocalDate
Date début
Date de début de perception du revenu - en découverte simplifiée, interdite pour revenu CAPITAL et DIVERS - pour le revenu TRAVAIL, doit être > 14 ans de la personne et > 1948
dateFinLocalDate
Date fin
Date de fin de perception du revenu - en découverte simplifiée, interdite pour revenu CAPITAL et DIVERS - doit être > date de début
RevenuProfessionnelInitializer

PropriétéTypeDescription
customIdString
Identifiant externe
Identifiant personnalisé
type *RevenuProfessionnelType
Type
Type de revenu professionnel (travail, capital ou divers)
montantActuel *MonetaryAmountEur
Montant actuel
Montant actuel annuel du revenu professionnel, net de charges sociales, avant prélèvement à la source d'IR - obligatoire - doit être >0 si de type TRAVAIL
dateDebutLocalDate
Date début
Date de début de perception du revenu - en découverte simplifiée, interdite pour revenu CAPITAL et DIVERS - pour le revenu TRAVAIL, doit être > 14 ans de la personne et > 1948
dateFinLocalDate
Date fin
Date de fin de perception du revenu - en découverte simplifiée, interdite pour revenu CAPITAL et DIVERS - doit être > date de début
Scoring

Scoring

Scoring au format décimal. Represente le score à une question posée à un client

PropriétéTypeDescription
SituationFamilialeUpdateReq

Mise à jour de situation familiale, données en entrée

PropriétéTypeDescription
situationFamiliale *SituationFamiliale
Nouvelle situation familiale
Situation familiale cible
regimeMatrimonialRegimeMatrimonial
Régime matrimonial
Nouveau régime matrimonial, obligatoire pour un couple marié. Ne doit pas être spécifié pour un célibataire.
dateMariageLocalDate
Date de mariage
Date de mariage d'un couple marié, uniquement si le dossier est en découverte approfondie
donationDernierVivantParticulierAConjointDonationDernierVivant
Donation dernier vivant vous à conjoint
Dans un couple marié, donation au dernier vivant du membre principal du foyer ('le particulier') à son conjoint
donationDernierVivantConjointAParticulierDonationDernierVivant
Donation dernier vivant du conjoint à vous
Dans un couple marié, donation au dernier vivant du conjoint au membre principal du foyer.
conjointPersonnePhysiqueInitializer
Conjoint
Conjoint, dans le cadre du passage d'un célibataire à couple
modeSeparationRedistributionSituationFamilialeUpdateSeparationRedistributionType
Mode de redistribution
Utilisé et obligatoire uniquement dans le cadre d'un divorce. Indique le mode de redistribution des biens. Dans les cas autres que le divorce, ce champ est ignoré
SituationFamilialeUpdateResp

Mise à jour de situation familiale, résultat des opérations menées

PropriétéTypeDescription
items *List<SituationFamilialeUpdateRespOperation>
Opérations
Opérations effectuées sur le dossier
SituationFamilialeUpdateRespOperation

Mise à jour de situation familiale, résultat des opérations menées

PropriétéTypeDescription
processCode *String
Code du processus
Code du processus TRANSFERT/NOOP/OK/AJOUT_CONJOINT/SUPPR_CALCULS/REDISTRIBUTION_PARTIELLE.
operationCode *String
Code de l'operation
Code de l'opération exécuté.
detail *String
Detail
Texte de l'opération
Stock

PropriétéTypeDescription
id *UUID
Identifiant
Identifiant
type *StockType
Type
Type de stock : bien d'usage (résidences, voitures, etc.), épargne salariale, biens professionnels - obligatoire
sousTypeStockSubType
Sous-type
Sous-type de stock - obligatoire si 'épargne salariale' ou 'bien professionnel'
montantActuel *MonetaryAmountEur
Montant actuel
Valeur actuelle du stock - obligatoire
fractionCommuneFraction
Fraction commune
Dans un couple, fraction du stock détenue en commun. Les fractions doivent être spécifiées pour biens d'usage et biens professionnels et leur somme égale à 1..
fractionPourMonsieurFraction
Fraction pour vous
Dans un couple, fraction détenue par le membre principal Les fractions doivent être spécifiées pour biens d'usage et biens professionnels et leur somme égale à 1.
fractionPourMadameFraction
Fraction pour le conjoint
Dans un couple, fraction détenue par le conjoint Les fractions doivent être spécifiées pour biens d'usage et biens professionnels et leur somme égale à 1.
detention *DetentionMode
Mode de détention
En découverte approfondie, décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété. En découverte simplifiée, seule la valeur pleine-propriété est autorisée.
detentionDetail *Detention Détail
Détention
Décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété avec les détails de la détention
montantAcquisAnnuelMonetaryAmountEur
Montant acquis annuel
Pour épargne salariale, montant acquis chaque année. Obligatoire si épargne salariale
dateFinVersementsLocalDate
Date fin versement
Date de fin des versements d'une épargne salariale. Obligatoire si épargne salariale
dateCessionLocalDate
Date de cession ou déblocage
Date de cession (vente, donation) d'un bien professionnel (obligatoire si découverte approfondie), date de déblocage d'une épargne salariale (obligatoire)
possesseurRattachementPersonneSimpleType
Possesseur
Bénéficiaire d'une épargne salariale, exploitant d'un bien professionnel en découverte approfondie, obligatoire pour une épargne salariale ou un bien professionnel. Ignoré pour les stocks qui ne supportent pas cette notion.
customIdString
Identifiant externe
Identifiant du stock dans le SI du client EFL
StockInitializer

PropriétéTypeDescription
type *StockType
Type
Type de stock : bien d'usage (résidences, voitures, etc.), épargne salariale, biens professionnels - obligatoire
sousTypeStockSubType
Sous-type
Sous-type de stock - obligatoire si 'épargne salariale' ou 'bien professionnel'
montantActuel *MonetaryAmountEur
Montant actuel
Valeur actuelle du stock - obligatoire
fractionCommuneFraction
Fraction commune
Dans un couple, fraction du stock détenue en commun. Les fractions doivent être spécifiées pour biens d'usage et biens professionnels et leur somme égale à 1..
fractionPourMonsieurFraction
Fraction pour vous
Dans un couple, fraction détenue par le membre principal Les fractions doivent être spécifiées pour biens d'usage et biens professionnels et leur somme égale à 1.
fractionPourMadameFraction
Fraction pour le conjoint
Dans un couple, fraction détenue par le conjoint Les fractions doivent être spécifiées pour biens d'usage et biens professionnels et leur somme égale à 1.
detentionDetentionMode
Mode de détention
En découverte approfondie, décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété. En découverte simplifiée, seule la valeur pleine-propriété est autorisée.
detentionDetailDetention Détail
Détention
Décrit en détail le mode de détention à appliquer.
montantAcquisAnnuelMonetaryAmountEur
Montant acquis annuel
Pour épargne salariale, montant acquis chaque année. Obligatoire si épargne salariale
dateFinVersementsLocalDate
Date fin versement
Date de fin des versements d'une épargne salariale. Obligatoire si épargne salariale
dateCessionLocalDate
Date de cession ou déblocage
Date de cession (vente, donation) d'un bien professionnel (obligatoire si découverte approfondie), date de déblocage d'une épargne salariale (obligatoire)
possesseurRattachementPersonneSimpleType
Possesseur
Bénéficiaire d'une épargne salariale, exploitant d'un bien professionnel en découverte approfondie, obligatoire pour une épargne salariale ou un bien professionnel. Ignoré pour les stocks qui ne supportent pas cette notion.
customIdString
Identifiant externe
Identifiant du stock dans le SI du client EFL
StockPatch

PropriétéTypeDescription
montantActuel *MonetaryAmountEur
Montant actuel
Valeur actuelle du stock. Peut être omis, mais la valeur doit être non-nulle si fournie.
fractionCommuneFraction
Fraction commune
Dans un couple, fraction du stock détenue en commun. Pour les biens d'usage et les biens professionnels, les fractions doivent être spécifiées. La somme des trois fractions doit être égale a 1 si envoyée. Les fractions doivent toutes êtres mises à jour en même temps.
fractionPourMonsieurFraction
Fraction pour vous
Dans un couple, fraction détenue par le membre principal. Pour les biens d'usage et les biens professionnels, les fractions doivent être spécifiées. La somme des trois fractions doit être égale a 1 si envoyée. Les fractions doivent toutes êtres mises à jour en même temps.
fractionPourMadameFraction
Fraction pour le conjoint
Dans un couple, fraction détenue par le conjoint. Pour les biens d'usage et les biens professionnels, les fractions doivent être spécifiées. La somme des trois fractions doit être égale a 1 si envoyée. Les fractions doivent toutes êtres mises à jour en même temps.
detention *DetentionMode
Mode de détention
En découverte approfondie, décrit si le bien est détenu en pleine-propriété, usufruit ou nue-propriété. En découverte simplifiée, seule la valeur pleine-propriété est autorisée.
detentionDetail *Detention Détail
Détention
Décrit en détail le mode de détention à appliquer.
montantAcquisAnnuel *MonetaryAmountEur
Montant acquis annuel
Pour épargne salariale, montant acquis chaque année. La valeur ne peut pas être mise à null dans le cadre de l'épargne salariale.
dateFinVersementsLocalDate
Date fin versement
Date de fin des versements d'une épargne salariale. La valeur ne peut pas être mise à null dans le cadre de l'épargne salariale.
dateCessionLocalDate
Date de cession ou déblocage
Date de cession (vente, donation) d'un bien professionnel. En découverte approfondie, comme cette valeur est obligatoire pour une épargne salariale, indique la date de déblocage, elle doit être non-nulle si envoyée dans ce cas.
possesseurRattachementPersonneSimpleType
Possesseur
Bénéficiaire d'une épargne salariale, exploitant d'un bien professionnel. Si envoyée doit être non-null pour une 'épargne salariale' ou un 'bien professionel'. Ignoré pour les stocks ne proposant pas cette notion.
customIdString
Identifiant externe
Identifiant du stock dans le SI du client EFL
User

PropriétéTypeDescription
id *UUID
Identifiant unique
Identifiant unique de l'utilisateur dans le compte client
login *String
Login
Login utilisateur, peut être différent de l'email selon la configuration du compte client.
firstName *String
Prénom
lastName *String
Nom
emailString
Email
Information complémentaire, présente selon les modes d'authentification choisis pour le compte client
adminboolean
Admin
Indique si l'utilisateur est administrateur du tenant.
orgunits *List<UUID>
orgunitIds
Liste des orgunits auxquels l'utilisateur est rattaché.
UserSyncReq

PropriétéTypeDescription
login *String
Login
Login de l'utilisateur. Dans le cadre de la synchronisation d'annuaires utilisateurs, sert d'identifiant unique pour créer ou modifier un compte. Si aucun compte utilisateur n'existe avec ce login, l'utilisateur sera créé. Si un utilisateur possède le même login et qu'il fait partie de votre tenant, il sera mis à jour.
user *UserSyncUser
Utilisateur
Permet de modifier les propriétés d'un utilisateur. Toujours obligatoire dans la mesure où cette API ne fait pas la différence entre une création et une modification d'utilisateur.
roleCustomIdsList<CustomId>
Roles
Liste de rôles auxquels affecter l'utilisateur, en utilisant leur customId. Si présente, les rôles auxquels l'utilisateur est affecté seront remplacés par ceux-ci. Si absente, l'affectation de l'utilisateur aux rôles ne sera pas modifiée. Si vide, l'utilisateur ne sera affecté à aucune rôle. Si un rôle est inconnu, une erreur sera levée.
orgunitCustomIdsList<CustomId>
Orgunit racines
Si présent, les orgunits auxquelles l'utilisateur est affecté seront remplacées par celles-ci. Les orgunit sont identifiées par leur customId. Si absent, l'affectation de l'utilisateur aux orgunits ne sera pas modifiée. Si vide, l'utilisateur ne sera plus affecté à aucune orgunit. Si une des orgunit n'est pas reconnue, une erreur sera levée.
UserSyncUser

PropriétéTypeDescription
firstname *String
Prénom
Prénom de l'utilisateur
lastname *String
Nom
Nom de famille de l'utilisateur
emailString
Email
Email utilisateur. Sert uniquement à la communication par email.
adminBoolean
Admin
Valeur par défaut : false
Indique si l'utilisateur est administrateur du tenant.
disabledDateInstant
Date désactivation
Si renseigné, le compte utilisateur est désactivé (sous entendu depuis cette date).

Enumérations

BienType

Type du bien

Type du bien

CodeLibelleDescription
BPBien professionnel
BUbien d'usage
PLplacement
BusinessSequenceType

Type de séquence métier

Type de séquence métier

CodeLibelleDescription
RAPPORTRapports
CaisseComplementaireCode

Code de caisse complémentaire

CodeLibelleDescription
CANCAVARCI (CANCAVA)
CARCDCARCDSF (ex CARCD)
CARMFCARMF
CARPIMKOCARPIMKO
CARPVCARPV
CARSAFCARCDSF (ex CARSAF)
CAVAMACCAVAMAC
CAVECCAVEC
CAVOMCAVOM
CAVPCAVP
CIPAVCIPAV
CNBFAPBF et CNBF
CRNCR
ORGANICRCI (ORGANIC)
RCORCO
CaisseRetraiteCode

Code de caisse de retraite

CodeLibelleDescription
AGIRC_AGIRC

Déprécié : Avant fusion ARRCO_AGIRC, MAIS à garder pour la prévoyance !!!

AGIRC_ARRCOAGIRC-ARRCO
ARRCO_ARRCO

Déprécié : Avant fusion ARRCO_AGIRC

CAISSE_INACTIFCaisse 'inactif'
CAISSE_ZEROCaisse 0
CANCAVACANCAVA
CANCAVA_CCCANCAVA (conjoint)
CARCDCARCD
CARCD_ASVCARCD_ASV
CARMFCARMF
CARMF_ASVCARMF_ASV
CARPIMKOCARPIMKO
CARPIMKO_ASVCARPIMKO_ASV
CARPVCARPV
CARSFFCARSFF
CARSFF_ASVCARSFF_ASV
CAVAMACCAVAMAC
CAVECCAVEC
CAVOMCAVOM
CAVPCAVP
CAVP_ASVCAVP_ASV
CCPMACCPMA
CIPAVCIPAV
CNAVPLCNAVPL
CNAVTSCNAVTS
CNBFCNBF
COREVA_CCCOREVA/RCO (conjoint)
CPCEACPCEA
CRNCRN
CRN_CCRN_C
FONCTFONCT
IRCANTECIRCANTEC
IRCECIRCEC
MSAMSA
MSA_CCMSA (conjoint)
MSA_SALARIEMSA Salarié

Déprécié : Obsolète

ORGANICORGANIC
ORGANIC_CCORGANIC (conjoint)
RACDRACD
RACLRACL
RAFPRAFP
RCORCO
CaisseRetraiteType

Type de caisse de retraite

CodeLibelleDescription
BASERetraite de base
COMPLEMENTAIRERetraite complémentaire
CarmfClasseCotisation

Classe de cotisation pour la caisse CARMF

CodeLibelleDescription
CLASSE_AClasse A
CLASSE_BClasse B
CLASSE_CClasse C
CategoriePlacement

Immobilier privé ou professionnel

Pour un placement 'immobilier' classique direct, indique s'il est privé ou professionnel

CodeLibelleDescription
PRIVEPrivé
PROFESSIONNELProfessionnel
Civilite

Civilité

Titre de civilité d'une personne

CodeLibelleDescription
MADAMEMadame
MONSIEURMonsieur
ClasseCotisation

Classes de cotisation de retraite

CodeLibelleDescription
CARCD_MINCARCD min

Déprécié : valeur plus exploitée dans le calcul

CARCD_OBLICARCD obligatoire

Déprécié : valeur plus exploitée dans le calcul

CARPV_12
CARPV_16
CARPV_2
CARPV_20
CARPV_24
CARPV_3
CARPV_4
CARPV_6
CARPV_8
CARPV_9
CAVEC_A
CAVEC_B
CAVEC_C
CAVEC_D
CAVEC_E
CAVEC_F
CAVEC_G
CAVEC_H
CAVOM_B
CAVOM_C
CAVOM_D
CAVOM_E
CAVOM_F
CAVOM_SP
CAVP_10
CAVP_11
CAVP_12
CAVP_13
CAVP_3
CAVP_4
CAVP_5
CAVP_6
CAVP_7
CAVP_8
CAVP_9
CIPAV_12
CIPAV_20
CIPAV_28
CIPAV_4
CIPAV_40
CIPAV_432
CIPAV_468
CIPAV_8
CNBF_COMPL_1Classe 1
CNBF_COMPL_2Classe 2
CNBF_COMPL_3Classe 3
CNBF_COMPL_4Classe 4
CNBF_COMPL_5Classe 5
CPCEABC_10
CPCEABC_2
CPCEABC_3
CPCEABC_4
CPCEA_10
CPCEA_2
CPCEA_3
CPCEA_4
CRN_10
CRN_20
CRN_30
CRN_40
CRN_50
CRN_60
CRN_70
CRN_80
IRCEC_A
IRCEC_B
IRCEC_C
IRCEC_D
IRCEC_SP
CompteTitreCategory

Type de compte titre

CodeLibelleDescription
ORDINAIRECompte d'instruments financiers
PLAN_EPARGNE_ACTIONPlan d'épargne en actions (PEA)
CompteTitresType

Type de compte titre

Type de compte titre

Souscription couple :
Indique s'il est possible de souscrire à ce type de compte-titres en tant que couple.
CodeLibelleDescription
COMPTE_INSTRUMENTS_FINANCIERSCompte d'instruments financiers
  • Souscription couple : true
PEA_CLASSIQUEPEA Classique
  • Souscription couple : false
PEA_PME_ETIPEA PME-ETI
  • Souscription couple : false
CumulSituationCode

Cumul situation code

CodeLibelleDescription
DECESDécès
IPTInvalidité Permanente Totale
ITTIncapacité Temporaire de Travail
DepenseType

Type depense

Type de dépenses courante

CodeLibelleDescription
ALIMENTATION
ASSURANCE
AUTRES_DEPENSES
EAU
EDF
FONCIER
HABILLEMENT
HABITATION
LOISIR
LOYER
SCOLAIRE
TELEPHONE
TRANSPORT
VACANCES
VEHICULE
DetentionMode

Mode de détention

Mode de détention d'un stock ou d'un placement

CodeLibelleDescription
NUE_PROPRIETENue-propriété
PLEINE_PROPRIETEPleine propriété
USUFRUITUsufruit
DomiciliationFiscale

Domiciliation fiscale

Lieu de domiciliation fiscale (pour l'application de la fiscalité Française)

CodeLibelleDescription
FRANCE_METROPOLITAINEMétropole
GUADELOUPEGuadeloupe
GUYANEGuyane
LA_REUNIONLa Réunion
MARTINIQUEMartinique
MAYOTTEMayotte
DonationDernierVivant

Donation au dernier vivant

CodeLibelleDescription
QUOTITE_DISPONIBLE_PPQuotité disponible ordinaire
QUOTITE_MAXQuotité la plus large
TOUT_USUFTotalité en usufruit
UN_QUART_PP_TROIS_QUART_USUF1/4 en pleine propriété, 3/4 en usufruit
DonationPartageType

Type Donation patrtagee

CodeLibelleDescription
CONJONCTIVE
SIMPLE_CONJOINT
SIMPLE_PRINCIPAL
DureeEngagement

DureeEngagement

Durées de réduction fiscales proposées pour les simulations immobilières de type PINEL

Valeur par défaut :
Valeur par défaut à la création d'un nouveau placement
CodeLibelleDescription
DOUZE12 ans
  • Valeur par défaut : true
NEUF9 ans
  • Valeur par défaut : false
SIX6 ans
  • Valeur par défaut : false
DureeTravail

Code duree de travail

CodeLibelleDescription
TEMPS_PARTIELTemps partiel
TEMP_PLEINTemps plein
EmpruntAffectation

Affectation d'un emprunt

CodeLibelleDescription
ACHAT_AUTOMOBILEAcquisition automobile
CREDIT_PERS_ET_DIVERSCrédit personnel et divers
LOCATIF_MALRAUXInvestissement immobilier Malraux
LOCATIF_MEUBLEInvestissement immobilier meublé
LOCATIF_MONUMENT_HISTORIQUEInvestissement Monuments Historiques
LOCATIF_PINELInvestissement immobilier Pinel
LOCATIF_URBAINInvestissement immobilier locatif
PROF_ACQ_DROITS_SOCIAUXAcquisition de droits sociaux
PROF_INVEST_IMMOInvestissements immobiliers professionnels
RESIDENCE_PRINCIPALEAcquisition / travaux résidence principale
RESIDENCE_PRINCIPALE_BBCAcquisition résidence principale (norme BBC)
RESIDENCE_PRINCIPALE_LOGEMENT_NEUFAcquisition résidence principale (logement neuf)
RESIDENCE_SECONDAIREAcquisition / travaux résidence secondaire
EmpruntFranchise

Type d'un emprunt

CodeLibelleDescription
AUCUNEAucune
PARTIELLEPartielle
TOTALETotale
EmpruntInvestissementImmobilierType

Type d'emprunt associé à un investissement immobilier locatif simulé

CodeLibelleDescription
MALRAUXInvestissement Malraux
MEUBLEInvestissement loueur en meublés
MONUMENT_HISTORIQUEInvestissement Monument Historique
PINELInvestissement Pinel
URBAINInvestissement immobilier
EmpruntType

Type d'un emprunt

CodeLibelleDescription
AMORTISSABLEAmortissable
IN_FINEIn Fine
EngagementPersonnelCategorie

TODO

CodeLibelleDescription
ASSURANCEAssurance
ENGAGEMENTEngagement
EngagementPersonnelType

TODO

CodeLibelleDescription
ASSURANCE_DECESDécès
ASSURANCE_DIVERSDivers
ASSURANCE_EMPRUNTEmprunt
ASSURANCE_HOMME_CLEFHomme clef
ENGAGEMENT_CAUTIONCaution
ENGAGEMENT_DIVERSDivers
ENGAGEMENT_NANTISSEMENTNantissement
HookAuthType

code du hook

CodeLibelleDescription
NONEAucun
OAUTH_AZUREOAUTH AZURE
HookType

Type de hook

CodeLibelleDescription
DOSSIER_SAUVEGARDEDossier sauvegardé
RAPPORT_GENERERapport généré
LienParente

Lien de parenté

CodeLibelleDescription
AUTRE_DESCENDANT_LIGNE_DIRECTEDescendant en ligne directe (2ème degré)
AUTRE_PARENT_AU_4E_DEGREAutre parent au 4e degré
AUTRE_PARENT_AU_DELA_DU_4E_DEGREAutre parent au-delà du 4e degré
CONJOINTConjoint
COUSIN_GERMAINCousin germain
ENFANTEnfant
FREREFrère/soeur
GRAND_ONCLEGrand oncle/tante
GRAND_PERE_MATERNELLEGrand-père/grand-mère maternel(le)
GRAND_PERE_PATERNELLEGrand-père/grand-mère paternel(le)
MEREMère
NEVEUNeveu/Nièce
NON_PARENTNon parent
ONCLEOncle/Tante
PEREPère
PRINCIPALParticulier
LienParenteCompatibiliteApi

Lien de parenté

CodeLibelleDescription
AUTRE_DESCENDANT_LIGNE_DIRECTEDescendant en ligne directe (2ème degré)
AUTRE_PARENT_AU_4E_DEGREAutre parent au 4e degré
AUTRE_PARENT_AU_DELA_DU_4E_DEGREAutre parent au-delà du 4e degré
CONJOINTConjoint
COUSIN_GERMAINCousin germain
ENFANTEnfant
ENFANT_A_CHARGEEnfant à charge

Déprécié : Remplacé par ENFANT et Le booléen personneACharge

ENFANT_NON_A_CHARGEEnfant non à charge

Déprécié : Remplacé par ENFANT et Le booléen personneACharge

FREREFrère/soeur
GRAND_ONCLEGrand oncle/tante
GRAND_PERE_MATERNELLEGrand-père/grand-mère maternel(le)
GRAND_PERE_PATERNELLEGrand-père/grand-mère paternel(le)
MEREMère
NEVEUNeveu/Nièce
NON_PARENTNon parent
ONCLEOncle/Tante
PEREPère
PRINCIPALParticulier
MeteoCategories

Catégories de météo

CodeLibelleDescription
BUDGETVotre budget
FISCALITEVotre fiscalité
PATRIMOINEVotre patrimoine
PREVOYANCEVotre prévoyance
RETRAITEVotre retraite
TRANSMISSIONVotre transmission
MultiSupportIdentifiant

Identifiant de support pour placements assurance-vie ou stock épargne salariale

Identifiant de support pour placements assurance-vie ou stock épargne salariale

CodeLibelleDescription
FONDS_EUROS_CLASSIQUEFonds en euros classiques
FONDS_EUROS_DIVERSIFIESFonds en euros diversifiés
FONDS_UC_DEVISEFonds en UC devises
FONDS_UC_IMMOBILIERFonds en UC immobilier
FONDS_UC_OPCVMFonds en UC OPCVM
FONDS_UC_VALEURS_MOBILIERES_DIRECTFonds en UC valeurs mobilières en direct
MultiSupportSousType

Sous-type de multi-support pour placements assurance-vie ou stock épargne salariale

Sous-type de multi-support pour placements assurance-vie ou stock épargne salariale

CodeLibelleDescription
FONDS_EUROSFonds en euros
FONDS_UNITES_DE_COMPTEFonds en unités de comptes
MultiSupportType

Type de multi-support pour placements assurance-vie ou stocke épargne salariale

Type de multi-support pour placements assurance-vie ou stocke épargne salariale

CodeLibelleDescription
BON_ASSURANCE_VIEMulti-support de bons de capitalisation assurance-vie
CONTRAT_ASSURANCE_VIEMulti-support de contrat d'assurance-vie
EPARGNE_SALARIALEMulti-support épargne salariale
PEP_ASSURANCE_VIEMulti-support de PEP assurance-vie
NationaliteType

Type de nationalité (simplifiée)

CodeLibelleDescription
AUTREAutre
FRANCEFrance
USAUSA
OrigineCaisse

Provenance d'une caisse

CodeLibelleDescription
ORIGINE_REELCaisse origine REEL
ORIGINE_RISCaisse origine RIS
PieceIdentiteType

Type de pièce d'identité fourni par le client au conseiller (Lois MIF)

CodeLibelleDescription
AUCUNE_PIECE_IDENTITEAucune
AUTRE_PIECE_IDENTITEAutre
CARTE_DE_SEJOURCarte de Séjour
CARTE_NATIONALE_IDENTITECarte Nationale d'Identité
PASSEPORTPasseport
PlacementIdentifier

Identifiant de placement

Eligibe abatement 40% :
L'abattement de 40% est uniquement sur les dividendes perçus (intérêts) et à condition que cela provienne d'une action française (d'office) ou Européenne (option car va dépendre de la composition exacte du placement).
CodeLibelleDescription
AUTRES_PLAC_DIVERSDivers
  • Eligibe abatement 40% : false
BILLETS_TRESORERIEBillet de trésorerie
  • Eligibe abatement 40% : false
BON_CAISSE_TX_LIBREBons de caisse à taux libre
  • Eligibe abatement 40% : false
BON_DU_TRESOR_NEGOCBon du trésor négociable
  • Eligibe abatement 40% : false
BON_IFABon IFA
  • Eligibe abatement 40% : false
BON_IFSBon IFS
  • Eligibe abatement 40% : false
BON_INTERETS_PROGRBons à intérêts progressifs
  • Eligibe abatement 40% : false
CELCEL
  • Eligibe abatement 40% : false
CERTIF_DEPOT_NEGOCIABLECertificat de dépôt négociable
  • Eligibe abatement 40% : false
CODEVILDD (ex-CODEVI)
  • Eligibe abatement 40% : false
COMPTE_A_TERMECompte à terme
  • Eligibe abatement 40% : false
COMPTE_COURANT_ASSOCIECompte courant associé
  • Eligibe abatement 40% : false
COMPTE_DEPOT_ESPECESCompte de dépôts et espèces
  • Eligibe abatement 40% : false
CONTRAT_ASSURANCE_VIEContrat d'assurance-vie
  • Eligibe abatement 40% : false
CONTRAT_CAPITALISATIONContrat de capitalisation
  • Eligibe abatement 40% : false
CONTRAT_PEP_VIEContrat d'assurance-vie PEP
  • Eligibe abatement 40% : false
DEPOT_A_TERMEDépôt à terme
  • Eligibe abatement 40% : false
DIAMANTDiamant
  • Eligibe abatement 40% : false
FONCIER_DIVERSDivers
  • Eligibe abatement 40% : false
FORESTForêts
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_BESSON_ANCIENImmobilier en direct Besson ancien
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_BESSON_NEUFImmobilier en direct Besson neuf / Robien neuf
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_BORLOOImmobilier en direct Borloo neuf ou Scellier 2009
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_CLASSIQUEImmobilier en direct Classique
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_DEMESSINEImmobilier en direct Demessine
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_DENORMANDIEImmobilier en direct Denormandie
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_DIVERSImmobilier en direct Divers
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_DUFFLOTImmobilier en direct Duflot
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_GIRARDINImmobilier en direct Girardin
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_MALRAUXImmobilier en direct Malraux
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_MEHAIGNERIEImmobilier en direct Méhaignerie
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_MEUBLEImmobilier en direct Meublé
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_MONUMENT_HISTORIQImmobilier en direct Monuments historiques
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_PERISSOLImmobilier en direct Périssol
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_PINELImmobilier en direct Pinel
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_PINEL_PLUSImmobilier en direct Pinel +
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_ROBIEN_RECENTREImmobilier en direct Robien recentré ou Scellier 2009
  • Eligibe abatement 40% : false
IMMOBILIER_DIRECT_SCELLIERImmobilier en direct Scellier (à partir de 2010)
  • Eligibe abatement 40% : false
IMMOBILIER_SCI_PRIVEE_CLASSIQUEImmobilier Classique en SCI Privée
  • Eligibe abatement 40% : false
IMMOBILIER_SCI_PROF_CLASSIQUEImmobilier Classique en SCI professionnelle
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_BESSON_ANCIENImmobilier Besson ancien en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_BESSON_NEUFImmobilier Besson neuf / Robien neuf en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_BORLOOImmobilier Borloo neuf ou Scellier 2009 en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_CLASSIQUEImmobilier Classique en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_DEMESSINEImmobilier Demessine en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_DENORMANDIEImmobilier Denormandie en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_DIVERSImmobilier Divers en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_DUFFLOTImmobilier Duflot en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_GIRARDINImmobilier Girardin en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_MALRAUXImmobilier Malraux en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_MEHAIGNERIEImmobilier Méhaignerie en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_MONUMENT_HISTORIQImmobilier Monuments historiques en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_PERISSOLImmobilier Périssol en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_PINELImmobilier Pinel en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_PINEL_PLUSImmobilier Pinel + en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_ROBIEN_RECENTREImmobilier Robien recentré ou Scellier 2009 en SCPI
  • Eligibe abatement 40% : false
IMMOBILIER_SCPI_SCELLIERImmobilier Scellier (à partir de 2010) en SCPI
  • Eligibe abatement 40% : false
INVEST_DOM_TOMInvestissement dans les DOM-TOM
  • Eligibe abatement 40% : false
LEPL.E.P.
  • Eligibe abatement 40% : false
LIVRET_ALivret A
  • Eligibe abatement 40% : false
LIVRET_BLivret B
  • Eligibe abatement 40% : false
LIVRET_BANCAIRELivret bancaire
  • Eligibe abatement 40% : false
LIVRET_BLEULivret Bleu
  • Eligibe abatement 40% : false
LIVRET_JEUNELivret jeune
  • Eligibe abatement 40% : false
OBJET_ART_COLLECTIONObjet d'art et de collection
  • Eligibe abatement 40% : false
OR_METALOr
  • Eligibe abatement 40% : false
PARTICIP_ENTREP_NON_COTEEParts d'entreprises non cotées
  • Eligibe abatement 40% : false
PARTS_GFAParts de GFA
  • Eligibe abatement 40% : false
PARTS_GROUP_FORESTIERParts de groupement forestier
  • Eligibe abatement 40% : false
PARTS_STE_CIVIL_FORESTParts de société civile forestière
  • Eligibe abatement 40% : false
PELPEL
  • Eligibe abatement 40% : false
PEP_TAUX_FIXEPEP à taux fixe
  • Eligibe abatement 40% : false
PEP_TAUX_PROGRESSIFPEP à taux progressif
  • Eligibe abatement 40% : false
PEP_TAUX_REVISABLEPEP à taux révisable
  • Eligibe abatement 40% : false
PRET_FAMILIALPrêt familial
  • Eligibe abatement 40% : false
PRET_ORDINAIREAutre prêt
  • Eligibe abatement 40% : false
SOFICASOFICA
  • Eligibe abatement 40% : false
SOFIPECHE_SOFIDOMSOFIDOM
  • Eligibe abatement 40% : false
TERRAINTerrains à bâtir
  • Eligibe abatement 40% : false
TERRES_AGRI_BAIL_CLASSIQTerres agricoles - bail classique
  • Eligibe abatement 40% : false
TERRES_AGRI_BAIL_LONG_TERMTerres agricoles - bail long terme
  • Eligibe abatement 40% : false
TERRES_VITI_BAIL_CLASSIQTerres viticoles - bail classique
  • Eligibe abatement 40% : false
TERRES_VITI_BAIL_LONG_TERMTerres viticoles - bail long terme
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_DIRECT_ACTIONS_EUActions Européennes détenues en direct
  • Eligibe abatement 40% : true
VALEURS_MOBILIERES_EN_DIRECT_ACTIONS_FRActions Françaises détenues en direct
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_DIRECT_ACTIONS_INTERNATActions internationales détenues en direct
  • Eligibe abatement 40% : true
VALEURS_MOBILIERES_EN_DIRECT_OBLIG_EUObligations Européennes détenues en direct
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_DIRECT_OBLIG_FRObligations Françaises détenues en direct
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_DIRECT_OBLIG_INTERNATObligations internationales détenues en direct
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_ACTIONS_EUActions Européennes détenues en FCP
  • Eligibe abatement 40% : true
VALEURS_MOBILIERES_EN_FCP_ACTIONS_FRActions Françaises détenues en FCP
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_ACTIONS_INTERNATActions internationales détenues en FCP
  • Eligibe abatement 40% : true
VALEURS_MOBILIERES_EN_FCP_FCCFCT (ex FCC) détenues en FCP
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_FCPIFCPI/FCPR/FIP détenues en FCP
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_FCP_DIVERSIFIEOPCVM diversifiés détenues en FCP
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_MONETAIRESMonétaires détenues en FCP
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_OBLIG_EUObligations Européennes détenues en FCP
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_OBLIG_FRObligations Françaises détenues en FCP
  • Eligibe abatement 40% : false
VALEURS_MOBILIERES_EN_FCP_OBLIG_INTERNATObligations internationales détenues en FCP
  • Eligibe abatement 40% : false
PlacementSubtype

Sous-type de placement

CodeLibelleDescription
ACTIONS_OBLIGATIONSActions et obligations

Uniquement si le type de placement est VALEURS_MOBILIERES

AUTRES_DISPONIBILITESAutres disponibilités

Uniquement si le type de placement est DISPONIBILITES

AUTRES_PLACEMENTSAutre placement

Uniquement si le type de placement est AUTRES_PLACEMENTS

BONSBons

Uniquement si le type de placement est DISPONIBILITES

BON_DE_CAPITALISATIONContrats de capitalisation

Uniquement si le type de placement est ASSURANCE_VIE

CELCEL

Uniquement si le type de placement est EPARGNE_GARANTIE

COMPTE_DEPOTS_ESPECESComptes de dépôts et espèces

Uniquement si le type de placement est DISPONIBILITES

CONTRAT_ASSURANCE_VIEContrat d'assurance-vie

Uniquement si le type de placement est ASSURANCE_VIE

DEPOTS_COMPTES_TERMEDépôts et comptes à terme

Uniquement si le type de placement est DISPONIBILITES

FCP_CLASSIQUESSICAV et FCP classique

Uniquement si le type de placement est VALEURS_MOBILIERES

FONCIERFoncier (en direct)

Uniquement si le type de placement est FONCIER

IMMOBILIER_DIRECTImmobilier (direct)

Uniquement si le type de placement est IMMOBILIER_DIRECT_OU_SCI

IMMOBILIER_SCI_PRIVEEImmobilier (SCI professionnelle)

Uniquement si le type de placement est IMMOBILIER_DIRECT_OU_SCI

IMMOBILIER_SCI_PROFImmobilier (SCI privée)

Uniquement si le type de placement est IMMOBILIER_DIRECT_OU_SCI

IMMOBILIER_SCPIImmobilier (détenu en SCPI)

Uniquement si le type de placement est IMMOBILIER_SCPI

LIVRETSLivret

Uniquement si le type de placement est DISPONIBILITES

PELPEL

Uniquement si le type de placement est EPARGNE_GARANTIE

PEP_BANCAIREPEP bancaire

Uniquement si le type de placement est EPARGNE_GARANTIE

PlacementType

Type de placement

CodeLibelleDescription
ASSURANCE_VIEAssurance-vie
AUTRES_PLACEMENTSAutres placements
DISPONIBILITESDisponibilités
EPARGNE_GARANTIEEpargne garantie
FONCIERFoncier
IMMOBILIER_DIRECT_OU_SCIImmobilier (direct ou SCI)
IMMOBILIER_SCPIImmobilier (SCPI)
VALEURS_MOBILIERESTitres financiers
PlanActionRetraiteActionRattachment

Rattachement d'une action de Plan d'action retraite

CodeLibelleDescription
CONJOINTConjoint
PRINCIPALPrincipal
PlanActionRetraiteActionType

Action de plan d'action retraite

CodeLibelleDescription
ASSURANCE_VIEAssurance vie
MADELINMadelin
PERPER
PERPPERP
PossesseurType

Possesseur, assuré, souscripteur,...

CodeLibelleDescription
CONJOINTConjoint
COUPLELe couple
PRINCIPALPrincipal
ProduitEpargneRetraiteType

Type de produit épargne retraite

CodeLibelleDescription
MADELINMadelin
PERPER
PERPPERP
ProfessionCategory

Code profession

CodeLibelleDescription
ARTISANArtisan

Si spécifié, alors aucun sous-type ne doit être spécifié

COMMERCANTCommerçant
EXPLOITANT_AGRICOLEExploitant agricole
PROFESSION_LIBERALEProfession libérale

Si spécifié, alors le sous-type de profession est obligatoire

RETRAITERetraité
SALARIESalarié

Si spécifié, alors le sous-type de profession est obligatoire

SANS_PROFESSIONSans profession
ProfessionSubCategory

Code sous-profession

CodeLibelleDescription
AGENT_GENERAL_ASSURANCESAgent général d'assurances

Uniquement disponible si la profession est PROFESSION_LIBERALE

ARCHITECTEArchitecte, technicien

Uniquement disponible si la profession est PROFESSION_LIBERALE

ARTISTEArtiste

Uniquement disponible si la profession est PROFESSION_LIBERALE

ARTISTE_LIBERALArtiste libéral

Uniquement disponible si la profession est PROFESSION_LIBERALE

AUTEURAuteur

Uniquement disponible si la profession est PROFESSION_LIBERALE

AUTRE_PROFESSION_LIBERALEAutre profession libérale

Uniquement disponible si la profession est PROFESSION_LIBERALE

AVOCATAvocat

Uniquement disponible si la profession est PROFESSION_LIBERALE

CHIRURGIEN_DENTISTEChirurgien-Dentiste

Uniquement disponible si la profession est PROFESSION_LIBERALE

CONSEILLER_INDEPENDANTConseiller Indépendant

Uniquement disponible si la profession est PROFESSION_LIBERALE

DIRECTEUR_LABORATOIRE_ANALYSESPharmacien, Directeur de laboratoire d'analyses (pharmacien biologiste)

Uniquement disponible si la profession est PROFESSION_LIBERALE

EXPERT_AGRICOLE_ET_FONCIERExpert agricole et foncier

Uniquement disponible si la profession est PROFESSION_LIBERALE

EXPERT_COMPTABLEExpert comptable

Uniquement disponible si la profession est PROFESSION_LIBERALE

GEOMETREGéomètre

Uniquement disponible si la profession est PROFESSION_LIBERALE

INFIRMIERInfirmier

Uniquement disponible si la profession est PROFESSION_LIBERALE

INGENIEUR_CONSEILIngénieur conseil

Uniquement disponible si la profession est PROFESSION_LIBERALE

KINESITHERAPEUTEKinésithérapeute

Uniquement disponible si la profession est PROFESSION_LIBERALE

MANNEQUINMannequin

Uniquement disponible si la profession est PROFESSION_LIBERALE

MASSEURMasseur

Uniquement disponible si la profession est PROFESSION_LIBERALE

MEDECINMédecin, Directeur de laboratoire d'analyses (médecin biologiste)

Uniquement disponible si la profession est PROFESSION_LIBERALE

MONITEURMoniteur

Uniquement disponible si la profession est PROFESSION_LIBERALE

NOTAIRENotaire

Uniquement disponible si la profession est PROFESSION_LIBERALE

OFFICIER_MINISTERIELOfficier ministériel

Uniquement disponible si la profession est PROFESSION_LIBERALE

OFFICIER_PUBLICOfficier public

Uniquement disponible si la profession est PROFESSION_LIBERALE

ORTHOPHONISTEOrthophoniste

Uniquement disponible si la profession est PROFESSION_LIBERALE

PODOLOGUEPodologue

Uniquement disponible si la profession est PROFESSION_LIBERALE

PROFESSEURProfesseur

Uniquement disponible si la profession est PROFESSION_LIBERALE

SAGE_FEMMESage-Femme

Uniquement disponible si la profession est PROFESSION_LIBERALE

SALARIE_COLLECTIVITE_PUBLIQUE_NON_TITULAIRECollectivité publique - non titulaire

Uniquement disponible si la profession est SALARIE

SALARIE_COLLECTIVITE_PUBLIQUE_TITULAIRECollectivité publique - titulaire

Uniquement disponible si la profession est SALARIE

SALARIE_EXPLOITATION_AGRICOLE_CADRESecteur privé exploitation agricole - cadre

Uniquement disponible si la profession est SALARIE

SALARIE_EXPLOITATION_AGRICOLE_NON_CADRESecteur privé exploitation agricole - non cadre

Uniquement disponible si la profession est SALARIE

SALARIE_ORGANISME_AGRICOLE_CADRESecteur privé organisme agricole - cadre

Uniquement disponible si la profession est SALARIE

SALARIE_ORGANISME_AGRICOLE_NON_CADRESecteur privé organisme agricole - non cadre

Uniquement disponible si la profession est SALARIE

SALARIE_PRIVE_CADRESecteur privé non agricole - cadre

Uniquement disponible si la profession est SALARIE

SALARIE_PRIVE_NON_CADRESecteur privé non agricole - non cadre

Uniquement disponible si la profession est SALARIE

VETERINAIREVétérinaire, Directeur de laboratoire d'analyses (vétérinaire biologiste)

Uniquement disponible si la profession est PROFESSION_LIBERALE

ProfessionType

Profession

CodeLibelleDescription
AGENT_GENERAL_ASSURANCESAgent général d'assurances

51

ARCHITECTEArchitecte, technicien

52

ARTISANArtisan

10

ARTISTEArtiste

53

ARTISTE_LIBERALArtiste libéral

52

AUTEURAuteur

53

AUTRE_PROFESSION_LIBERALEAutre profession libérale
AVOCATAvocat

55

CHIRURGIEN_DENTISTEChirurgien-Dentiste

57

COMMERCANTCommerçant

20

CONSEILLER_INDEPENDANTConseiller Indépendant

52

DIRECTEUR_LABORATOIRE_ANALYSESPharmacien, Directeur de laboratoire d'analyses (pharmacien biologiste)

58

EXPERT_AGRICOLE_ET_FONCIERExpert agricole et foncier

52

EXPERT_COMPTABLEExpert comptable

511

EXPLOITANT_AGRICOLEExploitant agricole

40

GEOMETREGéomètre

52

INFIRMIERInfirmier

513

INGENIEUR_CONSEILIngénieur conseil

52

KINESITHERAPEUTEKinésithérapeute

513

MANNEQUINMannequin

52

MASSEURMasseur

513

MEDECINMédecin, Directeur de laboratoire d'analyses (médecin biologiste)

518

MONITEURMoniteur

52

NOTAIRENotaire

520

OFFICIER_MINISTERIELOfficier ministériel

521

OFFICIER_PUBLICOfficier public

521

ORTHOPHONISTEOrthophoniste

513

PODOLOGUEPodologue

513

PROFESSEURProfesseur

52

RETRAITERetraité
SAGE_FEMMESage-Femme

527

SALARIE_COLLECTIVITE_PUBLIQUE_NON_TITULAIRECollectivité publique - non titulaire

75

SALARIE_COLLECTIVITE_PUBLIQUE_TITULAIRECollectivité publique - titulaire

75

SALARIE_EXPLOITATION_AGRICOLE_CADRESecteur privé exploitation agricole - cadre

751

SALARIE_EXPLOITATION_AGRICOLE_NON_CADRESecteur privé exploitation agricole - non cadre

75

SALARIE_ORGANISME_AGRICOLE_CADRESecteur privé organisme agricole - cadre

75

SALARIE_ORGANISME_AGRICOLE_NON_CADRESecteur privé organisme agricole - non cadre

75

SALARIE_PRIVE_CADRESecteur privé non agricole - cadre

75

SALARIE_PRIVE_NON_CADRESecteur privé non agricole - non cadre

75

SANS_PROFESSIONSans profession
VETERINAIREVétérinaire, Directeur de laboratoire d'analyses (vétérinaire biologiste)

528

RapportBirtType

Types de rapport

Tous les types de rapport connus par l'application y compris ceux qui ne peuvent plus être générés.

CodeLibelleDescription
COMPLETEtudes patrimoniales
DERDocuments d'entrée en relation (DER)
IMMOProjets immobiliers
INVESTAudits investisseur
LETTRE_MISSIONLettres de mission
MADELINSimulations Madelin
PERSimulations PER
PERPSimulations PERP
PREVOYANCEAudits protection sociale
PREVOYANCE_DECESProtections du foyer
RETRAITEAudits retraite
SIMASSVIERachats assurance-vie
SIMEPAPROJProjets d'épargne
TRANSMISSIONAudits transmission
RattachementPersonneSimpleType

Personne de rattachement

CodeLibelleDescription
CONJOINTConjoint
PRINCIPALPrincipal
RattachementPersonneType

Personne de rattachement

CodeLibelleDescription
CONJOINTConjoint
COUPLECouple
PRINCIPALVous
ReductionSoficaType

Classique, Société de réalisation (A ou B)

CodeLibelleDescription
SOFICA_CLASSIQUEClassique
SOFICA_SOCIETE_REA_ASociété de réalisation
SOFICA_SOCIETE_REA_BSociété de réalisation
RegimeMatrimonial

Régime matrimonial

CodeLibelleDescription
AUTRE_REGIME_DE_COMMUNAUTEContrat de communauté
COMMUNAUTE_LEGALE_ACTUELLECommunauté légale actuelle
COMMUNAUTE_LEGALE_AVANT_1966Communauté légale d'avant 1966
COMMUNAUTE_MEUBLES_ET_ACQUETSCommunauté de meubles et acquêts
COMMUNAUTE_UNIVERSELLECommunauté universelle
COMMUNAUTE_UNIVERSELLE_ATTRIBUTION_INTEGRALECommunauté universelle (attribution intégrale)
PARTICIPATION_AUX_ACQUETSParticipation aux acquêts (dont régime franco-allemand)
SEPARARATION_DE_BIENSSéparation de biens
RenteSubType

Type de rente

Percevoir en découverte dans les rentes :
La rente peut être créée en découverte en tant que rente à percevoir.
Verser en découverte dans les rentes :
La rente peut être créée en découverte en tant que rente à verser.
CodeLibelleDescription
CAPITAL_DECESCapital décès

Disponible comme rente à percevoir. Existe historiquement dans l'API mais déprécié. Ce code sera ignoré en création et modification. Les rentes de ce type ne sont pas renvoyées dans l'API GET.

  • Percevoir en découverte dans les rentes : false
  • Verser en découverte dans les rentes : false
CAPITAL_INVALIDITECapital invalidité

Disponible comme rente à percevoir. Existe historiquement dans l'API mais déprécié. Ce code sera ignoré en création et modification. Les rentes de ce type ne sont pas renvoyées dans l'API GET.

  • Percevoir en découverte dans les rentes : false
  • Verser en découverte dans les rentes : false
CAPITAL_PERPER

Disponible comme rente à percevoir. Existe historiquement dans l'API mais déprécié. Ce code sera ignoré en création et modification. Les rentes de ce type ne sont pas renvoyées dans l'API GET.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
CAPITAL_PERPPERP

Disponible comme rente à percevoir. Existe historiquement dans l'API mais déprécié. Ce code sera ignoré en création et modification. Les rentes de ce type ne sont pas renvoyées dans l'API GET.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
INDEMNITE_JOURNALIEREIndemnité journalière

Disponible comme rente à percevoir. Existe historiquement dans l'API mais déprécié. Ce code sera ignoré en création et modification. Les rentes de ce type ne sont pas renvoyées dans l'API GET.

  • Percevoir en découverte dans les rentes : false
  • Verser en découverte dans les rentes : false
PENSION_ALIMENTAIREPension alimentaire

Disponible comme rente à percevoir et à verser.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : true
PENSION_DIVERSEPension diverse

Disponible comme rente à verser.

  • Percevoir en découverte dans les rentes : false
  • Verser en découverte dans les rentes : true
PRESTATION_COMPENSATOIREPrestation compensatoire

Disponible comme rente à percevoir et à verser.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : true
PRE_RETRAITEPréretraite

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_ARTICLE_39Article 39

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_ARTICLE_83Article 83

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_DECESRente décès

Disponible comme rente à percevoir. Existe historiquement dans l'API mais déprécié. Ce code sera ignoré en création et modification. Les rentes de ce type ne sont pas renvoyées dans l'API GET.

  • Percevoir en découverte dans les rentes : false
  • Verser en découverte dans les rentes : false
RENTE_DIVERSERente diverse

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_INVALIDITERente invalidité

Disponible comme rente à percevoir. Existe historiquement dans l'API mais déprécié. Ce code sera ignoré en création et modification. Les rentes de ce type ne sont pas renvoyées dans l'API GET.

  • Percevoir en découverte dans les rentes : false
  • Verser en découverte dans les rentes : false
RENTE_LOI_MADELINLoi Madelin

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_PERRente PER

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_PERCORente PERCO

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_PERECORente PERECO

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RENTE_PERPRente PERP

Disponible comme rente à percevoir.

  • Percevoir en découverte dans les rentes : true
  • Verser en découverte dans les rentes : false
RenteType

Type de rente

CodeLibelleDescription
RENTE_A_RECEVOIRRente à recevoir
RENTE_A_VERSERRente à verser
RenteVersementType

Type de rente

CodeLibelleDescription
TEMPORAIRETemporaire
VIAGEREViagère
RevenuProfessionnelType

Type de revenu professionnel

CodeLibelleDescription
CUMULERevenus professionnels cumulés (SAM). Ne pas utiliser pour alimenter un dossier, uniquement présent dans les resultats de l'API GET dossier sur les reconstitutions de carrière.
DIVERSRevenus divers
DU_CAPITALRevenus du capital (dividendes)
DU_TRAVAILRevenus professionnels
RisquePlacement

Placement risque

Indique le niveau de risque financier d'un placement

CodeLibelleDescription
ELEVEElevé
FAIBLEFaible
MODEREModéré
Sexe

Sexe

Sexe d'une personne. Utilisé dans certains calculs (par exemple tables de mortalité).

CodeLibelleDescription
FEMMEFemme
HOMMEHomme
SituationFamiliale

Situation familiale

CodeLibelleDescription
CELIBATAIRECélibataire
CONCUBIN_UNION_LIBREConcubins en union libre
DIVORCE_SEPAREDivorcé, divorcée
MARIECouple marié
PACSECouple pacsé
VEUFVeuf, veuve
SituationFamilialeUpdateSeparationRedistributionType

Type de redistribution en séparation

CodeLibelleDescription
SUPPRIMER_BIENS_CONJOINTSupprimer les biens du conjoint
TRANSFERER_BIENS_CONJOINTTransférer les biens du conjoint
StockIdentifier

Identifiant de stock

CodeLibelleDescription
BP_DROITS_SOCIAUXDroits sociaux
BP_EXPL_AGRExploitations agricoles
BP_EXPL_INDIVExploitations individuelles
BP_IMMO_PROFImmobiliers professionnels

Déprécié : A priori plus utilisé car en fait si on essaie de saisir un bien pro immobilier, il redirige sur les écrans de placement

StockSubType

Sous-type de stock

CodeLibelleDescription
BIEN_PROFESSIONNEL_ACTIONSActions

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. N'est pas autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_BATIMENTBâtiments

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_CLIENTELEClientèles/Patientèles

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_DIVERSDivers exploitation individuelle

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_DIVERS_EXPLOITATION_AGRICOLEDivers agricole

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_ENTREPOTEntrepôts

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_ENTREPOT_AGRICOLEEntrepôts agricoles

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_ENTREPRISEEntreprise individuelle

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_EXPLOITATION_AGRICOLEExploitation agricole

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_FONDS_COMMERCEFonds de commerce

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_FORETSForêts

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_MURSMurs

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_PARTS_GFAParts de GFA

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_PARTS_SOCIALESParts sociales

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_TERR_AGRI_BAIL_CLASSTerres agricoles, bail classique

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_TERR_AGRI_BAIL_LONG_TERMTerres agricoles, bail à long terme

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_TERR_VITI_BAIL_CLASSTerres viticoles, bail classique

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

BIEN_PROFESSIONNEL_TERR_VITI_BAIL_LONG_TERMTerres viticoles, bail à long terme

Uniquement disponible si le type de stock est ACTIF_PROFESSIONEL_DIVERS. Autorisé en découverte simplifiée.

INTERESSEMENTIntéressement

Uniquement disponible si le type de stock est EPARGNE_PARTICIPATIVE. Autorisé en découverte simplifiée.

PARTICIPATIONParticipation

Uniquement disponible si le type de stock est EPARGNE_PARTICIPATIVE. Autorisé en découverte simplifiée.

PERCOPERCO

Uniquement disponible si le type de stock est EPARGNE_PARTICIPATIVE. Autorisé en découverte simplifiée.

PERECOPERECO

Uniquement disponible si le type de stock est EPARGNE_PARTICIPATIVE. Autorisé en découverte simplifiée.

PLAN_EPARGNE_ENTREPRISEPlan d'Epargne Entreprise

Uniquement disponible si le type de stock est EPARGNE_PARTICIPATIVE. Autorisé en découverte simplifiée.

STOCK_OPTIONStock options

Uniquement disponible si le type de stock est EPARGNE_PARTICIPATIVE. N'est pas autorisé en découverte simplifiée.

StockTauxExonerationIFI

Taux d'exonération IFI

Taux d'exonération IFI d'un bien profesisonnel

CodeLibelleDescription
EXONERATION_100100 %
EXONERATION_7575 %
NON_EXONERATION0 %
StockTauxExonerationTransmission

Taux d'exonération transmission

Taux d'exonération transmission d'un bien profesisonnel

CodeLibelleDescription
EXONERATION_7575 %
NON_EXONERATION0 %
StockType

Type de stock

CodeLibelleDescription
ACTIF_PROFESSIONEL_DIVERSActif professionnel divers
AUTOMOBILESAutomobiles
EFFETS_PERSONNELSAutre bien
EPARGNE_PARTICIPATIVEEpargne salariale
RESIDENCE_PRINCIPALERésidence principale
RESIDENCE_SECONDAIRERésidence secondaire
TypeSupport

Type de support pour des valeurs mobilières

Indique si une valeur mobilière est détenue dans un compte titres ordinaire ou un PEA

CodeLibelleDescription
COMPTE_INSTRUMENTS_FINANCIERSCompte d'instruments financiers
PEAPlan d'épargne en actions (PEA)
TypeVersement

Type de versement

Pour une assurance-vie ou un PEP bancaire, type de versement

CodeLibelleDescription
LIBREVersement libre
REGULIERVersement régulier
UNIQUEPrime unique
UsufruitDuree

Durée de l'usufruit

Durée de l'usufruit d'un stock ou d'un placement

CodeLibelleDescription
TEMPORAIRETemporaire
VIAGERViager

Types

Boolean
CompteTitresApiModel
FicheProfession
Instant
Integer
List
LocalDate
Long
Map
ObjectifPersonnelApiModel
String
UUID
Year
boolean
int
long