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

# Address

## Description

L'entité Address regroupe toutes les informations d'adresse.

## Relations

### Ascendantes

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

### Descendantes

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

## Propriétés

| Nom          | Type              | Description                                                                       | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------ | ----------------- | --------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| city         | `String`          | Ville                                                                             |            |                 |             | 1.4.0                     |
| country      | `String`          | Pays                                                                              |            |                 |             | 1.5.0                     |
| department   | `String`          | Département                                                                       |            |                 |             | 1.5.0                     |
| fields       | `String[]`        | Champs de l'adresse                                                               |            |                 |             | 2.0.0                     |
| postalCode   | `Number`          | Code postal numérique                                                             |            |                 |             | 1.5.0                     |
| type         | `AddressTypeEnum` | Type de l'adresse [AddressTypeEnum](#)                                            |            |                 |             | 2.6.0                     |
| zipCode      | `String`          | Code postal                                                                       |            |                 |             | 2.2.0                     |
| id           | `String`          | Identifiant de l'entité `Address`                                                 |            | X               |             |                           |
| code         | `String`          | Codification fonctionnelle de l'entité `Address`                                  |            |                 |             |                           |
| externalId   | `String`          | Identifiant de l'entité `Address` dans le système client                          |            |                 |             |                           |
| externalCode | `String`          | Codification fonctionnelle de l'entité `Address` dans le système client           |            |                 |             |                           |
| addressId    | `String`          | Identifiant public de l'entité `Address` dans l'OIP                               |            |                 |             |                           |
| label        | `String`          | Information relative au nom de l'entité `Address` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt    | `Date`            | Date de création de l'entité `Address`                                            |            | X               |             |                           |
| updatedAt    | `Date`            | Date de modification de l'entité `Address`                                        |            | X               |             |                           |

## Enumérations

### AddressTypeEnum

- `ACCOMMODATION`
- ~~ACOMMODATION~~ ; utiliser `ACCOMMODATION`
- `AGENCY`
- `HEAD_OFFICE`
- `HOME_OFFICE`
- `LETTERBOX`
- `OFFICE`
- `OTHER`
- `PRINCIPAL_RESIDENCE`
- `SECONDARY_RESIDENCE`

## 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 { getAddressAddressId, getAddressCity, getAddressCode, getAddressCountry, getAddressDepartment, getAddressExternalCode, getAddressExternalId, getAddressFields, getAddressId, getAddressLabel, getAddressPostalCode, getAddressType, getAddressZipCode, setAddressAddressId, setAddressCity, setAddressCode, setAddressCountry, setAddressDepartment, setAddressExternalCode, setAddressExternalId, setAddressFields, setAddressLabel, setAddressPostalCode, setAddressType, setAddressZipCode } from '@fasstech/oip-core/entities/Address';
import { AddressTypeEnum } from '@fasstech/oip-core/entities/Address/enums';
import { getCompanyId } from '@fasstech/oip-core/entities/Company';
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 address = await Entities('Address').create();
  
  setAddressCity('city', address);
  setAddressCountry('country', address);
  setAddressDepartment('department', address);
  setAddressFields(['fields'], address);
  setAddressPostalCode(112, address);
  setAddressType(AddressTypeEnum.OFFICE, address);
  setAddressZipCode('zipCode', address);
  setAddressCode('code', address);
  setAddressExternalId('externalId', address);
  setAddressExternalCode('externalCode', address);
  setAddressAddressId('addressId', address);
  setAddressLabel('label', address);
  
  activePolicy = await Entities('Address').save(activePolicy, address);
  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 addressToTest = await Entities('Address').get(activePolicyToTest, { filter: ({ id }) => id === getAddressId(address) });
  
  getAddressCity(addressToTest); // 'city'
  getAddressCountry(addressToTest); // 'country'
  getAddressDepartment(addressToTest); // 'department'
  getAddressFields(addressToTest); // ['fields']
  getAddressPostalCode(addressToTest); // 112
  getAddressType(addressToTest); // AddressTypeEnum.OFFICE
  getAddressZipCode(addressToTest); // 'zipCode'
  getAddressCode(addressToTest); // 'code'
  getAddressExternalId(addressToTest); // 'externalId'
  getAddressExternalCode(addressToTest); // 'externalCode'
  getAddressAddressId(addressToTest); // 'addressId'
  getAddressLabel(addressToTest); // 'label'
})();
```
