---
title: Customer
slug: oip-next/jqbtpjpfk6ynolkjbgxxd
createdAt: 2024-02-21T13:40:09.000Z
---

# Customer

## Description

L'entité Customer contient les données d'un utilisateur client.

## Relations

### Ascendantes

| Entité  | Propriété |
| ------- | --------- |
| Project | customer  |

### Descendantes

| Entité          | Propriété       |
| --------------- | --------------- |
| CSP             | CSPs            |
| GDPR            | GDPRs           |
| ActivePolicy    | activePolicies  |
| Address         | address         |
| Address         | addresses       |
| Aml             | aml             |
| BankAccount     | bankAccount     |
| BankAccount     | bankAccounts    |
| Email           | emails          |
| Finance         | finance         |
| History         | history         |
| LegalProfile    | legalProfile    |
| Markup          | markups         |
| PersonalProfile | personalProfile |
| Phone           | phones          |
| SocialSecurity  | socialSecurity  |

## Liste des propriétés

| Nom                           | Type                                    | Dernière version modifiée | Description                                                                                                                                                                                                    | Getter                                   | Setter                                   | Deprecated                                                              |
| ----------------------------- | --------------------------------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ---------------------------------------- | ----------------------------------------------------------------------- |
| SSNumber                      | `String`                                | 1.4.0                     | Numéro de sécurité sociale                                                                                                                                                                                     | getCustomerSSNumber                      | setCustomerSSNumber                      | -                                                                       |
| birthCity                     | `String`                                | 1.5.0                     | Ville de naissance                                                                                                                                                                                             | getCustomerBirthCity                     | setCustomerBirthCity                     | -                                                                       |
| birthCountry                  | `String`                                | 1.5.0                     | Pays de naissance                                                                                                                                                                                              | getCustomerBirthCountry                  | setCustomerBirthCountry                  | -                                                                       |
| birthDate                     | `Date`                                  | 2.0.0                     | Date de naissance                                                                                                                                                                                              | getCustomerBirthDate                     | setCustomerBirthDate                     | -                                                                       |
| birthDatePartner              | `Date`                                  | 2.0.0                     | Date de naissance du conjoint                                                                                                                                                                                  | getCustomerBirthDatePartner              | setCustomerBirthDatePartner              | -                                                                       |
| birthName                     | `String`                                | 1.4.0                     | Nom de naissance                                                                                                                                                                                               | getCustomerBirthName                     | setCustomerBirthName                     | -                                                                       |
| birthZipCode                  | `String`                                |                           | Code postal de naissance                                                                                                                                                                                       | getCustomerBirthZipCode                  | setCustomerBirthZipCode                  | -                                                                       |
| civility                      | `CivilityEnum`                          | 2.1.1                     | Civilité                                                                                                                                                                                                       | getCustomerCivility                      | setCustomerCivility                      | -                                                                       |
| corporateName                 | `String`                                | 2.1.1                     | Nom de la société                                                                                                                                                                                              | getCustomerCorporateName                 | setCustomerCorporateName                 | -                                                                       |
| createdAt                     | `Date`                                  |                           | Date de création de l'entité `Customer`                                                                                                                                                                        | getCustomerCreatedAt                     | Lecture seule                            | -                                                                       |
| createdBy                     | `String`                                |                           | Utilisateur à l'origine de la création de l'entité `Customer`                                                                                                                                                  | getCustomerCreatedBy                     | Lecture seule                            | -                                                                       |
| dependentChildren             | `Number`                                | 1.5.0                     | Nombre d'enfants à charge                                                                                                                                                                                      | getCustomerDependentChildren             | setCustomerDependentChildren             | -                                                                       |
| email                         | `String`                                | 1.5.0                     | Email                                                                                                                                                                                                          | getCustomerEmail                         | setCustomerEmail                         | Utiliser l'entité email                                                 |
| externalId                    | `String`                                | 2.4.0                     | Identifiant externe                                                                                                                                                                                            | getCustomerExternalId                    | setCustomerExternalId                    | -                                                                       |
| firstName                     | `String`                                | 2.1.1                     | Prénom                                                                                                                                                                                                         | getCustomerFirstName                     | setCustomerFirstName                     | -                                                                       |
| hasCertifiedOnTheHonor        | `Boolean`                               | 1.4.0                     | Certifie sur l'honneur de l'exactitude des données renseignées                                                                                                                                                 | getCustomerHasCertifiedOnTheHonor        | setCustomerHasCertifiedOnTheHonor        | -                                                                       |
| hasRelationPoliticallyExposed | `String`                                | 2.1.1                     | A une relation avec une personne exposée politiquement                                                                                                                                                         | getCustomerHasRelationPoliticallyExposed | setCustomerHasRelationPoliticallyExposed | -                                                                       |
| healthReimbursementMethod     | `CustomerHealthReimbursementMethodEnum` | 2.4.0                     | Mode de remboursement                                                                                                                                                                                          | getCustomerHealthReimbursementMethod     | setCustomerHealthReimbursementMethod     | -                                                                       |
| id                            | `String`                                |                           | Identifiant unique de l'entité `Customer`                                                                                                                                                                      | getCustomerId                            | Lecture seule                            | -                                                                       |
| isAlsaceMoselle               | `Boolean`                               | 2.4.0                     | Dépend ou non du régime d'Alsace-Moselle                                                                                                                                                                       | getCustomerIsAlsaceMoselle               | setCustomerIsAlsaceMoselle               | -                                                                       |
| isDigitalContract             | `Boolean`                               | 2.4.0                     | Indique si le client accepte de recevoir les documents contractuels de manière dématérialisée (email, disponible dans espace adhérent)                                                                         | getCustomerIsDigitalContract             | setCustomerIsDigitalContract             | -                                                                       |
| isDigitalHealthInsuranceCard  | `Boolean`                               | 2.4.0                     | Indique si la carte tiers payant a été optée au format dématérialisé                                                                                                                                           | getCustomerIsDigitalHealthInsuranceCard  | setCustomerIsDigitalHealthInsuranceCard  | -                                                                       |
| isMadelin                     | `Boolean`                               | 2.4.0                     | La « loi Madelin » permet au travailleur non salarié (TNS) de déduire de son revenu imposable les cotisations sur un contrat Madelin                                                                           | getCustomerIsMadelin                     | setCustomerIsMadelin                     | Cette information est portée par la propriété isMadelin de l'entité TNS |
| isMember                      | `Boolean`                               | 1.4.0                     | Est membre                                                                                                                                                                                                     | getCustomerIsMember                      | setCustomerIsMember                      | -                                                                       |
| isPoliticallyExposed          | `IsPoliticallyExposedEnum`              | 2.1.1                     | Est une personne exposée politiquement                                                                                                                                                                         | getCustomerIsPoliticallyExposed          | setCustomerIsPoliticallyExposed          | -                                                                       |
| isTns                         | `Boolean`                               | 1.4.0                     | Est un travailleur non salarié (TNS)                                                                                                                                                                           | getCustomerIsTns                         | setCustomerIsTns                         | Cette information est portée par l'entité TNS                           |
| lastName                      | `String`                                | 2.1.1                     | Nom                                                                                                                                                                                                            | getCustomerLastName                      | setCustomerLastName                      | -                                                                       |
| madelinMonth                  | `MadelinMonthEnum`                      | 2.6.0                     | La « loi Madelin » permet au travailleur non salarié (TNS) de déduire de son revenu imposable les cotisations sur un contrat Madelin. L'imposition est donc liée au mois d'exercice fiscal du TNS déclaré ici. | getCustomerMadelinMonth                  | setCustomerMadelinMonth                  | -                                                                       |
| maritalStatus                 | `MaritalStatusEnum`                     | 2.1.1                     | Situation familiale                                                                                                                                                                                            | getCustomerMaritalStatus                 | setCustomerMaritalStatus                 | -                                                                       |
| mobilePhoneIndicative         | `String`                                | 2.1.1                     | Indicatif téléphonique mobile                                                                                                                                                                                  | getCustomerMobilePhoneIndicative         | setCustomerMobilePhoneIndicative         | Utiliser l'entité phone                                                 |
| mobilePhoneNumber             | `String`                                | 2.1.1                     | Numéro de téléphone mobile                                                                                                                                                                                     | getCustomerMobilePhoneNumber             | setCustomerMobilePhoneNumber             | Utiliser l'entité phone                                                 |
| nationality                   | `NationalityEnum`                       | 2.1.1                     | Nationalité                                                                                                                                                                                                    | getCustomerNationality                   | setCustomerNationality                   | -                                                                       |
| phoneIndicative               | `String`                                | 2.1.1                     | Indicatif téléphonique                                                                                                                                                                                         | getCustomerPhoneIndicative               | setCustomerPhoneIndicative               | Utiliser l'entité phone                                                 |
| phoneNumber                   | `String`                                | 2.1.1                     | Numéro de téléphone                                                                                                                                                                                            | getCustomerPhoneNumber                   | setCustomerPhoneNumber                   | Utiliser l'entité phone                                                 |
| professionalActivity          | `ProfessionalActivityEnum`              | 2.1.1                     | Activité professionnelle                                                                                                                                                                                       | getCustomerProfessionalActivity          | setCustomerProfessionalActivity          | -                                                                       |
| professionalStatus            | `ProfessionalStatusEnum`                | 2.1.1                     | Statut professionnel                                                                                                                                                                                           | getCustomerProfessionalStatus            | setCustomerProfessionalStatus            | -                                                                       |
| regime                        | `RegimeEnum`                            | 1.4.0                     | Régime de sécurité sociale                                                                                                                                                                                     | getCustomerRegime                        | setCustomerRegime                        | -                                                                       |
| regimeSpecification           | `String`                                | 1.4.0                     | Spécificité du régime de sécurité sociale                                                                                                                                                                      | getCustomerRegimeSpecification           | setCustomerRegimeSpecification           | -                                                                       |
| retirementAge                 | `Number`                                | 2.0.0                     | Age de départ à la retraite                                                                                                                                                                                    | getCustomerRetirementAge                 | setCustomerRetirementAge                 | -                                                                       |
| subscriptionStatus            | `CustomerSubscriptionStatusEnum`        | 2.8.0                     | Statut de souscription du client au moment du parcours OAV.                                                                                                                                                    | getCustomerSubscriptionStatus            | setCustomerSubscriptionStatus            | -                                                                       |
| updatedAt                     | `Date`                                  |                           | Date de modification de l'entité `Customer`                                                                                                                                                                    | getCustomerUpdatedAt                     | Lecture seule                            | -                                                                       |
| updatedBy                     | `String`                                |                           | Utilisateur à l'origine de la modification de l'entité `Customer`                                                                                                                                              | getCustomerUpdatedBy                     | Lecture seule                            | -                                                                       |

