Skip to main content
GET
Get Bank Transactions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
sort_by
enum<string>
default:timestamp
Available options:
timestamp,
amount,
account_mask,
agent_confidence_score,
counterparty,
reference_number,
description
sort_order
enum<string>
default:desc
Available options:
asc,
desc
date_from
string<date> | null

Filter transactions on or after this date (inclusive)

date_to
string<date> | null

Filter transactions on or before this date (inclusive)

bank_account_id
string | null

Bank account ID to filter by

search
string | null

Search in description, reference_number, counterparty_name, remote_id

status__in
enum<string>[] | null

Filter by cash application status

Status indicating the phase of cash application for a bank transaction.

Available options:
non_payment,
potential_payment,
draft_payment,
posted_payment,
handled_outside
allocation_status__in
enum<string>[] | null

Filter by allocation status (unallocated, partially_allocated, fully_allocated)

Allocation status for bank transactions.

Available options:
unallocated,
partially_allocated,
fully_allocated
include_withdrawals
boolean
default:false

Include withdrawal transactions in results (default: False)

has_posting_errors
boolean | null

Filter to transactions with (True) or without (False) posting errors

Response

Successful Response

data
BankTransactionListItem · object[]
required

The list of records.

current_page
integer
default:0
required

The current page.

total_records
integer | null
required

Total number of records.

Required range: x >= 0
next_page
integer | null
required

The next page number, if one exists.