---
title: GroupPension
slug: oip-next/uhanflbxubejgynlh7iib
createdAt: 2024-02-21T13:33:47.000Z
---

# GroupPension

## Description

L'entité GroupPension contient toutes les informations spécifiques à l'épargne collective.

## Relations

### Ascendantes

| Entité  | Propriété    |
| ------- | ------------ |
| Pension | groupPension |

### Descendantes

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

## Liste des propriétés

| Nom                         | Type                                    | Dernière version modifiée | Description                                                                         | Getter                                     | Setter                                     | Deprecated                                          |
| --------------------------- | --------------------------------------- | ------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------ | --------------------------------------------------- |
| completionWarrantyFee       | `Number`                                | 2.6.0                     | Frais de garantie de bonne fin (en %)                                               | getGroupPensionCompletionWarrantyFee       | setGroupPensionCompletionWarrantyFee       | -                                                   |
| createdAt                   | `Date`                                  |                           | Date de création de l'entité `GroupPension`                                         | getGroupPensionCreatedAt                   | Lecture seule                              | -                                                   |
| createdBy                   | `String`                                |                           | Utilisateur à l'origine de la création de l'entité `GroupPension`                   | getGroupPensionCreatedBy                   | Lecture seule                              | -                                                   |
| customerHasInvestmentOption | `Boolean`                               | 2.5.0                     | Le client choisit une option financière (pour sécuriser et/ou avoir une plus-value) | getGroupPensionCustomerHasInvestmentOption | setGroupPensionCustomerHasInvestmentOption | -                                                   |
| financialOffer              | `GroupPensionFinancialOfferEnum`        | 2.5.0                     | Offre financière                                                                    | getGroupPensionFinancialOffer              | setGroupPensionFinancialOffer              | -                                                   |
| id                          | `String`                                |                           | Identifiant unique de l'entité `GroupPension`                                       | getGroupPensionId                          | Lecture seule                              | -                                                   |
| optionalDeathCoverage       | `GroupPensionOptionalDeathCoverageEnum` | 2.5.0                     | Couverture décès optionnelle                                                        | getGroupPensionOptionalDeathCoverage       | setGroupPensionOptionalDeathCoverage       | Utiliser le tableau de couverture décès optionnelle |
| optionalDeathCoverages      | `String[]`                              | 2.7.0                     | Tableau de couverture décès optionnelle                                             | getGroupPensionOptionalDeathCoverages      | setGroupPensionOptionalDeathCoverages      | -                                                   |
| updatedAt                   | `Date`                                  |                           | Date de modification de l'entité `GroupPension`                                     | getGroupPensionUpdatedAt                   | Lecture seule                              | -                                                   |
| updatedBy                   | `String`                                |                           | Utilisateur à l'origine de la modification de l'entité `GroupPension`               | getGroupPensionUpdatedBy                   | Lecture seule                              | -                                                   |

## Enums

### GroupPensionFinancialOfferEnum

- `GroupPensionFinancialOfferEnum.GUIDED`
- `GroupPensionFinancialOfferEnum.SIMPLE`

### GroupPensionOptionalDeathCoverageEnum

- `GroupPensionOptionalDeathCoverageEnum.COMPLETION_WARRANTY`
- `GroupPensionOptionalDeathCoverageEnum.MINIMUM_AND_COMPLETION_WARRANTY`
- `GroupPensionOptionalDeathCoverageEnum.MINIMUM_WARRANTY`
- `GroupPensionOptionalDeathCoverageEnum.NONE`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getGroupPensionCompletionWarrantyFee, getGroupPensionCustomerHasInvestmentOption, getGroupPensionFinancialOffer, getGroupPensionOptionalDeathCoverage, getGroupPensionOptionalDeathCoverages, setGroupPensionCompletionWarrantyFee, setGroupPensionCustomerHasInvestmentOption, setGroupPensionFinancialOffer, setGroupPensionOptionalDeathCoverage, setGroupPensionOptionalDeathCoverages } from '@fasstech/oip-core/entities/groupPension';
import { GroupPensionFinancialOfferEnum, GroupPensionOptionalDeathCoverageEnum } from '@fasstech/oip-core/entities/groupPension/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();
  let PensionEntity = await Entities('Pension').get(OfferEntity);
  const GroupPensionEntity = await Entities('GroupPension').get(PensionEntity);
  
  setGroupPensionCompletionWarrantyFee(99, GroupPensionEntity);
  setGroupPensionCustomerHasInvestmentOption(false, GroupPensionEntity);
  setGroupPensionFinancialOffer(GroupPensionFinancialOfferEnum.GUIDED, GroupPensionEntity);
  setGroupPensionOptionalDeathCoverage(GroupPensionOptionalDeathCoverageEnum.NONE, GroupPensionEntity);
  setGroupPensionOptionalDeathCoverages(['optionalDeathCoverages'], GroupPensionEntity);
  
  PensionEntity = await Entities('GroupPension').save(PensionEntity, GroupPensionEntity);
  OfferEntity = await Entities('Pension').save(OfferEntity, PensionEntity);
  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 PensionEntityToTest = await Entities('Pension').get(OfferEntityToTest);
  const GroupPensionEntityToTest = await Entities('GroupPension').get(PensionEntityToTest);
  
  getGroupPensionCompletionWarrantyFee(GroupPensionEntityToTest); // 99
  getGroupPensionCustomerHasInvestmentOption(GroupPensionEntityToTest); // false
  getGroupPensionFinancialOffer(GroupPensionEntityToTest); // GroupPensionFinancialOfferEnum.GUIDED
  getGroupPensionOptionalDeathCoverage(GroupPensionEntityToTest); // GroupPensionOptionalDeathCoverageEnum.NONE
  getGroupPensionOptionalDeathCoverages(GroupPensionEntityToTest); // ['optionalDeathCoverages']
})();
```