## Enums

### CivilityEnum

- `CivilityEnum.MISS`
- `CivilityEnum.MISTER`

### CustomerHealthReimbursementMethodEnum

- `CustomerHealthReimbursementMethodEnum.BOTH`
- `CustomerHealthReimbursementMethodEnum.DIGITAL`
- `CustomerHealthReimbursementMethodEnum.POSTAL`

### CustomerSubscriptionStatusEnum

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

### IsPoliticallyExposedEnum

- `IsPoliticallyExposedEnum.NO`
- `IsPoliticallyExposedEnum.YES`
- `IsPoliticallyExposedEnum.YES_LAST_12M`

### MadelinMonthEnum

- `MadelinMonthEnum.JANUARY`
- `MadelinMonthEnum.FEBRUARY`
- `MadelinMonthEnum.MARCH`
- `MadelinMonthEnum.APRIL`
- `MadelinMonthEnum.MAY`
- `MadelinMonthEnum.JUNE`
- `MadelinMonthEnum.JULY`
- `MadelinMonthEnum.AUGUST`
- `MadelinMonthEnum.SEPTEMBER`
- `MadelinMonthEnum.OCTOBER`
- `MadelinMonthEnum.NOVEMBER`
- `MadelinMonthEnum.DECEMBER`

### MaritalStatusEnum

