---
title: Customer
slug: oip-next/3xgj5hdx0c0fxqkjh7ql
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# Customer

## Description

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

## Relations

### Ascendantes

| Entité  | Propriété |
| ------- | --------- |
| Project | customers |

### Descendantes

| Entité          | Propriété        |
| --------------- | ---------------- |
| CSP             | CSPs             |
| GDPR            | GDPRs            |
| ActivePolicy    | activePolicies   |
| Address         | addresses        |
| Aml             | amls             |
| BankAccount     | bankAccounts     |
| Email           | emails           |
| Finance         | finances         |
| 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 |
| ---------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| SSNumber                     | `String`                                | Numéro de sécurité sociale                                                                                                                                                                                     |            |                 |             | 1.4.0                     |
| birthCity                    | `String`                                | Ville de naissance                                                                                                                                                                                             |            |                 |             | 1.5.0                     |
| birthCountry                 | `String`                                | Pays de naissance                                                                                                                                                                                              |            |                 |             | 1.5.0                     |
| birthDate                    | `Date`                                  | Date de naissance                                                                                                                                                                                              |            |                 |             | 2.0.0                     |
| birthDatePartner             | `Date`                                  | Date de naissance du conjoint                                                                                                                                                                                  |            |                 |             | 2.0.0                     |
| birthName                    | `String`                                | Nom de naissance                                                                                                                                                                                               |            |                 |             | 1.4.0                     |
| birthZipCode                 | `String`                                | Code postal de naissance                                                                                                                                                                                       |            |                 |             |                           |
| civility                     | `CivilityEnum`                          | Civilité                                                                                                                                                                                                       |            |                 |             | 2.1.1                     |
| corporateName                | `String`                                | Nom de la société                                                                                                                                                                                              |            |                 |             | 2.1.1                     |
| dependentChildren            | `Number`                                | Nombre d'enfants à charge                                                                                                                                                                                      |            |                 |             | 1.5.0                     |
| firstName                    | `String`                                | Prénom                                                                                                                                                                                                         |            |                 |             | 2.1.1                     |
| hasCertifiedOnTheHonor       | `Boolean`                               | Certifie sur l'honneur de l'exactitude des données renseignées                                                                                                                                                 |            |                 |             | 1.4.0                     |
| healthReimbursementMethod    | `CustomerHealthReimbursementMethodEnum` | Mode de remboursement                                                                                                                                                                                          |            |                 |             | 2.4.0                     |
| isAlsaceMoselle              | `Boolean`                               | Dépend ou non du régime d'Alsace-Moselle                                                                                                                                                                       |            |                 |             | 2.4.0                     |
| isDigitalContract            | `Boolean`                               | Indique si le client accepte de recevoir les documents contractuels de manière dématérialisée (email, disponible dans espace adhérent)                                                                         |            |                 |             | 2.4.0                     |
| isDigitalHealthInsuranceCard | `Boolean`                               | Indique si la carte tiers payant a été optée au format dématérialisé                                                                                                                                           |            |                 |             | 2.4.0                     |
| isMember                     | `Boolean`                               | Est membre                                                                                                                                                                                                     |            |                 |             | 1.4.0                     |
| lastName                     | `String`                                | Nom                                                                                                                                                                                                            |            |                 |             | 2.1.1                     |
| legalProtection              | `CustomerLegalProtectionEnum`           | Type de protection juridique du client                                                                                                                                                                         |            |                 |             | 3.12.0                    |
| madelinMonth                 | `MonthEnum`                             | 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. |            |                 |             | 2.6.0                     |
| maritalStatus                | `MaritalStatusEnum`                     | Situation familiale                                                                                                                                                                                            |            |                 |             | 2.1.1                     |
| nationality                  | `CustomerNationalityEnum`               | Nationalité                                                                                                                                                                                                    |            |                 |             | 2.1.1                     |
| professionalActivity         | `ProfessionalActivityEnum`              | Activité professionnelle                                                                                                                                                                                       |            |                 |             | 2.1.1                     |
| professionalStatus           | `CustomerProfessionalStatusEnum`        | Statut professionnel                                                                                                                                                                                           |            |                 |             | 2.1.1                     |
| regime                       | `RegimeEnum`                            | Régime de sécurité sociale                                                                                                                                                                                     |            |                 |             | 1.4.0                     |
| regimeSpecification          | `String`                                | Spécificité du régime de sécurité sociale                                                                                                                                                                      |            |                 |             | 1.4.0                     |
| retirementAge                | `Number`                                | Age de départ à la retraite                                                                                                                                                                                    |            |                 |             | 2.0.0                     |
| subscriptionStatus           | `CustomerSubscriptionStatusEnum`        | Statut de souscription du client au moment du parcours OAV.                                                                                                                                                    |            |                 |             | 2.8.0                     |
| id                           | `String`                                | Identifiant de l'entité `Customer`                                                                                                                                                                             |            | X               |             |                           |
| code                         | `String`                                | Codification fonctionnelle de l'entité `Customer`                                                                                                                                                              |            |                 |             |                           |
| externalId                   | `String`                                | Identifiant de l'entité `Customer` dans le système client                                                                                                                                                      |            |                 |             |                           |
| externalCode                 | `String`                                | Codification fonctionnelle de l'entité `Customer` dans le système client                                                                                                                                       |            |                 |             |                           |
| customerId                   | `String`                                | Identifiant public de l'entité `Customer` dans l'OIP                                                                                                                                                           |            |                 |             |                           |
| label                        | `String`                                | Information relative au nom de l'entité `Customer` dans son contexte d'utilisation                                                                                                                             |            |                 |             |                           |
| createdAt                    | `Date`                                  | Date de création de l'entité `Customer`                                                                                                                                                                        |            | X               |             |                           |
| updatedAt                    | `Date`                                  | Date de modification de l'entité `Customer`                                                                                                                                                                    |            | X               |             |                           |

