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

# Pack

## Description

L'entité Pack correspond à une formule. Cela peut s'apparenter à différents devis rattachés à une offre. On l'utilisera notamment dans la santé, la prévoyance collective ou pour les travailleurs non salariés (TNS).

## Relations

### Ascendantes

| Entité | Propriété |
| ------ | --------- |
| Offer  | packs     |

### Descendantes

| Entité        | Propriété      |
| ------------- | -------------- |
| Commission    | commissions    |
| History       | history        |
| Payment       | payments       |
| Pricing       | pricings       |
| Relation      | relation       |
| WaiverRequest | waiverRequests |

## Propriétés

| Nom                    | Type                  | Description                                                                    | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ---------------------- | --------------------- | ------------------------------------------------------------------------------ | ---------- | --------------- | ----------- | ------------------------- |
| TNSid                  | `String`              | Id du travailleur non salarié (TNS).                                           |            |                 |             | 2.7.0                     |
| beneficiary            | `PackBeneficiaryEnum` | Bénéficiaire de la structure tarifaire.                                        |            |                 |             | 2.7.0                     |
| customerId             | `String`              | Identifiant de l'adhérent à qui s'applique la formule.                         |            |                 |             | 2.6.0                     |
| estimatedAnnualBudget  | `Number`              | Budget estimé annuel.                                                          |            |                 |             | 2.5.0                     |
| estimatedMonthlyBudget | `Number`              | Budget estimé mensuel.                                                         |            |                 |             | 2.5.0                     |
| externalQuoteId        | `String`              | Numéro de devis externe dans le SI.                                            |            |                 |             | 2.4.0                     |
| granteeId              | `String`              | Identifiant du bénéficiaire affilié à la formule.                              |            |                 |             | 2.4.0                     |
| isRecommended          | `Boolean`             | Indique si le pack est le résultat de la recommandation.                       |            |                 |             | 2.7.0                     |
| name                   | `String`              | Nom de la formule.                                                             |            |                 |             | 2.4.0                     |
| status                 | `PackStatusEnum`      | Statut de la formule.                                                          |            |                 |             | 2.4.0                     |
| id                     | `String`              | Identifiant de l'entité `Pack`                                                 |            | X               |             |                           |
| code                   | `String`              | Codification fonctionnelle de l'entité `Pack`                                  |            |                 |             |                           |
| externalId             | `String`              | Identifiant de l'entité `Pack` dans le système client                          |            |                 |             |                           |
| externalCode           | `String`              | Codification fonctionnelle de l'entité `Pack` dans le système client           |            |                 |             |                           |
| packId                 | `String`              | Identifiant public de l'entité `Pack` dans l'OIP                               |            |                 |             |                           |
| label                  | `String`              | Information relative au nom de l'entité `Pack` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt              | `Date`                | Date de création de l'entité `Pack`                                            |            | X               |             |                           |
| updatedAt              | `Date`                | Date de modification de l'entité `Pack`                                        |            | X               |             |                           |

## Enumérations

### PackBeneficiaryEnum

- `TA`
- `TB`
- `TC`

### PackStatusEnum

- `BLOCKED`
- `CREATED`
- `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`

## 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 { getPackBeneficiary, getPackCode, getPackCustomerId, getPackEstimatedAnnualBudget, getPackEstimatedMonthlyBudget, getPackExternalCode, getPackExternalId, getPackExternalQuoteId, getPackGranteeId, getPackId, getPackIsRecommended, getPackLabel, getPackName, getPackPackId, getPackStatus, getPackTNSid, setPackBeneficiary, setPackCode, setPackCustomerId, setPackEstimatedAnnualBudget, setPackEstimatedMonthlyBudget, setPackExternalCode, setPackExternalId, setPackExternalQuoteId, setPackGranteeId, setPackIsRecommended, setPackLabel, setPackName, setPackPackId, setPackStatus, setPackTNSid } from '@fasstech/oip-core/entities/Pack';
import { PackBeneficiaryEnum, PackStatusEnum } from '@fasstech/oip-core/entities/Pack/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let offer = await Entities('Offer').create();
  const pack = await Entities('Pack').create();
  
  setPackTNSid('TNSid', pack);
  setPackBeneficiary(PackBeneficiaryEnum.TC, pack);
  setPackCustomerId('customerId', pack);
  setPackEstimatedAnnualBudget(101, pack);
  setPackEstimatedMonthlyBudget(101, pack);
  setPackExternalQuoteId('externalQuoteId', pack);
  setPackGranteeId('granteeId', pack);
  setPackIsRecommended(false, pack);
  setPackName('name', pack);
  setPackStatus(PackStatusEnum.IN_PROGRESS, pack);
  setPackCode('code', pack);
  setPackExternalId('externalId', pack);
  setPackExternalCode('externalCode', pack);
  setPackPackId('packId', pack);
  setPackLabel('label', pack);
  
  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) });
  
  getPackTNSid(packToTest); // 'TNSid'
  getPackBeneficiary(packToTest); // PackBeneficiaryEnum.TC
  getPackCustomerId(packToTest); // 'customerId'
  getPackEstimatedAnnualBudget(packToTest); // 101
  getPackEstimatedMonthlyBudget(packToTest); // 101
  getPackExternalQuoteId(packToTest); // 'externalQuoteId'
  getPackGranteeId(packToTest); // 'granteeId'
  getPackIsRecommended(packToTest); // false
  getPackName(packToTest); // 'name'
  getPackStatus(packToTest); // PackStatusEnum.IN_PROGRESS
  getPackCode(packToTest); // 'code'
  getPackExternalId(packToTest); // 'externalId'
  getPackExternalCode(packToTest); // 'externalCode'
  getPackPackId(packToTest); // 'packId'
  getPackLabel(packToTest); // 'label'
})();
```
