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

# Finance

## Description

L'entité Finance contient les informations financières pour un produit d'épargne pour un adhérent. Notamment les revenus mensuels.

## Relations

### Ascendantes

| Entité   | Propriété |
| -------- | --------- |
| Customer | finances  |
| Tns      | finances  |

### Descendantes

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

## Propriétés

| Nom                                  | Type                                      | Description                                                                                                                           | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------------------------------ | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| annualHouseholdIncome                | `Number`                                  | Montant annuel des revenus de votre foyer                                                                                             |            |                 |             | 2.1.1                     |
| annualIncome                         | `Number`                                  | Revenus annuels                                                                                                                       |            |                 |             | 2.1.1                     |
| annualSavingEstimation               | `Number`                                  | Estimation épargne annuelle                                                                                                           |            |                 |             | 2.1.1                     |
| bankSavings                          | `FinanceBankSavingsEnum`                  | Epargne bancaire                                                                                                                      |            |                 |             | 2.1.1                     |
| corporateTaxRate                     | `Number`                                  | Assujetissement IS                                                                                                                    |            |                 |             | 2.1.1                     |
| dividend                             | `Number`                                  | le montant perçu par une distribution de dividende                                                                                    |            |                 |             | 2.8.0                     |
| employeeAndRetirementSavings         | `FinanceEmployeeAndRetirementSavingsEnum` | Epargne salariale / Epargne retraite                                                                                                  |            |                 |             | 2.1.1                     |
| financialSavings                     | `FinanceFinancialSavingsEnum`             | Epargne financière                                                                                                                    |            |                 |             | 2.1.1                     |
| financialWealthOrigin                | `FinanceFinancialWealthOriginEnum`        | Revenus/activité professionnelle, Épargne constituée, Succession/donation, Vente immobilière, Stock-options, Cession de participation |            |                 |             | 2.1.1                     |
| fiscalCountryResidence               | `String`                                  | Pays de résidence fiscale                                                                                                             |            |                 |             | 2.1.1                     |
| hasForeignFiscalResidence            | `Boolean`                                 | Résidences fiscales en dehors de la France.                                                                                           |            |                 |             | 2.1.1                     |
| hasTinWithoutAmericanFiscalResidence | `Boolean`                                 | Possède un TIN sans résidence fiscale USA.                                                                                            |            |                 |             | 2.1.1                     |
| incomeTaxRate                        | `FinanceIncomeTaxRateEnum`                | Taux d'imposition sur le revenu.                                                                                                      |            |                 |             | 2.1.1                     |
| incomesOrigin                        | `FinanceIncomesOriginEnum`                | Origine des revenus.                                                                                                                  |            |                 |             | 2.1.1                     |
| investedSavingEstimation             | `Number`                                  | Montant estimé de votre épargne placée (A) en €                                                                                       |            |                 |             | 2.1.1                     |
| investmentOrigin                     | `FinanceInvestmentOriginEnum`             | Origine de l'investissement                                                                                                           |            |                 |             | 2.1.1                     |
| investmentPaymentMethod              | `FinanceInvestmentPaymentMethodEnum`      | Méthode de paiement de l'investissement                                                                                               |            |                 |             | 2.1.1                     |
| investmentSourceAccount              | `FinanceInvestmentSourceAccountEnum`      | Compte source de l'investissement                                                                                                     |            |                 |             | 2.1.1                     |
| isAmericanCitizen                    | `Boolean`                                 | Citoyen USA                                                                                                                           |            |                 |             | 2.1.1                     |
| isAmericanFiscalResident             | `Boolean`                                 | Est résident fiscal USA                                                                                                               |            |                 |             | 2.1.1                     |
| lifeInsurance                        | `FinanceLifeInsuranceEnum`                | Assurance vie                                                                                                                         |            |                 |             | 2.1.1                     |
| marginalTaxRate                      | `Number`                                  | Taux marginal d'imposition                                                                                                            |            |                 |             | 2.1.1                     |
| monthlyHouseholdIncome               | `Number`                                  | Montant mensuel des revenus du foyer                                                                                                  |            |                 |             | 3.16.0                    |
| monthlyIncome                        | `Number`                                  | Montant du revenu mensuel                                                                                                             |            |                 |             | 3.12.0                    |
| movableIncome                        | `Number`                                  | Revenus mobiliers                                                                                                                     |            |                 |             | 2.1.1                     |
| otherFinancialWealthOrigin           | `String`                                  | Autres revenus patrimoniaux                                                                                                           |            |                 |             | 2.1.1                     |
| otherIncome                          | `Number`                                  | Autres revenus                                                                                                                        |            |                 |             | 2.1.1                     |
| pensionIncome                        | `Number`                                  | Revenus de pensions                                                                                                                   |            |                 |             | 2.1.1                     |
| personalMonthlyChargesRentOrLoan     | `Number`                                  | Frais mensuels personnel de location ou de loyer                                                                                      |            |                 |             | 2.1.1                     |
| personalMonthlyChargesTax            | `Number`                                  | Impôt mensuel sur les revenus                                                                                                         |            |                 |             | 2.1.1                     |
| personalMonthlyCurrentExpenses       | `Number`                                  | Dépenses mensuelles personnelles courantes                                                                                            |            |                 |             | 2.1.1                     |
| personalMonthlyOtherCharges          | `Number`                                  | Autres charges mensuelles personnelles                                                                                                |            |                 |             | 2.1.1                     |
| personalMonthlyOtherChargesOrigin    | `String`                                  | Origine des autres charges mensuelles personnelles                                                                                    |            |                 |             | 2.1.1                     |
| professionalIncome                   | `Number`                                  | Salaires ou revenus professionnels                                                                                                    |            |                 |             | 2.1.1                     |
| realEstate                           | `FinanceRealEstateEnum`                   | Biens immobiliers                                                                                                                     |            |                 |             | 2.1.1                     |
| realEstateEstimation                 | `Number`                                  | Estimation des biens immobiliers                                                                                                      |            |                 |             | 2.1.1                     |
| realEstateFortuneTaxRate             | `FinanceRealEstateFortuneTaxRateEnum`     | Taux d'imposition sur la fortune immoblière                                                                                           |            |                 |             | 2.1.1                     |
| realEstateIncome                     | `Number`                                  | Revenus immobiliers                                                                                                                   |            |                 |             | 2.1.1                     |
| realEstateStatus                     | `FinanceRealEstateStatusEnum`             | Information de statut immobilier                                                                                                      |            |                 |             | 3.16.0                    |
| retirementSavingEstimation           | `Number`                                  | Estimation de l'épargne retraite                                                                                                      |            |                 |             | 2.1.1                     |
| riskyOwnedAssetPercentage            | `FinanceRiskyOwnedAssetPercentageEnum`    | Pourcentage d'actifs risqués possédés                                                                                                 |            |                 |             | 2.1.1                     |
| totalWealth                          | `Number`                                  | Richesse globale                                                                                                                      |            |                 |             | 2.1.1                     |
| id                                   | `String`                                  | Identifiant de l'entité `Finance`                                                                                                     |            | X               |             |                           |
| code                                 | `String`                                  | Codification fonctionnelle de l'entité `Finance`                                                                                      |            |                 |             |                           |
| externalId                           | `String`                                  | Identifiant de l'entité `Finance` dans le système client                                                                              |            |                 |             |                           |
| externalCode                         | `String`                                  | Codification fonctionnelle de l'entité `Finance` dans le système client                                                               |            |                 |             |                           |
| financeId                            | `String`                                  | Identifiant public de l'entité `Finance` dans l'OIP                                                                                   |            |                 |             |                           |
| label                                | `String`                                  | Information relative au nom de l'entité `Finance` dans son contexte d'utilisation                                                     |            |                 |             |                           |
| createdAt                            | `Date`                                    | Date de création de l'entité `Finance`                                                                                                |            | X               |             |                           |
| updatedAt                            | `Date`                                    | Date de modification de l'entité `Finance`                                                                                            |            | X               |             |                           |

