Hypothesis
Hypothesis
Description
L'entité Hypothesis contient les données de simulation. Elle sera utilisée notamment lors de contrats d'épargne ou de retraite.
Relations
Ascendantes
Entité | Propriété |
|---|---|
Offer | hypothesis |
Descendantes
Entité | Propriété |
|---|---|
History | history |
HypothesisResult | hypothesisResults |
SeverancePayHypothesis | severancePayHypothesis |
WaiverRequest | waiverRequests |
Liste des propriétés
Nom | Type | Dernière version modifiée | Description | Getter | Setter | Deprecated |
|---|---|---|---|---|---|---|
FeesRateOnCompletionWarranty | Number | 2.9.0 | Il s’agit des frais sur la garantie de bonne fin. | getHypothesisFeesRateOnCompletionWarranty | setHypothesisFeesRateOnCompletionWarranty | - |
annualDeposit | Number | 2.5.0 | Versement Annuel. | getHypothesisAnnualDeposit | setHypothesisAnnualDeposit | - |
annualProgressRate | Number | 2.5.0 | Taux de progression annuel. | getHypothesisAnnualProgressRate | setHypothesisAnnualProgressRate | - |
arrearsFeeRate | Number | 2.7.0 | Taux de frais de gestion sur arrérages. | getHypothesisArrearsFeeRate | setHypothesisArrearsFeeRate | - |
brokerFees | Number[] | 2.6.0 | Part dévolue au commissionnement du courtier (frais sur versement, frais garantie de bonne fin, frais sur encours). | getHypothesisBrokerFees | setHypothesisBrokerFees | - |
brokerFeesType | BrokerFeesTypeEnum | 2.6.0 | Type de commissionnement. | getHypothesisBrokerFeesType | setHypothesisBrokerFeesType | - |
contributionBase | ContributionBaseEnum | 2.6.0 | Base observée soumise au taux, généralement les salaires bruts ou les tranches A, B et C, y compris les 12èmes et les Xèmes mois, ainsi que tous les versements soumis aux charges sociales. | getHypothesisContributionBase | setHypothesisContributionBase | - |
createdAt | Date | | Date de création de l'entité Hypothesis | getHypothesisCreatedAt | Lecture seule | - |
createdBy | String | | Utilisateur à l'origine de la création de l'entité Hypothesis | getHypothesisCreatedBy | Lecture seule | - |
effectDate | Date | 2.7.0 | Date d’effet. | getHypothesisEffectDate | setHypothesisEffectDate | - |
eurosExpenseRatio | Number | 2.5.0 | Frais encours euros. | getHypothesisEurosExpenseRatio | setHypothesisEurosExpenseRatio | - |
feeRate | Number[] | 2.6.0 | Taux de cotisation (en %). | getHypothesisFeeRate | setHypothesisFeeRate | - |
feesRateInEurosExpenseRatio | Number | 2.7.0 | Taux de frais sur encours en euros. | getHypothesisFeesRateInEurosExpenseRatio | setHypothesisFeesRateInEurosExpenseRatio | - |
feesRateOnDeposit | Number | 2.5.0 | Frais sur versement. | getHypothesisFeesRateOnDeposit | setHypothesisFeesRateOnDeposit | - |
feesRateUnitsOfAccountsExpenseRatio | Number | 2.7.0 | Taux de frais sur encours en UC. | getHypothesisFeesRateUnitsOfAccountsExpenseRatio | setHypothesisFeesRateUnitsOfAccountsExpenseRatio | - |
fixedRateInEurosExpenseRatio | Number | 2.7.0 | Taux incompressible assureur sur l’encours en euros. | getHypothesisFixedRateInEurosExpenseRatio | setHypothesisFixedRateInEurosExpenseRatio | - |
fixedRateOnArrearsFee | Number | 2.7.0 | Taux incompressible assureur sur arrérage. | getHypothesisFixedRateOnArrearsFee | setHypothesisFixedRateOnArrearsFee | - |
fixedRateOnCompletionWarrantyFee | Number | 2.7.0 | Taux incompressible assureur sur l’encours sur la garantie bonne fin. | getHypothesisFixedRateOnCompletionWarrantyFee | setHypothesisFixedRateOnCompletionWarrantyFee | - |
fixedRateOnMandatoryDeposit | Number | 2.7.0 | Taux incompressible assureur sur versements obligatoires. | getHypothesisFixedRateOnMandatoryDeposit | setHypothesisFixedRateOnMandatoryDeposit | - |
fixedRateOnUnitsOfAccountsExpenseRatio | Number | 2.7.0 | Taux incompressible assureur sur l’encours en UC. | getHypothesisFixedRateOnUnitsOfAccountsExpenseRatio | setHypothesisFixedRateOnUnitsOfAccountsExpenseRatio | - |
freeDepositValue | Number | 2.10.0 | Il s’agit du versement initial. | getHypothesisFreeDepositValue | setHypothesisFreeDepositValue | - |
id | String | | Identifiant unique de l'entité Hypothesis | getHypothesisId | Lecture seule | - |
label | String | 2.5.0 | Libellé de la simulation. | getHypothesisLabel | setHypothesisLabel | - |
netRate | Number | 2.6.0 | Rendement net affecté au capital (en %). | getHypothesisNetRate | setHypothesisNetRate | - |
netRateType | NetRateTypeEnum | 2.6.0 | Rendement réellement affecté au capital, excluant les frais de gestion sur encours. Par exemple, un rendement brut de 4 %, dont 0,80 % sont des frais de gestion, aboutissant à un rendement net de 3,2 %. | getHypothesisNetRateType | setHypothesisNetRateType | - |
optionalDeathCoverages | HypothesisOptionalDeathCoveragesEnum | 2.7.0 | Couverture décès optionnelle. | getHypothesisOptionalDeathCoverages | setHypothesisOptionalDeathCoverages | - |
periodicity | PeriodicityEnum | 2.5.0 | Périodicité. | getHypothesisPeriodicity | setHypothesisPeriodicity | - |
rateType | RateTypeEnum | 2.6.0 | Type de taux. | getHypothesisRateType | setHypothesisRateType | - |
retirementAge | Number | 2.5.0 | Age de départ à la retraite. | getHypothesisRetirementAge | setHypothesisRetirementAge | - |
transferDepositValue | Number | 2.5.0 | Montant transfert entrant. | getHypothesisTransferDepositValue | setHypothesisTransferDepositValue | - |
type | HypothesisTypeEnum | 2.8.0 | Il s’agit du type de simulation | getHypothesisType | setHypothesisType | - |
unitsOfAccountsExpenseRatio | Number | 2.5.0 | Frais encours UC. | getHypothesisUnitsOfAccountsExpenseRatio | setHypothesisUnitsOfAccountsExpenseRatio | - |
updatedAt | Date | | Date de modification de l'entité Hypothesis | getHypothesisUpdatedAt | Lecture seule | - |
updatedBy | String | | Utilisateur à l'origine de la modification de l'entité Hypothesis | getHypothesisUpdatedBy | Lecture seule | - |
Enums
BrokerFeesTypeEnum
- BrokerFeesTypeEnum.GLOBAL
- BrokerFeesTypeEnum.DISTRIBUTED
ContributionBaseEnum
- ContributionBaseEnum.SALARY
- ContributionBaseEnum.PASS
HypothesisOptionalDeathCoveragesEnum
- HypothesisOptionalDeathCoveragesEnum.COMPLETION_WARRANTY
- HypothesisOptionalDeathCoveragesEnum.MINIMUM_WARRANTY
- HypothesisOptionalDeathCoveragesEnum.WAIVER_WARRANTY
- HypothesisOptionalDeathCoveragesEnum.NONE
HypothesisTypeEnum
- HypothesisTypeEnum.SOCIAL_LIABILITY_CALCULATION
- HypothesisTypeEnum.FUNDING_PLAN_CALCULATION
NetRateTypeEnum
- NetRateTypeEnum.NONE
- NetRateTypeEnum.LOW
- NetRateTypeEnum.AVERAGE
- NetRateTypeEnum.HIGH
- NetRateTypeEnum.CUSTOM
PeriodicityEnum
- PeriodicityEnum.HALF_YEARLY
- PeriodicityEnum.MONTHLY
- PeriodicityEnum.QUARTERLY
- PeriodicityEnum.YEARLY
RateTypeEnum
- RateTypeEnum.GLOBAL
- RateTypeEnum.DISTRIBUTED
Exemple
import { Entities } from '@fasstech/oip-core';
import { getHypothesisAnnualDeposit, getHypothesisAnnualProgressRate, getHypothesisArrearsFeeRate, getHypothesisBrokerFees, getHypothesisBrokerFeesType, getHypothesisContributionBase, getHypothesisEffectDate, getHypothesisEurosExpenseRatio, getHypothesisFeeRate, getHypothesisFeesRateInEurosExpenseRatio, getHypothesisFeesRateOnCompletionWarranty, getHypothesisFeesRateOnDeposit, getHypothesisFeesRateUnitsOfAccountsExpenseRatio, getHypothesisFixedRateInEurosExpenseRatio, getHypothesisFixedRateOnArrearsFee, getHypothesisFixedRateOnCompletionWarrantyFee, getHypothesisFixedRateOnMandatoryDeposit, getHypothesisFixedRateOnUnitsOfAccountsExpenseRatio, getHypothesisFreeDepositValue, getHypothesisLabel, getHypothesisNetRate, getHypothesisNetRateType, getHypothesisOptionalDeathCoverages, getHypothesisPeriodicity, getHypothesisRateType, getHypothesisRetirementAge, getHypothesisTransferDepositValue, getHypothesisType, getHypothesisUnitsOfAccountsExpenseRatio, gethypothesisId, setHypothesisAnnualDeposit, setHypothesisAnnualProgressRate, setHypothesisArrearsFeeRate, setHypothesisBrokerFees, setHypothesisBrokerFeesType, setHypothesisContributionBase, setHypothesisEffectDate, setHypothesisEurosExpenseRatio, setHypothesisFeeRate, setHypothesisFeesRateInEurosExpenseRatio, setHypothesisFeesRateOnCompletionWarranty, setHypothesisFeesRateOnDeposit, setHypothesisFeesRateUnitsOfAccountsExpenseRatio, setHypothesisFixedRateInEurosExpenseRatio, setHypothesisFixedRateOnArrearsFee, setHypothesisFixedRateOnCompletionWarrantyFee, setHypothesisFixedRateOnMandatoryDeposit, setHypothesisFixedRateOnUnitsOfAccountsExpenseRatio, setHypothesisFreeDepositValue, setHypothesisLabel, setHypothesisNetRate, setHypothesisNetRateType, setHypothesisOptionalDeathCoverages, setHypothesisPeriodicity, setHypothesisRateType, setHypothesisRetirementAge, setHypothesisTransferDepositValue, setHypothesisType, setHypothesisUnitsOfAccountsExpenseRatio } from '@fasstech/oip-core/entities/hypothesis';
import { PeriodicityEnum, RateTypeEnum, NetRateTypeEnum, BrokerFeesTypeEnum, ContributionBaseEnum, HypothesisOptionalDeathCoveragesEnum, HypothesisTypeEnum } from '@fasstech/oip-core/entities/hypothesis/enums';
import { getOfferId } from '@fasstech/oip-core/entities/offer';
import { getProjectId } from '@fasstech/oip-core/entities/project';
(async () => {
let ProjectEntity = await Entities('Project').get({ id: projectId });
let OfferEntity = await Entities('Offer').create();
const HypothesisEntity = await Entities('Hypothesis').create();
setHypothesisFeesRateOnCompletionWarranty(70, HypothesisEntity);
setHypothesisAnnualDeposit(97, HypothesisEntity);
setHypothesisAnnualProgressRate(97, HypothesisEntity);
setHypothesisArrearsFeeRate(97, HypothesisEntity);
setHypothesisBrokerFees([98], HypothesisEntity);
setHypothesisBrokerFeesType(BrokerFeesTypeEnum.DISTRIBUTED, HypothesisEntity);
setHypothesisContributionBase(ContributionBaseEnum.SALARY, HypothesisEntity);
setHypothesisEffectDate(new Date('2017-01-01'), HypothesisEntity);
setHypothesisEurosExpenseRatio(101, HypothesisEntity);
setHypothesisFeeRate([102], HypothesisEntity);
setHypothesisFeesRateInEurosExpenseRatio(102, HypothesisEntity);
setHypothesisFeesRateOnDeposit(102, HypothesisEntity);
setHypothesisFeesRateUnitsOfAccountsExpenseRatio(102, HypothesisEntity);
setHypothesisFixedRateInEurosExpenseRatio(102, HypothesisEntity);
setHypothesisFixedRateOnArrearsFee(102, HypothesisEntity);
setHypothesisFixedRateOnCompletionWarrantyFee(102, HypothesisEntity);
setHypothesisFixedRateOnMandatoryDeposit(102, HypothesisEntity);
setHypothesisFixedRateOnUnitsOfAccountsExpenseRatio(102, HypothesisEntity);
setHypothesisFreeDepositValue(102, HypothesisEntity);
setHypothesisLabel('label', HypothesisEntity);
setHypothesisNetRate(110, HypothesisEntity);
setHypothesisNetRateType(NetRateTypeEnum.AVERAGE, HypothesisEntity);
setHypothesisOptionalDeathCoverages([HypothesisOptionalDeathCoveragesEnum.WAIVER_WARRANTY], HypothesisEntity);
setHypothesisPeriodicity(PeriodicityEnum.HALF_YEARLY, HypothesisEntity);
setHypothesisRateType(RateTypeEnum.DISTRIBUTED, HypothesisEntity);
setHypothesisRetirementAge(114, HypothesisEntity);
setHypothesisTransferDepositValue(116, HypothesisEntity);
setHypothesisType(HypothesisTypeEnum.FUNDING_PLAN_CALCULATION, HypothesisEntity);
setHypothesisUnitsOfAccountsExpenseRatio(117, HypothesisEntity);
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));
getHypothesisFeesRateOnCompletionWarranty(HypothesisEntityToTest); // 70
getHypothesisAnnualDeposit(HypothesisEntityToTest); // 97
getHypothesisAnnualProgressRate(HypothesisEntityToTest); // 97
getHypothesisArrearsFeeRate(HypothesisEntityToTest); // 97
getHypothesisBrokerFees(HypothesisEntityToTest); // [98]
getHypothesisBrokerFeesType(HypothesisEntityToTest); // BrokerFeesTypeEnum.DISTRIBUTED
getHypothesisContributionBase(HypothesisEntityToTest); // ContributionBaseEnum.SALARY
getHypothesisEffectDate(HypothesisEntityToTest); // new Date('2017-01-01')
getHypothesisEurosExpenseRatio(HypothesisEntityToTest); // 101
getHypothesisFeeRate(HypothesisEntityToTest); // [102]
getHypothesisFeesRateInEurosExpenseRatio(HypothesisEntityToTest); // 102
getHypothesisFeesRateOnDeposit(HypothesisEntityToTest); // 102
getHypothesisFeesRateUnitsOfAccountsExpenseRatio(HypothesisEntityToTest); // 102
getHypothesisFixedRateInEurosExpenseRatio(HypothesisEntityToTest); // 102
getHypothesisFixedRateOnArrearsFee(HypothesisEntityToTest); // 102
getHypothesisFixedRateOnCompletionWarrantyFee(HypothesisEntityToTest); // 102
getHypothesisFixedRateOnMandatoryDeposit(HypothesisEntityToTest); // 102
getHypothesisFixedRateOnUnitsOfAccountsExpenseRatio(HypothesisEntityToTest); // 102
getHypothesisFreeDepositValue(HypothesisEntityToTest); // 102
getHypothesisLabel(HypothesisEntityToTest); // 'label'
getHypothesisNetRate(HypothesisEntityToTest); // 110
getHypothesisNetRateType(HypothesisEntityToTest); // NetRateTypeEnum.AVERAGE
getHypothesisOptionalDeathCoverages(HypothesisEntityToTest); // [HypothesisOptionalDeathCoveragesEnum.WAIVER_WARRANTY]
getHypothesisPeriodicity(HypothesisEntityToTest); // PeriodicityEnum.HALF_YEARLY
getHypothesisRateType(HypothesisEntityToTest); // RateTypeEnum.DISTRIBUTED
getHypothesisRetirementAge(HypothesisEntityToTest); // 114
getHypothesisTransferDepositValue(HypothesisEntityToTest); // 116
getHypothesisType(HypothesisEntityToTest); // HypothesisTypeEnum.FUNDING_PLAN_CALCULATION
getHypothesisUnitsOfAccountsExpenseRatio(HypothesisEntityToTest); // 117
})();