---
title: Scenario
slug: oip-next/vn8dsseshd27fj9l3-qwd
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.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   |

## Propriétés

| Nom                        | Type               | Description                                                                                                                                                                                     | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| -------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| annualDeposit              | `Number`           | Versement total calculé à partir du versement volontaire et du versement obligatoire annuels.                                                                                                   |            |                 |             | 2.7.0                     |
| annualMandatoryDeposit     | `Number`           | Versement obligatoire annuel                                                                                                                                                                    |            |                 |             | 2.8.0                     |
| annualVoluntaryDeposit     | `Number`           | Versement volontaire annuel calculé à partir du versement volontaire brut mensuel                                                                                                               |            |                 |             | 2.8.0                     |
| annuityAmount              | `Number`           | Montant de la rente (par salarié). Versement annuel de la retraite.                                                                                                                             |            |                 |             | 2.6.0                     |
| annuityReplacementRate     | `Number`           | Taux de remplacement sur rente (par salarié). Taux de recouvrement par rapport aux revenus perçus avant le départ en retraite.                                                                  |            |                 |             | 2.6.0                     |
| capital                    | `Number`           | Capital.                                                                                                                                                                                        |            |                 |             | 2.5.0                     |
| capitalAtTerm              | `Number`           | 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. |            |                 |             | 2.6.0                     |
| companyAnnuity             | `Number`           | Rente annuelle (par salarié) hors versement volontaire. Il s'agit de la rente calculée uniquement sur les versements de l'entreprise (obligatoires).                                            |            |                 |             | 2.6.0                     |
| employeeId                 | `String`           | Identifiant du salarié.                                                                                                                                                                         |            |                 |             | 2.7.0                     |
| firstYearPremiumCommission | `Number`           | Il s'agit de la commission sur la cotisation de la première année.                                                                                                                              |            |                 |             | 2.10.0                    |
| grossDepositTotal          | `Number`           | Cumul versement brut.                                                                                                                                                                           |            |                 |             | 2.5.0                     |
| lifeAnnuity                | `Number`           | Rente viagère sans reversion.                                                                                                                                                                   |            |                 |             | 2.5.0                     |
| lifeAnnuityWithReversion   | `Number`           | Rente viagère avec reversion.                                                                                                                                                                   |            |                 |             | 2.5.0                     |
| pensionDuration            | `Number`           | Nombre d'années de versement, aussi appelé duration du contrat, durée de versement de la rente.                                                                                                 |            |                 |             | 2.6.0                     |
| replacementRate            | `Number`           | Taux de remplacement total estimé par salarié.                                                                                                                                                  |            |                 |             | 2.7.0                     |
| scenarioType               | `ScenarioTypeEnum` | Type de scénario.                                                                                                                                                                               |            |                 |             | 2.5.0                     |
| totalAnnuity               | `Number`           | Rente annuelle (par salarié) y compris versement volontaire. La rente incluant tous les versements de l'entreprise et des salariés.                                                             |            |                 |             | 2.6.0                     |
| id                         | `String`           | Identifiant de l'entité `Scenario`                                                                                                                                                              |            | X               |             |                           |
| code                       | `String`           | Codification fonctionnelle de l'entité `Scenario`                                                                                                                                               |            |                 |             |                           |
| externalId                 | `String`           | Identifiant de l'entité `Scenario` dans le système client                                                                                                                                       |            |                 |             |                           |
| externalCode               | `String`           | Codification fonctionnelle de l'entité `Scenario` dans le système client                                                                                                                        |            |                 |             |                           |
| scenarioId                 | `String`           | Identifiant public de l'entité `Scenario` dans l'OIP                                                                                                                                            |            |                 |             |                           |
| label                      | `String`           | Information relative au nom de l'entité `Scenario` dans son contexte d'utilisation                                                                                                              |            |                 |             |                           |
| createdAt                  | `Date`             | Date de création de l'entité `Scenario`                                                                                                                                                         |            | X               |             |                           |
| updatedAt                  | `Date`             | Date de modification de l'entité `Scenario`                                                                                                                                                     |            | X               |             |                           |

## Enumérations

### ScenarioTypeEnum

- `CENTRAL`
- `FAVOURABLE`
- `UNFAVOURABLE`

## Enumérations génériques

Aucune enumération générique.

