---
title: Grantee
slug: oip-next/m857d-ufnfnyikrh6xefg
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.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             | amls                         |
| Relation        | attachedSocialSecurityNumber |
| BankAccount     | bankAccounts                 |
| Email           | emails                       |
| History         | history                      |
| LegalProfile    | legalProfiles                |
| OfferNode       | offerNodes                   |
| PersonalProfile | personalProfiles             |
| Phone           | phones                       |
| SocialSecurity  | socialSecurities             |

## Propriétés

| Nom                            | Type                            | Description                                                                       | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------------------------ | ------------------------------- | --------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| birthCity                      | `String`                        | Ville de naissance                                                                |            |                 |             | 1.5.0                     |
| birthCountry                   | `String`                        | Pays de naissance                                                                 |            |                 |             | 2.0.0                     |
| birthDate                      | `Date`                          | Date de naissance                                                                 |            |                 |             | 2.0.0                     |
| birthName                      | `String`                        | Nom de naissance                                                                  |            |                 |             | 2.0.0                     |
| birthZipCode                   | `String`                        | Code postal de naissance                                                          |            |                 |             |                           |
| civility                       | `String`                        | Civilité                                                                          |            |                 |             | 2.0.0                     |
| firstName                      | `String`                        | Prénom                                                                            |            |                 |             | 2.0.0                     |
| hasEducationAnnuityBeneficiary | `Boolean`                       | Le souscripteur déclare avoir des bénéficiaires d'une rente éducation             |            |                 |             | 2.1.1                     |
| hasHealthContract              | `Boolean`                       | Le bénéficiaire est actuellement couverte par un contrat de santé                 |            |                 |             | 2.1.1                     |
| hasProtectionContract          | `Boolean`                       | Le bénéficiaire est actuellement couverte par un contrat de prévoyance            |            |                 |             | 2.1.1                     |
| isTNS                          | `Boolean`                       | Indique si le bénéficiaire est TNS                                                |            |                 |             |                           |
| lastName                       | `String`                        | Nom                                                                               |            |                 |             | 2.0.0                     |
| legalProtection                | `GranteeLegalProtectionEnum`    | Type de protection juridique du client                                            |            |                 |             | 3.12.0                    |
| percentShare                   | `Number`                        | Pourcentage du bénéficiaire en cas de décès                                       |            |                 |             | 2.1.1                     |
| subscriptionStatus             | `GranteeSubscriptionStatusEnum` | status de souscription du client au moment du parcours OAV                        |            |                 |             | 2.8.0                     |
| type                           | `GranteeTypeEnum`               | Type de bénéficiaire : enfant, conjoint                                           |            |                 |             | 2.1.1                     |
| id                             | `String`                        | Identifiant de l'entité `Grantee`                                                 |            | X               |             |                           |
| code                           | `String`                        | Codification fonctionnelle de l'entité `Grantee`                                  |            |                 |             |                           |
| externalId                     | `String`                        | Identifiant de l'entité `Grantee` dans le système client                          |            |                 |             |                           |
| externalCode                   | `String`                        | Codification fonctionnelle de l'entité `Grantee` dans le système client           |            |                 |             |                           |
| granteeId                      | `String`                        | Identifiant public de l'entité `Grantee` dans l'OIP                               |            |                 |             |                           |
| label                          | `String`                        | Information relative au nom de l'entité `Grantee` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt                      | `Date`                          | Date de création de l'entité `Grantee`                                            |            | X               |             |                           |
| updatedAt                      | `Date`                          | Date de modification de l'entité `Grantee`                                        |            | X               |             |                           |

## Enumérations

### GranteeLegalProtectionEnum

- `GUARDIANSHIP`
- `LIMITED_GUARDIANSHIP`
- `NONE`

### GranteeSubscriptionStatusEnum

- `DEROGATION`
- `FORMER_MEMBER`
- `MEMBER`
- `PROSPECT`
- `SPECIAL_CASE`

### GranteeTypeEnum

