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

# ActivePolicy

## Description

L'entité ActivePolicy regroupe les informations du/des contrat(s) en cours chez un assureur tiers.

## Relations

### Ascendantes

| Entité   | Propriété      |
| -------- | -------------- |
| Company  | activePolicies |
| Customer | activePolicies |
| Tns      | activePolicies |

### Descendantes

| Entité  | Propriété |
| ------- | --------- |
| Address | addresses |
| Email   | emails    |
| History | history   |
| Phone   | phones    |

## Propriétés

| Nom                       | Type                                    | Description                                                                                                 | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| amount                    | `Number`                                | Montant du contrat à transférer.                                                                            |            |                 |             | 2.22.0                    |
| cancellationApplicant     | `ActivePolicyCancellationApplicantEnum` | Qui sera en charge de traiter la demande RIA.                                                               |            |                 |             | 2.4.0                     |
| cancellationReason        | `String`                                | Raison de clôture du précédent contrat.                                                                     |            |                 |             | 2.4.0                     |
| comment                   | `String`                                | Information additionnelle relative à la couverture actuelle.                                                |            |                 |             | 2.12.0                    |
| contractNumber            | `String`                                | Numéro de contrat.                                                                                          |            |                 |             | 2.4.0                     |
| level                     | `ActivePolicyLevelEnum`                 | Niveau générique de couverture.                                                                             |            |                 |             | 2.12.0                    |
| name                      | `String`                                | Nom de l'assurance.                                                                                         |            |                 |             | 2.4.0                     |
| requestedCancellationDate | `Date`                                  | Date de résilitation souhaitée.                                                                             |            |                 |             | 2.4.0                     |
| version                   | `String`                                | En relation avec la propriété RiskAndRange, permet de différencier la nature du cadre juridique du contrat. |            |                 |             | 2.22.0                    |
| id                        | `String`                                | Identifiant de l'entité `ActivePolicy`                                                                      |            | X               |             |                           |
| code                      | `String`                                | Codification fonctionnelle de l'entité `ActivePolicy`                                                       |            |                 |             |                           |
| externalId                | `String`                                | Identifiant de l'entité `ActivePolicy` dans le système client                                               |            |                 |             |                           |
| externalCode              | `String`                                | Codification fonctionnelle de l'entité `ActivePolicy` dans le système client                                |            |                 |             |                           |
| activePolicyId            | `String`                                | Identifiant public de l'entité `ActivePolicy` dans l'OIP                                                    |            |                 |             |                           |
| label                     | `String`                                | Information relative au nom de l'entité `ActivePolicy` dans son contexte d'utilisation                      |            |                 |             |                           |
| createdAt                 | `Date`                                  | Date de création de l'entité `ActivePolicy`                                                                 |            | X               |             |                           |
| updatedAt                 | `Date`                                  | Date de modification de l'entité `ActivePolicy`                                                             |            | X               |             |                           |

## Enumérations

### ActivePolicyCancellationApplicantEnum

- `BROKER`
- `CLIENT`
- `FASST`
- `USER`

### ActivePolicyLevelEnum

- `ONE`
- `TWO`
- `THREE`
- `FOUR`
- `FIVE`
- `SIX`
- `SEVEN`
- `EIGHT`
- `NINE`
- `TEN`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getActivePolicyActivePolicyId, getActivePolicyAmount, getActivePolicyCancellationApplicant, getActivePolicyCancellationReason, getActivePolicyCode, getActivePolicyComment, getActivePolicyContractNumber, getActivePolicyExternalCode, getActivePolicyExternalId, getActivePolicyId, getActivePolicyLabel, getActivePolicyLevel, getActivePolicyName, getActivePolicyRequestedCancellationDate, getActivePolicyVersion, setActivePolicyActivePolicyId, setActivePolicyAmount, setActivePolicyCancellationApplicant, setActivePolicyCancellationReason, setActivePolicyCode, setActivePolicyComment, setActivePolicyContractNumber, setActivePolicyExternalCode, setActivePolicyExternalId, setActivePolicyLabel, setActivePolicyLevel, setActivePolicyName, setActivePolicyRequestedCancellationDate, setActivePolicyVersion } from '@fasstech/oip-core/entities/ActivePolicy';
import { ActivePolicyCancellationApplicantEnum, ActivePolicyLevelEnum } from '@fasstech/oip-core/entities/ActivePolicy/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();
  const activePolicy = await Entities('ActivePolicy').create();
  
  setActivePolicyAmount(97, activePolicy);
  setActivePolicyCancellationApplicant(ActivePolicyCancellationApplicantEnum.USER, activePolicy);
  setActivePolicyCancellationReason('cancellationReason', activePolicy);
  setActivePolicyComment('comment', activePolicy);
  setActivePolicyContractNumber('contractNumber', activePolicy);
  setActivePolicyLevel(ActivePolicyLevelEnum.THREE, activePolicy);
  setActivePolicyName('name', activePolicy);
  setActivePolicyRequestedCancellationDate(new Date('2017-01-01'), activePolicy);
  setActivePolicyVersion('version', activePolicy);
  setActivePolicyCode('code', activePolicy);
  setActivePolicyExternalId('externalId', activePolicy);
  setActivePolicyExternalCode('externalCode', activePolicy);
  setActivePolicyActivePolicyId('activePolicyId', activePolicy);
  setActivePolicyLabel('label', activePolicy);
  
  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) });
  
  getActivePolicyAmount(activePolicyToTest); // 97
  getActivePolicyCancellationApplicant(activePolicyToTest); // ActivePolicyCancellationApplicantEnum.USER
  getActivePolicyCancellationReason(activePolicyToTest); // 'cancellationReason'
  getActivePolicyComment(activePolicyToTest); // 'comment'
  getActivePolicyContractNumber(activePolicyToTest); // 'contractNumber'
  getActivePolicyLevel(activePolicyToTest); // ActivePolicyLevelEnum.THREE
  getActivePolicyName(activePolicyToTest); // 'name'
  getActivePolicyRequestedCancellationDate(activePolicyToTest); // new Date('2017-01-01')
  getActivePolicyVersion(activePolicyToTest); // 'version'
  getActivePolicyCode(activePolicyToTest); // 'code'
  getActivePolicyExternalId(activePolicyToTest); // 'externalId'
  getActivePolicyExternalCode(activePolicyToTest); // 'externalCode'
  getActivePolicyActivePolicyId(activePolicyToTest); // 'activePolicyId'
  getActivePolicyLabel(activePolicyToTest); // 'label'
})();
```