## Enumérations

### CustomerHealthReimbursementMethodEnum

- `BOTH`
- `DIGITAL`
- `POSTAL`

### CustomerLegalProtectionEnum

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

### CustomerNationalityEnum

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

### CustomerProfessionalStatusEnum

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

### CustomerSubscriptionStatusEnum

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

## Enumérations génériques

- CivilityEnum
- MaritalStatusEnum
- MonthEnum
- ProfessionalActivityEnum
- RegimeEnum

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCustomerBirthCity, getCustomerBirthCountry, getCustomerBirthDate, getCustomerBirthDatePartner, getCustomerBirthName, getCustomerBirthZipCode, getCustomerCivility, getCustomerCode, getCustomerCorporateName, getCustomerCustomerId, getCustomerDependentChildren, getCustomerExternalCode, getCustomerExternalId, getCustomerFirstName, getCustomerHasCertifiedOnTheHonor, getCustomerHealthReimbursementMethod, getCustomerId, getCustomerIsAlsaceMoselle, getCustomerIsDigitalContract, getCustomerIsDigitalHealthInsuranceCard, getCustomerIsMember, getCustomerLabel, getCustomerLastName, getCustomerLegalProtection, getCustomerMadelinMonth, getCustomerMaritalStatus, getCustomerNationality, getCustomerProfessionalActivity, getCustomerProfessionalStatus, getCustomerRegime, getCustomerRegimeSpecification, getCustomerRetirementAge, getCustomerSSNumber, getCustomerSubscriptionStatus, setCustomerBirthCity, setCustomerBirthCountry, setCustomerBirthDate, setCustomerBirthDatePartner, setCustomerBirthName, setCustomerBirthZipCode, setCustomerCivility, setCustomerCode, setCustomerCorporateName, setCustomerCustomerId, setCustomerDependentChildren, setCustomerExternalCode, setCustomerExternalId, setCustomerFirstName, setCustomerHasCertifiedOnTheHonor, setCustomerHealthReimbursementMethod, setCustomerIsAlsaceMoselle, setCustomerIsDigitalContract, setCustomerIsDigitalHealthInsuranceCard, setCustomerIsMember, setCustomerLabel, setCustomerLastName, setCustomerLegalProtection, setCustomerMadelinMonth, setCustomerMaritalStatus, setCustomerNationality, setCustomerProfessionalActivity, setCustomerProfessionalStatus, setCustomerRegime, setCustomerRegimeSpecification, setCustomerRetirementAge, setCustomerSSNumber, setCustomerSubscriptionStatus } from '@fasstech/oip-core/entities/Customer';
import { CustomerHealthReimbursementMethodEnum, CustomerLegalProtectionEnum, CustomerNationalityEnum, CustomerProfessionalStatusEnum, CustomerSubscriptionStatusEnum } from '@fasstech/oip-core/entities/Customer/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';
import { CivilityEnum, MaritalStatusEnum, MonthEnum, ProfessionalActivityEnum, RegimeEnum } from '@fasstech/oip-core/entities/enums';

