---
title: PensionNeed
slug: oip-next/4uddicrhyrpvvmlcesj07
createdAt: 2024-02-21T13:29:46.000Z
---

# PensionNeed

## Description

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

## Relations

### Ascendantes

| Entité         | Propriété   |
| -------------- | ----------- |
| CollectionNeed | pensionNeed |

### Descendantes

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

## Liste des propriétés

| Nom                    | Type                         | Dernière version modifiée | Description                                                          | Getter                               | Setter                               | Deprecated |
| ---------------------- | ---------------------------- | ------------------------- | -------------------------------------------------------------------- | ------------------------------------ | ------------------------------------ | ---------- |
| createdAt              | `Date`                       |                           | Date de création de l'entité `PensionNeed`                           | getPensionNeedCreatedAt              | Lecture seule                        | -          |
| createdBy              | `String`                     |                           | Utilisateur à l'origine de la création de l'entité `PensionNeed`     | getPensionNeedCreatedBy              | Lecture seule                        | -          |
| id                     | `String`                     |                           | Identifiant unique de l'entité `PensionNeed`                         | getPensionNeedId                     | Lecture seule                        | -          |
| knowledgeLevel         | `knowledgeLevelEnum`         |                           | Niveau de connaissance du client en produits d’épargne retraite      | getPensionNeedKnowledgeLevel         | setPensionNeedKnowledgeLevel         | -          |
| mainExpectation        | `mainExpectationEnum`        |                           | Objectif de la souscription au plan épargne retraite                 | getPensionNeedMainExpectation        | setPensionNeedMainExpectation        | -          |
| planAvailabilityOption | `planAvailabilityOptionEnum` |                           | Besoins en liquidité sur les placements épargne retraite             | getPensionNeedPlanAvailabilityOption | setPensionNeedPlanAvailabilityOption | -          |
| planExpectations       | `planExpectationsEnum`       |                           | Attentes concernant ce plan épargne retraite                         | getPensionNeedPlanExpectations       | setPensionNeedPlanExpectations       | -          |
| updatedAt              | `Date`                       |                           | Date de modification de l'entité `PensionNeed`                       | getPensionNeedUpdatedAt              | Lecture seule                        | -          |
| updatedBy              | `String`                     |                           | Utilisateur à l'origine de la modification de l'entité `PensionNeed` | getPensionNeedUpdatedBy              | Lecture seule                        | -          |

## Enums

### knowledgeLevelEnum

- `knowledgeLevelEnum.LOW`
- `knowledgeLevelEnum.MEDIUM`
- `knowledgeLevelEnum.HIGH`

### mainExpectationEnum

- `mainExpectationEnum.RETIRED_CAPITAL_PROFIT`
- `mainExpectationEnum.FISCAL_REDUCTION`

### planAvailabilityOptionEnum

- `planAvailabilityOptionEnum.OTHER_INVESTMENTS`
- `planAvailabilityOptionEnum.INVESTMENT_MAY_BE_AVAILABLE`
- `planAvailabilityOptionEnum.INVESTMENT_AVAILABLE`
- `planAvailabilityOptionEnum.INVESTMENT_FOR_MAIN_RESIDENCE`

### planExpectationsEnum

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

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCollectionNeedId } from '@fasstech/oip-core/entities/collectionNeed';
import { getPensionNeedKnowledgeLevel, getPensionNeedMainExpectation, getPensionNeedPlanAvailabilityOption, getPensionNeedPlanExpectations, setPensionNeedKnowledgeLevel, setPensionNeedMainExpectation, setPensionNeedPlanAvailabilityOption, setPensionNeedPlanExpectations } from '@fasstech/oip-core/entities/pensionNeed';
import { mainExpectationEnum, planAvailabilityOptionEnum, knowledgeLevelEnum, planExpectationsEnum } from '@fasstech/oip-core/entities/pensionNeed/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  let CollectionNeedEntity = await Entities('CollectionNeed').create();
  const PensionNeedEntity = await Entities('PensionNeed').get(CollectionNeedEntity);
  
  setPensionNeedKnowledgeLevel(knowledgeLevelEnum.MEDIUM, PensionNeedEntity);
  setPensionNeedMainExpectation([mainExpectationEnum.RETIRED_CAPITAL_PROFIT], PensionNeedEntity);
  setPensionNeedPlanAvailabilityOption(planAvailabilityOptionEnum.INVESTMENT_AVAILABLE, PensionNeedEntity);
  setPensionNeedPlanExpectations([planExpectationsEnum.PARTNER_DEATH_PROTECTION], PensionNeedEntity);
  
  CollectionNeedEntity = await Entities('PensionNeed').save(CollectionNeedEntity, PensionNeedEntity);
  ProjectEntity = await Entities('CollectionNeed').save(ProjectEntity, CollectionNeedEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const CollectionNeedEntityToTest = await Entities('CollectionNeed').get(ProjectEntityToTest, getCollectionNeedId(CollectionNeedEntity));
  const PensionNeedEntityToTest = await Entities('PensionNeed').get(CollectionNeedEntityToTest);
  
  getPensionNeedKnowledgeLevel(PensionNeedEntityToTest); // knowledgeLevelEnum.MEDIUM
  getPensionNeedMainExpectation(PensionNeedEntityToTest); // [mainExpectationEnum.RETIRED_CAPITAL_PROFIT]
  getPensionNeedPlanAvailabilityOption(PensionNeedEntityToTest); // planAvailabilityOptionEnum.INVESTMENT_AVAILABLE
  getPensionNeedPlanExpectations(PensionNeedEntityToTest); // [planExpectationsEnum.PARTNER_DEATH_PROTECTION]
})();
```
