---
title: OfferNode
slug: oip-next/z298-offer
icon: {"lucideIcon":"📘"}
createdAt: 2024-10-16T07:10:44.000Z
---

# OfferNode

## Description

L'entité OfferNode représente la structure de l'offre commerciale formulée à un client.

## Relations

### Ascendantes

| Entité   | Propriété  |
| -------- | ---------- |
| Company  | offerNodes |
| Customer | offerNodes |
| Grantee  | offerNodes |
| Project  | offerNodes |
| Tns      | offerNodes |

### Descendantes

| Entité        | Propriété     |
| ------------- | ------------- |
| Contribution  | contributions |
| History       | history       |
| OSCommonProps | oSCommonProps |
| OSOfferProps  | oSOfferProps  |
| OfferNode     | offerNodes    |
| Parameter     | parameters    |

## Propriétés

| Nom                   | Type                | Description                                                                         | Validateur | Lecture seule ? | Dépréciée ?                                                                  | Dernière version modifiée |
| --------------------- | ------------------- | ----------------------------------------------------------------------------------- | ---------- | --------------- | ---------------------------------------------------------------------------- | ------------------------- |
| contributionStructure | `String`            | Structure de cotisations associé au nœud. Valeur libre pour le PERco.               |            |                 | Propriété remplacée ; Utiliser offerNode.OSCommonProps.contributionStructure | 3.1.0                     |
| description           | `String`            | Description du nœud.                                                                |            |                 |                                                                              | 3.1.0                     |
| level                 | `String`            | Level de couverture du nœud.                                                        |            |                 |                                                                              | 3.1.0                     |
| offerNodeType         | `OfferNodeTypeEnum` | Type sémantique du nœud.                                                            |            |                 |                                                                              | 3.1.0                     |
| status                | `String`            | Statut du nœud.                                                                     |            |                 | Propriété remplacée ; Utiliser offerNode.OSCommonProps.status                | 3.1.0                     |
| id                    | `String`            | Identifiant de l'entité `OfferNode`                                                 |            | X               |                                                                              |                           |
| code                  | `String`            | Codification fonctionnelle de l'entité `OfferNode`                                  |            |                 |                                                                              |                           |
| externalId            | `String`            | Identifiant de l'entité `OfferNode` dans le système client                          |            |                 |                                                                              |                           |
| externalCode          | `String`            | Codification fonctionnelle de l'entité `OfferNode` dans le système client           |            |                 |                                                                              |                           |
| offerNodeId           | `String`            | Identifiant public de l'entité `OfferNode` dans l'OIP                               |            |                 |                                                                              |                           |
| label                 | `String`            | Information relative au nom de l'entité `OfferNode` dans son contexte d'utilisation |            |                 |                                                                              |                           |
| createdAt             | `Date`              | Date de création de l'entité `OfferNode`                                            |            | X               |                                                                              |                           |
| updatedAt             | `Date`              | Date de modification de l'entité `OfferNode`                                        |            | X               |                                                                              |                           |

## Enumérations

### OfferNodeTypeEnum

- `OFFER`
- `PRODUCT_CONFIGURATION`
- `GUARANTEE_GROUP`
- `GUARANTEE`
- `MODULE`
- `MANAGEMENT_MODE`
- `INVESTMENT_PROFILE`
- `ITEM_CONFIGURATION`
- `TARIFF_STRUCTURE`
- `MODULE_GROUP`
- `OPTION_GROUP`
- `OPTION`

## 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 { getOfferNodeCode, getOfferNodeContributionStructure, getOfferNodeDescription, getOfferNodeExternalCode, getOfferNodeExternalId, getOfferNodeId, getOfferNodeLabel, getOfferNodeLevel, getOfferNodeOfferNodeId, getOfferNodeOfferNodeType, getOfferNodeStatus, setOfferNodeCode, setOfferNodeContributionStructure, setOfferNodeDescription, setOfferNodeExternalCode, setOfferNodeExternalId, setOfferNodeLabel, setOfferNodeLevel, setOfferNodeOfferNodeId, setOfferNodeOfferNodeType, setOfferNodeStatus } from '@fasstech/oip-core/entities/OfferNode';
import { OfferNodeTypeEnum } from '@fasstech/oip-core/entities/OfferNode/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let company = await Entities('Company').create();
  const offerNode = await Entities('OfferNode').create();
  
  setOfferNodeContributionStructure('contributionStructure', offerNode);
  setOfferNodeDescription('description', offerNode);
  setOfferNodeLevel('level', offerNode);
  setOfferNodeOfferNodeType(OfferNodeTypeEnum.ITEM_CONFIGURATION, offerNode);
  setOfferNodeStatus('status', offerNode);
  setOfferNodeCode('code', offerNode);
  setOfferNodeExternalId('externalId', offerNode);
  setOfferNodeExternalCode('externalCode', offerNode);
  setOfferNodeOfferNodeId('offerNodeId', offerNode);
  setOfferNodeLabel('label', offerNode);
  
  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) });
  
  getOfferNodeContributionStructure(offerNodeToTest); // 'contributionStructure'
  getOfferNodeDescription(offerNodeToTest); // 'description'
  getOfferNodeLevel(offerNodeToTest); // 'level'
  getOfferNodeOfferNodeType(offerNodeToTest); // OfferNodeTypeEnum.ITEM_CONFIGURATION
  getOfferNodeStatus(offerNodeToTest); // 'status'
  getOfferNodeCode(offerNodeToTest); // 'code'
  getOfferNodeExternalId(offerNodeToTest); // 'externalId'
  getOfferNodeExternalCode(offerNodeToTest); // 'externalCode'
  getOfferNodeOfferNodeId(offerNodeToTest); // 'offerNodeId'
  getOfferNodeLabel(offerNodeToTest); // 'label'
})();
```