- `ASCENDANT_OR_DEPENDANT`
- `CHILD`
- `SPOUSE`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getGranteeBirthCity, getGranteeBirthCountry, getGranteeBirthDate, getGranteeBirthName, getGranteeBirthZipCode, getGranteeCivility, getGranteeCode, getGranteeExternalCode, getGranteeExternalId, getGranteeFirstName, getGranteeGranteeId, getGranteeHasEducationAnnuityBeneficiary, getGranteeHasHealthContract, getGranteeHasProtectionContract, getGranteeId, getGranteeIsTNS, getGranteeLabel, getGranteeLastName, getGranteeLegalProtection, getGranteePercentShare, getGranteeSubscriptionStatus, getGranteeType, setGranteeBirthCity, setGranteeBirthCountry, setGranteeBirthDate, setGranteeBirthName, setGranteeBirthZipCode, setGranteeCivility, setGranteeCode, setGranteeExternalCode, setGranteeExternalId, setGranteeFirstName, setGranteeGranteeId, setGranteeHasEducationAnnuityBeneficiary, setGranteeHasHealthContract, setGranteeHasProtectionContract, setGranteeIsTNS, setGranteeLabel, setGranteeLastName, setGranteeLegalProtection, setGranteePercentShare, setGranteeSubscriptionStatus, setGranteeType } from '@fasstech/oip-core/entities/Grantee';
import { GranteeLegalProtectionEnum, GranteeSubscriptionStatusEnum, GranteeTypeEnum } from '@fasstech/oip-core/entities/Grantee/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  const grantee = await Entities('Grantee').create();
  
  setGranteeBirthCity('birthCity', grantee);
  setGranteeBirthCountry('birthCountry', grantee);
  setGranteeBirthDate(new Date('2017-01-01'), grantee);
  setGranteeBirthName('birthName', grantee);
  setGranteeBirthZipCode('birthZipCode', grantee);
  setGranteeCivility('civility', grantee);
  setGranteeFirstName('firstName', grantee);
  setGranteeHasEducationAnnuityBeneficiary(true, grantee);
  setGranteeHasHealthContract(true, grantee);
  setGranteeHasProtectionContract(true, grantee);
  setGranteeIsTNS(false, grantee);
  setGranteeLastName('lastName', grantee);
  setGranteeLegalProtection(GranteeLegalProtectionEnum.GUARDIANSHIP, grantee);
  setGranteePercentShare(112, grantee);
  setGranteeSubscriptionStatus(GranteeSubscriptionStatusEnum.DEROGATION, grantee);
  setGranteeType(GranteeTypeEnum.SPOUSE, grantee);
  setGranteeCode('code', grantee);
  setGranteeExternalId('externalId', grantee);
  setGranteeExternalCode('externalCode', grantee);
  setGranteeGranteeId('granteeId', grantee);
  setGranteeLabel('label', grantee);
  
  project = await Entities('Grantee').save(project, grantee);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const granteeToTest = await Entities('Grantee').get(projectToTest, { filter: ({ id }) => id === getGranteeId(grantee) });
  
  getGranteeBirthCity(granteeToTest); // 'birthCity'
  getGranteeBirthCountry(granteeToTest); // 'birthCountry'
  getGranteeBirthDate(granteeToTest); // new Date('2017-01-01')
  getGranteeBirthName(granteeToTest); // 'birthName'
  getGranteeBirthZipCode(granteeToTest); // 'birthZipCode'
  getGranteeCivility(granteeToTest); // 'civility'
  getGranteeFirstName(granteeToTest); // 'firstName'
  getGranteeHasEducationAnnuityBeneficiary(granteeToTest); // true
  getGranteeHasHealthContract(granteeToTest); // true
  getGranteeHasProtectionContract(granteeToTest); // true
  getGranteeIsTNS(granteeToTest); // false
  getGranteeLastName(granteeToTest); // 'lastName'
  getGranteeLegalProtection(granteeToTest); // GranteeLegalProtectionEnum.GUARDIANSHIP
  getGranteePercentShare(granteeToTest); // 112
  getGranteeSubscriptionStatus(granteeToTest); // GranteeSubscriptionStatusEnum.DEROGATION
  getGranteeType(granteeToTest); // GranteeTypeEnum.SPOUSE
  getGranteeCode(granteeToTest); // 'code'
  getGranteeExternalId(granteeToTest); // 'externalId'
  getGranteeExternalCode(granteeToTest); // 'externalCode'
  getGranteeGranteeId(granteeToTest); // 'granteeId'
  getGranteeLabel(granteeToTest); // 'label'
})();
```
