Grantee
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 |
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
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'
})();