Search bank transactions

get

https://{tenant}.onechurchsoftware.com/api/banking/transactions

Retrieve a list of imported bank transactions for a bank account. The view parameter switches between pending transactions awaiting review (the default), transactions already posted to the register, and excluded transactions.

Required permission: Full Read Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

account

int32

required

≥ 1

The id of the bank account (from the chart of accounts) to list transactions for. Required.

entry

string

Comma-delimited list of bank transaction ids to retrieve.

date.start

date

Return transactions dated on or after this date.

date.end

date

Return transactions dated on or before this date.

description

string

Return transactions whose description contains the given text.

amount.start

double

Return transactions with an amount of at least this value.

amount.end

double

Return transactions with an amount of at most this value.

view

string

Which transactions to return: pending (awaiting review, the default), posted (already posted to the register), or excluded.

filter

string

Return transactions whose description contains the given text.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK