---
title: Grantee
slug: oip-next/7r3nbb1tjzw8ts4r3zjo
createdAt: 2024-02-21T13:33:49.000Z
---

# Grantee

## Description

L'entité Grantee contient la gestion des bénéficiaires d'un contrat.

## Relations

### Ascendantes

| Entité  | Propriété |
| ------- | --------- |
| Project | grantees  |

### Descendantes

| Entité          | Propriété                    |
| --------------- | ---------------------------- |
| CSP             | CSPs                         |
| GDPR            | GDPRs                        |
| Address         | addresses                    |
| Aml             | aml                          |
| Relation        | attachedSocialSecurityNumber |
| BankAccount     | bankAccounts                 |
| Email           | emails                       |
| History         | history                      |
| LegalProfile    | legalProfile                 |
| PersonalProfile | personalProfile              |
| Phone           | phones                       |
| SocialSecurity  | socialSecurity               |

## Liste des propriétés

| Nom                            | Type                            | Dernière version modifiée | Description                                                                | Getter                                   | Setter                                   | Deprecated                                                                                |
| ------------------------------ | ------------------------------- | ------------------------- | -------------------------------------------------------------------------- | ---------------------------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------- |
| attachedSocialSecurity         | `String[]`                      | 2.4.0                     | Numéro de sécurité sociale rattaché                                        | getGranteeAttachedSocialSecurity         | setGranteeAttachedSocialSecurity         | Utiliser l'entité relation                                                                |
| birthCity                      | `String`                        | 1.5.0                     | Ville de naissance                                                         | getGranteeBirthCity                      | setGranteeBirthCity                      | -                                                                                         |
| birthCountry                   | `String`                        | 2.0.0                     | Pays de naissance                                                          | getGranteeBirthCountry                   | setGranteeBirthCountry                   | -                                                                                         |
| birthDate                      | `Date`                          | 2.0.0                     | Date de naissance                                                          | getGranteeBirthDate                      | setGranteeBirthDate                      | -                                                                                         |
| birthName                      | `String`                        | 2.0.0                     | Nom de naissance                                                           | getGranteeBirthName                      | setGranteeBirthName                      | -                                                                                         |
| birthZipCode                   | `String`                        |                           | Code postal de naissance                                                   | getGranteeBirthZipCode                   | setGranteeBirthZipCode                   | -                                                                                         |
| civility                       | `String`                        | 2.0.0                     | Civilité                                                                   | getGranteeCivility                       | setGranteeCivility                       | -                                                                                         |
| createdAt                      | `Date`                          |                           | Date de création de l'entité `Grantee`                                     | getGranteeCreatedAt                      | Lecture seule                            | -                                                                                         |
| createdBy                      | `String`                        |                           | Utilisateur à l'origine de la création de l'entité `Grantee`               | getGranteeCreatedBy                      | Lecture seule                            | -                                                                                         |
| externalId                     | `String`                        | 2.4.0                     | Identifiant externe du bénéficiaire                                        | getGranteeExternalId                     | setGranteeExternalId                     | -                                                                                         |
| firstName                      | `String`                        | 2.0.0                     | Prénom                                                                     | getGranteeFirstName                      | setGranteeFirstName                      | -                                                                                         |
| hasEducationAnnuityBeneficiary | `Boolean`                       | 2.1.1                     | Le souscripteur déclare avoir des bénéficiaires d’une rente éducation      | getGranteeHasEducationAnnuityBeneficiary | setGranteeHasEducationAnnuityBeneficiary | -                                                                                         |
| hasHealthContract              | `Boolean`                       | 2.1.1                     | Le bénéficiaire est actuellement couverte par un contrat de santé          | getGranteeHasHealthContract              | setGranteeHasHealthContract              | -                                                                                         |
| hasProtectionContract          | `Boolean`                       | 2.1.1                     | Le bénéficiaire est actuellement couverte par un contrat de prévoyance     | getGranteeHasProtectionContract          | setGranteeHasProtectionContract          | -                                                                                         |
| id                             | `String`                        |                           | Identifiant unique de l'entité `Grantee`                                   | getGranteeId                             | Lecture seule                            | -                                                                                         |
| isCCS                          | `Boolean`                       | 2.6.0                     | Indique si le bénéficiaire bénéficie de la complémentarité santé solidaire | getGranteeIsCCS                          | setGranteeIsCCS                          | Cette information est dorénavant donnée par la propriété isCCS de l'entité SocialSecurity |
| isTNS                          | `Boolean`                       |                           | Indique si le bénéficiaire est TNS                                         | getGranteeIsTNS                          | setGranteeIsTNS                          | -                                                                                         |
| lastName                       | `String`                        | 2.0.0                     | Nom                                                                        | getGranteeLastName                       | setGranteeLastName                       | -                                                                                         |
| percentShare                   | `Number`                        | 2.1.1                     | Pourcentage du bénéficiaire en cas de décès                                | getGranteePercentShare                   | setGranteePercentShare                   | -                                                                                         |
| subscriptionStatus             | `GranteeSubscriptionStatusEnum` | 2.8.0                     | status de souscription du client au moment du parcours OAV                 | getGranteeSubscriptionStatus             | setGranteeSubscriptionStatus             | -                                                                                         |
| type                           | `GranteeTypeEnum`               | 2.1.1                     | Type de bénéficiaire : enfant, conjoint                                    | getGranteeType                           | setGranteeType                           | -                                                                                         |
| updatedAt                      | `Date`                          |                           | Date de modification de l'entité `Grantee`                                 | getGranteeUpdatedAt                      | Lecture seule                            | -                                                                                         |
| updatedBy                      | `String`                        |                           | Utilisateur à l'origine de la modification de l'entité `Grantee`           | getGranteeUpdatedBy                      | Lecture seule                            | -                                                                                         |

