---
title: Pension
slug: oip-next/ypc6-5ye93wumwgyyvxqg
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# Pension

## Description

L'entité Pension contient toutes les informations communes liées à de l'épargne individuelle ou collective.

## Relations

### Ascendantes

| Entité  | Propriété |
| ------- | --------- |
| Offer   | pensions  |
| Project | pensions  |

### Descendantes

| Entité              | Propriété            |
| ------------------- | -------------------- |
| GroupPension        | groupPensions        |
| History             | history              |
| IndividualPension   | individualPensions   |
| InvestmentBreakdown | investmentBreakdowns |
| SeverancePay        | severancePays        |

## Propriétés

| Nom                                 | Type                                   | Description                                                                                                                                                      | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ----------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| UnitsOfAccountsExpenseRatio         | `Number`                               | Simulateur capital/rente : frais sur encours UC.                                                                                                                 |            |                 |             | 2.0.0                     |
| adviceFollowed                      | `Boolean`                              | Conseil suivi concernant le mode de gestion financière préconisé.                                                                                                |            |                 |             | 2.0.0                     |
| advisedFinancialManagementMethod    | `PensionFinancialManagementMethodEnum` | Mode de gestion financière préconisé.                                                                                                                            |            |                 |             | 2.0.0                     |
| advisedFinancialManagementOption    | `PensionGuidedManagementOptionEnum`    | Mode préconisé de gestion pilotée.                                                                                                                               |            |                 |             | 2.0.0                     |
| alreadyUsedRetirement               | `Number`                               | Simulateur de retraite fiscale disponible (résultat) : montant déjà utilisé de l'enveloppe déductible.                                                           |            |                 |             | 2.0.0                     |
| arrearsFee                          | `Number`                               | Frais sur arrérages. Il s'agit d'une ponction faite directement sur la rente versée. Ils rémunèrent l'assureur pour sa gestion du capital sur le long terme (%). |            |                 |             | 2.6.0                     |
| availableFiscalAmountOverTheYear    | `Number`                               | Simulateur de retraite fiscale disponible (résultat) : enveloppe fiscale disponible sur l'année.                                                                 |            |                 |             | 2.0.0                     |
| availableUnusedFiscalAmount         | `Number`                               | Simulateur disponible fiscal retraite (résultat) : montant du report de l'enveloppe fiscale disponible pour les années futures.                                  |            |                 |             | 2.0.0                     |
| deathClause                         | `PensionDeathClauseEnum`               | Clause de décès.                                                                                                                                                 |            |                 |             | 2.0.0                     |
| depositFiscalChoice                 | `PensionFiscalChoiceEnum`              | Cadre fiscal du versement.                                                                                                                                       |            |                 |             | 2.0.0                     |
| desiredFinancialManagementMethod    | `PensionFinancialManagementMethodEnum` | Mode de gestion financière souhaité par le client.                                                                                                               |            |                 |             | 2.0.0                     |
| dutyOfAdviceSkipped                 | `Boolean`                              | Devoir de conseil ignoré.                                                                                                                                        |            |                 |             | 2.0.0                     |
| expectedAnnualPensionInvestment     | `Number`                               | Montant du placement envisagé.                                                                                                                                   |            |                 |             | 2.0.0                     |
| feesRateOnDeposit                   | `Number`                               | Simulateur capital/rente : frais sur versement.                                                                                                                  |            |                 |             | 2.0.0                     |
| financialManagementMethod           | `PensionFinancialManagementMethodEnum` | Mode de gestion financière retenu.                                                                                                                               |            |                 |             | 2.0.0                     |
| freeDepositPaymentMethod            | `PensionFreeDepositPaymentMethodEnum`  | Mode de paiement du versement libre.                                                                                                                             |            |                 |             | 2.0.0                     |
| freeDepositValue                    | `Number`                               | Montant du versement libre.                                                                                                                                      |            |                 |             | 2.0.0                     |
| guidedManagementOption              | `PensionGuidedManagementOptionEnum`    | Mode de la gestion pilotée.                                                                                                                                      |            |                 |             | 2.0.0                     |
| isFloorGuaranteeEnabled             | `Boolean`                              | Garantie plancher.                                                                                                                                               |            |                 |             | 2.0.0                     |
| isLifeAnnuityEnabled                | `Boolean`                              | Rente viagère.                                                                                                                                                   |            |                 |             | 2.0.0                     |
| knowledgeLevel                      | `PensionKnowledgeLevelEnum`            | Niveau de connaissance du client en produits d'épargne retraite.                                                                                                 |            |                 |             | 2.0.0                     |
| madelinHealthContribution           | `Number`                               | Simulateur disponible fiscal retraite : montant cotisations Madelin santé.                                                                                       |            |                 |             | 2.0.0                     |
| madelinInsuranceContribution        | `Number`                               | Simulateur disponible fiscal retraite : montant cotisations Madelin prévoyance.                                                                                  |            |                 |             | 2.0.0                     |
| madelinPensionContributionOrPerin   | `Number`                               | Simulateur disponible fiscal retraite : montant versements Madelin retraite ou PER individuel.                                                                   |            |                 |             | 2.0.0                     |
| mainExpectation                     | `PensionMainExpectationEnum`           | Objectif de la souscription au plan épargne retraite.                                                                                                            |            |                 |             | 2.1.1                     |
| perecoOrPercolCompanyContribution   | `Number`                               | Simulateur disponible fiscal retraite : montant abondement entreprise PERECO ou PERCOL.                                                                          |            |                 |             | 2.0.0                     |
| peroOrClause83MandatoryContribution | `Number`                               | Simulateur disponible fiscal retraite : cotisations obligatoires article 83 ou PERO.                                                                             |            |                 |             | 2.0.0                     |
| perp                                | `Number`                               | Plan d'épargne retraite populaire.                                                                                                                               |            |                 |             | 2.4.0                     |
| perpOrPerinDeposit                  | `Number`                               | Simulateur disponible fiscal retraite : versements PERP ou PER individuel.                                                                                       |            |                 |             | 2.0.0                     |
| planAvailabilityOption              | `PensionPlanAvailabilityOptionEnum`    | Besoins en liquidités sur les placements épargne retraite.                                                                                                       |            |                 |             | 2.0.0                     |
| planExpectations                    | `PensionPlanExpectationsEnum`          | Attentes concernant ce plan épargne retraite.                                                                                                                    |            |                 |             | 2.1.1                     |
| saverProfileScore                   | `Number`                               | Scoring profil épargnant.                                                                                                                                        |            |                 |             | 2.0.0                     |
| saverProfileType                    | `PensionSaverProfileTypeEnum`          | Profil épargnant.                                                                                                                                                |            |                 |             | 2.1.1                     |
| scheduledDepositPeriodicity         | `PensionPeriodicityEnum`               | Périodicité du versement programmé.                                                                                                                              |            |                 |             | 2.0.0                     |
| scheduledDepositValue               | `Number`                               | Montant du versement programmé.                                                                                                                                  |            |                 |             | 2.0.0                     |
| taxDeductibleAmount                 | `Number`                               | Simulateur disponible fiscal retraite (résultat) : enveloppe déductible retraite.                                                                                |            |                 |             | 2.0.0                     |
| transferDepositValue                | `Number`                               | Montant du versement du transfert entrant.                                                                                                                       |            |                 |             | 2.0.0                     |
| id                                  | `String`                               | Identifiant de l'entité `Pension`                                                                                                                                |            | X               |             |                           |
| code                                | `String`                               | Codification fonctionnelle de l'entité `Pension`                                                                                                                 |            |                 |             |                           |
| externalId                          | `String`                               | Identifiant de l'entité `Pension` dans le système client                                                                                                         |            |                 |             |                           |
| externalCode                        | `String`                               | Codification fonctionnelle de l'entité `Pension` dans le système client                                                                                          |            |                 |             |                           |
| pensionId                           | `String`                               | Identifiant public de l'entité `Pension` dans l'OIP                                                                                                              |            |                 |             |                           |
| label                               | `String`                               | Information relative au nom de l'entité `Pension` dans son contexte d'utilisation                                                                                |            |                 |             |                           |
| createdAt                           | `Date`                                 | Date de création de l'entité `Pension`                                                                                                                           |            | X               |             |                           |
| updatedAt                           | `Date`                                 | Date de modification de l'entité `Pension`                                                                                                                       |            | X               |             |                           |