## 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, getScenarioAnnualVoluntaryDeposit, getScenarioAnnuityAmount, getScenarioAnnuityReplacementRate, getScenarioCapital, getScenarioCapitalAtTerm, getScenarioCode, getScenarioCompanyAnnuity, getScenarioEmployeeId, getScenarioExternalCode, getScenarioExternalId, getScenarioFirstYearPremiumCommission, getScenarioGrossDepositTotal, getScenarioId, getScenarioLabel, getScenarioLifeAnnuity, getScenarioLifeAnnuityWithReversion, getScenarioPensionDuration, getScenarioReplacementRate, getScenarioScenarioId, getScenarioScenarioType, getScenarioTotalAnnuity, setScenarioAnnualDeposit, setScenarioAnnualMandatoryDeposit, setScenarioAnnualVoluntaryDeposit, setScenarioAnnuityAmount, setScenarioAnnuityReplacementRate, setScenarioCapital, setScenarioCapitalAtTerm, setScenarioCode, setScenarioCompanyAnnuity, setScenarioEmployeeId, setScenarioExternalCode, setScenarioExternalId, setScenarioFirstYearPremiumCommission, setScenarioGrossDepositTotal, setScenarioLabel, setScenarioLifeAnnuity, setScenarioLifeAnnuityWithReversion, setScenarioPensionDuration, setScenarioReplacementRate, setScenarioScenarioId, setScenarioScenarioType, setScenarioTotalAnnuity } from '@fasstech/oip-core/entities/Scenario';
import { ScenarioTypeEnum } from '@fasstech/oip-core/entities/Scenario/enums';

(async () => {
  let project = await Entities('Project').create();
  let offer = await Entities('Offer').create();
  let hypothesis = await Entities('Hypothesis').create();
  let hypothesisResult = await Entities('HypothesisResult').create();
  const scenario = await Entities('Scenario').create();
  
  setScenarioAnnualDeposit(97, scenario);
  setScenarioAnnualMandatoryDeposit(97, scenario);
  setScenarioAnnualVoluntaryDeposit(97, scenario);
  setScenarioAnnuityAmount(97, scenario);
  setScenarioAnnuityReplacementRate(97, scenario);
  setScenarioCapital(99, scenario);
  setScenarioCapitalAtTerm(99, scenario);
  setScenarioCompanyAnnuity(99, scenario);
  setScenarioEmployeeId('employeeId', scenario);
  setScenarioFirstYearPremiumCommission(102, scenario);
  setScenarioGrossDepositTotal(103, scenario);
  setScenarioLifeAnnuity(108, scenario);
  setScenarioLifeAnnuityWithReversion(108, scenario);
  setScenarioPensionDuration(112, scenario);
  setScenarioReplacementRate(114, scenario);
  setScenarioScenarioType(ScenarioTypeEnum.FAVOURABLE, scenario);
  setScenarioTotalAnnuity(116, scenario);
  setScenarioCode('code', scenario);
  setScenarioExternalId('externalId', scenario);
  setScenarioExternalCode('externalCode', scenario);
  setScenarioScenarioId('scenarioId', scenario);
  setScenarioLabel('label', scenario);
  
  hypothesisResult = await Entities('Scenario').save(hypothesisResult, scenario);
  hypothesis = await Entities('HypothesisResult').save(hypothesis, hypothesisResult);
  offer = await Entities('Hypothesis').save(offer, hypothesis);
  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 hypothesisToTest = await Entities('Hypothesis').get(offerToTest, { filter: ({ id }) => id === getHypothesisId(hypothesis) });
  const hypothesisResultToTest = await Entities('HypothesisResult').get(hypothesisToTest, { filter: ({ id }) => id === getHypothesisResultId(hypothesisResult) });
  const scenarioToTest = await Entities('Scenario').get(hypothesisResultToTest, { filter: ({ id }) => id === getScenarioId(scenario) });
  
  getScenarioAnnualDeposit(scenarioToTest); // 97
  getScenarioAnnualMandatoryDeposit(scenarioToTest); // 97
  getScenarioAnnualVoluntaryDeposit(scenarioToTest); // 97
  getScenarioAnnuityAmount(scenarioToTest); // 97
  getScenarioAnnuityReplacementRate(scenarioToTest); // 97
  getScenarioCapital(scenarioToTest); // 99
  getScenarioCapitalAtTerm(scenarioToTest); // 99
  getScenarioCompanyAnnuity(scenarioToTest); // 99
  getScenarioEmployeeId(scenarioToTest); // 'employeeId'
  getScenarioFirstYearPremiumCommission(scenarioToTest); // 102
  getScenarioGrossDepositTotal(scenarioToTest); // 103
  getScenarioLifeAnnuity(scenarioToTest); // 108
  getScenarioLifeAnnuityWithReversion(scenarioToTest); // 108
  getScenarioPensionDuration(scenarioToTest); // 112
  getScenarioReplacementRate(scenarioToTest); // 114
  getScenarioScenarioType(scenarioToTest); // ScenarioTypeEnum.FAVOURABLE
  getScenarioTotalAnnuity(scenarioToTest); // 116
  getScenarioCode(scenarioToTest); // 'code'
  getScenarioExternalId(scenarioToTest); // 'externalId'
  getScenarioExternalCode(scenarioToTest); // 'externalCode'
  getScenarioScenarioId(scenarioToTest); // 'scenarioId'
  getScenarioLabel(scenarioToTest); // 'label'
})();
```
