---
title: Price
slug: oip-next/cp2fpgh7pbphufsg78adr
createdAt: 2024-02-21T13:29:44.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   |

## Liste des propriétés

| Nom             | Type                   | Dernière version modifiée | Description                                                                           | Getter                  | Setter                  | Deprecated |
| --------------- | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------- | ----------------------- | ----------------------- | ---------- |
| beneficiary     | `PriceBeneficiaryEnum` | 2.7.0                     | Bénéficiaire de la structure tarifaire                                                | getPriceBeneficiary     | setPriceBeneficiary     | -          |
| createdAt       | `Date`                 |                           | Date de création de l'entité `Price`                                                  | getPriceCreatedAt       | Lecture seule           | -          |
| createdBy       | `String`               |                           | Utilisateur à l'origine de la création de l'entité `Price`                            | getPriceCreatedBy       | Lecture seule           | -          |
| defaultPrice    | `Number`               | 2.7.0                     | Tarif du bénéficiaire avant la prise en compte des dérogations                        | getPriceDefaultPrice    | setPriceDefaultPrice    | -          |
| defaultRate     | `Number`               | 2.8.0                     | Taux du bénéficiaire avant la prise en compte des dérogations                         | getPriceDefaultRate     | setPriceDefaultRate     | -          |
| derogatedAmount | `Number`               | 2.8.0                     | Montant dérogé du bénéficiaire. Il prend en compte l’ensemble des dérogations         | getPriceDerogatedAmount | setPriceDerogatedAmount | -          |
| derogatedRate   | `Number`               | 2.8.0                     | Taux du bénéficiaire. Il prend en compte l’ensemble des dérogations                   | getPriceDerogatedRate   | setPriceDerogatedRate   | -          |
| id              | `String`               |                           | Identifiant unique de l'entité `Price`                                                | getPriceId              | Lecture seule           | -          |
| isMandatory     | `Boolean`              | 2.4.0                     | Permet de savoir si le bénéficiaire est obligatoire au sein de la structure tarifaire | getPriceIsMandatory     | setPriceIsMandatory     | -          |
| price           | `Number`               | 2.4.0                     | Tarif de la structure                                                                 | getPricePrice           | setPricePrice           | -          |
| rate            | `Number`               | 2.4.0                     | Taux de la structure                                                                  | getPriceRate            | setPriceRate            | -          |
| updatedAt       | `Date`                 |                           | Date de modification de l'entité `Price`                                              | getPriceUpdatedAt       | Lecture seule           | -          |
| updatedBy       | `String`               |                           | Utilisateur à l'origine de la modification de l'entité `Price`                        | getPriceUpdatedBy       | Lecture seule           | -          |

## Enums

### PriceBeneficiaryEnum

- `PriceBeneficiaryEnum.ADULT`
- `PriceBeneficiaryEnum.ADULT_CHILD`
- `PriceBeneficiaryEnum.CHILD`
- `PriceBeneficiaryEnum.DUO`
- `PriceBeneficiaryEnum.EMPLOYEE`
- `PriceBeneficiaryEnum.FAMILY`
- `PriceBeneficiaryEnum.PARTNER`
- `PriceBeneficiaryEnum.TA`
- `PriceBeneficiaryEnum.TB`
- `PriceBeneficiaryEnum.TC`
- `PriceBeneficiaryEnum.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 { getPriceBeneficiary, getPriceDefaultPrice, getPriceDefaultRate, getPriceDerogatedAmount, getPriceDerogatedRate, getPriceIsMandatory, getPricePrice, getPriceRate, getpriceId, setPriceBeneficiary, setPriceDefaultPrice, setPriceDefaultRate, setPriceDerogatedAmount, setPriceDerogatedRate, setPriceIsMandatory, setPricePrice, 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 ProjectEntity = await Entities('Project').get({ id: projectId });
  let OfferEntity = await Entities('Offer').create();
  let PackEntity = await Entities('Pack').create();
  let PricingEntity = await Entities('Pricing').create();
  const PriceEntity = await Entities('Price').create();
  
  setPriceBeneficiary(PriceBeneficiaryEnum.UNIFORM, PriceEntity);
  setPriceDefaultPrice(100, PriceEntity);
  setPriceDefaultRate(100, PriceEntity);
  setPriceDerogatedAmount(100, PriceEntity);
  setPriceDerogatedRate(100, PriceEntity);
  setPriceIsMandatory(false, PriceEntity);
  setPricePrice(112, PriceEntity);
  setPriceRate(114, PriceEntity);
  
  PricingEntity = await Entities('Price').save(PricingEntity, PriceEntity);
  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));
  const PriceEntityToTest = await Entities('Price').get(PricingEntityToTest, getPriceId(PriceEntity));
  
  getPriceBeneficiary(PriceEntityToTest); // PriceBeneficiaryEnum.UNIFORM
  getPriceDefaultPrice(PriceEntityToTest); // 100
  getPriceDefaultRate(PriceEntityToTest); // 100
  getPriceDerogatedAmount(PriceEntityToTest); // 100
  getPriceDerogatedRate(PriceEntityToTest); // 100
  getPriceIsMandatory(PriceEntityToTest); // false
  getPricePrice(PriceEntityToTest); // 112
  getPriceRate(PriceEntityToTest); // 114
})();
```
