Scenario
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
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'
})();