---
title: Contribution
slug: oip-next/pbgi-contribution
icon: {"lucideIcon":"📘"}
createdAt: 2024-10-16T07:12:57.000Z
---

# Contribution

## Description

L'entité Contribution représente la structure tarifaire appliquée au niveau courant. Fait partie d'une arborescence d'OfferNode. A utiliser comme un colorTree, chaque nœud est un résumé de ses nœuds enfants.

## Relations

### Ascendantes

| Entité    | Propriété     |
| --------- | ------------- |
| OfferNode | contributions |

### Descendantes

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

## Propriétés

| Nom                   | Type                             | Description                                                                            | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| --------------------- | -------------------------------- | -------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| appliedAmount         | `Number`                         | Montant absolu appliqué.                                                               |            |                 |             | 3.1.0                     |
| appliedRate           | `Number`                         | Taux relatif appliqué.                                                                 |            |                 |             | 3.1.0                     |
| commission            | `Number`                         | Commission touchée par l'utilisateur, en pourcentage.                                  |            |                 |             | 3.1.0                     |
| contributionFrequency | `ContributionFrequencyEnum`      | Fréquence de la structure tarifaire.                                                   |            |                 |             | 3.1.0                     |
| defaultAmount         | `Number`                         | Montant absolu par défaut.                                                             |            |                 |             | 3.1.0                     |
| defaultRate           | `Number`                         | Taux relatif par défaut.                                                               |            |                 |             | 3.1.0                     |
| derogatedAmount       | `Number`                         | Montant absolu dérogé, dans les bornes minmax.                                         |            |                 |             | 3.1.0                     |
| derogatedRate         | `Number`                         | Taux relatif dérogé, dans les bornes minmax.                                           |            |                 |             | 3.1.0                     |
| maxAmount             | `Number`                         | Montant absolu maximum.                                                                |            |                 |             | 3.1.0                     |
| maxRate               | `Number`                         | Taux relatif maximum.                                                                  |            |                 |             | 3.1.0                     |
| minAmount             | `Number`                         | Montant absolu minimum.                                                                |            |                 |             | 3.1.0                     |
| minRate               | `Number`                         | Taux relatif minimum.                                                                  |            |                 |             | 3.1.0                     |
| typologyFamily        | `ContributionTypologyFamilyEnum` | Type de structure tarifaire.                                                           |            |                 |             | 3.10.0                    |
| id                    | `String`                         | Identifiant de l'entité `Contribution`                                                 |            | X               |             |                           |
| code                  | `String`                         | Codification fonctionnelle de l'entité `Contribution`                                  |            |                 |             |                           |
| externalId            | `String`                         | Identifiant de l'entité `Contribution` dans le système client                          |            |                 |             |                           |
| externalCode          | `String`                         | Codification fonctionnelle de l'entité `Contribution` dans le système client           |            |                 |             |                           |
| contributionId        | `String`                         | Identifiant public de l'entité `Contribution` dans l'OIP                               |            |                 |             |                           |
| label                 | `String`                         | Information relative au nom de l'entité `Contribution` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt             | `Date`                           | Date de création de l'entité `Contribution`                                            |            | X               |             |                           |
| updatedAt             | `Date`                           | Date de modification de l'entité `Contribution`                                        |            | X               |             |                           |

## Enumérations

### ContributionFrequencyEnum

- `UNIQUE`
- `DAILY`
- `WEEKLY`
- `FORTNIGHTLY`
- `MONTHLY`
- `QUARTERLY`
- `HALF_YEARLY`
- `YEARLY`

### ContributionTypologyFamilyEnum

