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

# Offer

## Description

L'entité Offer contient les données communes aux différentes formules telles que le risque avec sa gamme et le groupe assuré. La cotisation totale ainsi que la remise sont également présentes.

## Relations

### Ascendantes

| Entité  | Propriété |
| ------- | --------- |
| Project | offers    |

### Descendantes

| Entité     | Propriété  |
| ---------- | ---------- |
| History    | history    |
| Hypothesis | hypothesis |
| Pack       | packs      |
| Pension    | pensions   |

## Propriétés

| Nom                        | Type                           | Description                                                                                                                     | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| -------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| college                    | `CollegeEnum`                  | Ensemble du personnel, cadre, non cadre, TNS                                                                                    |            |                 |             | 2.1.1                     |
| dateRia                    | `Date`                         | Date de résiliation infra annuelle d'un contrat santé                                                                           |            |                 |             | 1.7.0                     |
| defaultPrice               | `Number`                       | Prix de l'offre par défaut                                                                                                      |            |                 |             | 1.6.0                     |
| demographyId               | `String[]`                     | Identifiant unique de la démographie                                                                                            |            |                 |             | 2.4.0                     |
| effectDate                 | `Date`                         | Date d'effet de l'offre                                                                                                         |            |                 |             | 1.5.0                     |
| employeeAverageAge         | `Number`                       | Age moyen des salariés                                                                                                          |            |                 |             | 2.0.0                     |
| employeeCount              | `Number`                       | Nombre de salariés                                                                                                              |            |                 |             | 2.0.0                     |
| employerPercentShare       | `Number`                       | Part de l'employeur en poucentage                                                                                               |            |                 |             | 2.0.0                     |
| hasHealthContract          | `Boolean`                      | L'entreprise est actuellement couverte par un contrat de santé                                                                  |            |                 |             | 2.0.0                     |
| hasProtectionContract      | `Boolean`                      | L'entreprise est actuellement couverte par un contrat de prévoyance                                                             |            |                 |             | 2.0.0                     |
| increase                   | `Number`                       | Variation de prix de l'offre                                                                                                    |            |                 |             | 1.6.0                     |
| isPreSelected              | `Boolean`                      | Il s'agit d'identifier les formules et/ou garanties présélectionnées pour l'utilisateur pour permettre de faire une comparaison |            |                 |             | 3.7.0                     |
| isRia                      | `Boolean`                      | Résiliation infra annuelle d'un contrat santé                                                                                   |            |                 |             | 1.7.0                     |
| isSelected                 | `Boolean`                      | Offre sélectionnée                                                                                                              |            |                 |             |                           |
| level                      | `String`                       | Niveau de garantie                                                                                                              |            |                 |             | 1.6.0                     |
| longLabel                  | `String`                       | Nom de l'offre long                                                                                                             |            |                 |             | 1.5.0                     |
| maxAge                     | `Number`                       | Maximum de la moyenne d'âge acceptée pour souscription à l'offre                                                                |            |                 |             | 1.5.0                     |
| maxEffectDate              | `Date`                         | Date d'effet maximum pour souscription à l'offre                                                                                |            |                 |             | 1.5.0                     |
| minAge                     | `Number`                       | Minimum de la moyenne d'âge acceptée pour souscription à l'offre                                                                |            |                 |             | 1.5.0                     |
| minEffectDate              | `Date`                         | Date d'effet minimum pour souscription à l'offre                                                                                |            |                 |             | 1.5.0                     |
| name                       | `String`                       | Nom de l'offre                                                                                                                  |            |                 |             | 1.5.0                     |
| need                       | `OfferNeedEnum`                | Niveau de Besoin                                                                                                                |            |                 |             | 2.1.1                     |
| price                      | `Number`                       | Prix de l'offre                                                                                                                 |            |                 |             | 1.6.0                     |
| regime                     | `RegimeEnum`                   | Régime de sécurité sociale                                                                                                      |            |                 |             | 2.1.1                     |
| riskAndRange               | `RiskAndRangeEnum`             | Décrit le type (risque/gamme) d'offre                                                                                           |            |                 |             | 2.2.0                     |
| shortLabel                 | `String`                       | Nom de l'offre court                                                                                                            |            |                 |             | 1.5.0                     |
| status                     | `OfferStatusEnum`              | Statut de l'offre                                                                                                               |            |                 |             | 2.2.0                     |
| supplInsuranceExtGuarantee | `Boolean`                      | Contrôle du besoin d'étendre la sur-complémentaire aux ayants-droits                                                            |            |                 |             | 2.0.0                     |
| supplInsuranceNeeded       | `Boolean`                      | Contrôle du besoin sur-complémentaire dans une offre                                                                            |            |                 |             | 2.0.0                     |
| supplInsurancePayer        | `OfferSupplInsurancePayerEnum` | Contrôle pour connaître qui paiera la sur-complémentaire                                                                        |            |                 |             | 2.1.1                     |
| tariffStructure            | `OfferTariffStructureEnum`     | Dans le cadre du parcours, le commercial va sélectionner la structure tarifaire qui sera appliquée                              |            |                 |             | 2.7.0                     |
| id                         | `String`                       | Identifiant de l'entité `Offer`                                                                                                 |            | X               |             |                           |
| code                       | `String`                       | Codification fonctionnelle de l'entité `Offer`                                                                                  |            |                 |             |                           |
| externalId                 | `String`                       | Identifiant de l'entité `Offer` dans le système client                                                                          |            |                 |             |                           |
| externalCode               | `String`                       | Codification fonctionnelle de l'entité `Offer` dans le système client                                                           |            |                 |             |                           |
| offerId                    | `String`                       | Identifiant public de l'entité `Offer` dans l'OIP                                                                               |            |                 |             |                           |
| label                      | `String`                       | Information relative au nom de l'entité `Offer` dans son contexte d'utilisation                                                 |            |                 |             |                           |
| createdAt                  | `Date`                         | Date de création de l'entité `Offer`                                                                                            |            | X               |             |                           |
| updatedAt                  | `Date`                         | Date de modification de l'entité `Offer`                                                                                        |            | X               |             |                           |

