---
title: HypothesisResult
slug: oip-next/8gjdipzucdgltbnja4bt
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# HypothesisResult

## Description

L'entité HypothesisResult contient les résultats de simulation effectuée pour un produit épargne ou retraite.

## Relations

### Ascendantes

| Entité     | Propriété         |
| ---------- | ----------------- |
| Hypothesis | hypothesisResults |

### Descendantes

| Entité     | Propriété   |
| ---------- | ----------- |
| Commission | commissions |
| History    | history     |
| Scenario   | scenarios   |

## Propriétés

| Nom                          | Type     | Description                                                                                                | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ---------------------------- | -------- | ---------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| annualMandatoryDeposit       | `Number` | Versement obligatoire (VO) annuel total calculé à partir des VO de l'ensemble des salariés.                |            |                 |             | 2.7.0                     |
| annualOptionalDeposit        | `Number` | Versement volontaire (VV) annuel total calculé à partir des VV de l'ensemble des salariés du client.       |            |                 |             | 2.7.0                     |
| companyBudget                | `Number` | Budget de l'entreprise                                                                                     |            |                 |             | 2.7.0                     |
| companyTaxTheoreticalGain    | `Number` | Gain d'impôt sur la société théorique.                                                                     |            |                 |             | 2.7.0                     |
| firstYearCompanyBudget       | `Number` | Budget de l'entreprise pour la première année (en supposant que la première année est complète).           |            |                 |             | 2.7.0                     |
| firstYearFiscalSaving        | `Number` | Economie fiscale sur la première année.                                                                    |            |                 |             | 2.5.0                     |
| grossDeposit                 | `Number` | Versements brutes.                                                                                         |            |                 |             | 2.7.0                     |
| grossDepositWithSocialCharge | `Number` | Versement des Cotisations brutes. Versement incluant les taxes telles que les 16% de prélèvements sociaux. |            |                 |             | 2.7.0                     |
| socialContributionAmount     | `Number` | Montant des cotisations sociales.                                                                          |            |                 |             | 2.7.0                     |
| totalDeposit                 | `Number` | Cotisations totales. Versement intégral fait par le salarié et l'entreprise.                               |            |                 |             | 2.6.0                     |
| id                           | `String` | Identifiant de l'entité `HypothesisResult`                                                                 |            | X               |             |                           |
| code                         | `String` | Codification fonctionnelle de l'entité `HypothesisResult`                                                  |            |                 |             |                           |
| externalId                   | `String` | Identifiant de l'entité `HypothesisResult` dans le système client                                          |            |                 |             |                           |
| externalCode                 | `String` | Codification fonctionnelle de l'entité `HypothesisResult` dans le système client                           |            |                 |             |                           |
| hypothesisResultId           | `String` | Identifiant public de l'entité `HypothesisResult` dans l'OIP                                               |            |                 |             |                           |
| label                        | `String` | Information relative au nom de l'entité `HypothesisResult` dans son contexte d'utilisation                 |            |                 |             |                           |
| createdAt                    | `Date`   | Date de création de l'entité `HypothesisResult`                                                            |            | X               |             |                           |
| updatedAt                    | `Date`   | Date de modification de l'entité `HypothesisResult`                                                        |            | X               |             |                           |

## Enumérations

Aucune enumération.

## 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 { getHypothesisResultAnnualMandatoryDeposit, getHypothesisResultAnnualOptionalDeposit, getHypothesisResultCode, getHypothesisResultCompanyBudget, getHypothesisResultCompanyTaxTheoreticalGain, getHypothesisResultExternalCode, getHypothesisResultExternalId, getHypothesisResultFirstYearCompanyBudget, getHypothesisResultFirstYearFiscalSaving, getHypothesisResultGrossDeposit, getHypothesisResultGrossDepositWithSocialCharge, getHypothesisResultHypothesisResultId, getHypothesisResultId, getHypothesisResultLabel, getHypothesisResultSocialContributionAmount, getHypothesisResultTotalDeposit, setHypothesisResultAnnualMandatoryDeposit, setHypothesisResultAnnualOptionalDeposit, setHypothesisResultCode, setHypothesisResultCompanyBudget, setHypothesisResultCompanyTaxTheoreticalGain, setHypothesisResultExternalCode, setHypothesisResultExternalId, setHypothesisResultFirstYearCompanyBudget, setHypothesisResultFirstYearFiscalSaving, setHypothesisResultGrossDeposit, setHypothesisResultGrossDepositWithSocialCharge, setHypothesisResultHypothesisResultId, setHypothesisResultLabel, setHypothesisResultSocialContributionAmount, setHypothesisResultTotalDeposit } from '@fasstech/oip-core/entities/HypothesisResult';
import { getOfferId } from '@fasstech/oip-core/entities/Offer';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let offer = await Entities('Offer').create();
  let hypothesis = await Entities('Hypothesis').create();
  const hypothesisResult = await Entities('HypothesisResult').create();
  
  setHypothesisResultAnnualMandatoryDeposit(97, hypothesisResult);
  setHypothesisResultAnnualOptionalDeposit(97, hypothesisResult);
  setHypothesisResultCompanyBudget(99, hypothesisResult);
  setHypothesisResultCompanyTaxTheoreticalGain(99, hypothesisResult);
  setHypothesisResultFirstYearCompanyBudget(102, hypothesisResult);
  setHypothesisResultFirstYearFiscalSaving(102, hypothesisResult);
  setHypothesisResultGrossDeposit(103, hypothesisResult);
  setHypothesisResultGrossDepositWithSocialCharge(103, hypothesisResult);
  setHypothesisResultSocialContributionAmount(115, hypothesisResult);
  setHypothesisResultTotalDeposit(116, hypothesisResult);
  setHypothesisResultCode('code', hypothesisResult);
  setHypothesisResultExternalId('externalId', hypothesisResult);
  setHypothesisResultExternalCode('externalCode', hypothesisResult);
  setHypothesisResultHypothesisResultId('hypothesisResultId', hypothesisResult);
  setHypothesisResultLabel('label', hypothesisResult);
  
  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) });
  
  getHypothesisResultAnnualMandatoryDeposit(hypothesisResultToTest); // 97
  getHypothesisResultAnnualOptionalDeposit(hypothesisResultToTest); // 97
  getHypothesisResultCompanyBudget(hypothesisResultToTest); // 99
  getHypothesisResultCompanyTaxTheoreticalGain(hypothesisResultToTest); // 99
  getHypothesisResultFirstYearCompanyBudget(hypothesisResultToTest); // 102
  getHypothesisResultFirstYearFiscalSaving(hypothesisResultToTest); // 102
  getHypothesisResultGrossDeposit(hypothesisResultToTest); // 103
  getHypothesisResultGrossDepositWithSocialCharge(hypothesisResultToTest); // 103
  getHypothesisResultSocialContributionAmount(hypothesisResultToTest); // 115
  getHypothesisResultTotalDeposit(hypothesisResultToTest); // 116
  getHypothesisResultCode(hypothesisResultToTest); // 'code'
  getHypothesisResultExternalId(hypothesisResultToTest); // 'externalId'
  getHypothesisResultExternalCode(hypothesisResultToTest); // 'externalCode'
  getHypothesisResultHypothesisResultId(hypothesisResultToTest); // 'hypothesisResultId'
  getHypothesisResultLabel(hypothesisResultToTest); // 'label'
})();
```
