Bank Transactions

Bank transactions represent financial transactions that occur in bank accounts. They can be imported from bank statements or created manually, and are used to track money movement and reconcile with accounting records.

Endpoints

Query Parameters

The GET /bank-transactions endpoint supports the following query parameters:

Attributes

Transaction Details

Each bank transaction includes details that provide additional information about the transaction:

Transaction Statements

Bank transaction statements provide additional context and documentation for transactions:

Example Response

{
    "id": 1,
    "client_account_id": 1,
    "payee_name": "John Doe",
    "payee_bank_account_id": null,
    "payor_name": "ACME Corp",
    "payor_bank_account_id": null,
    "message_id": "MSG123",
    "payment_id": "PAY456",
    "instruction_id": "INS789",
    "end_to_end_id": "E2E123",
    "booking_date": "2023-05-10",
    "value_date": "2023-05-11",
    "memo": "Invoice payment",
    "instructed_amount": "1000.00",
    "instructed_currency_code": "USD",
    "instructed_exchange_rate": "1.0000",
    "amount": "1000.00",
    "currency_code": "USD",
    "exchange_rate": "1.0000",
    "bank_reference": "REF123",
    "external_reconciled_amount": "0.00",
    "details": [
        {
            "id": 1,
            "transaction_type": "CREDIT",
            "account_name": "ACME Corp",
            "account_number": "12345678",
            "account_currency_code": "USD",
            "archive_reference": "AR123",
            "structured_reference": "INV123",
            "bank_information": "Payment for services",
            "amount": "1000.00",
            "currency_code": "USD",
            "description": "Invoice payment INV123",
            "booking_date": "2023-05-10",
            "value_date": "2023-05-11",
            "invoice_number": "INV123",
            "sender_name": "ACME Corp",
            "sender_account": "87654321",
            "receiver_name": "John Doe",
            "receiver_account": "12345678",
            "transaction_uuid": "UUID123",
            "statement_uuid": "STMT123"
        }
    ],
    "statements": [
        {
            "id": 1,
            "created_at": "2023-05-10T12:00:00Z",
            "created_by_id": 1,
            "client_account_id": 1,
            "bank_transaction_id": 1,
            "category": "INVOICE",
            "business_partner_id": 2,
            "voucher_id": 3,
            "comment": "Invoice payment received"
        }
    ]
}

Get Single Transaction

GET /api/v2/bank-transactions/{id}

Retrieves a single bank transaction by ID. The details relation is included by default.

Path Parameters

Query Parameters

Response

Returns the bank transaction object — same shape as the entries in the list response (see the Example Response above).

Error Responses

Create Transaction

POST /api/v2/bank-transactions

Creates a new bank transaction. Use this when importing transactions that are not produced by an automatic bank integration. The created transaction is not automatically attached to a bank statement — to bundle transactions with opening/closing balances, use POST /bank-statements instead and pass the transactions in the transactions array.

Amount Sign Convention

amount is signed and selects which of the two bank-account fields is required:

• Positive amount (incoming credit — money received): payee_bank_account_id is required and must identify our bank account
• Negative amount (outgoing debit — money paid out): payor_bank_account_id is required and must identify our bank account

The counter-party name goes in the other *_name field — payor_name for incoming credits, payee_name for outgoing debits.

Request Body

The id and external_reconciled_amount fields are read-only and ignored on input.

Example Request

{
  "client_account_id": 7,
  "payee_bank_account_id": 24,
  "payor_name": "ACME Corp",
  "booking_date": "2024-03-15",
  "value_date": "2024-03-15",
  "amount": "2500.00",
  "currency_code": "NOK",
  "memo": "Invoice 1042"
}

Response (201 Created)

Returns the created bank transaction object. The details relation is not included by default on the create response — fetch via GET /bank-transactions/{id} if you need it.

Error Responses

Transaction Statement Endpoints

Bank transaction statements provide additional context and user-provided metadata for a bank transaction — such as the expense category, business partner, or a link to a voucher. Creating a statement automatically closes any open statement or upload questions for the bank transaction.

List Statements

GET /api/v2/bank-transactions/{id}/statements

Returns all statements for a specific bank transaction.

Path Parameters

Query Parameters

Response

[
  {
    "id": 1,
    "created_at": "2024-03-15T10:30:00Z",
    "created_by_id": 7,
    "client_account_id": 7,
    "bank_transaction_id": 123,
    "category": "INVOICE",
    "business_partner_id": 56,
    "voucher_id": 789,
    "comment": "Invoice payment received"
  }
]

Error Responses

Create Statement

POST /api/v2/bank-transactions/{id}/statements

Creates a new statement for a bank transaction. The client_account_id and bank_transaction_id are set automatically from the parent transaction. Creating a statement closes any open questions of type ATTACH_FILE or STATEMENT for the bank transaction.

Path Parameters

Request Body

Example Request

{
  "category": "INVOICE",
  "business_partner_id": 56,
  "voucher_id": 789,
  "comment": "Invoice payment received"
}

Response (201 Created)

Returns the created statement object.

Error Responses

Relationships

The details relationship is included by default in the response. Other relationships can be included using the with query parameter (comma-separated values).

Available relationships:

Notes

• The client_account_id must be one of the eligible client accounts for the authenticated user
• All amounts are returned as string representations of decimal numbers
• Dates are returned in ISO 8601 format (YYYY-MM-DD)
• When creating a transaction or statement, the created_by_id is automatically set to the authenticated user’s ID