## Enumérations

### OfferNeedEnum

- `EMPLOYEES_PROTECTION`
- `EMPLOYEES_RETENTION`
- `EMPLOYER_OBLIGATIONS`

### OfferStatusEnum

- `BLOCKED`
- `CREATED`
- `DIGITAL_SERVICE_DONE`
- `DIGITAL_SERVICE_STARTED`
- `EDITING`
- `IN_PROGRESS`
- `REMOVED`
- `SENT_FOR_SIGNATURE`
- `SIGNATURE_CANCELLED`
- `SIGNATURE_EXPIRED`
- `SIGNATURE_REFUSED`
- `SIGNED`
- `SUBSCRIPTION_ACCEPTED`
- `SUBSCRIPTION_FAILED`
- `SUBSCRIPTION_PENDING`
- `WAIVER_ACCEPTED`
- `WAIVER_IN_PROGRESS`
- `WAIVER_REFUSED`

### OfferSupplInsurancePayerEnum

- `EMPLOYEE`
- `EMPLOYER`

### OfferTariffStructureEnum

- `ADULT_CHILD`
- `EMPLOYEE`
- `EMPLOYEE_CHILD`
- `EMPLOYEE_DUO_FAMILY`
- `EMPLOYEE_FAMILY`
- `FAMILY`
- `TA`
- `TA_TB`
- `TA_TB_TC`

## Enumérations génériques

- CollegeEnum
- RegimeEnum
- RiskAndRangeEnum

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getOfferCode, getOfferCollege, getOfferDateRia, getOfferDefaultPrice, getOfferDemographyId, getOfferEffectDate, getOfferEmployeeAverageAge, getOfferEmployeeCount, getOfferEmployerPercentShare, getOfferExternalCode, getOfferExternalId, getOfferHasHealthContract, getOfferHasProtectionContract, getOfferId, getOfferIncrease, getOfferIsPreSelected, getOfferIsRia, getOfferIsSelected, getOfferLabel, getOfferLevel, getOfferLongLabel, getOfferMaxAge, getOfferMaxEffectDate, getOfferMinAge, getOfferMinEffectDate, getOfferName, getOfferNeed, getOfferOfferId, getOfferPrice, getOfferRegime, getOfferRiskAndRange, getOfferShortLabel, getOfferStatus, getOfferSupplInsuranceExtGuarantee, getOfferSupplInsuranceNeeded, getOfferSupplInsurancePayer, getOfferTariffStructure, setOfferCode, setOfferCollege, setOfferDateRia, setOfferDefaultPrice, setOfferDemographyId, setOfferEffectDate, setOfferEmployeeAverageAge, setOfferEmployeeCount, setOfferEmployerPercentShare, setOfferExternalCode, setOfferExternalId, setOfferHasHealthContract, setOfferHasProtectionContract, setOfferIncrease, setOfferIsPreSelected, setOfferIsRia, setOfferIsSelected, setOfferLabel, setOfferLevel, setOfferLongLabel, setOfferMaxAge, setOfferMaxEffectDate, setOfferMinAge, setOfferMinEffectDate, setOfferName, setOfferNeed, setOfferOfferId, setOfferPrice, setOfferRegime, setOfferRiskAndRange, setOfferShortLabel, setOfferStatus, setOfferSupplInsuranceExtGuarantee, setOfferSupplInsuranceNeeded, setOfferSupplInsurancePayer, setOfferTariffStructure } from '@fasstech/oip-core/entities/Offer';
import { OfferNeedEnum, OfferStatusEnum, OfferSupplInsurancePayerEnum, OfferTariffStructureEnum } from '@fasstech/oip-core/entities/Offer/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';
import { CollegeEnum, RegimeEnum, RiskAndRangeEnum } from '@fasstech/oip-core/entities/enums';

