---
title: Scenario
slug: oip-next/gdxxk7lltb0omwgb5fk
createdAt: 2024-02-21T13:26:11.000Z
---

# Scenario

## Description

L'entité Scenario contient un scénario issu de la simulation d'un produit d'épargne ou de retraite.

## Relations

### Ascendantes

| Entité           | Propriété |
| ---------------- | --------- |
| HypothesisResult | scenarios |

### Descendantes

| Entité  | Propriété |
| ------- | --------- |
| History | history   |

## Liste des propriétés

| Nom                        | Type               | Dernière version modifiée | Description                                                                                                                                                                                     | Getter                                | Setter                                | Deprecated                      |
| -------------------------- | ------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------- |
| annualDeposit              | `Number`           | 2.7.0                     | Versement total calculé à partir du versement volontaire et du versement obligatoire annuels.                                                                                                   | getScenarioAnnualDeposit              | setScenarioAnnualDeposit              | -                               |
| annualMandatoryDeposit     | `Number`           | 2.8.0                     | Versement obligatoire annuel                                                                                                                                                                    | getScenarioAnnualMandatoryDeposit     | setScenarioAnnualMandatoryDeposit     | -                               |
| annualPayment              | `Number`           | 2.7.0                     | Versement annuel (par salarié) ou prime (effectuée sur une période de 12 mois).                                                                                                                 | getScenarioAnnualPayment              | setScenarioAnnualPayment              | Est remplacé par annualDeposit. |
| annualVoluntaryDeposit     | `Number`           | 2.8.0                     | Versement volontaire annuel calculé à partir du versement volontaire brut mensuel                                                                                                               | getScenarioAnnualVoluntaryDeposit     | setScenarioAnnualVoluntaryDeposit     | -                               |
| annuityAmount              | `Number`           | 2.6.0                     | Montant de la rente (par salarié). Versement annuel de la retraite.                                                                                                                             | getScenarioAnnuityAmount              | setScenarioAnnuityAmount              | -                               |
| annuityReplacementRate     | `Number`           | 2.6.0                     | Taux de remplacement sur rente (par salarié). Taux de recouvrement par rapport aux revenus perçus avant le départ en retraite.                                                                  | getScenarioAnnuityReplacementRate     | setScenarioAnnuityReplacementRate     | -                               |
| capital                    | `Number`           | 2.5.0                     | Capital.                                                                                                                                                                                        | getScenarioCapital                    | setScenarioCapital                    | -                               |
| capitalAtTerm              | `Number`           | 2.6.0                     | Capital rente (par salarié), également appelé capital à échéance. Aussi appelé provision mathématique, c'est le total des sommes atteint en fin de contrat et servant au versement de la rente. | getScenarioCapitalAtTerm              | setScenarioCapitalAtTerm              | -                               |
| companyAnnuity             | `Number`           | 2.6.0                     | Rente annuelle (par salarié) hors versement volontaire. Il s'agit de la rente calculée uniquement sur les versements de l'entreprise (obligatoires).                                            | getScenarioCompanyAnnuity             | setScenarioCompanyAnnuity             | -                               |
| createdAt                  | `Date`             |                           | Date de création de l'entité `Scenario`                                                                                                                                                         | getScenarioCreatedAt                  | Lecture seule                         | -                               |
| createdBy                  | `String`           |                           | Utilisateur à l'origine de la création de l'entité `Scenario`                                                                                                                                   | getScenarioCreatedBy                  | Lecture seule                         | -                               |
| employeeId                 | `String`           | 2.7.0                     | Identifiant du salarié.                                                                                                                                                                         | getScenarioEmployeeId                 | setScenarioEmployeeId                 | -                               |
| firstYearPremiumCommission | `Number`           | 2.10.0                    | Il s'agit de la commission sur la cotisation de la première année.                                                                                                                              | getScenarioFirstYearPremiumCommission | setScenarioFirstYearPremiumCommission | -                               |
| grossDepositTotal          | `Number`           | 2.5.0                     | Cumul versement brut.                                                                                                                                                                           | getScenarioGrossDepositTotal          | setScenarioGrossDepositTotal          | -                               |
| id                         | `String`           |                           | Identifiant unique de l'entité `Scenario`                                                                                                                                                       | getScenarioId                         | Lecture seule                         | -                               |
| lifeAnnuity                | `Number`           | 2.5.0                     | Rente viagère sans reversion.                                                                                                                                                                   | getScenarioLifeAnnuity                | setScenarioLifeAnnuity                | -                               |
| lifeAnnuityWithReversion   | `Number`           | 2.5.0                     | Rente viagère avec reversion.                                                                                                                                                                   | getScenarioLifeAnnuityWithReversion   | setScenarioLifeAnnuityWithReversion   | -                               |
| pensionDuration            | `Number`           | 2.6.0                     | Nombre d’années de versement, aussi appelé duration du contrat, durée de versement de la rente.                                                                                                 | getScenarioPensionDuration            | setScenarioPensionDuration            | -                               |
| replacementRate            | `Number`           | 2.7.0                     | Taux de remplacement total estimé par salarié.                                                                                                                                                  | getScenarioReplacementRate            | setScenarioReplacementRate            | -                               |
| scenarioType               | `ScenarioTypeEnum` | 2.5.0                     | Type de scénario.                                                                                                                                                                               | getScenarioScenarioType               | setScenarioScenarioType               | -                               |
| totalAnnuity               | `Number`           | 2.6.0                     | Rente annuelle (par salarié) y compris versement volontaire. La rente incluant tous les versements de l'entreprise et des salariés.                                                             | getScenarioTotalAnnuity               | setScenarioTotalAnnuity               | -                               |
| updatedAt                  | `Date`             |                           | Date de modification de l'entité `Scenario`                                                                                                                                                     | getScenarioUpdatedAt                  | Lecture seule                         | -                               |
| updatedBy                  | `String`           |                           | Utilisateur à l'origine de la modification de l'entité `Scenario`                                                                                                                               | getScenarioUpdatedBy                  | Lecture seule                         | -                               |