- `MaritalStatusEnum.COUPLE`
- `MaritalStatusEnum.DIVORCED`
- `MaritalStatusEnum.MARRIED`
- `MaritalStatusEnum.PACS`
- `MaritalStatusEnum.SINGLE`
- `MaritalStatusEnum.WIDOW`

### NationalityEnum

- `NationalityEnum.FRENCH` => `FRANCAISE`
- `NationalityEnum.OTHER` => `AUTRE`

### ProfessionalActivityEnum

- `ProfessionalActivityEnum.COLLABORATING_PARTNER`
- `ProfessionalActivityEnum.EMPLOYEE_PUBLIC_REPRESENTATIVE`
- `ProfessionalActivityEnum.ENTREPRENEUR`
- `ProfessionalActivityEnum.LIBERAL`
- `ProfessionalActivityEnum.SELF_EMPLOYED`
- `ProfessionalActivityEnum.SPOUSE_COLLABORATOR`
- `ProfessionalActivityEnum.UNEMPLOYED`

### ProfessionalStatusEnum

- `ProfessionalStatusEnum.COLLABORATING_PARTNER`
- `ProfessionalStatusEnum.COLLABORATOR`
- `ProfessionalStatusEnum.EMPLOYED_REPRESENTATIVE`
- `ProfessionalStatusEnum.EMPLOYEE`
- `ProfessionalStatusEnum.ENTREPRENEUR`
- `ProfessionalStatusEnum.LIBERAL`
- `ProfessionalStatusEnum.RETIRED`
- `ProfessionalStatusEnum.SELF_EMPLOYED`
- `ProfessionalStatusEnum.STUDENT`
- `ProfessionalStatusEnum.UNEMPLOYED`