(async () => {
  let project = await Entities('Project').create();
  const offer = await Entities('Offer').create();
  
  setOfferCollege([CollegeEnum.ALL], offer);
  setOfferDateRia(new Date('2017-01-01'), offer);
  setOfferDefaultPrice(100, offer);
  setOfferDemographyId(['demographyId'], offer);
  setOfferEffectDate(new Date('2017-01-01'), offer);
  setOfferEmployeeAverageAge(101, offer);
  setOfferEmployeeCount(101, offer);
  setOfferEmployerPercentShare(101, offer);
  setOfferHasHealthContract(true, offer);
  setOfferHasProtectionContract(true, offer);
  setOfferIncrease(105, offer);
  setOfferIsPreSelected(false, offer);
  setOfferIsRia(false, offer);
  setOfferIsSelected(false, offer);
  setOfferLevel('level', offer);
  setOfferLongLabel('longLabel', offer);
  setOfferMaxAge(109, offer);
  setOfferMaxEffectDate(new Date('2017-01-01'), offer);
  setOfferMinAge(109, offer);
  setOfferMinEffectDate(new Date('2017-01-01'), offer);
  setOfferName('name', offer);
  setOfferNeed(OfferNeedEnum.EMPLOYER_OBLIGATIONS, offer);
  setOfferPrice(112, offer);
  setOfferRegime(RegimeEnum.REGIME_INDEPENDANT, offer);
  setOfferRiskAndRange(RiskAndRangeEnum.GROUP_PROTECTION, offer);
  setOfferShortLabel('shortLabel', offer);
  setOfferStatus(OfferStatusEnum.SENT_FOR_SIGNATURE, offer);
  setOfferSupplInsuranceExtGuarantee(false, offer);
  setOfferSupplInsuranceNeeded(false, offer);
  setOfferSupplInsurancePayer(OfferSupplInsurancePayerEnum.EMPLOYER, offer);
  setOfferTariffStructure(OfferTariffStructureEnum.TA_TB_TC, offer);
  setOfferCode('code', offer);
  setOfferExternalId('externalId', offer);
  setOfferExternalCode('externalCode', offer);
  setOfferOfferId('offerId', offer);
  setOfferLabel('label', offer);
  
  project = await Entities('Offer').save(project, offer);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const offerToTest = await Entities('Offer').get(projectToTest, { filter: ({ id }) => id === getOfferId(offer) });
  
  getOfferCollege(offerToTest); // [CollegeEnum.ALL]
  getOfferDateRia(offerToTest); // new Date('2017-01-01')
  getOfferDefaultPrice(offerToTest); // 100
  getOfferDemographyId(offerToTest); // ['demographyId']
  getOfferEffectDate(offerToTest); // new Date('2017-01-01')
  getOfferEmployeeAverageAge(offerToTest); // 101
  getOfferEmployeeCount(offerToTest); // 101
  getOfferEmployerPercentShare(offerToTest); // 101
  getOfferHasHealthContract(offerToTest); // true
  getOfferHasProtectionContract(offerToTest); // true
  getOfferIncrease(offerToTest); // 105
  getOfferIsPreSelected(offerToTest); // false
  getOfferIsRia(offerToTest); // false
  getOfferIsSelected(offerToTest); // false
  getOfferLevel(offerToTest); // 'level'
  getOfferLongLabel(offerToTest); // 'longLabel'
  getOfferMaxAge(offerToTest); // 109
  getOfferMaxEffectDate(offerToTest); // new Date('2017-01-01')
  getOfferMinAge(offerToTest); // 109
  getOfferMinEffectDate(offerToTest); // new Date('2017-01-01')
  getOfferName(offerToTest); // 'name'
  getOfferNeed(offerToTest); // OfferNeedEnum.EMPLOYER_OBLIGATIONS
  getOfferPrice(offerToTest); // 112
  getOfferRegime(offerToTest); // RegimeEnum.REGIME_INDEPENDANT
  getOfferRiskAndRange(offerToTest); // RiskAndRangeEnum.GROUP_PROTECTION
  getOfferShortLabel(offerToTest); // 'shortLabel'
  getOfferStatus(offerToTest); // OfferStatusEnum.SENT_FOR_SIGNATURE
  getOfferSupplInsuranceExtGuarantee(offerToTest); // false
  getOfferSupplInsuranceNeeded(offerToTest); // false
  getOfferSupplInsurancePayer(offerToTest); // OfferSupplInsurancePayerEnum.EMPLOYER
  getOfferTariffStructure(offerToTest); // OfferTariffStructureEnum.TA_TB_TC
  getOfferCode(offerToTest); // 'code'
  getOfferExternalId(offerToTest); // 'externalId'
  getOfferExternalCode(offerToTest); // 'externalCode'
  getOfferOfferId(offerToTest); // 'offerId'
  getOfferLabel(offerToTest); // 'label'
})();
```