## Enums

### ScenarioTypeEnum

- `ScenarioTypeEnum.CENTRAL`
- `ScenarioTypeEnum.FAVOURABLE`
- `ScenarioTypeEnum.UNFAVOURABLE`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getHypothesisId } from '@fasstech/oip-core/entities/hypothesis';
import { getHypothesisResultId } from '@fasstech/oip-core/entities/hypothesisResult';
import { getOfferId } from '@fasstech/oip-core/entities/offer';
import { getProjectId } from '@fasstech/oip-core/entities/project';
import { getScenarioAnnualDeposit, getScenarioAnnualMandatoryDeposit, getScenarioAnnualPayment, getScenarioAnnualVoluntaryDeposit, getScenarioAnnuityAmount, getScenarioAnnuityReplacementRate, getScenarioCapital, getScenarioCapitalAtTerm, getScenarioCompanyAnnuity, getScenarioEmployeeId, getScenarioFirstYearPremiumCommission, getScenarioGrossDepositTotal, getScenarioLifeAnnuity, getScenarioLifeAnnuityWithReversion, getScenarioPensionDuration, getScenarioReplacementRate, getScenarioScenarioType, getScenarioTotalAnnuity, getscenarioId, setScenarioAnnualDeposit, setScenarioAnnualMandatoryDeposit, setScenarioAnnualPayment, setScenarioAnnualVoluntaryDeposit, setScenarioAnnuityAmount, setScenarioAnnuityReplacementRate, setScenarioCapital, setScenarioCapitalAtTerm, setScenarioCompanyAnnuity, setScenarioEmployeeId, setScenarioFirstYearPremiumCommission, setScenarioGrossDepositTotal, setScenarioLifeAnnuity, setScenarioLifeAnnuityWithReversion, setScenarioPensionDuration, setScenarioReplacementRate, setScenarioScenarioType, setScenarioTotalAnnuity } from '@fasstech/oip-core/entities/scenario';
import { ScenarioTypeEnum } from '@fasstech/oip-core/entities/scenario/enums';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  let OfferEntity = await Entities('Offer').create();
  let HypothesisEntity = await Entities('Hypothesis').create();
  let HypothesisResultEntity = await Entities('HypothesisResult').create();
  const ScenarioEntity = await Entities('Scenario').create();
  
  setScenarioAnnualDeposit(97, ScenarioEntity);
  setScenarioAnnualMandatoryDeposit(97, ScenarioEntity);
  setScenarioAnnualPayment(97, ScenarioEntity);
  setScenarioAnnualVoluntaryDeposit(97, ScenarioEntity);
  setScenarioAnnuityAmount(97, ScenarioEntity);
  setScenarioAnnuityReplacementRate(97, ScenarioEntity);
  setScenarioCapital(99, ScenarioEntity);
  setScenarioCapitalAtTerm(99, ScenarioEntity);
  setScenarioCompanyAnnuity(99, ScenarioEntity);
  setScenarioEmployeeId('employeeId', ScenarioEntity);
  setScenarioFirstYearPremiumCommission(102, ScenarioEntity);
  setScenarioGrossDepositTotal(103, ScenarioEntity);
  setScenarioLifeAnnuity(108, ScenarioEntity);
  setScenarioLifeAnnuityWithReversion(108, ScenarioEntity);
  setScenarioPensionDuration(112, ScenarioEntity);
  setScenarioReplacementRate(114, ScenarioEntity);
  setScenarioScenarioType(ScenarioTypeEnum.FAVOURABLE, ScenarioEntity);
  setScenarioTotalAnnuity(116, ScenarioEntity);
  
  HypothesisResultEntity = await Entities('Scenario').save(HypothesisResultEntity, ScenarioEntity);
  HypothesisEntity = await Entities('HypothesisResult').save(HypothesisEntity, HypothesisResultEntity);
  OfferEntity = await Entities('Hypothesis').save(OfferEntity, HypothesisEntity);
  ProjectEntity = await Entities('Offer').save(ProjectEntity, OfferEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const OfferEntityToTest = await Entities('Offer').get(ProjectEntityToTest, getOfferId(OfferEntity));
  const HypothesisEntityToTest = await Entities('Hypothesis').get(OfferEntityToTest, getHypothesisId(HypothesisEntity));
  const HypothesisResultEntityToTest = await Entities('HypothesisResult').get(HypothesisEntityToTest, getHypothesisResultId(HypothesisResultEntity));
  const ScenarioEntityToTest = await Entities('Scenario').get(HypothesisResultEntityToTest, getScenarioId(ScenarioEntity));
  
  getScenarioAnnualDeposit(ScenarioEntityToTest); // 97
  getScenarioAnnualMandatoryDeposit(ScenarioEntityToTest); // 97
  getScenarioAnnualPayment(ScenarioEntityToTest); // 97
  getScenarioAnnualVoluntaryDeposit(ScenarioEntityToTest); // 97
  getScenarioAnnuityAmount(ScenarioEntityToTest); // 97
  getScenarioAnnuityReplacementRate(ScenarioEntityToTest); // 97
  getScenarioCapital(ScenarioEntityToTest); // 99
  getScenarioCapitalAtTerm(ScenarioEntityToTest); // 99
  getScenarioCompanyAnnuity(ScenarioEntityToTest); // 99
  getScenarioEmployeeId(ScenarioEntityToTest); // 'employeeId'
  getScenarioFirstYearPremiumCommission(ScenarioEntityToTest); // 102
  getScenarioGrossDepositTotal(ScenarioEntityToTest); // 103
  getScenarioLifeAnnuity(ScenarioEntityToTest); // 108
  getScenarioLifeAnnuityWithReversion(ScenarioEntityToTest); // 108
  getScenarioPensionDuration(ScenarioEntityToTest); // 112
  getScenarioReplacementRate(ScenarioEntityToTest); // 114
  getScenarioScenarioType(ScenarioEntityToTest); // ScenarioTypeEnum.FAVOURABLE
  getScenarioTotalAnnuity(ScenarioEntityToTest); // 116
})();
```
