---
title: Commission
slug: oip-next/mvutcq77ugjryldkpj1k
createdAt: 2024-02-21T13:40:13.000Z
---

# Commission

## Description

L'entité Commission correspond à la commission touchée par l’agent/courtier pour une formule donnée.

## Relations

### Ascendantes

| Entité           | Propriété   |
| ---------------- | ----------- |
| HypothesisResult | commissions |
| Pack             | commissions |

### Descendantes

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

## Liste des propriétés

| Nom       | Type                 | Dernière version modifiée | Description                                                         | Getter                 | Setter              | Deprecated |
| --------- | -------------------- | ------------------------- | ------------------------------------------------------------------- | ---------------------- | ------------------- | ---------- |
| amount    | `Number`             | 2.4.0                     | Montant de la commission                                            | getCommissionAmount    | setCommissionAmount | -          |
| createdAt | `Date`               |                           | Date de création de l'entité `Commission`                           | getCommissionCreatedAt | Lecture seule       | -          |
| createdBy | `String`             |                           | Utilisateur à l'origine de la création de l'entité `Commission`     | getCommissionCreatedBy | Lecture seule       | -          |
| id        | `String`             |                           | Identifiant unique de l'entité `Commission`                         | getCommissionId        | Lecture seule       | -          |
| rate      | `Number`             | 2.4.0                     | Taux de la commission                                               | getCommissionRate      | setCommissionRate   | -          |
| type      | `typeCommissionEnum` | 2.7.0                     | Type de commission                                                  | getCommissionType      | setCommissionType   | -          |
| updatedAt | `Date`               |                           | Date de modification de l'entité `Commission`                       | getCommissionUpdatedAt | Lecture seule       | -          |
| updatedBy | `String`             |                           | Utilisateur à l'origine de la modification de l'entité `Commission` | getCommissionUpdatedBy | Lecture seule       | -          |

## Enums

### typeCommissionEnum

- `typeCommissionEnum.APPORTEUR`
- `typeCommissionEnum.COMPLETION_WARRANTY`
- `typeCommissionEnum.MANDATORY_FIRST_YEAR_DEPOSIT`
- `typeCommissionEnum.MANDATORY_DEPOSIT_FEE`
- `typeCommissionEnum.EUROS_EXPANSE_RATIO`
- `typeCommissionEnum.UNITS_OF_ACCOUNTS_EXPANSE_RATIO`
- `typeCommissionEnum.ARREARS_EXPANSE_RATIO`
- `typeCommissionEnum.SUPPLEMENTARY_COVERAGE`
- `typeCommissionEnum.BASE`
- `typeCommissionEnum.TRANSFER`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCommissionAmount, getCommissionRate, getCommissionType, getcommissionId, setCommissionAmount, setCommissionRate, setCommissionType } from '@fasstech/oip-core/entities/commission';
import { typeCommissionEnum } from '@fasstech/oip-core/entities/commission/enums';
import { getHypothesisId } from '@fasstech/oip-core/entities/hypothesis';
import { getHypothesisResultId } from '@fasstech/oip-core/entities/hypothesisResult';
import { getOfferId } from '@fasstech/oip-core/entities/offer';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  let OfferEntity = await Entities('Offer').create();
  let HypothesisEntity = await Entities('Hypothesis').create();
  let HypothesisResultEntity = await Entities('HypothesisResult').create();
  const CommissionEntity = await Entities('Commission').create();
  
  setCommissionAmount(97, CommissionEntity);
  setCommissionRate(114, CommissionEntity);
  setCommissionType(typeCommissionEnum.MANDATORY_FIRST_YEAR_DEPOSIT, CommissionEntity);
  
  HypothesisResultEntity = await Entities('Commission').save(HypothesisResultEntity, CommissionEntity);
  HypothesisEntity = await Entities('HypothesisResult').save(HypothesisEntity, HypothesisResultEntity);
  OfferEntity = await Entities('Hypothesis').save(OfferEntity, HypothesisEntity);
  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 HypothesisEntityToTest = await Entities('Hypothesis').get(OfferEntityToTest, getHypothesisId(HypothesisEntity));
  const HypothesisResultEntityToTest = await Entities('HypothesisResult').get(HypothesisEntityToTest, getHypothesisResultId(HypothesisResultEntity));
  const CommissionEntityToTest = await Entities('Commission').get(HypothesisResultEntityToTest, getCommissionId(CommissionEntity));
  
  getCommissionAmount(CommissionEntityToTest); // 97
  getCommissionRate(CommissionEntityToTest); // 114
  getCommissionType(CommissionEntityToTest); // typeCommissionEnum.MANDATORY_FIRST_YEAR_DEPOSIT
})();
```
