---
title: Pricing
slug: oip-next/aeqyndf9qsvltw8lqf9rp
createdAt: 2024-02-21T13:29:42.000Z
---

# Pricing

## Description

L'entité Pricing correspond à la structure tarifaire de la formule.

## Relations

### Ascendantes

| Entité | Propriété |
| ------ | --------- |
| Pack   | pricings  |

### Descendantes

| Entité        | Propriété      |
| ------------- | -------------- |
| History       | history        |
| Price         | prices         |
| WaiverRequest | waiverRequests |

## Liste des propriétés

| Nom                | Type                         | Dernière version modifiée | Description                                                                                 | Getter                       | Setter                       | Deprecated |
| ------------------ | ---------------------------- | ------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------- | ---------------------------- | ---------- |
| createdAt          | `Date`                       |                           | Date de création de l'entité `Pricing`                                                      | getPricingCreatedAt          | Lecture seule                | -          |
| createdBy          | `String`                     |                           | Utilisateur à l'origine de la création de l'entité `Pricing`                                | getPricingCreatedBy          | Lecture seule                | -          |
| defaultPrice       | `Number`                     | 2.8.0                     | Tarif total de la structure  avant la prise en compte des dérogations.                      | getPricingDefaultPrice       | setPricingDefaultPrice       | -          |
| defaultRate        | `Number`                     | 2.8.0                     | Taux total de la structure  avant la prise en compte des dérogations.                       | getPricingDefaultRate        | setPricingDefaultRate        | -          |
| derogatedAmount    | `Number`                     | 2.8.0                     | Montant total dérogé de la structure. Il prend en compte l’ensemble des dérogations.        | getPricingDerogatedAmount    | setPricingDerogatedAmount    | -          |
| derogatedRate      | `Number`                     | 2.8.0                     | Taux total dérogé de la structure. Il prend en compte l’ensemble des dérogations.           | getPricingDerogatedRate      | setPricingDerogatedRate      | -          |
| guaranteeCode      | `String`                     | 2.8.0                     | Code de la garantie. Cela peut être la référence de classification ou bien un code interne. | getPricingGuaranteeCode      | setPricingGuaranteeCode      | -          |
| guaranteeLabel     | `String`                     | 2.8.0                     | Libellé de la garantie flexiproduct.                                                        | getPricingGuaranteeLabel     | setPricingGuaranteeLabel     | -          |
| id                 | `String`                     |                           | Identifiant unique de l'entité `Pricing`                                                    | getPricingId                 | Lecture seule                | -          |
| isSelected         | `Boolean`                    | 2.6.0                     | Indique si le client a sélectionné cette structure tarifaire.                               | getPricingIsSelected         | setPricingIsSelected         | -          |
| level              | `String`                     | 2.4.0                     | Niveau du module                                                                            | getPricingLevel              | setPricingLevel              | -          |
| moduleCode         | `String`                     | 2.4.0                     | Code du module                                                                              | getPricingModuleCode         | setPricingModuleCode         | -          |
| moduleId           | `String`                     | 2.4.0                     | Identifiant unique du module                                                                | getPricingModuleId           | setPricingModuleId           | -          |
| moduleLabel        | `String`                     | 2.8.0                     | Libellé du module flexiproduct                                                              | getPricingModuleLabel        | setPricingModuleLabel        | -          |
| price              | `Number`                     | 2.8.0                     | Tarif total de la structure en tenant compte des dérogations.                               | getPricingPrice              | setPricingPrice              | -          |
| rate               | `Number`                     | 2.8.0                     | Taux total de la structure en tenant compte des dérogations.                                | getPricingRate               | setPricingRate               | -          |
| regime             | `PricingRegimeEnum`          | 2.4.0                     | Régime                                                                                      | getPricingRegime             | setPricingRegime             | -          |
| supplementaryCover | `String`                     | 2.4.0                     | Code de la surcomplémentaire si celle-ci est sélectionnée dans le parcours                  | getPricingSupplementaryCover | setPricingSupplementaryCover | -          |
| tariffStructure    | `PricingTariffStructureEnum` | 2.7.0                     | Structure tarifaire sur laquelle on va appliquer un tarif                                   | getPricingTariffStructure    | setPricingTariffStructure    | -          |
| updatedAt          | `Date`                       |                           | Date de modification de l'entité `Pricing`                                                  | getPricingUpdatedAt          | Lecture seule                | -          |
| updatedBy          | `String`                     |                           | Utilisateur à l'origine de la modification de l'entité `Pricing`                            | getPricingUpdatedBy          | Lecture seule                | -          |

## Enums

### PricingRegimeEnum

- `PricingRegimeEnum.REGIME_AGRICOLE`
- `PricingRegimeEnum.REGIME_GLOBAL`
- `PricingRegimeEnum.REGIME_INDEPENDANT`
- `PricingRegimeEnum.REGIME_LOCAL`