## Enumérations

### PensionDeathClauseEnum

- `NOMINATIVE_CLAUSE`
- `STANDARD_CLAUSE`

### PensionFinancialManagementMethodEnum

- `FREE`
- `GUIDED`

### PensionFiscalChoiceEnum

- `PERSONAL`
- `PROFESSIONAL`
- `RENONCIATION`

### PensionFreeDepositPaymentMethodEnum

- `AUTOMATIC_DEBIT`
- `BANK_TRANSFER`
- `CHECK`

### PensionGuidedManagementOptionEnum

- `BALANCE`
- `CAREFUL`
- `DYNAMIC`

### PensionKnowledgeLevelEnum

- `HIGH`
- `LOW`
- `MEDIUM`

### PensionMainExpectationEnum

- `FISCAL_REDUCTION`
- `RETIRED_CAPITAL_PROFIT`

### PensionPeriodicityEnum

- `HALF_YEARLY`
- `MONTHLY`
- `QUARTERLY`
- `YEARLY`

### PensionPlanAvailabilityOptionEnum

- `MAY_NEED`
- `NEED_ANYTIME`
- `NEED_ANYTIME_FOR_PRIMARY_RESIDENCE`
- `NONE`

### PensionPlanExpectationsEnum

- `FISCAL_REDUCTION`
- `LIFE_ANNUITY_PROFIT`
- `MIDDLE_OR_LONG_TERM_INCOME_PROFIT`
- `PARTNER_DEATH_PROTECTION`
- `PRIMARY_RESIDENCE_CAPITAL_PROFIT`
- `RETIRED_CAPITAL_PROFIT`

