---
title: Project
slug: oip-next/cdrzrsdeh1kewjjsrj6t
createdAt: 2024-02-21T13:26:18.000Z
---

# Project

## Description

L'entité Project est l'entité principale qui porte l'ensemble des autres entités.

## Relations

### Ascendantes

Aucune relation ascendante.

### Descendantes

| Entité             | Propriété           |
| ------------------ | ------------------- |
| Address            | address             |
| BankAccount        | bankAccount         |
| BankAccount        | bankAccounts        |
| ChosenRiskAndRange | chosenRiskAndRanges |
| CollectionNeed     | collectionNeeds     |
| Company            | companies           |
| Contact            | contacts            |
| Customer           | customer            |
| Demography         | demographies        |
| Document           | documents           |
| ErrorHistory       | errorHistory        |
| FollowUpHistory    | followUpHistory     |
| Grantee            | grantees            |
| History            | history             |
| Markup             | markups             |
| Offer              | offers              |
| Pension            | pension             |
| Product            | products            |
| Signature          | signature           |
| StatusHistory      | statusHistory       |
| Svc                | svcs                |
| Tns                | tns                 |
| Turnover           | turnovers           |
| User               | users               |

## Liste des propriétés

| Nom           | Type                | Dernière version modifiée | Description                                                                     | Getter                  | Setter               | Deprecated |
| ------------- | ------------------- | ------------------------- | ------------------------------------------------------------------------------- | ----------------------- | -------------------- | ---------- |
| createdAt     | `Date`              |                           | Date de création de l'entité `Project`                                          | getProjectCreatedAt     | Lecture seule        | -          |
| createdBy     | `String`            |                           | Utilisateur à l'origine de la création de l'entité `Project`                    | getProjectCreatedBy     | Lecture seule        | -          |
| externalId    | `String`            | 1.6.0                     | Identifiant externe du projet                                                   | getProjectExternalId    | setProjectExternalId | -          |
| id            | `String`            |                           | Identifiant unique de l'entité `Project`                                        | getProjectId            | Lecture seule        | -          |
| name          | `String`            | 1.5.0                     | Nom du projet                                                                   | getProjectName          | setProjectName       | -          |
| projectNumber | `Number`            | 2.0.0                     | Utilisé pour définir le numéro d'un contrat lisible par des utilisateurs finaux | getProjectProjectNumber | Lecture seule        | -          |
| status        | `projectStatusEnum` | 2.0.0                     | Statut du projet                                                                | getProjectStatus        | setProjectStatus     | -          |
| step          | `String`            | 1.6.0                     | Étape du projet                                                                 | getProjectStep          | setProjectStep       | -          |
| updatedAt     | `Date`              |                           | Date de modification de l'entité `Project`                                      | getProjectUpdatedAt     | Lecture seule        | -          |
| updatedBy     | `String`            |                           | Utilisateur à l'origine de la modification de l'entité `Project`                | getProjectUpdatedBy     | Lecture seule        | -          |

## Enums

### projectStatusEnum

- `projectStatusEnum.CREATED`
- `projectStatusEnum.DELETED`
- `projectStatusEnum.DIGITAL_SERVICE_DONE`
- `projectStatusEnum.DIGITAL_SERVICE_STARTED`
- `projectStatusEnum.EDITING`
- `projectStatusEnum.IN_PROGRESS`
- `projectStatusEnum.PENDING_APPROVAL`
- `projectStatusEnum.SENT_FOR_SIGNATURE`
- `projectStatusEnum.SIGNATURE_CANCELLED`
- `projectStatusEnum.SIGNATURE_EXPIRED`
- `projectStatusEnum.SIGNATURE_REFUSED`
- `projectStatusEnum.SIGNED`
- `projectStatusEnum.SUBSCRIPTION_PENDING`
- `projectStatusEnum.SUBSCRIPTION_ACCEPTED`
- `projectStatusEnum.SUBSCRIPTION_FAILED`
- `projectStatusEnum.MEDICAL_SELECTION_PENDING`
- `projectStatusEnum.MEDICAL_SELECTION_ACCEPTED`
- `projectStatusEnum.MEDICAL_SELECTION_REJECTED`
- `projectStatusEnum.MEDICAL_SELECTION_FINALIZED`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getProjectExternalId, getProjectName, getProjectStatus, getProjectStep, setProjectExternalId, setProjectName, setProjectStatus, setProjectStep } from '@fasstech/oip-core/entities/project';
import { projectStatusEnum } from '@fasstech/oip-core/entities/project/enums';

(async () => {
  const ProjectEntity = await Entities('Project').create();
  
  setProjectExternalId('externalId', ProjectEntity);
  setProjectName('name', ProjectEntity);
  setProjectStatus(projectStatusEnum.DELETED, ProjectEntity);
  setProjectStep('step', ProjectEntity);
  
  await Entities('Project').save(ProjectEntity);
  
  getProjectExternalId(ProjectEntity); // 'externalId'
  getProjectName(ProjectEntity); // 'name'
  getProjectStatus(ProjectEntity); // projectStatusEnum.DELETED
  getProjectStep(ProjectEntity); // 'step'
})();
```
