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

# PaymentMethod

## Description

L'entité paymentMethod représente les moyens de paiement sélectionnés dans l'OAV. Potentiellement, un ou plusieurs moyens de paiement peuvent être définis.

## Relations

### Ascendantes

| Entité  | Propriété      |
| ------- | -------------- |
| Payment | paymentMethods |

### Descendantes

| Entité      | Propriété    |
| ----------- | ------------ |
| BankAccount | bankAccounts |
| Check       | checks       |
| History     | history      |
| Mandate     | mandates     |

## Propriétés

| Nom             | Type                              | Description                                                                                                                                 | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| --------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| debitDate       | `Date`                            | Date d'utilisation du moyen de paiement. Elle sert comme valeur de référence pour calculer la récurrence de paiement avec `debitFrequency`. |            |                 |             | 2.7.0                     |
| debitFrequency  | `PaymentMethodDebitFrequencyEnum` | Fréquence de paiement                                                                                                                       |            |                 |             | 2.7.0                     |
| id              | `String`                          | Identifiant de l'entité `PaymentMethod`                                                                                                     |            | X               |             |                           |
| code            | `String`                          | Codification fonctionnelle de l'entité `PaymentMethod`                                                                                      |            |                 |             |                           |
| externalId      | `String`                          | Identifiant de l'entité `PaymentMethod` dans le système client                                                                              |            |                 |             |                           |
| externalCode    | `String`                          | Codification fonctionnelle de l'entité `PaymentMethod` dans le système client                                                               |            |                 |             |                           |
| paymentMethodId | `String`                          | Identifiant public de l'entité `PaymentMethod` dans l'OIP                                                                                   |            |                 |             |                           |
| label           | `String`                          | Information relative au nom de l'entité `PaymentMethod` dans son contexte d'utilisation                                                     |            |                 |             |                           |
| createdAt       | `Date`                            | Date de création de l'entité `PaymentMethod`                                                                                                |            | X               |             |                           |
| updatedAt       | `Date`                            | Date de modification de l'entité `PaymentMethod`                                                                                            |            | X               |             |                           |

## Enumérations

### PaymentMethodDebitFrequencyEnum

- `ANNUAL`
- `BIANNUAL`
- `MONTHLY`
- `ONE_TIME`
- `QUARTERLY`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
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 { getPaymentMethodCode, getPaymentMethodDebitDate, getPaymentMethodDebitFrequency, getPaymentMethodExternalCode, getPaymentMethodExternalId, getPaymentMethodId, getPaymentMethodLabel, getPaymentMethodPaymentMethodId, setPaymentMethodCode, setPaymentMethodDebitDate, setPaymentMethodDebitFrequency, setPaymentMethodExternalCode, setPaymentMethodExternalId, setPaymentMethodLabel, setPaymentMethodPaymentMethodId } from '@fasstech/oip-core/entities/PaymentMethod';
import { PaymentMethodDebitFrequencyEnum } from '@fasstech/oip-core/entities/PaymentMethod/enums';
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();
  const paymentMethod = await Entities('PaymentMethod').create();
  
  setPaymentMethodDebitDate(new Date('2017-01-01'), paymentMethod);
  setPaymentMethodDebitFrequency(PaymentMethodDebitFrequencyEnum.ANNUAL, paymentMethod);
  setPaymentMethodCode('code', paymentMethod);
  setPaymentMethodExternalId('externalId', paymentMethod);
  setPaymentMethodExternalCode('externalCode', paymentMethod);
  setPaymentMethodPaymentMethodId('paymentMethodId', paymentMethod);
  setPaymentMethodLabel('label', paymentMethod);
  
  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) });
  
  getPaymentMethodDebitDate(paymentMethodToTest); // new Date('2017-01-01')
  getPaymentMethodDebitFrequency(paymentMethodToTest); // PaymentMethodDebitFrequencyEnum.ANNUAL
  getPaymentMethodCode(paymentMethodToTest); // 'code'
  getPaymentMethodExternalId(paymentMethodToTest); // 'externalId'
  getPaymentMethodExternalCode(paymentMethodToTest); // 'externalCode'
  getPaymentMethodPaymentMethodId(paymentMethodToTest); // 'paymentMethodId'
  getPaymentMethodLabel(paymentMethodToTest); // 'label'
})();
```