### PricingTariffStructureEnum

- `PricingTariffStructureEnum.ADULT_CHILD`
- `PricingTariffStructureEnum.EMPLOYEE`
- `PricingTariffStructureEnum.EMPLOYEE_CHILD`
- `PricingTariffStructureEnum.EMPLOYEE_DUO_FAMILY`
- `PricingTariffStructureEnum.EMPLOYEE_FAMILY`
- `PricingTariffStructureEnum.FAMILY`
- `PricingTariffStructureEnum.TA`
- `PricingTariffStructureEnum.TA_TB`
- `PricingTariffStructureEnum.TA_TB_TC`
- `PricingTariffStructureEnum.UNIFORM`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getOfferId } from '@fasstech/oip-core/entities/offer';
import { getPackId } from '@fasstech/oip-core/entities/pack';
import { getPricingDefaultPrice, getPricingDefaultRate, getPricingDerogatedAmount, getPricingDerogatedRate, getPricingGuaranteeCode, getPricingGuaranteeLabel, getPricingIsSelected, getPricingLevel, getPricingModuleCode, getPricingModuleId, getPricingModuleLabel, getPricingPrice, getPricingRate, getPricingRegime, getPricingSupplementaryCover, getPricingTariffStructure, getpricingId, setPricingDefaultPrice, setPricingDefaultRate, setPricingDerogatedAmount, setPricingDerogatedRate, setPricingGuaranteeCode, setPricingGuaranteeLabel, setPricingIsSelected, setPricingLevel, setPricingModuleCode, setPricingModuleId, setPricingModuleLabel, setPricingPrice, setPricingRate, setPricingRegime, setPricingSupplementaryCover, setPricingTariffStructure } from '@fasstech/oip-core/entities/pricing';
import { PricingTariffStructureEnum, PricingRegimeEnum } from '@fasstech/oip-core/entities/pricing/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  let OfferEntity = await Entities('Offer').create();
  let PackEntity = await Entities('Pack').create();
  const PricingEntity = await Entities('Pricing').create();
  
  setPricingDefaultPrice(100, PricingEntity);
  setPricingDefaultRate(100, PricingEntity);
  setPricingDerogatedAmount(100, PricingEntity);
  setPricingDerogatedRate(100, PricingEntity);
  setPricingGuaranteeCode('guaranteeCode', PricingEntity);
  setPricingGuaranteeLabel('guaranteeLabel', PricingEntity);
  setPricingIsSelected(false, PricingEntity);
  setPricingLevel('level', PricingEntity);
  setPricingModuleCode('moduleCode', PricingEntity);
  setPricingModuleId('moduleId', PricingEntity);
  setPricingModuleLabel('moduleLabel', PricingEntity);
  setPricingPrice(112, PricingEntity);
  setPricingRate(114, PricingEntity);
  setPricingRegime(PricingRegimeEnum.REGIME_INDEPENDANT, PricingEntity);
  setPricingSupplementaryCover('supplementaryCover', PricingEntity);
  setPricingTariffStructure(PricingTariffStructureEnum.TA, PricingEntity);
  
  PackEntity = await Entities('Pricing').save(PackEntity, PricingEntity);
  OfferEntity = await Entities('Pack').save(OfferEntity, PackEntity);
  ProjectEntity = await Entities('Offer').save(ProjectEntity, OfferEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const OfferEntityToTest = await Entities('Offer').get(ProjectEntityToTest, getOfferId(OfferEntity));
  const PackEntityToTest = await Entities('Pack').get(OfferEntityToTest, getPackId(PackEntity));
  const PricingEntityToTest = await Entities('Pricing').get(PackEntityToTest, getPricingId(PricingEntity));
  
  getPricingDefaultPrice(PricingEntityToTest); // 100
  getPricingDefaultRate(PricingEntityToTest); // 100
  getPricingDerogatedAmount(PricingEntityToTest); // 100
  getPricingDerogatedRate(PricingEntityToTest); // 100
  getPricingGuaranteeCode(PricingEntityToTest); // 'guaranteeCode'
  getPricingGuaranteeLabel(PricingEntityToTest); // 'guaranteeLabel'
  getPricingIsSelected(PricingEntityToTest); // false
  getPricingLevel(PricingEntityToTest); // 'level'
  getPricingModuleCode(PricingEntityToTest); // 'moduleCode'
  getPricingModuleId(PricingEntityToTest); // 'moduleId'
  getPricingModuleLabel(PricingEntityToTest); // 'moduleLabel'
  getPricingPrice(PricingEntityToTest); // 112
  getPricingRate(PricingEntityToTest); // 114
  getPricingRegime(PricingEntityToTest); // PricingRegimeEnum.REGIME_INDEPENDANT
  getPricingSupplementaryCover(PricingEntityToTest); // 'supplementaryCover'
  getPricingTariffStructure(PricingEntityToTest); // PricingTariffStructureEnum.TA
})();
```