### RegimeEnum

- `RegimeEnum.REGIME_AGRICOLE`
- `RegimeEnum.REGIME_GLOBAL`
- `RegimeEnum.REGIME_INDEPENDANT`
- `RegimeEnum.REGIME_LOCAL`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCustomerBirthCity, getCustomerBirthCountry, getCustomerBirthDate, getCustomerBirthDatePartner, getCustomerBirthName, getCustomerBirthZipCode, getCustomerCivility, getCustomerCorporateName, getCustomerDependentChildren, getCustomerEmail, getCustomerExternalId, getCustomerFirstName, getCustomerHasCertifiedOnTheHonor, getCustomerHasRelationPoliticallyExposed, getCustomerHealthReimbursementMethod, getCustomerIsAlsaceMoselle, getCustomerIsDigitalContract, getCustomerIsDigitalHealthInsuranceCard, getCustomerIsMadelin, getCustomerIsMember, getCustomerIsPoliticallyExposed, getCustomerIsTns, getCustomerLastName, getCustomerMadelinMonth, getCustomerMaritalStatus, getCustomerMobilePhoneIndicative, getCustomerMobilePhoneNumber, getCustomerNationality, getCustomerPhoneIndicative, getCustomerPhoneNumber, getCustomerProfessionalActivity, getCustomerProfessionalStatus, getCustomerRegime, getCustomerRegimeSpecification, getCustomerRetirementAge, getCustomerSSNumber, getCustomerSubscriptionStatus, setCustomerBirthCity, setCustomerBirthCountry, setCustomerBirthDate, setCustomerBirthDatePartner, setCustomerBirthName, setCustomerBirthZipCode, setCustomerCivility, setCustomerCorporateName, setCustomerDependentChildren, setCustomerEmail, setCustomerExternalId, setCustomerFirstName, setCustomerHasCertifiedOnTheHonor, setCustomerHasRelationPoliticallyExposed, setCustomerHealthReimbursementMethod, setCustomerIsAlsaceMoselle, setCustomerIsDigitalContract, setCustomerIsDigitalHealthInsuranceCard, setCustomerIsMadelin, setCustomerIsMember, setCustomerIsPoliticallyExposed, setCustomerIsTns, setCustomerLastName, setCustomerMadelinMonth, setCustomerMaritalStatus, setCustomerMobilePhoneIndicative, setCustomerMobilePhoneNumber, setCustomerNationality, setCustomerPhoneIndicative, setCustomerPhoneNumber, setCustomerProfessionalActivity, setCustomerProfessionalStatus, setCustomerRegime, setCustomerRegimeSpecification, setCustomerRetirementAge, setCustomerSSNumber, setCustomerSubscriptionStatus } from '@fasstech/oip-core/entities/customer';
import { CivilityEnum, CustomerHealthReimbursementMethodEnum, MadelinMonthEnum, IsPoliticallyExposedEnum, MaritalStatusEnum, NationalityEnum, ProfessionalActivityEnum, ProfessionalStatusEnum, RegimeEnum, CustomerSubscriptionStatusEnum } from '@fasstech/oip-core/entities/customer/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  const CustomerEntity = await Entities('Customer').get(ProjectEntity);
  
  setCustomerSSNumber('SSNumber', CustomerEntity);
  setCustomerBirthCity('birthCity', CustomerEntity);
  setCustomerBirthCountry('birthCountry', CustomerEntity);
  setCustomerBirthDate(new Date('2017-01-01'), CustomerEntity);
  setCustomerBirthDatePartner(new Date('2017-01-01'), CustomerEntity);
  setCustomerBirthName('birthName', CustomerEntity);
  setCustomerBirthZipCode('birthZipCode', CustomerEntity);
  setCustomerCivility(CivilityEnum.MISTER, CustomerEntity);
  setCustomerCorporateName('corporateName', CustomerEntity);
  setCustomerDependentChildren(100, CustomerEntity);
  setCustomerEmail('email', CustomerEntity);
  setCustomerExternalId('externalId', CustomerEntity);
  setCustomerFirstName('firstName', CustomerEntity);
  setCustomerHasCertifiedOnTheHonor(true, CustomerEntity);
  setCustomerHasRelationPoliticallyExposed('hasRelationPoliticallyExposed', CustomerEntity);
  setCustomerHealthReimbursementMethod(CustomerHealthReimbursementMethodEnum.POSTAL, CustomerEntity);
  setCustomerIsAlsaceMoselle(false, CustomerEntity);
  setCustomerIsDigitalContract(false, CustomerEntity);
  setCustomerIsDigitalHealthInsuranceCard(false, CustomerEntity);
  setCustomerIsMadelin(false, CustomerEntity);
  setCustomerIsMember(false, CustomerEntity);
  setCustomerIsPoliticallyExposed(IsPoliticallyExposedEnum.NO, CustomerEntity);
  setCustomerIsTns(false, CustomerEntity);
  setCustomerLastName('lastName', CustomerEntity);
  setCustomerMadelinMonth(MadelinMonthEnum.AUGUST, CustomerEntity);
  setCustomerMaritalStatus(MaritalStatusEnum.DIVORCED, CustomerEntity);
  setCustomerMobilePhoneIndicative('mobilePhoneIndicative', CustomerEntity);
  setCustomerMobilePhoneNumber('mobilePhoneNumber', CustomerEntity);
  setCustomerNationality(NationalityEnum.FRENCH, CustomerEntity);
  setCustomerPhoneIndicative('phoneIndicative', CustomerEntity);
  setCustomerPhoneNumber('phoneNumber', CustomerEntity);
  setCustomerProfessionalActivity(ProfessionalActivityEnum.COLLABORATING_PARTNER, CustomerEntity);
  setCustomerProfessionalStatus(ProfessionalStatusEnum.EMPLOYED_REPRESENTATIVE, CustomerEntity);
  setCustomerRegime(RegimeEnum.REGIME_INDEPENDANT, CustomerEntity);
  setCustomerRegimeSpecification('regimeSpecification', CustomerEntity);
  setCustomerRetirementAge(114, CustomerEntity);
  setCustomerSubscriptionStatus(CustomerSubscriptionStatusEnum.DEROGATION, CustomerEntity);
  
  ProjectEntity = await Entities('Customer').save(ProjectEntity, CustomerEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const CustomerEntityToTest = await Entities('Customer').get(ProjectEntityToTest);
  
  getCustomerSSNumber(CustomerEntityToTest); // 'SSNumber'
  getCustomerBirthCity(CustomerEntityToTest); // 'birthCity'
  getCustomerBirthCountry(CustomerEntityToTest); // 'birthCountry'
  getCustomerBirthDate(CustomerEntityToTest); // new Date('2017-01-01')
  getCustomerBirthDatePartner(CustomerEntityToTest); // new Date('2017-01-01')
  getCustomerBirthName(CustomerEntityToTest); // 'birthName'
  getCustomerBirthZipCode(CustomerEntityToTest); // 'birthZipCode'
  getCustomerCivility(CustomerEntityToTest); // CivilityEnum.MISTER
  getCustomerCorporateName(CustomerEntityToTest); // 'corporateName'
  getCustomerDependentChildren(CustomerEntityToTest); // 100
  getCustomerEmail(CustomerEntityToTest); // 'email'
  getCustomerExternalId(CustomerEntityToTest); // 'externalId'
  getCustomerFirstName(CustomerEntityToTest); // 'firstName'
  getCustomerHasCertifiedOnTheHonor(CustomerEntityToTest); // true
  getCustomerHasRelationPoliticallyExposed(CustomerEntityToTest); // 'hasRelationPoliticallyExposed'
  getCustomerHealthReimbursementMethod(CustomerEntityToTest); // CustomerHealthReimbursementMethodEnum.POSTAL
  getCustomerIsAlsaceMoselle(CustomerEntityToTest); // false
  getCustomerIsDigitalContract(CustomerEntityToTest); // false
  getCustomerIsDigitalHealthInsuranceCard(CustomerEntityToTest); // false
  getCustomerIsMadelin(CustomerEntityToTest); // false
  getCustomerIsMember(CustomerEntityToTest); // false
  getCustomerIsPoliticallyExposed(CustomerEntityToTest); // IsPoliticallyExposedEnum.NO
  getCustomerIsTns(CustomerEntityToTest); // false
  getCustomerLastName(CustomerEntityToTest); // 'lastName'
  getCustomerMadelinMonth(CustomerEntityToTest); // MadelinMonthEnum.AUGUST
  getCustomerMaritalStatus(CustomerEntityToTest); // MaritalStatusEnum.DIVORCED
  getCustomerMobilePhoneIndicative(CustomerEntityToTest); // 'mobilePhoneIndicative'
  getCustomerMobilePhoneNumber(CustomerEntityToTest); // 'mobilePhoneNumber'
  getCustomerNationality(CustomerEntityToTest); // NationalityEnum.FRENCH
  getCustomerPhoneIndicative(CustomerEntityToTest); // 'phoneIndicative'
  getCustomerPhoneNumber(CustomerEntityToTest); // 'phoneNumber'
  getCustomerProfessionalActivity(CustomerEntityToTest); // ProfessionalActivityEnum.COLLABORATING_PARTNER
  getCustomerProfessionalStatus(CustomerEntityToTest); // ProfessionalStatusEnum.EMPLOYED_REPRESENTATIVE
  getCustomerRegime(CustomerEntityToTest); // RegimeEnum.REGIME_INDEPENDANT
  getCustomerRegimeSpecification(CustomerEntityToTest); // 'regimeSpecification'
  getCustomerRetirementAge(CustomerEntityToTest); // 114
  getCustomerSubscriptionStatus(CustomerEntityToTest); // CustomerSubscriptionStatusEnum.DEROGATION
})();
```
