---
title: Pricing
slug: v08/pricing
description: Learn about the pricing entity and its properties, including module code, level, regime, surco, and tariff structure. Discover the various options available for regime and tariff structure through the pricingRegimeEnum and pricingTariffStructureEnum enume
icon: ▶️
createdAt: 2023-08-22T10:13:43.078Z
---

## Introduction

L'entité `pricing` correspond à la structure tarifaire de la formule. Elle sera rattachée à l'entité `pack` sous forme de tableau.

Si le module et le code sont présent, nous serons dans le détail d'un module.
Le cas échéant, nous serons sur la structure tarifaire agrégée de la formule.

## Propriétes

| Nom                              | Type                         | Description                                                                                                                       |
| -------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| id                               | `String`                     | Identifiant unique de l'entité `Pricing`                                                                                          |
| moduleCode                       | `String`                     | Code du module dans le SI                                                                                                         |
| moduleLabel                      | `String`                     | Libellé du module                                                                                                                 |
| level                            | `String`                     | Niveau du module / garantie                                                                                                       |
| value                            | `String`                     | Valeur de la garantie                                                                                                             |
| guaranteeCode                    | `String`                     | Code de la garantie dans le SI                                                                                                    |
| guaranteeLabel                   | `String`                     | Libellé de la garantie                                                                                                            |
| guaranteeGroup                   | `String`                     | Groupement de la garantie (Capital Décès, Invalidité, Handicap)                                                                   |
| subscriptionCode                 | `String[]`                   | Code du module ou de la garantie pour la mise en gestion.                                                                         |
| surco                            | `String`                     | Code de la surcomplémentaire si celle ci est sélectionnée dans le parcours.<br />Elle sera utilisée dans le cas du Booster 1 et 2 |
| tariffStructure                  | `pricingTariffStructureEnum` | Structure tarifaire : [pricingTariffStructureEnum](#)                                                                             |
| price                            | `Number`                     | Tarif total de la structure en tenant compte des remises ou majorations                                                           |
| rate                             | `Number`                     | Taux total de la structure en tenant compte des remises ou majorations                                                            |
| defaultPrice                     | `Number`                     | Tarif total de base avant toute remise ou majoration                                                                              |
| defaultRate                      | `Number`                     | Taux total de base avant toute remise ou majoration                                                                               |
| derogatedAmount                  | `Number`                     |  Total de toutes les remises ou majorations appliquées au tarif de base total                                                     |
| derogatedRate                    | `Number`                     | Total de toutes les remises ou majorations appliquées au taux de base total                                                       |
| estimatedAnnualBudget            | `Number`                     | Budget annuel estimé                                                                                                              |
| estimatedMonthlyBudget           | `Number`                     | Budget mensuel estimé                                                                                                             |
| discountedEstimatedAnnualBudget  | `Number`                     | Budget annuel estimé avec remise                                                                                                  |
| discountedEstimatedMonthlyBudget | `Number`                     | Budget mensuel estimé avec remise                                                                                                 |
| isSelected                       | `Boolean`                    | Permet de savoir quelle structure tarifaire a été sélectionnée                                                                    |
| createdAt                        | `Date`                       | Date de création de l'entité `Pricing`                                                                                            |
| updatedAt                        | `Date`                       | Date de modification de l'entité `Pricing`                                                                                        |

## Enumérations

### PricingRegimeEnum

- **REGIME\_GLOBAL&#x20;**: Régime général
- **REGIME\_AGRICOLE&#x20;**: Régime agricole
- **REGIME\_INDEPENDANT&#x20;**: Régime indépendant
- **REGIME\_LOCAL&#x20;**: Régime local Alsace-Modèle

### PricingTariffStructureEnum

- **EMPLOYEE\_FAMILY&#x20;**: Isolé / Famille
  - EMPLOYEE
  - FAMILY
- **EMPLOYEE\_DUO\_FAMILY&#x20;**: Isolé / Duo / Famille
  - EMPLOYEE
  - DUO
  - FAMILY
- **EMPLOYEE&#x20;**: Adulte / Conjoint / Enfant
  - ADULT
  - PARTNER
  - CHILD
- **FAMILY&#x20;**: Famille unique
  - FAMILY
- **ADULT\_CHILD&#x20;**: Salariée et enfant(s) / Conjoint
  - ADULT\_CHILD
  - PARTNER
- **TA\_TB**
  - TA
  - TB
- **TA\_TB\_TC**
  - TA
  - TB
  - TC

