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

# BankAccount

## Description

L'entité BankAccount regroupe les informations des comptes bancaires, que ce soit de type débit ou crédit, et cela pour tous les types d'utilisateurs.

## Relations

### Ascendantes

| Entité        | Propriété    |
| ------------- | ------------ |
| Company       | bankAccounts |
| Contact       | bankAccounts |
| Customer      | bankAccounts |
| Grantee       | bankAccounts |
| PaymentMethod | bankAccounts |
| Project       | bankAccounts |
| Tns           | bankAccounts |

### Descendantes

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

## Propriétés

| Nom               | Type                      | Description                                                                           | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ----------------- | ------------------------- | ------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| bankName          | `String`                  | Nom de la banque                                                                      |            |                 |             | 1.5.0                     |
| bic               | `String`                  | Code BIC de la banque                                                                 |            |                 |             | 1.5.0                     |
| debitDay          | `BankAccountDebitDayEnum` | Jour du prélèvement                                                                   |            |                 |             | 2.5.0                     |
| debitFrequency    | `BankAccountPeriodEnum`   | Fréquence du prélèvement                                                              |            |                 |             | 2.5.0                     |
| dueDate           | `Date`                    | Date d'échéance                                                                       |            |                 |             | 2.5.0                     |
| iban              | `String`                  | Code IBAN du compte                                                                   |            |                 |             | 1.5.0                     |
| ownerName         | `String`                  | Nom du titulaire du compte                                                            |            |                 |             | 1.5.0                     |
| renewalPeriod     | `BankAccountPeriodEnum`   | Période de renouvellement                                                             |            |                 |             | 2.5.0                     |
| type              | `String`                  | Type de règlement : PRELEVEMENT, VIREMENT, CHEQUE                                     |            |                 |             | 1.5.0                     |
| validityEndDate   | `Date`                    | Date de fin de validité                                                               |            |                 |             | 2.5.0                     |
| validityStartDate | `Date`                    | Date de début de validité                                                             |            |                 |             | 2.5.0                     |
| id                | `String`                  | Identifiant de l'entité `BankAccount`                                                 |            | X               |             |                           |
| code              | `String`                  | Codification fonctionnelle de l'entité `BankAccount`                                  |            |                 |             |                           |
| externalId        | `String`                  | Identifiant de l'entité `BankAccount` dans le système client                          |            |                 |             |                           |
| externalCode      | `String`                  | Codification fonctionnelle de l'entité `BankAccount` dans le système client           |            |                 |             |                           |
| bankAccountId     | `String`                  | Identifiant public de l'entité `BankAccount` dans l'OIP                               |            |                 |             |                           |
| label             | `String`                  | Information relative au nom de l'entité `BankAccount` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt         | `Date`                    | Date de création de l'entité `BankAccount`                                            |            | X               |             |                           |
| updatedAt         | `Date`                    | Date de modification de l'entité `BankAccount`                                        |            | X               |             |                           |

## Enumérations

### BankAccountDebitDayEnum

- `DAY_1`
- `DAY_2`
- `DAY_3`
- `DAY_4`
- `DAY_5`
- `DAY_6`
- `DAY_7`
- `DAY_8`
- `DAY_9`
- `DAY_10`
- `DAY_11`
- `DAY_12`
- `DAY_13`
- `DAY_14`
- `DAY_15`
- `DAY_16`
- `DAY_17`
- `DAY_18`
- `DAY_19`
- `DAY_20`
- `DAY_21`
- `DAY_22`
- `DAY_23`
- `DAY_24`
- `DAY_25`
- `DAY_26`
- `DAY_27`
- `DAY_28`

### BankAccountPeriodEnum

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

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getBankAccountBankAccountId, getBankAccountBankName, getBankAccountBic, getBankAccountCode, getBankAccountDebitDay, getBankAccountDebitFrequency, getBankAccountDueDate, getBankAccountExternalCode, getBankAccountExternalId, getBankAccountIban, getBankAccountId, getBankAccountLabel, getBankAccountOwnerName, getBankAccountRenewalPeriod, getBankAccountType, getBankAccountValidityEndDate, getBankAccountValidityStartDate, setBankAccountBankAccountId, setBankAccountBankName, setBankAccountBic, setBankAccountCode, setBankAccountDebitDay, setBankAccountDebitFrequency, setBankAccountDueDate, setBankAccountExternalCode, setBankAccountExternalId, setBankAccountIban, setBankAccountLabel, setBankAccountOwnerName, setBankAccountRenewalPeriod, setBankAccountType, setBankAccountValidityEndDate, setBankAccountValidityStartDate } from '@fasstech/oip-core/entities/BankAccount';
import { BankAccountDebitDayEnum, BankAccountPeriodEnum } from '@fasstech/oip-core/entities/BankAccount/enums';
import { getCompanyId } from '@fasstech/oip-core/entities/Company';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let company = await Entities('Company').create();
  const bankAccount = await Entities('BankAccount').create();
  
  setBankAccountBankName('bankName', bankAccount);
  setBankAccountBic('bic', bankAccount);
  setBankAccountDebitDay(BankAccountDebitDayEnum.DAY_24, bankAccount);
  setBankAccountDebitFrequency(BankAccountPeriodEnum.ANNUAL, bankAccount);
  setBankAccountDueDate(new Date('2017-01-01'), bankAccount);
  setBankAccountIban('iban', bankAccount);
  setBankAccountOwnerName('ownerName', bankAccount);
  setBankAccountRenewalPeriod(BankAccountPeriodEnum.MONTHLY, bankAccount);
  setBankAccountType('type', bankAccount);
  setBankAccountValidityEndDate(new Date('2017-01-01'), bankAccount);
  setBankAccountValidityStartDate(new Date('2017-01-01'), bankAccount);
  setBankAccountCode('code', bankAccount);
  setBankAccountExternalId('externalId', bankAccount);
  setBankAccountExternalCode('externalCode', bankAccount);
  setBankAccountBankAccountId('bankAccountId', bankAccount);
  setBankAccountLabel('label', bankAccount);
  
  company = await Entities('BankAccount').save(company, bankAccount);
  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 bankAccountToTest = await Entities('BankAccount').get(companyToTest, { filter: ({ id }) => id === getBankAccountId(bankAccount) });
  
  getBankAccountBankName(bankAccountToTest); // 'bankName'
  getBankAccountBic(bankAccountToTest); // 'bic'
  getBankAccountDebitDay(bankAccountToTest); // BankAccountDebitDayEnum.DAY_24
  getBankAccountDebitFrequency(bankAccountToTest); // BankAccountPeriodEnum.ANNUAL
  getBankAccountDueDate(bankAccountToTest); // new Date('2017-01-01')
  getBankAccountIban(bankAccountToTest); // 'iban'
  getBankAccountOwnerName(bankAccountToTest); // 'ownerName'
  getBankAccountRenewalPeriod(bankAccountToTest); // BankAccountPeriodEnum.MONTHLY
  getBankAccountType(bankAccountToTest); // 'type'
  getBankAccountValidityEndDate(bankAccountToTest); // new Date('2017-01-01')
  getBankAccountValidityStartDate(bankAccountToTest); // new Date('2017-01-01')
  getBankAccountCode(bankAccountToTest); // 'code'
  getBankAccountExternalId(bankAccountToTest); // 'externalId'
  getBankAccountExternalCode(bankAccountToTest); // 'externalCode'
  getBankAccountBankAccountId(bankAccountToTest); // 'bankAccountId'
  getBankAccountLabel(bankAccountToTest); // 'label'
})();
```