## Enumérations

### FinanceBankSavingsEnum

- `BANK_PEP`
- `CURRENT_ACCOUNT`
- `HOUSING_SAVINGS`
- `SAVINGS_ACCOUNT`
- `TERM_ACCOUNTS`

### FinanceEmployeeAndRetirementSavingsEnum

- `PEE`
- `PERCO`
- `RETIREMENT_CONTRACT_SUPP`
- `RETIREMENT_PERP_MADELIN`

### FinanceFinancialSavingsEnum

- `PEA`
- `TITLES_ACCOUNTS`

### FinanceFinancialWealthOriginEnum

- `OTHER`
- `PROFESSIONAL_INCOME`
- `REAL_ESTATE_SELLING`
- `SALE_OF_STAKE`
- `SAVINGS`
- `STOCK_OPTIONS`
- `SUCCESSION_DONATION`

### FinanceIncomeTaxRateEnum

- `NOT_LIABLE` => `0`
- `ELEVEN_PERCENT` => `11`
- `THIRTY_PERCENT` => `30`
- `FORTY_ONE_PERCENT` => `41`
- `FORTY_FIVE_PERCENT` => `45`
- `UNKNOWN`

### FinanceIncomesOriginEnum

- `OTHER`
- `PROFESSIONAL_INCOME`
- `REAL_ESTATE_MOVABLE`
- `REAL_ESTATE_RENT`
- `RETIREMENT`

