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

# Phone

## Description

L'entité Phone contient les différentes informations sur la structure d'un numéro de téléphone ainsi que sur son type.

## Relations

### Ascendantes

| Entité       | Propriété |
| ------------ | --------- |
| ActivePolicy | phones    |
| Company      | phones    |
| Contact      | phones    |
| Customer     | phones    |
| Employee     | phones    |
| Grantee      | phones    |
| Tns          | phones    |
| User         | phones    |

### Descendantes

| Entité  | Propriété |
| ------- | --------- |
| History | history   |

## Propriétés

| Nom               | Type            | Description                                                                     | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ----------------- | --------------- | ------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| internationalCode | `String`        | Indicatif téléphone.                                                            |            |                 |             | 2.4.0                     |
| isMobile          | `Boolean`       | Permet de savoir si le numéro est un mobile.                                    |            |                 |             | 2.4.0                     |
| number            | `String`        | Numéro de téléphone.                                                            |            |                 |             | 2.6.1                     |
| type              | `PhoneTypeEnum` | Type de numéro de téléphone.                                                    |            |                 |             | 2.4.0                     |
| id                | `String`        | Identifiant de l'entité `Phone`                                                 |            | X               |             |                           |
| code              | `String`        | Codification fonctionnelle de l'entité `Phone`                                  |            |                 |             |                           |
| externalId        | `String`        | Identifiant de l'entité `Phone` dans le système client                          |            |                 |             |                           |
| externalCode      | `String`        | Codification fonctionnelle de l'entité `Phone` dans le système client           |            |                 |             |                           |
| phoneId           | `String`        | Identifiant public de l'entité `Phone` dans l'OIP                               |            |                 |             |                           |
| label             | `String`        | Information relative au nom de l'entité `Phone` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt         | `Date`          | Date de création de l'entité `Phone`                                            |            | X               |             |                           |
| updatedAt         | `Date`          | Date de modification de l'entité `Phone`                                        |            | X               |             |                           |

## Enumérations

### PhoneTypeEnum

- `FAX`
- `PERSONAL`
- `PROFESSIONAL`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getActivePolicyId } from '@fasstech/oip-core/entities/ActivePolicy';
import { getCompanyId } from '@fasstech/oip-core/entities/Company';
import { getPhoneCode, getPhoneExternalCode, getPhoneExternalId, getPhoneId, getPhoneInternationalCode, getPhoneIsMobile, getPhoneLabel, getPhoneNumber, getPhonePhoneId, getPhoneType, setPhoneCode, setPhoneExternalCode, setPhoneExternalId, setPhoneInternationalCode, setPhoneIsMobile, setPhoneLabel, setPhoneNumber, setPhonePhoneId, setPhoneType } from '@fasstech/oip-core/entities/Phone';
import { PhoneTypeEnum } from '@fasstech/oip-core/entities/Phone/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let company = await Entities('Company').create();
  let activePolicy = await Entities('ActivePolicy').create();
  const phone = await Entities('Phone').create();
  
  setPhoneInternationalCode('internationalCode', phone);
  setPhoneIsMobile(false, phone);
  setPhoneNumber('number', phone);
  setPhoneType(PhoneTypeEnum.PROFESSIONAL, phone);
  setPhoneCode('code', phone);
  setPhoneExternalId('externalId', phone);
  setPhoneExternalCode('externalCode', phone);
  setPhonePhoneId('phoneId', phone);
  setPhoneLabel('label', phone);
  
  activePolicy = await Entities('Phone').save(activePolicy, phone);
  company = await Entities('ActivePolicy').save(company, activePolicy);
  project = await Entities('Company').save(project, company);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const companyToTest = await Entities('Company').get(projectToTest, { filter: ({ id }) => id === getCompanyId(company) });
  const activePolicyToTest = await Entities('ActivePolicy').get(companyToTest, { filter: ({ id }) => id === getActivePolicyId(activePolicy) });
  const phoneToTest = await Entities('Phone').get(activePolicyToTest, { filter: ({ id }) => id === getPhoneId(phone) });
  
  getPhoneInternationalCode(phoneToTest); // 'internationalCode'
  getPhoneIsMobile(phoneToTest); // false
  getPhoneNumber(phoneToTest); // 'number'
  getPhoneType(phoneToTest); // PhoneTypeEnum.PROFESSIONAL
  getPhoneCode(phoneToTest); // 'code'
  getPhoneExternalId(phoneToTest); // 'externalId'
  getPhoneExternalCode(phoneToTest); // 'externalCode'
  getPhonePhoneId(phoneToTest); // 'phoneId'
  getPhoneLabel(phoneToTest); // 'label'
})();
```
