---
title: PaymentMethod
slug: oip-next/5hnmm6sfy99dgrrbck3ys
createdAt: 2024-02-21T13:29:48.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 | bankAccount |
| Check       | check       |
| History     | history     |
| Mandate     | mandate     |

## 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é `PaymentMethod`                                                                                                | getPaymentMethodCreatedAt      | Lecture seule                  | -          |
| createdBy      | `String`             |                           | Utilisateur à l'origine de la création de l'entité `PaymentMethod`                                                                          | getPaymentMethodCreatedBy      | Lecture seule                  | -          |
| debitDate      | `Date`               | 2.7.0                     | Date d'utilisation du moyen de paiement. Elle sert comme valeur de référence pour calculer la récurrence de paiement avec `debitFrequency`. | getPaymentMethodDebitDate      | setPaymentMethodDebitDate      | -          |
| debitFrequency | `DebitFrequencyEnum` | 2.7.0                     | Fréquence de paiement                                                                                                                       | getPaymentMethodDebitFrequency | setPaymentMethodDebitFrequency | -          |
| id             | `String`             |                           | Identifiant unique de l'entité `PaymentMethod`                                                                                              | getPaymentMethodId             | Lecture seule                  | -          |
| updatedAt      | `Date`               |                           | Date de modification de l'entité `PaymentMethod`                                                                                            | getPaymentMethodUpdatedAt      | Lecture seule                  | -          |
| updatedBy      | `String`             |                           | Utilisateur à l'origine de la modification de l'entité `PaymentMethod`                                                                      | getPaymentMethodUpdatedBy      | Lecture seule                  | -          |

## Enums

### DebitFrequencyEnum

- `DebitFrequencyEnum.ANNUAL`
- `DebitFrequencyEnum.BIANNUAL`
- `DebitFrequencyEnum.MONTHLY`
- `DebitFrequencyEnum.ONE_TIME`
- `DebitFrequencyEnum.QUARTERLY`

## 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 { getPaymentMethodDebitDate, getPaymentMethodDebitFrequency, getpaymentMethodId, setPaymentMethodDebitDate, setPaymentMethodDebitFrequency } from '@fasstech/oip-core/entities/paymentMethod';
import { DebitFrequencyEnum } from '@fasstech/oip-core/entities/paymentMethod/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  let OfferEntity = await Entities('Offer').create();
  let PackEntity = await Entities('Pack').create();
  let PaymentEntity = await Entities('Payment').create();
  const PaymentMethodEntity = await Entities('PaymentMethod').create();
  
  setPaymentMethodDebitDate(new Date('2017-01-01'), PaymentMethodEntity);
  setPaymentMethodDebitFrequency(DebitFrequencyEnum.ANNUAL, PaymentMethodEntity);
  
  PaymentEntity = await Entities('PaymentMethod').save(PaymentEntity, PaymentMethodEntity);
  PackEntity = await Entities('Payment').save(PackEntity, PaymentEntity);
  OfferEntity = await Entities('Pack').save(OfferEntity, PackEntity);
  ProjectEntity = await Entities('Offer').save(ProjectEntity, OfferEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const OfferEntityToTest = await Entities('Offer').get(ProjectEntityToTest, getOfferId(OfferEntity));
  const PackEntityToTest = await Entities('Pack').get(OfferEntityToTest, getPackId(PackEntity));
  const PaymentEntityToTest = await Entities('Payment').get(PackEntityToTest, getPaymentId(PaymentEntity));
  const PaymentMethodEntityToTest = await Entities('PaymentMethod').get(PaymentEntityToTest, getPaymentMethodId(PaymentMethodEntity));
  
  getPaymentMethodDebitDate(PaymentMethodEntityToTest); // new Date('2017-01-01')
  getPaymentMethodDebitFrequency(PaymentMethodEntityToTest); // DebitFrequencyEnum.ANNUAL
})();
```
