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

# PensionNeed

## Description

L'entité PensionNeed correspond au recueil des besoins pour de l'épargne.

## Relations

### Ascendantes

| Entité         | Propriété    |
| -------------- | ------------ |
| CollectionNeed | pensionNeeds |

### Descendantes

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

## Propriétés

| Nom                    | Type                                    | Description                                                                           | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ---------------------- | --------------------------------------- | ------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| knowledgeLevel         | `PensionNeedKnowledgeLevelEnum`         | Niveau de connaissance du client en produits d'épargne retraite                       |            |                 |             |                           |
| mainExpectation        | `PensionNeedMainExpectationEnum`        | Objectif de la souscription au plan épargne retraite                                  |            |                 |             |                           |
| planAvailabilityOption | `PensionNeedPlanAvailabilityOptionEnum` | Besoins en liquidité sur les placements épargne retraite                              |            |                 |             |                           |
| planExpectations       | `PensionNeedPlanExpectationsEnum`       | Attentes concernant ce plan épargne retraite                                          |            |                 |             |                           |
| id                     | `String`                                | Identifiant de l'entité `PensionNeed`                                                 |            | X               |             |                           |
| code                   | `String`                                | Codification fonctionnelle de l'entité `PensionNeed`                                  |            |                 |             |                           |
| externalId             | `String`                                | Identifiant de l'entité `PensionNeed` dans le système client                          |            |                 |             |                           |
| externalCode           | `String`                                | Codification fonctionnelle de l'entité `PensionNeed` dans le système client           |            |                 |             |                           |
| pensionNeedId          | `String`                                | Identifiant public de l'entité `PensionNeed` dans l'OIP                               |            |                 |             |                           |
| label                  | `String`                                | Information relative au nom de l'entité `PensionNeed` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt              | `Date`                                  | Date de création de l'entité `PensionNeed`                                            |            | X               |             |                           |
| updatedAt              | `Date`                                  | Date de modification de l'entité `PensionNeed`                                        |            | X               |             |                           |

## Enumérations

### PensionNeedKnowledgeLevelEnum

- `HIGH`
- `LOW`
- `MEDIUM`

### PensionNeedMainExpectationEnum

- `FISCAL_REDUCTION`
- `RETIRED_CAPITAL_PROFIT`

### PensionNeedPlanAvailabilityOptionEnum

- `INVESTMENT_AVAILABLE`
- `INVESTMENT_FOR_MAIN_RESIDENCE`
- `INVESTMENT_MAY_BE_AVAILABLE`
- `OTHER_INVESTMENTS`

### PensionNeedPlanExpectationsEnum

- `FISCAL_REDUCTION`
- `LIFE_ANNUITY_PROFIT`
- `MAIN_RESIDENCE_CAPITAL_PROFIT`
- `MIDDLE_OR_LONG_TERM_INCOME_PROFIT`
- `PARTNER_DEATH_PROTECTION`
- `RETIRED_CAPITAL_PROFIT`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCollectionNeedId } from '@fasstech/oip-core/entities/CollectionNeed';
import { getPensionNeedCode, getPensionNeedExternalCode, getPensionNeedExternalId, getPensionNeedId, getPensionNeedKnowledgeLevel, getPensionNeedLabel, getPensionNeedMainExpectation, getPensionNeedPensionNeedId, getPensionNeedPlanAvailabilityOption, getPensionNeedPlanExpectations, setPensionNeedCode, setPensionNeedExternalCode, setPensionNeedExternalId, setPensionNeedKnowledgeLevel, setPensionNeedLabel, setPensionNeedMainExpectation, setPensionNeedPensionNeedId, setPensionNeedPlanAvailabilityOption, setPensionNeedPlanExpectations } from '@fasstech/oip-core/entities/PensionNeed';
import { PensionNeedKnowledgeLevelEnum, PensionNeedMainExpectationEnum, PensionNeedPlanAvailabilityOptionEnum, PensionNeedPlanExpectationsEnum } from '@fasstech/oip-core/entities/PensionNeed/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let collectionNeed = await Entities('CollectionNeed').create();
  const pensionNeed = await Entities('PensionNeed').create();
  
  setPensionNeedKnowledgeLevel(PensionNeedKnowledgeLevelEnum.MEDIUM, pensionNeed);
  setPensionNeedMainExpectation([PensionNeedMainExpectationEnum.RETIRED_CAPITAL_PROFIT], pensionNeed);
  setPensionNeedPlanAvailabilityOption(PensionNeedPlanAvailabilityOptionEnum.INVESTMENT_AVAILABLE, pensionNeed);
  setPensionNeedPlanExpectations([PensionNeedPlanExpectationsEnum.PARTNER_DEATH_PROTECTION], pensionNeed);
  setPensionNeedCode('code', pensionNeed);
  setPensionNeedExternalId('externalId', pensionNeed);
  setPensionNeedExternalCode('externalCode', pensionNeed);
  setPensionNeedPensionNeedId('pensionNeedId', pensionNeed);
  setPensionNeedLabel('label', pensionNeed);
  
  collectionNeed = await Entities('PensionNeed').save(collectionNeed, pensionNeed);
  project = await Entities('CollectionNeed').save(project, collectionNeed);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const collectionNeedToTest = await Entities('CollectionNeed').get(projectToTest, { filter: ({ id }) => id === getCollectionNeedId(collectionNeed) });
  const pensionNeedToTest = await Entities('PensionNeed').get(collectionNeedToTest, { filter: ({ id }) => id === getPensionNeedId(pensionNeed) });
  
  getPensionNeedKnowledgeLevel(pensionNeedToTest); // PensionNeedKnowledgeLevelEnum.MEDIUM
  getPensionNeedMainExpectation(pensionNeedToTest); // [PensionNeedMainExpectationEnum.RETIRED_CAPITAL_PROFIT]
  getPensionNeedPlanAvailabilityOption(pensionNeedToTest); // PensionNeedPlanAvailabilityOptionEnum.INVESTMENT_AVAILABLE
  getPensionNeedPlanExpectations(pensionNeedToTest); // [PensionNeedPlanExpectationsEnum.PARTNER_DEATH_PROTECTION]
  getPensionNeedCode(pensionNeedToTest); // 'code'
  getPensionNeedExternalId(pensionNeedToTest); // 'externalId'
  getPensionNeedExternalCode(pensionNeedToTest); // 'externalCode'
  getPensionNeedPensionNeedId(pensionNeedToTest); // 'pensionNeedId'
  getPensionNeedLabel(pensionNeedToTest); // 'label'
})();
```
