---
title: Address
slug: oip-next/pyfrvsf0kb4cbsnjiztb
createdAt: 2024-02-21T13:19:28.000Z
---

# Address

## Description

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

## Relations

### Ascendantes

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

### Descendantes

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

## Liste des propriétés

| Nom        | Type       | Dernière version modifiée | Description                                                      | Getter               | Setter               | Deprecated |
| ---------- | ---------- | ------------------------- | ---------------------------------------------------------------- | -------------------- | -------------------- | ---------- |
| city       | `String`   | 1.4.0                     | Ville                                                            | getAddressCity       | setAddressCity       | -          |
| country    | `String`   | 1.5.0                     | Pays                                                             | getAddressCountry    | setAddressCountry    | -          |
| createdAt  | `Date`     |                           | Date de création de l'entité `Address`                           | getAddressCreatedAt  | Lecture seule        | -          |
| createdBy  | `String`   |                           | Utilisateur à l'origine de la création de l'entité `Address`     | getAddressCreatedBy  | Lecture seule        | -          |
| department | `String`   | 1.5.0                     | Département                                                      | getAddressDepartment | setAddressDepartment | -          |
| fields     | `String[]` | 2.0.0                     | Champs de l'adresse                                              | getAddressFields     | setAddressFields     | -          |
| id         | `String`   |                           | Identifiant unique de l'entité `Address`                         | getAddressId         | Lecture seule        | -          |
| label      | `String`   | 2.6.0                     | Label de l'adresse                                               | getAddressLabel      | setAddressLabel      | -          |
| postalCode | `Number`   | 1.5.0                     | Code postal numérique                                            | getAddressPostalCode | setAddressPostalCode | -          |
| type       | `typeEnum` | 2.6.0                     | Type de l'adresse                                                | getAddressType       | setAddressType       | -          |
| updatedAt  | `Date`     |                           | Date de modification de l'entité `Address`                       | getAddressUpdatedAt  | Lecture seule        | -          |
| updatedBy  | `String`   |                           | Utilisateur à l'origine de la modification de l'entité `Address` | getAddressUpdatedBy  | Lecture seule        | -          |
| zipCode    | `String`   | 2.2.0                     | Code postal                                                      | getAddressZipCode    | setAddressZipCode    | -          |

## Enums

### typeEnum

- `typeEnum.PRINCIPAL_RESIDENCE`
- `typeEnum.SECONDARY_RESIDENCE`
- `typeEnum.ACOMMODATION`
- `typeEnum.HEAD_OFFICE`
- `typeEnum.HOME_OFFICE`
- `typeEnum.OFFICE`
- `typeEnum.AGENCY`
- `typeEnum.LETTERBOX`
- `typeEnum.OTHER`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getActivePolicyId } from '@fasstech/oip-core/entities/activePolicy';
import { getAddressCity, getAddressCountry, getAddressDepartment, getAddressFields, getAddressLabel, getAddressPostalCode, getAddressType, getAddressZipCode, getaddressId, setAddressCity, setAddressCountry, setAddressDepartment, setAddressFields, setAddressLabel, setAddressPostalCode, setAddressType, setAddressZipCode } from '@fasstech/oip-core/entities/address';
import { typeEnum } 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 ProjectEntity = await Entities('Project').get({ id: projectId });
  let CompanyEntity = await Entities('Company').create();
  let ActivePolicyEntity = await Entities('ActivePolicy').create();
  const AddressEntity = await Entities('Address').create();
  
  setAddressCity('city', AddressEntity);
  setAddressCountry('country', AddressEntity);
  setAddressDepartment('department', AddressEntity);
  setAddressFields(['fields'], AddressEntity);
  setAddressLabel('label', AddressEntity);
  setAddressPostalCode(112, AddressEntity);
  setAddressType(typeEnum.SECONDARY_RESIDENCE, AddressEntity);
  setAddressZipCode('zipCode', AddressEntity);
  
  ActivePolicyEntity = await Entities('Address').save(ActivePolicyEntity, AddressEntity);
  CompanyEntity = await Entities('ActivePolicy').save(CompanyEntity, ActivePolicyEntity);
  ProjectEntity = await Entities('Company').save(ProjectEntity, CompanyEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const CompanyEntityToTest = await Entities('Company').get(ProjectEntityToTest, getCompanyId(CompanyEntity));
  const ActivePolicyEntityToTest = await Entities('ActivePolicy').get(CompanyEntityToTest, getActivePolicyId(ActivePolicyEntity));
  const AddressEntityToTest = await Entities('Address').get(ActivePolicyEntityToTest, getAddressId(AddressEntity));
  
  getAddressCity(AddressEntityToTest); // 'city'
  getAddressCountry(AddressEntityToTest); // 'country'
  getAddressDepartment(AddressEntityToTest); // 'department'
  getAddressFields(AddressEntityToTest); // ['fields']
  getAddressLabel(AddressEntityToTest); // 'label'
  getAddressPostalCode(AddressEntityToTest); // 112
  getAddressType(AddressEntityToTest); // typeEnum.SECONDARY_RESIDENCE
  getAddressZipCode(AddressEntityToTest); // 'zipCode'
})();
```