### FinanceInvestmentOriginEnum

- `LIFE_INSURANCE_PROFITS`
- `OTHER`
- `PENSION_CONTRACT`
- `PROFESSIONAL_INCOME`
- `SAVINGS`

### FinanceInvestmentPaymentMethodEnum

- `AUTOMATIC_DEBIT`
- `BANK_TRANSFER`
- `CHECK`
- `CONTRACT_TRANSFER`

### FinanceInvestmentSourceAccountEnum

- `PERSONAL_ACCOUNT`
- `PROFESSIONAL_ACCOUNT`
- `THIRD_PARTY_ACCOUNT`

### FinanceLifeInsuranceEnum

- `CAPITALIZATION_CONTRACTS`
- `CONTRACTS`
- `PEP_INSURANCE`

### FinanceRealEstateEnum

- `OTHER`
- `PRIMARY_RESIDENCE`
- `RENTAL_PROPERTY_VALUE`
- `SECONDARY_RESIDENCE`

### FinanceRealEstateFortuneTaxRateEnum

- `NONE`
- `PERCENT_0_5`
- `PERCENT_0_7`
- `PERCENT_1`
- `PERCENT_1_25`
- `PERCENT_1_5`

### FinanceRealEstateStatusEnum

- `LANDLORD`
- `TENANT`

### FinanceRiskyOwnedAssetPercentageEnum