(async () => {
  let project = await Entities('Project').create();
  const customer = await Entities('Customer').create();
  
  setCustomerSSNumber('SSNumber', customer);
  setCustomerBirthCity('birthCity', customer);
  setCustomerBirthCountry('birthCountry', customer);
  setCustomerBirthDate(new Date('2017-01-01'), customer);
  setCustomerBirthDatePartner(new Date('2017-01-01'), customer);
  setCustomerBirthName('birthName', customer);
  setCustomerBirthZipCode('birthZipCode', customer);
  setCustomerCivility(CivilityEnum.MISTER, customer);
  setCustomerCorporateName('corporateName', customer);
  setCustomerDependentChildren(100, customer);
  setCustomerFirstName('firstName', customer);
  setCustomerHasCertifiedOnTheHonor(true, customer);
  setCustomerHealthReimbursementMethod(CustomerHealthReimbursementMethodEnum.POSTAL, customer);
  setCustomerIsAlsaceMoselle(false, customer);
  setCustomerIsDigitalContract(false, customer);
  setCustomerIsDigitalHealthInsuranceCard(false, customer);
  setCustomerIsMember(false, customer);
  setCustomerLastName('lastName', customer);
  setCustomerLegalProtection(CustomerLegalProtectionEnum.GUARDIANSHIP, customer);
  setCustomerMadelinMonth(MonthEnum.AUGUST, customer);
  setCustomerMaritalStatus(MaritalStatusEnum.DIVORCED, customer);
  setCustomerNationality(CustomerNationalityEnum.FRENCH, customer);
  setCustomerProfessionalActivity(ProfessionalActivityEnum.COLLABORATING_PARTNER, customer);
  setCustomerProfessionalStatus(CustomerProfessionalStatusEnum.EMPLOYED_REPRESENTATIVE, customer);
  setCustomerRegime(RegimeEnum.REGIME_INDEPENDANT, customer);
  setCustomerRegimeSpecification('regimeSpecification', customer);
  setCustomerRetirementAge(114, customer);
  setCustomerSubscriptionStatus(CustomerSubscriptionStatusEnum.DEROGATION, customer);
  setCustomerCode('code', customer);
  setCustomerExternalId('externalId', customer);
  setCustomerExternalCode('externalCode', customer);
  setCustomerCustomerId('customerId', customer);
  setCustomerLabel('label', customer);
  
  project = await Entities('Customer').save(project, customer);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const customerToTest = await Entities('Customer').get(projectToTest, { filter: ({ id }) => id === getCustomerId(customer) });
  
  getCustomerSSNumber(customerToTest); // 'SSNumber'
  getCustomerBirthCity(customerToTest); // 'birthCity'
  getCustomerBirthCountry(customerToTest); // 'birthCountry'
  getCustomerBirthDate(customerToTest); // new Date('2017-01-01')
  getCustomerBirthDatePartner(customerToTest); // new Date('2017-01-01')
  getCustomerBirthName(customerToTest); // 'birthName'
  getCustomerBirthZipCode(customerToTest); // 'birthZipCode'
  getCustomerCivility(customerToTest); // CivilityEnum.MISTER
  getCustomerCorporateName(customerToTest); // 'corporateName'
  getCustomerDependentChildren(customerToTest); // 100
  getCustomerFirstName(customerToTest); // 'firstName'
  getCustomerHasCertifiedOnTheHonor(customerToTest); // true
  getCustomerHealthReimbursementMethod(customerToTest); // CustomerHealthReimbursementMethodEnum.POSTAL
  getCustomerIsAlsaceMoselle(customerToTest); // false
  getCustomerIsDigitalContract(customerToTest); // false
  getCustomerIsDigitalHealthInsuranceCard(customerToTest); // false
  getCustomerIsMember(customerToTest); // false
  getCustomerLastName(customerToTest); // 'lastName'
  getCustomerLegalProtection(customerToTest); // CustomerLegalProtectionEnum.GUARDIANSHIP
  getCustomerMadelinMonth(customerToTest); // MonthEnum.AUGUST
  getCustomerMaritalStatus(customerToTest); // MaritalStatusEnum.DIVORCED
  getCustomerNationality(customerToTest); // CustomerNationalityEnum.FRENCH
  getCustomerProfessionalActivity(customerToTest); // ProfessionalActivityEnum.COLLABORATING_PARTNER
  getCustomerProfessionalStatus(customerToTest); // CustomerProfessionalStatusEnum.EMPLOYED_REPRESENTATIVE
  getCustomerRegime(customerToTest); // RegimeEnum.REGIME_INDEPENDANT
  getCustomerRegimeSpecification(customerToTest); // 'regimeSpecification'
  getCustomerRetirementAge(customerToTest); // 114
  getCustomerSubscriptionStatus(customerToTest); // CustomerSubscriptionStatusEnum.DEROGATION
  getCustomerCode(customerToTest); // 'code'
  getCustomerExternalId(customerToTest); // 'externalId'
  getCustomerExternalCode(customerToTest); // 'externalCode'
  getCustomerCustomerId(customerToTest); // 'customerId'
  getCustomerLabel(customerToTest); // 'label'
})();
```