- `CHILD`
- `DUO`
- `EMPLOYEE`
- `FAMILY`
- `PARTNER`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCompanyId } from '@fasstech/oip-core/entities/Company';
import { getContributionAppliedAmount, getContributionAppliedRate, getContributionCode, getContributionCommission, getContributionContributionFrequency, getContributionContributionId, getContributionDefaultAmount, getContributionDefaultRate, getContributionDerogatedAmount, getContributionDerogatedRate, getContributionExternalCode, getContributionExternalId, getContributionId, getContributionLabel, getContributionMaxAmount, getContributionMaxRate, getContributionMinAmount, getContributionMinRate, getContributionTypologyFamily, setContributionAppliedAmount, setContributionAppliedRate, setContributionCode, setContributionCommission, setContributionContributionFrequency, setContributionContributionId, setContributionDefaultAmount, setContributionDefaultRate, setContributionDerogatedAmount, setContributionDerogatedRate, setContributionExternalCode, setContributionExternalId, setContributionLabel, setContributionMaxAmount, setContributionMaxRate, setContributionMinAmount, setContributionMinRate, setContributionTypologyFamily } from '@fasstech/oip-core/entities/Contribution';
import { ContributionFrequencyEnum, ContributionTypologyFamilyEnum } from '@fasstech/oip-core/entities/Contribution/enums';
import { getOfferNodeId } from '@fasstech/oip-core/entities/OfferNode';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let company = await Entities('Company').create();
  let offerNode = await Entities('OfferNode').create();
  const contribution = await Entities('Contribution').create();
  
  setContributionAppliedAmount(97, contribution);
  setContributionAppliedRate(97, contribution);
  setContributionCommission(99, contribution);
  setContributionContributionFrequency(ContributionFrequencyEnum.MONTHLY, contribution);
  setContributionDefaultAmount(100, contribution);
  setContributionDefaultRate(100, contribution);
  setContributionDerogatedAmount(100, contribution);
  setContributionDerogatedRate(100, contribution);
  setContributionMaxAmount(109, contribution);
  setContributionMaxRate(109, contribution);
  setContributionMinAmount(109, contribution);
  setContributionMinRate(109, contribution);
  setContributionTypologyFamily(ContributionTypologyFamilyEnum.DUO, contribution);
  setContributionCode('code', contribution);
  setContributionExternalId('externalId', contribution);
  setContributionExternalCode('externalCode', contribution);
  setContributionContributionId('contributionId', contribution);
  setContributionLabel('label', contribution);
  
  offerNode = await Entities('Contribution').save(offerNode, contribution);
  company = await Entities('OfferNode').save(company, offerNode);
  project = await Entities('Company').save(project, company);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const companyToTest = await Entities('Company').get(projectToTest, { filter: ({ id }) => id === getCompanyId(company) });
  const offerNodeToTest = await Entities('OfferNode').get(companyToTest, { filter: ({ id }) => id === getOfferNodeId(offerNode) });
  const contributionToTest = await Entities('Contribution').get(offerNodeToTest, { filter: ({ id }) => id === getContributionId(contribution) });
  
  getContributionAppliedAmount(contributionToTest); // 97
  getContributionAppliedRate(contributionToTest); // 97
  getContributionCommission(contributionToTest); // 99
  getContributionContributionFrequency(contributionToTest); // ContributionFrequencyEnum.MONTHLY
  getContributionDefaultAmount(contributionToTest); // 100
  getContributionDefaultRate(contributionToTest); // 100
  getContributionDerogatedAmount(contributionToTest); // 100
  getContributionDerogatedRate(contributionToTest); // 100
  getContributionMaxAmount(contributionToTest); // 109
  getContributionMaxRate(contributionToTest); // 109
  getContributionMinAmount(contributionToTest); // 109
  getContributionMinRate(contributionToTest); // 109
  getContributionTypologyFamily(contributionToTest); // ContributionTypologyFamilyEnum.DUO
  getContributionCode(contributionToTest); // 'code'
  getContributionExternalId(contributionToTest); // 'externalId'
  getContributionExternalCode(contributionToTest); // 'externalCode'
  getContributionContributionId(contributionToTest); // 'contributionId'
  getContributionLabel(contributionToTest); // 'label'
})();
```