- `GREATER_THAN_30`
- `LESS_THAN_10`
- `NOT_APPLICABLE`
- `PERCENT_10_TO_30`
- `UNKNOWN`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCustomerId } from '@fasstech/oip-core/entities/Customer';
import { getFinanceAnnualHouseholdIncome, getFinanceAnnualIncome, getFinanceAnnualSavingEstimation, getFinanceBankSavings, getFinanceCode, getFinanceCorporateTaxRate, getFinanceDividend, getFinanceEmployeeAndRetirementSavings, getFinanceExternalCode, getFinanceExternalId, getFinanceFinanceId, getFinanceFinancialSavings, getFinanceFinancialWealthOrigin, getFinanceFiscalCountryResidence, getFinanceHasForeignFiscalResidence, getFinanceHasTinWithoutAmericanFiscalResidence, getFinanceId, getFinanceIncomeTaxRate, getFinanceIncomesOrigin, getFinanceInvestedSavingEstimation, getFinanceInvestmentOrigin, getFinanceInvestmentPaymentMethod, getFinanceInvestmentSourceAccount, getFinanceIsAmericanCitizen, getFinanceIsAmericanFiscalResident, getFinanceLabel, getFinanceLifeInsurance, getFinanceMarginalTaxRate, getFinanceMonthlyHouseholdIncome, getFinanceMonthlyIncome, getFinanceMovableIncome, getFinanceOtherFinancialWealthOrigin, getFinanceOtherIncome, getFinancePensionIncome, getFinancePersonalMonthlyChargesRentOrLoan, getFinancePersonalMonthlyChargesTax, getFinancePersonalMonthlyCurrentExpenses, getFinancePersonalMonthlyOtherCharges, getFinancePersonalMonthlyOtherChargesOrigin, getFinanceProfessionalIncome, getFinanceRealEstate, getFinanceRealEstateEstimation, getFinanceRealEstateFortuneTaxRate, getFinanceRealEstateIncome, getFinanceRealEstateStatus, getFinanceRetirementSavingEstimation, getFinanceRiskyOwnedAssetPercentage, getFinanceTotalWealth, setFinanceAnnualHouseholdIncome, setFinanceAnnualIncome, setFinanceAnnualSavingEstimation, setFinanceBankSavings, setFinanceCode, setFinanceCorporateTaxRate, setFinanceDividend, setFinanceEmployeeAndRetirementSavings, setFinanceExternalCode, setFinanceExternalId, setFinanceFinanceId, setFinanceFinancialSavings, setFinanceFinancialWealthOrigin, setFinanceFiscalCountryResidence, setFinanceHasForeignFiscalResidence, setFinanceHasTinWithoutAmericanFiscalResidence, setFinanceIncomeTaxRate, setFinanceIncomesOrigin, setFinanceInvestedSavingEstimation, setFinanceInvestmentOrigin, setFinanceInvestmentPaymentMethod, setFinanceInvestmentSourceAccount, setFinanceIsAmericanCitizen, setFinanceIsAmericanFiscalResident, setFinanceLabel, setFinanceLifeInsurance, setFinanceMarginalTaxRate, setFinanceMonthlyHouseholdIncome, setFinanceMonthlyIncome, setFinanceMovableIncome, setFinanceOtherFinancialWealthOrigin, setFinanceOtherIncome, setFinancePensionIncome, setFinancePersonalMonthlyChargesRentOrLoan, setFinancePersonalMonthlyChargesTax, setFinancePersonalMonthlyCurrentExpenses, setFinancePersonalMonthlyOtherCharges, setFinancePersonalMonthlyOtherChargesOrigin, setFinanceProfessionalIncome, setFinanceRealEstate, setFinanceRealEstateEstimation, setFinanceRealEstateFortuneTaxRate, setFinanceRealEstateIncome, setFinanceRealEstateStatus, setFinanceRetirementSavingEstimation, setFinanceRiskyOwnedAssetPercentage, setFinanceTotalWealth } from '@fasstech/oip-core/entities/Finance';
import { FinanceBankSavingsEnum, FinanceEmployeeAndRetirementSavingsEnum, FinanceFinancialSavingsEnum, FinanceFinancialWealthOriginEnum, FinanceIncomeTaxRateEnum, FinanceIncomesOriginEnum, FinanceInvestmentOriginEnum, FinanceInvestmentPaymentMethodEnum, FinanceInvestmentSourceAccountEnum, FinanceLifeInsuranceEnum, FinanceRealEstateEnum, FinanceRealEstateFortuneTaxRateEnum, FinanceRealEstateStatusEnum, FinanceRiskyOwnedAssetPercentageEnum } from '@fasstech/oip-core/entities/Finance/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let customer = await Entities('Customer').create();
  const finance = await Entities('Finance').create();
  
  setFinanceAnnualHouseholdIncome(97, finance);
  setFinanceAnnualIncome(97, finance);
  setFinanceAnnualSavingEstimation(97, finance);
  setFinanceBankSavings([FinanceBankSavingsEnum.SAVINGS_ACCOUNT], finance);
  setFinanceCorporateTaxRate(99, finance);
  setFinanceDividend(100, finance);
  setFinanceEmployeeAndRetirementSavings([FinanceEmployeeAndRetirementSavingsEnum.PERCO], finance);
  setFinanceFinancialSavings([FinanceFinancialSavingsEnum.PEA], finance);
  setFinanceFinancialWealthOrigin([FinanceFinancialWealthOriginEnum.SAVINGS], finance);
  setFinanceFiscalCountryResidence('fiscalCountryResidence', finance);
  setFinanceHasForeignFiscalResidence(true, finance);
  setFinanceHasTinWithoutAmericanFiscalResidence(true, finance);
  setFinanceIncomeTaxRate(FinanceIncomeTaxRateEnum.NOT_LIABLE, finance);
  setFinanceIncomesOrigin([FinanceIncomesOriginEnum.OTHER], finance);
  setFinanceInvestedSavingEstimation(105, finance);
  setFinanceInvestmentOrigin(FinanceInvestmentOriginEnum.LIFE_INSURANCE_PROFITS, finance);
  setFinanceInvestmentPaymentMethod(FinanceInvestmentPaymentMethodEnum.BANK_TRANSFER, finance);
  setFinanceInvestmentSourceAccount(FinanceInvestmentSourceAccountEnum.PERSONAL_ACCOUNT, finance);
  setFinanceIsAmericanCitizen(false, finance);
  setFinanceIsAmericanFiscalResident(false, finance);
  setFinanceLifeInsurance([FinanceLifeInsuranceEnum.CAPITALIZATION_CONTRACTS], finance);
  setFinanceMarginalTaxRate(109, finance);
  setFinanceMonthlyHouseholdIncome(109, finance);
  setFinanceMonthlyIncome(109, finance);
  setFinanceMovableIncome(109, finance);
  setFinanceOtherFinancialWealthOrigin('otherFinancialWealthOrigin', finance);
  setFinanceOtherIncome(111, finance);
  setFinancePensionIncome(112, finance);
  setFinancePersonalMonthlyChargesRentOrLoan(112, finance);
  setFinancePersonalMonthlyChargesTax(112, finance);
  setFinancePersonalMonthlyCurrentExpenses(112, finance);
  setFinancePersonalMonthlyOtherCharges(112, finance);
  setFinancePersonalMonthlyOtherChargesOrigin('personalMonthlyOtherChargesOrigin', finance);
  setFinanceProfessionalIncome(112, finance);
  setFinanceRealEstate([FinanceRealEstateEnum.RENTAL_PROPERTY_VALUE], finance);
  setFinanceRealEstateEstimation(114, finance);
  setFinanceRealEstateFortuneTaxRate(FinanceRealEstateFortuneTaxRateEnum.NONE, finance);
  setFinanceRealEstateIncome(114, finance);
  setFinanceRealEstateStatus(FinanceRealEstateStatusEnum.LANDLORD, finance);
  setFinanceRetirementSavingEstimation(114, finance);
  setFinanceRiskyOwnedAssetPercentage(FinanceRiskyOwnedAssetPercentageEnum.UNKNOWN, finance);
  setFinanceTotalWealth(116, finance);
  setFinanceCode('code', finance);
  setFinanceExternalId('externalId', finance);
  setFinanceExternalCode('externalCode', finance);
  setFinanceFinanceId('financeId', finance);
  setFinanceLabel('label', finance);
  
  customer = await Entities('Finance').save(customer, finance);
  project = await Entities('Customer').save(project, customer);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const customerToTest = await Entities('Customer').get(projectToTest, { filter: ({ id }) => id === getCustomerId(customer) });
  const financeToTest = await Entities('Finance').get(customerToTest, { filter: ({ id }) => id === getFinanceId(finance) });
  
  getFinanceAnnualHouseholdIncome(financeToTest); // 97
  getFinanceAnnualIncome(financeToTest); // 97
  getFinanceAnnualSavingEstimation(financeToTest); // 97
  getFinanceBankSavings(financeToTest); // [FinanceBankSavingsEnum.SAVINGS_ACCOUNT]
  getFinanceCorporateTaxRate(financeToTest); // 99
  getFinanceDividend(financeToTest); // 100
  getFinanceEmployeeAndRetirementSavings(financeToTest); // [FinanceEmployeeAndRetirementSavingsEnum.PERCO]
  getFinanceFinancialSavings(financeToTest); // [FinanceFinancialSavingsEnum.PEA]
  getFinanceFinancialWealthOrigin(financeToTest); // [FinanceFinancialWealthOriginEnum.SAVINGS]
  getFinanceFiscalCountryResidence(financeToTest); // 'fiscalCountryResidence'
  getFinanceHasForeignFiscalResidence(financeToTest); // true
  getFinanceHasTinWithoutAmericanFiscalResidence(financeToTest); // true
  getFinanceIncomeTaxRate(financeToTest); // FinanceIncomeTaxRateEnum.NOT_LIABLE
  getFinanceIncomesOrigin(financeToTest); // [FinanceIncomesOriginEnum.OTHER]
  getFinanceInvestedSavingEstimation(financeToTest); // 105
  getFinanceInvestmentOrigin(financeToTest); // FinanceInvestmentOriginEnum.LIFE_INSURANCE_PROFITS
  getFinanceInvestmentPaymentMethod(financeToTest); // FinanceInvestmentPaymentMethodEnum.BANK_TRANSFER
  getFinanceInvestmentSourceAccount(financeToTest); // FinanceInvestmentSourceAccountEnum.PERSONAL_ACCOUNT
  getFinanceIsAmericanCitizen(financeToTest); // false
  getFinanceIsAmericanFiscalResident(financeToTest); // false
  getFinanceLifeInsurance(financeToTest); // [FinanceLifeInsuranceEnum.CAPITALIZATION_CONTRACTS]
  getFinanceMarginalTaxRate(financeToTest); // 109
  getFinanceMonthlyHouseholdIncome(financeToTest); // 109
  getFinanceMonthlyIncome(financeToTest); // 109
  getFinanceMovableIncome(financeToTest); // 109
  getFinanceOtherFinancialWealthOrigin(financeToTest); // 'otherFinancialWealthOrigin'
  getFinanceOtherIncome(financeToTest); // 111
  getFinancePensionIncome(financeToTest); // 112
  getFinancePersonalMonthlyChargesRentOrLoan(financeToTest); // 112
  getFinancePersonalMonthlyChargesTax(financeToTest); // 112
  getFinancePersonalMonthlyCurrentExpenses(financeToTest); // 112
  getFinancePersonalMonthlyOtherCharges(financeToTest); // 112
  getFinancePersonalMonthlyOtherChargesOrigin(financeToTest); // 'personalMonthlyOtherChargesOrigin'
  getFinanceProfessionalIncome(financeToTest); // 112
  getFinanceRealEstate(financeToTest); // [FinanceRealEstateEnum.RENTAL_PROPERTY_VALUE]
  getFinanceRealEstateEstimation(financeToTest); // 114
  getFinanceRealEstateFortuneTaxRate(financeToTest); // FinanceRealEstateFortuneTaxRateEnum.NONE
  getFinanceRealEstateIncome(financeToTest); // 114
  getFinanceRealEstateStatus(financeToTest); // FinanceRealEstateStatusEnum.LANDLORD
  getFinanceRetirementSavingEstimation(financeToTest); // 114
  getFinanceRiskyOwnedAssetPercentage(financeToTest); // FinanceRiskyOwnedAssetPercentageEnum.UNKNOWN
  getFinanceTotalWealth(financeToTest); // 116
  getFinanceCode(financeToTest); // 'code'
  getFinanceExternalId(financeToTest); // 'externalId'
  getFinanceExternalCode(financeToTest); // 'externalCode'
  getFinanceFinanceId(financeToTest); // 'financeId'
  getFinanceLabel(financeToTest); // 'label'
})();
```