## Enums

### GranteeSubscriptionStatusEnum

- `GranteeSubscriptionStatusEnum.PROSPECT`
- `GranteeSubscriptionStatusEnum.FORMER_MEMBER`
- `GranteeSubscriptionStatusEnum.MEMBER`
- `GranteeSubscriptionStatusEnum.DEROGATION`
- `GranteeSubscriptionStatusEnum.SPECIAL_CASE`

### GranteeTypeEnum

- `GranteeTypeEnum.CHILD`
- `GranteeTypeEnum.SPOUSE`
- `GranteeTypeEnum.ASCENDANT_OR_DEPENDANT`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getGranteeAttachedSocialSecurity, getGranteeBirthCity, getGranteeBirthCountry, getGranteeBirthDate, getGranteeBirthName, getGranteeBirthZipCode, getGranteeCivility, getGranteeExternalId, getGranteeFirstName, getGranteeHasEducationAnnuityBeneficiary, getGranteeHasHealthContract, getGranteeHasProtectionContract, getGranteeIsCCS, getGranteeIsTNS, getGranteeLastName, getGranteePercentShare, getGranteeSubscriptionStatus, getGranteeType, getgranteeId, setGranteeAttachedSocialSecurity, setGranteeBirthCity, setGranteeBirthCountry, setGranteeBirthDate, setGranteeBirthName, setGranteeBirthZipCode, setGranteeCivility, setGranteeExternalId, setGranteeFirstName, setGranteeHasEducationAnnuityBeneficiary, setGranteeHasHealthContract, setGranteeHasProtectionContract, setGranteeIsCCS, setGranteeIsTNS, setGranteeLastName, setGranteePercentShare, setGranteeSubscriptionStatus, setGranteeType } from '@fasstech/oip-core/entities/grantee';
import { GranteeTypeEnum, GranteeSubscriptionStatusEnum } from '@fasstech/oip-core/entities/grantee/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  const GranteeEntity = await Entities('Grantee').create();
  
  setGranteeAttachedSocialSecurity(['attachedSocialSecurity'], GranteeEntity);
  setGranteeBirthCity('birthCity', GranteeEntity);
  setGranteeBirthCountry('birthCountry', GranteeEntity);
  setGranteeBirthDate(new Date('2017-01-01'), GranteeEntity);
  setGranteeBirthName('birthName', GranteeEntity);
  setGranteeBirthZipCode('birthZipCode', GranteeEntity);
  setGranteeCivility('civility', GranteeEntity);
  setGranteeExternalId('externalId', GranteeEntity);
  setGranteeFirstName('firstName', GranteeEntity);
  setGranteeHasEducationAnnuityBeneficiary(true, GranteeEntity);
  setGranteeHasHealthContract(true, GranteeEntity);
  setGranteeHasProtectionContract(true, GranteeEntity);
  setGranteeIsCCS(false, GranteeEntity);
  setGranteeIsTNS(false, GranteeEntity);
  setGranteeLastName('lastName', GranteeEntity);
  setGranteePercentShare(112, GranteeEntity);
  setGranteeSubscriptionStatus(GranteeSubscriptionStatusEnum.DEROGATION, GranteeEntity);
  setGranteeType(GranteeTypeEnum.SPOUSE, GranteeEntity);
  
  ProjectEntity = await Entities('Grantee').save(ProjectEntity, GranteeEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const GranteeEntityToTest = await Entities('Grantee').get(ProjectEntityToTest, getGranteeId(GranteeEntity));
  
  getGranteeAttachedSocialSecurity(GranteeEntityToTest); // ['attachedSocialSecurity']
  getGranteeBirthCity(GranteeEntityToTest); // 'birthCity'
  getGranteeBirthCountry(GranteeEntityToTest); // 'birthCountry'
  getGranteeBirthDate(GranteeEntityToTest); // new Date('2017-01-01')
  getGranteeBirthName(GranteeEntityToTest); // 'birthName'
  getGranteeBirthZipCode(GranteeEntityToTest); // 'birthZipCode'
  getGranteeCivility(GranteeEntityToTest); // 'civility'
  getGranteeExternalId(GranteeEntityToTest); // 'externalId'
  getGranteeFirstName(GranteeEntityToTest); // 'firstName'
  getGranteeHasEducationAnnuityBeneficiary(GranteeEntityToTest); // true
  getGranteeHasHealthContract(GranteeEntityToTest); // true
  getGranteeHasProtectionContract(GranteeEntityToTest); // true
  getGranteeIsCCS(GranteeEntityToTest); // false
  getGranteeIsTNS(GranteeEntityToTest); // false
  getGranteeLastName(GranteeEntityToTest); // 'lastName'
  getGranteePercentShare(GranteeEntityToTest); // 112
  getGranteeSubscriptionStatus(GranteeEntityToTest); // GranteeSubscriptionStatusEnum.DEROGATION
  getGranteeType(GranteeEntityToTest); // GranteeTypeEnum.SPOUSE
})();
```
