---
title: Check
slug: oip-next/pgqbudc0xhxvujqzs2xwx
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# Check

## Description

L'entité Check regroupe les informations sur le moyen de paiement de type chèque.

## Relations

### Ascendantes

| Entité        | Propriété |
| ------------- | --------- |
| PaymentMethod | checks    |

### Descendantes

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

## Propriétés

| Nom          | Type     | Description                                                                     | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------ | -------- | ------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| documentId   | `String` | Relation document vers l'image du scan du chèque.                               |            |                 |             | 2.7.0                     |
| number       | `String` | Numéro du chèque bancaire.                                                      |            |                 |             | 2.7.0                     |
| id           | `String` | Identifiant de l'entité `Check`                                                 |            | X               |             |                           |
| code         | `String` | Codification fonctionnelle de l'entité `Check`                                  |            |                 |             |                           |
| externalId   | `String` | Identifiant de l'entité `Check` dans le système client                          |            |                 |             |                           |
| externalCode | `String` | Codification fonctionnelle de l'entité `Check` dans le système client           |            |                 |             |                           |
| checkId      | `String` | Identifiant public de l'entité `Check` dans l'OIP                               |            |                 |             |                           |
| label        | `String` | Information relative au nom de l'entité `Check` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt    | `Date`   | Date de création de l'entité `Check`                                            |            | X               |             |                           |
| updatedAt    | `Date`   | Date de modification de l'entité `Check`                                        |            | X               |             |                           |

## Enumérations

Aucune enumération.

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCheckCheckId, getCheckCode, getCheckDocumentId, getCheckExternalCode, getCheckExternalId, getCheckId, getCheckLabel, getCheckNumber, setCheckCheckId, setCheckCode, setCheckDocumentId, setCheckExternalCode, setCheckExternalId, setCheckLabel, setCheckNumber } from '@fasstech/oip-core/entities/Check';
import { getOfferId } from '@fasstech/oip-core/entities/Offer';
import { getPackId } from '@fasstech/oip-core/entities/Pack';
import { getPaymentId } from '@fasstech/oip-core/entities/Payment';
import { getPaymentMethodId } from '@fasstech/oip-core/entities/PaymentMethod';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let offer = await Entities('Offer').create();
  let pack = await Entities('Pack').create();
  let payment = await Entities('Payment').create();
  let paymentMethod = await Entities('PaymentMethod').create();
  const check = await Entities('Check').create();
  
  setCheckDocumentId('documentId', check);
  setCheckNumber('number', check);
  setCheckCode('code', check);
  setCheckExternalId('externalId', check);
  setCheckExternalCode('externalCode', check);
  setCheckCheckId('checkId', check);
  setCheckLabel('label', check);
  
  paymentMethod = await Entities('Check').save(paymentMethod, check);
  payment = await Entities('PaymentMethod').save(payment, paymentMethod);
  pack = await Entities('Payment').save(pack, payment);
  offer = await Entities('Pack').save(offer, pack);
  project = await Entities('Offer').save(project, offer);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const offerToTest = await Entities('Offer').get(projectToTest, { filter: ({ id }) => id === getOfferId(offer) });
  const packToTest = await Entities('Pack').get(offerToTest, { filter: ({ id }) => id === getPackId(pack) });
  const paymentToTest = await Entities('Payment').get(packToTest, { filter: ({ id }) => id === getPaymentId(payment) });
  const paymentMethodToTest = await Entities('PaymentMethod').get(paymentToTest, { filter: ({ id }) => id === getPaymentMethodId(paymentMethod) });
  const checkToTest = await Entities('Check').get(paymentMethodToTest, { filter: ({ id }) => id === getCheckId(check) });
  
  getCheckDocumentId(checkToTest); // 'documentId'
  getCheckNumber(checkToTest); // 'number'
  getCheckCode(checkToTest); // 'code'
  getCheckExternalId(checkToTest); // 'externalId'
  getCheckExternalCode(checkToTest); // 'externalCode'
  getCheckCheckId(checkToTest); // 'checkId'
  getCheckLabel(checkToTest); // 'label'
})();
```