### PensionSaverProfileTypeEnum

- `BALANCE`
- `CAREFUL`
- `DYNAMIC`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getOfferId } from '@fasstech/oip-core/entities/Offer';
import { getPensionAdviceFollowed, getPensionAdvisedFinancialManagementMethod, getPensionAdvisedFinancialManagementOption, getPensionAlreadyUsedRetirement, getPensionArrearsFee, getPensionAvailableFiscalAmountOverTheYear, getPensionAvailableUnusedFiscalAmount, getPensionCode, getPensionDeathClause, getPensionDepositFiscalChoice, getPensionDesiredFinancialManagementMethod, getPensionDutyOfAdviceSkipped, getPensionExpectedAnnualPensionInvestment, getPensionExternalCode, getPensionExternalId, getPensionFeesRateOnDeposit, getPensionFinancialManagementMethod, getPensionFreeDepositPaymentMethod, getPensionFreeDepositValue, getPensionGuidedManagementOption, getPensionId, getPensionIsFloorGuaranteeEnabled, getPensionIsLifeAnnuityEnabled, getPensionKnowledgeLevel, getPensionLabel, getPensionMadelinHealthContribution, getPensionMadelinInsuranceContribution, getPensionMadelinPensionContributionOrPerin, getPensionMainExpectation, getPensionPensionId, getPensionPerecoOrPercolCompanyContribution, getPensionPeroOrClause83MandatoryContribution, getPensionPerp, getPensionPerpOrPerinDeposit, getPensionPlanAvailabilityOption, getPensionPlanExpectations, getPensionSaverProfileScore, getPensionSaverProfileType, getPensionScheduledDepositPeriodicity, getPensionScheduledDepositValue, getPensionTaxDeductibleAmount, getPensionTransferDepositValue, getPensionUnitsOfAccountsExpenseRatio, setPensionAdviceFollowed, setPensionAdvisedFinancialManagementMethod, setPensionAdvisedFinancialManagementOption, setPensionAlreadyUsedRetirement, setPensionArrearsFee, setPensionAvailableFiscalAmountOverTheYear, setPensionAvailableUnusedFiscalAmount, setPensionCode, setPensionDeathClause, setPensionDepositFiscalChoice, setPensionDesiredFinancialManagementMethod, setPensionDutyOfAdviceSkipped, setPensionExpectedAnnualPensionInvestment, setPensionExternalCode, setPensionExternalId, setPensionFeesRateOnDeposit, setPensionFinancialManagementMethod, setPensionFreeDepositPaymentMethod, setPensionFreeDepositValue, setPensionGuidedManagementOption, setPensionIsFloorGuaranteeEnabled, setPensionIsLifeAnnuityEnabled, setPensionKnowledgeLevel, setPensionLabel, setPensionMadelinHealthContribution, setPensionMadelinInsuranceContribution, setPensionMadelinPensionContributionOrPerin, setPensionMainExpectation, setPensionPensionId, setPensionPerecoOrPercolCompanyContribution, setPensionPeroOrClause83MandatoryContribution, setPensionPerp, setPensionPerpOrPerinDeposit, setPensionPlanAvailabilityOption, setPensionPlanExpectations, setPensionSaverProfileScore, setPensionSaverProfileType, setPensionScheduledDepositPeriodicity, setPensionScheduledDepositValue, setPensionTaxDeductibleAmount, setPensionTransferDepositValue, setPensionUnitsOfAccountsExpenseRatio } from '@fasstech/oip-core/entities/Pension';
import { PensionDeathClauseEnum, PensionFinancialManagementMethodEnum, PensionFiscalChoiceEnum, PensionFreeDepositPaymentMethodEnum, PensionGuidedManagementOptionEnum, PensionKnowledgeLevelEnum, PensionMainExpectationEnum, PensionPeriodicityEnum, PensionPlanAvailabilityOptionEnum, PensionPlanExpectationsEnum, PensionSaverProfileTypeEnum } from '@fasstech/oip-core/entities/Pension/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let offer = await Entities('Offer').create();
  const pension = await Entities('Pension').create();
  
  setPensionUnitsOfAccountsExpenseRatio(85, pension);
  setPensionAdviceFollowed(false, pension);
  setPensionAdvisedFinancialManagementMethod(PensionFinancialManagementMethodEnum.GUIDED, pension);
  setPensionAdvisedFinancialManagementOption(PensionGuidedManagementOptionEnum.CAREFUL, pension);
  setPensionAlreadyUsedRetirement(97, pension);
  setPensionArrearsFee(97, pension);
  setPensionAvailableFiscalAmountOverTheYear(97, pension);
  setPensionAvailableUnusedFiscalAmount(97, pension);
  setPensionDeathClause(PensionDeathClauseEnum.NOMINATIVE_CLAUSE, pension);
  setPensionDepositFiscalChoice(PensionFiscalChoiceEnum.PROFESSIONAL, pension);
  setPensionDesiredFinancialManagementMethod(PensionFinancialManagementMethodEnum.FREE, pension);
  setPensionDutyOfAdviceSkipped(true, pension);
  setPensionExpectedAnnualPensionInvestment(101, pension);
  setPensionFeesRateOnDeposit(102, pension);
  setPensionFinancialManagementMethod(PensionFinancialManagementMethodEnum.FREE, pension);
  setPensionFreeDepositPaymentMethod(PensionFreeDepositPaymentMethodEnum.AUTOMATIC_DEBIT, pension);
  setPensionFreeDepositValue(102, pension);
  setPensionGuidedManagementOption(PensionGuidedManagementOptionEnum.CAREFUL, pension);
  setPensionIsFloorGuaranteeEnabled(false, pension);
  setPensionIsLifeAnnuityEnabled(false, pension);
  setPensionKnowledgeLevel(PensionKnowledgeLevelEnum.MEDIUM, pension);
  setPensionMadelinHealthContribution(109, pension);
  setPensionMadelinInsuranceContribution(109, pension);
  setPensionMadelinPensionContributionOrPerin(109, pension);
  setPensionMainExpectation([PensionMainExpectationEnum.RETIRED_CAPITAL_PROFIT], pension);
  setPensionPerecoOrPercolCompanyContribution(112, pension);
  setPensionPeroOrClause83MandatoryContribution(112, pension);
  setPensionPerp(112, pension);
  setPensionPerpOrPerinDeposit(112, pension);
  setPensionPlanAvailabilityOption(PensionPlanAvailabilityOptionEnum.MAY_NEED, pension);
  setPensionPlanExpectations(PensionPlanExpectationsEnum.PRIMARY_RESIDENCE_CAPITAL_PROFIT, pension);
  setPensionSaverProfileScore(115, pension);
  setPensionSaverProfileType(PensionSaverProfileTypeEnum.CAREFUL, pension);
  setPensionScheduledDepositPeriodicity(PensionPeriodicityEnum.YEARLY, pension);
  setPensionScheduledDepositValue(115, pension);
  setPensionTaxDeductibleAmount(116, pension);
  setPensionTransferDepositValue(116, pension);
  setPensionCode('code', pension);
  setPensionExternalId('externalId', pension);
  setPensionExternalCode('externalCode', pension);
  setPensionPensionId('pensionId', pension);
  setPensionLabel('label', pension);
  
  offer = await Entities('Pension').save(offer, pension);
  project = await Entities('Offer').save(project, offer);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const offerToTest = await Entities('Offer').get(projectToTest, { filter: ({ id }) => id === getOfferId(offer) });
  const pensionToTest = await Entities('Pension').get(offerToTest, { filter: ({ id }) => id === getPensionId(pension) });
  
  getPensionUnitsOfAccountsExpenseRatio(pensionToTest); // 85
  getPensionAdviceFollowed(pensionToTest); // false
  getPensionAdvisedFinancialManagementMethod(pensionToTest); // PensionFinancialManagementMethodEnum.GUIDED
  getPensionAdvisedFinancialManagementOption(pensionToTest); // PensionGuidedManagementOptionEnum.CAREFUL
  getPensionAlreadyUsedRetirement(pensionToTest); // 97
  getPensionArrearsFee(pensionToTest); // 97
  getPensionAvailableFiscalAmountOverTheYear(pensionToTest); // 97
  getPensionAvailableUnusedFiscalAmount(pensionToTest); // 97
  getPensionDeathClause(pensionToTest); // PensionDeathClauseEnum.NOMINATIVE_CLAUSE
  getPensionDepositFiscalChoice(pensionToTest); // PensionFiscalChoiceEnum.PROFESSIONAL
  getPensionDesiredFinancialManagementMethod(pensionToTest); // PensionFinancialManagementMethodEnum.FREE
  getPensionDutyOfAdviceSkipped(pensionToTest); // true
  getPensionExpectedAnnualPensionInvestment(pensionToTest); // 101
  getPensionFeesRateOnDeposit(pensionToTest); // 102
  getPensionFinancialManagementMethod(pensionToTest); // PensionFinancialManagementMethodEnum.FREE
  getPensionFreeDepositPaymentMethod(pensionToTest); // PensionFreeDepositPaymentMethodEnum.AUTOMATIC_DEBIT
  getPensionFreeDepositValue(pensionToTest); // 102
  getPensionGuidedManagementOption(pensionToTest); // PensionGuidedManagementOptionEnum.CAREFUL
  getPensionIsFloorGuaranteeEnabled(pensionToTest); // false
  getPensionIsLifeAnnuityEnabled(pensionToTest); // false
  getPensionKnowledgeLevel(pensionToTest); // PensionKnowledgeLevelEnum.MEDIUM
  getPensionMadelinHealthContribution(pensionToTest); // 109
  getPensionMadelinInsuranceContribution(pensionToTest); // 109
  getPensionMadelinPensionContributionOrPerin(pensionToTest); // 109
  getPensionMainExpectation(pensionToTest); // [PensionMainExpectationEnum.RETIRED_CAPITAL_PROFIT]
  getPensionPerecoOrPercolCompanyContribution(pensionToTest); // 112
  getPensionPeroOrClause83MandatoryContribution(pensionToTest); // 112
  getPensionPerp(pensionToTest); // 112
  getPensionPerpOrPerinDeposit(pensionToTest); // 112
  getPensionPlanAvailabilityOption(pensionToTest); // PensionPlanAvailabilityOptionEnum.MAY_NEED
  getPensionPlanExpectations(pensionToTest); // PensionPlanExpectationsEnum.PRIMARY_RESIDENCE_CAPITAL_PROFIT
  getPensionSaverProfileScore(pensionToTest); // 115
  getPensionSaverProfileType(pensionToTest); // PensionSaverProfileTypeEnum.CAREFUL
  getPensionScheduledDepositPeriodicity(pensionToTest); // PensionPeriodicityEnum.YEARLY
  getPensionScheduledDepositValue(pensionToTest); // 115
  getPensionTaxDeductibleAmount(pensionToTest); // 116
  getPensionTransferDepositValue(pensionToTest); // 116
  getPensionCode(pensionToTest); // 'code'
  getPensionExternalId(pensionToTest); // 'externalId'
  getPensionExternalCode(pensionToTest); // 'externalCode'
  getPensionPensionId(pensionToTest); // 'pensionId'
  getPensionLabel(pensionToTest); // 'label'
})();
```
