---
title: Pack
slug: oip-next/omthuiz6il-l9rf0r6o2w
createdAt: 2024-02-21T13:29:50.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 |

## Liste des propriétés

| Nom                    | Type                  | Dernière version modifiée | Description                                                   | Getter                        | Setter                        | Deprecated |
| ---------------------- | --------------------- | ------------------------- | ------------------------------------------------------------- | ----------------------------- | ----------------------------- | ---------- |
| TNSid                  | `String`              | 2.7.0                     | Id du travailleur non salarié (TNS).                          | getPackTNSid                  | setPackTNSid                  | -          |
| beneficiary            | `PackBeneficiaryEnum` | 2.7.0                     | Bénéficiaire de la structure tarifaire.                       | getPackBeneficiary            | setPackBeneficiary            | -          |
| createdAt              | `Date`                |                           | Date de création de l'entité `Pack`                           | getPackCreatedAt              | Lecture seule                 | -          |
| createdBy              | `String`              |                           | Utilisateur à l'origine de la création de l'entité `Pack`     | getPackCreatedBy              | Lecture seule                 | -          |
| customerId             | `String`              | 2.6.0                     | Identifiant de l'adhérent à qui s’applique la formule.        | getPackCustomerId             | setPackCustomerId             | -          |
| estimatedAnnualBudget  | `Number`              | 2.5.0                     | Budget estimé annuel.                                         | getPackEstimatedAnnualBudget  | setPackEstimatedAnnualBudget  | -          |
| estimatedMonthlyBudget | `Number`              | 2.5.0                     | Budget estimé mensuel.                                        | getPackEstimatedMonthlyBudget | setPackEstimatedMonthlyBudget | -          |
| externalId             | `String`              | 2.4.0                     | Identifiant externe de la formule dans le SI.                 | getPackExternalId             | setPackExternalId             | -          |
| externalQuoteId        | `String`              | 2.4.0                     | Numéro de devis externe dans le SI.                           | getPackExternalQuoteId        | setPackExternalQuoteId        | -          |
| granteeId              | `String`              | 2.4.0                     | Identifiant du bénéficiaire affilié à la formule.             | getPackGranteeId              | setPackGranteeId              | -          |
| id                     | `String`              |                           | Identifiant unique de l'entité `Pack`                         | getPackId                     | Lecture seule                 | -          |
| isRecommended          | `Boolean`             | 2.7.0                     | Indique si le pack est le résultat de la recommandation.      | getPackIsRecommended          | setPackIsRecommended          | -          |
| name                   | `String`              | 2.4.0                     | Nom de la formule.                                            | getPackName                   | setPackName                   | -          |
| status                 | `PackStatusEnum`      | 2.4.0                     | Statut de la formule.                                         | getPackStatus                 | setPackStatus                 | -          |
| updatedAt              | `Date`                |                           | Date de modification de l'entité `Pack`                       | getPackUpdatedAt              | Lecture seule                 | -          |
| updatedBy              | `String`              |                           | Utilisateur à l'origine de la modification de l'entité `Pack` | getPackUpdatedBy              | Lecture seule                 | -          |

## Enums

### PackBeneficiaryEnum

- `PackBeneficiaryEnum.TA`
- `PackBeneficiaryEnum.TB`
- `PackBeneficiaryEnum.TC`

### PackStatusEnum

- `PackStatusEnum.BLOCKED`
- `PackStatusEnum.CREATED`
- `PackStatusEnum.EDITING`
- `PackStatusEnum.IN_PROGRESS`
- `PackStatusEnum.REMOVED`
- `PackStatusEnum.SENT_FOR_SIGNATURE`
- `PackStatusEnum.SIGNATURE_CANCELLED`
- `PackStatusEnum.SIGNATURE_EXPIRED`
- `PackStatusEnum.SIGNATURE_REFUSED`
- `PackStatusEnum.SIGNED`
- `PackStatusEnum.WAIVER_ACCEPTED`
- `PackStatusEnum.WAIVER_IN_PROGRESS`
- `PackStatusEnum.WAIVER_REFUSED`
- `PackStatusEnum.SUBSCRIPTION_PENDING`
- `PackStatusEnum.SUBSCRIPTION_ACCEPTED`
- `PackStatusEnum.SUBSCRIPTION_FAILED`
- `PackStatusEnum.MEDICAL_SELECTION_PENDING`
- `PackStatusEnum.MEDICAL_SELECTION_ACCEPTED`
- `PackStatusEnum.MEDICAL_SELECTION_REJECTED`
- `PackStatusEnum.MEDICAL_SELECTION_INCREASED_RISK`
- `PackStatusEnum.MEDICAL_SELECTION_DEFERRAL`
- `PackStatusEnum.MEDICAL_SELECTION_PROCEEDING_DISCONTINUATION`
- `PackStatusEnum.MEDICAL_SELECTION_NO_FURTHER_ACTION`
- `PackStatusEnum.MEDICAL_SELECTION_ERROR`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getOfferId } from '@fasstech/oip-core/entities/offer';
import { getPackBeneficiary, getPackCustomerId, getPackEstimatedAnnualBudget, getPackEstimatedMonthlyBudget, getPackExternalId, getPackExternalQuoteId, getPackGranteeId, getPackIsRecommended, getPackName, getPackStatus, getPackTNSid, getpackId, setPackBeneficiary, setPackCustomerId, setPackEstimatedAnnualBudget, setPackEstimatedMonthlyBudget, setPackExternalId, setPackExternalQuoteId, setPackGranteeId, setPackIsRecommended, setPackName, setPackStatus, setPackTNSid } from '@fasstech/oip-core/entities/pack';
import { PackStatusEnum, PackBeneficiaryEnum } from '@fasstech/oip-core/entities/pack/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  let OfferEntity = await Entities('Offer').create();
  const PackEntity = await Entities('Pack').create();
  
  setPackTNSid('TNSid', PackEntity);
  setPackBeneficiary(PackBeneficiaryEnum.TC, PackEntity);
  setPackCustomerId('customerId', PackEntity);
  setPackEstimatedAnnualBudget(101, PackEntity);
  setPackEstimatedMonthlyBudget(101, PackEntity);
  setPackExternalId('externalId', PackEntity);
  setPackExternalQuoteId('externalQuoteId', PackEntity);
  setPackGranteeId('granteeId', PackEntity);
  setPackIsRecommended(false, PackEntity);
  setPackName('name', PackEntity);
  setPackStatus(PackStatusEnum.SUBSCRIPTION_FAILED, PackEntity);
  
  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));
  
  getPackTNSid(PackEntityToTest); // 'TNSid'
  getPackBeneficiary(PackEntityToTest); // PackBeneficiaryEnum.TC
  getPackCustomerId(PackEntityToTest); // 'customerId'
  getPackEstimatedAnnualBudget(PackEntityToTest); // 101
  getPackEstimatedMonthlyBudget(PackEntityToTest); // 101
  getPackExternalId(PackEntityToTest); // 'externalId'
  getPackExternalQuoteId(PackEntityToTest); // 'externalQuoteId'
  getPackGranteeId(PackEntityToTest); // 'granteeId'
  getPackIsRecommended(PackEntityToTest); // false
  getPackName(PackEntityToTest); // 'name'
  getPackStatus(PackEntityToTest); // PackStatusEnum.SUBSCRIPTION_FAILED
})();
```
