GET
List bank statements
Organization space Accounting module For: Accountant · Permission: bank_statements.list Conditions
  • The accounting module must be active for the organization.
  • The caller must have been granted access to the book in the URL.
  • Only the organization’s own book is accepted; a company book or a client book is refused.
  • Only statements of the organization’s own book are listed.
Part of Reconcile bank statements.

Authorizations

Authorization
string
header
required

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

Path Parameters

book
string
required

Identifier of the book. Only the organization's own book is accepted.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
start_date,
end_date,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
money_account_id
string | null

Keeps only the statements of this money account (27-character KSUID string).

status
enum<string> | null

Keeps only statements in this status: open (still being reconciled) or reconciled (closed).

Available options:
open,
reconciled
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, money_account_id, label, start_date, end_date, opening_balance, closing_balance, currency_code, currency_exponent, status, reconciled_at, reconciled_by, reconciled_by_type, created_by, created_by_type, created_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: lines.

Response

Resource.

data
BankStatementResource · object[]
required

Items of this page.

meta
object
required

Pagination details.