v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Bank transactions

Create bank transactions

Create new bank transactions

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

Path parameters

consumer_idstring uuid required

Query parameters

folder_idstring nullable

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

Request body

bank_statement_datestring date required

Date of the bank statement

bank_account_idstring required

Unique ID of the bank account in the accounting system

currencystring required

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

external_bank_statement_idstring required

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

opening_balancenumber nullable

Opening balance of the bank account before the statement

pdfstring nullable

Base64 PDF attachment of the bank statement.

pdf_namestring nullable

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

Example request

{
  "items": [
    {
      "counterpart": {
        "name": "John Doe",
        "iban": "BE61310126985517",
        "bank_account": "310126985517"
      }
    }
  ]
}

Response

Successful Response

bank_statement_datestring date required

Date of the bank statement

bank_account_idstring required

Unique ID of the bank account in the accounting system

currencystring required

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

idstring nullable

Internal bank statement ID generated by the accounting system

external_bank_statement_idstring nullable

External bank statement ID

Example response

{
  "items": [
    {
      "counterpart": {
        "name": "John Doe",
        "iban": "BE61310126985517",
        "bank_account": "310126985517"
      }
    }
  ]
}