Create bank transactions

Create new bank transactions

POST /consumers/{consumer_id}/accounting/bank-transactions

Create bank transactions

cURL

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/bank-transactions \
  --header 'Content-Type: application/json' \
  --data '
{
  "bank_statement_date": "2023-12-25",
  "bank_account_id": "<string>",
  "currency": "<string>",
  "external_bank_statement_id": "<string>",
  "items": [
    {
      "amount": 123,
      "general_ledger_account": "<string>",
      "description": "<string>",
      "external_transaction_id": "<string>",
      "fee_amount": 0,
      "tax_amount": 0,
      "currency_exchange_rate": 1,
      "counterpart": {
        "id": "<string>",
        "name": "John Doe",
        "iban": "BE61310126985517",
        "bank_account": "310126985517"
      }
    }
  ],
  "opening_balance": 123,
  "pdf": "<string>",
  "pdf_name": "<string>"
}
'

200

{
  "bank_statement_date": "2023-12-25",
  "bank_account_id": "<string>",
  "currency": "<string>",
  "items": [
    {
      "amount": 123,
      "general_ledger_account": "<string>",
      "description": "<string>",
      "external_transaction_id": "<string>",
      "fee_amount": 0,
      "tax_amount": 0,
      "currency_exchange_rate": 1,
      "counterpart": {
        "id": "<string>",
        "name": "John Doe",
        "iban": "BE61310126985517",
        "bank_account": "310126985517"
      },
      "id": "<string>"
    }
  ],
  "id": "<string>",
  "external_bank_statement_id": "<string>"
}

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

bank_statement_date · string<date> · required

Date of the bank statement

bank_account_id · string · required

Unique ID of the bank account in the accounting system

Minimum string length: 1

currency · string · required

Currency of the bank statement. This must be the same as the currency of the bank account.

Minimum string length: 1

external_bank_statement_id · string · required

External bank statement ID. To be compatible with all software, we recommend to use only digits with a maximum length of 10.

Minimum string length: 1

items · BankTransactionItemIn · object[] · required

List of transaction items

Show child attributes

opening_balance · number | null

Opening balance of the bank account before the statement

pdf · string | null

Base64 PDF attachment of the bank statement.

pdf_name · string | null

A name for the PDF file to be created for accounting software that support it.

Required string length: 1 - 200

Pattern: ^[a-zA-Z0-9\-_ ]{1,196}(?:.pdf)?$

Response

200

application/json

Successful Response

bank_statement_date · string<date> · required

Date of the bank statement

bank_account_id · string · required

Unique ID of the bank account in the accounting system

Minimum string length: 1

currency · string · required

Currency of the bank statement. This must be the same as the currency of the bank account.

Minimum string length: 1

items · BankTransactionItemOut · object[] · required

List of transaction items with their IDs

Show child attributes

id · string | null

Internal bank statement ID generated by the accounting system

external_bank_statement_id · string | null

External bank statement ID