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

# Price

## Description

L'entité Price correspond au détail de la structure tarifaire de pricing. Elle contient donc la cotisation pour chaque bénéficiaire.

## Relations

### Ascendantes

| Entité  | Propriété |
| ------- | --------- |
| Pricing | prices    |

### Descendantes

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

## Propriétés

| Nom             | Type                   | Description                                                                           | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| --------------- | ---------------------- | ------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| beneficiary     | `PriceBeneficiaryEnum` | Bénéficiaire de la structure tarifaire                                                |            |                 |             | 2.7.0                     |
| defaultPrice    | `Number`               | Tarif du bénéficiaire avant la prise en compte des dérogations                        |            |                 |             | 2.7.0                     |
| defaultRate     | `Number`               | Taux du bénéficiaire avant la prise en compte des dérogations                         |            |                 |             | 2.8.0                     |
| derogatedAmount | `Number`               | Montant dérogé du bénéficiaire. Il prend en compte l'ensemble des dérogations         |            |                 |             | 2.8.0                     |
| derogatedRate   | `Number`               | Taux du bénéficiaire. Il prend en compte l'ensemble des dérogations                   |            |                 |             | 2.8.0                     |
| isMandatory     | `Boolean`              | Permet de savoir si le bénéficiaire est obligatoire au sein de la structure tarifaire |            |                 |             | 2.4.0                     |
| price           | `Number`               | Tarif de la structure                                                                 |            |                 |             | 2.4.0                     |
| rate            | `Number`               | Taux de la structure                                                                  |            |                 |             | 2.4.0                     |
| id              | `String`               | Identifiant de l'entité `Price`                                                       |            | X               |             |                           |
| code            | `String`               | Codification fonctionnelle de l'entité `Price`                                        |            |                 |             |                           |
| externalId      | `String`               | Identifiant de l'entité `Price` dans le système client                                |            |                 |             |                           |
| externalCode    | `String`               | Codification fonctionnelle de l'entité `Price` dans le système client                 |            |                 |             |                           |
| priceId         | `String`               | Identifiant public de l'entité `Price` dans l'OIP                                     |            |                 |             |                           |
| label           | `String`               | Information relative au nom de l'entité `Price` dans son contexte d'utilisation       |            |                 |             |                           |
| createdAt       | `Date`                 | Date de création de l'entité `Price`                                                  |            | X               |             |                           |
| updatedAt       | `Date`                 | Date de modification de l'entité `Price`                                              |            | X               |             |                           |

## Enumérations

### PriceBeneficiaryEnum

- `ADULT`
- `ADULT_CHILD`
- `CHILD`
- `DUO`
- `EMPLOYEE`
- `FAMILY`
- `PARTNER`
- `TA`
- `TB`
- `TC`
- `UNIFORM`

## Enumérations génériques

Aucune enumération générique.

## 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 { getPriceBeneficiary, getPriceCode, getPriceDefaultPrice, getPriceDefaultRate, getPriceDerogatedAmount, getPriceDerogatedRate, getPriceExternalCode, getPriceExternalId, getPriceId, getPriceIsMandatory, getPriceLabel, getPricePrice, getPricePriceId, getPriceRate, setPriceBeneficiary, setPriceCode, setPriceDefaultPrice, setPriceDefaultRate, setPriceDerogatedAmount, setPriceDerogatedRate, setPriceExternalCode, setPriceExternalId, setPriceIsMandatory, setPriceLabel, setPricePrice, setPricePriceId, setPriceRate } from '@fasstech/oip-core/entities/Price';
import { PriceBeneficiaryEnum } from '@fasstech/oip-core/entities/Price/enums';
import { getPricingId } from '@fasstech/oip-core/entities/Pricing';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let offer = await Entities('Offer').create();
  let pack = await Entities('Pack').create();
  let pricing = await Entities('Pricing').create();
  const price = await Entities('Price').create();
  
  setPriceBeneficiary(PriceBeneficiaryEnum.UNIFORM, price);
  setPriceDefaultPrice(100, price);
  setPriceDefaultRate(100, price);
  setPriceDerogatedAmount(100, price);
  setPriceDerogatedRate(100, price);
  setPriceIsMandatory(false, price);
  setPricePrice(112, price);
  setPriceRate(114, price);
  setPriceCode('code', price);
  setPriceExternalId('externalId', price);
  setPriceExternalCode('externalCode', price);
  setPricePriceId('priceId', price);
  setPriceLabel('label', price);
  
  pricing = await Entities('Price').save(pricing, price);
  pack = await Entities('Pricing').save(pack, pricing);
  offer = await Entities('Pack').save(offer, pack);
  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) });
  const packToTest = await Entities('Pack').get(offerToTest, { filter: ({ id }) => id === getPackId(pack) });
  const pricingToTest = await Entities('Pricing').get(packToTest, { filter: ({ id }) => id === getPricingId(pricing) });
  const priceToTest = await Entities('Price').get(pricingToTest, { filter: ({ id }) => id === getPriceId(price) });
  
  getPriceBeneficiary(priceToTest); // PriceBeneficiaryEnum.UNIFORM
  getPriceDefaultPrice(priceToTest); // 100
  getPriceDefaultRate(priceToTest); // 100
  getPriceDerogatedAmount(priceToTest); // 100
  getPriceDerogatedRate(priceToTest); // 100
  getPriceIsMandatory(priceToTest); // false
  getPricePrice(priceToTest); // 112
  getPriceRate(priceToTest); // 114
  getPriceCode(priceToTest); // 'code'
  getPriceExternalId(priceToTest); // 'externalId'
  getPriceExternalCode(priceToTest); // 'externalCode'
  getPricePriceId(priceToTest); // 'priceId'
  getPriceLabel(priceToTest); // 'label'
})();
```
