POST
/
consumers
/
{consumer_id}
/
accounting
/
bank-accounts
Create bank account
curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/bank-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "<string>",
  "currency": "<string>",
  "account_name": "<string>",
  "account_number": "<string>",
  "iban": "<string>",
  "bank_name": "<string>"
}'
{
  "id": "<string>",
  "code": "<string>",
  "currency": "<string>",
  "account_name": "<string>",
  "account_number": "<string>",
  "iban": "<string>",
  "bank_name": "<string>",
  "journal_id": "<string>",
  "ledger_account": "<string>"
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
folder_id
string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

Body

application/json
​
code
string
required

A userfriendly code to represent the bank account. This will be used as the code of the journal if we need to create a journal for the bank account.

Minimum length: 1
​
currency
string
required

Currency of the bank account (e.g., EUR, USD).

Minimum length: 1
​
bank_name
string
required

Name of the bank linked to the bank account.

​
account_name
string | null

Name of the bank account. Represents this specific bank account in the accounting system.

​
account_number
string | null

Unique number representing the bank account. At least one of the fields 'account_number' or 'IBAN' must be filled in.

​
iban
string | null

IBAN of the bank account. At least one of the fields 'account_number' or 'IBAN' must be filled in.

Response

Successful Response

​
id
string
required
​
code
string | null

A userfriendly code to represent the bank account. This will be used as the code of the journal if we need to create a journal for the bank account.

​
currency
string | null

Currency of the bank account (e.g., EUR, USD).

​
account_name
string | null

Name of the bank account. Represents this specific bank account in the accounting system.

​
account_number
string | null

Unique number representing the bank account.

​
iban
string | null

IBAN of the bank account.

​
bank_name
string | null

Name of the bank linked to the bank account.

​
journal_id
string | null

Indicates the journal used in the accounting system to represent the bank account. The journal contains all the transactions related to this specific bank account.

​
ledger_account
string | null

Indicates the ledger account used in the accounting system to represent the bank account. The ledger account is used in all the transactions related to this specific bank account. This ledger account is used to track the balance of the bank account.