Exclude bank transactions

put

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

Exclude imported bank transactions from review so they are never posted to the register. Provide ids, or set include to false to exclude every transaction matching the filters. Transactions already posted to the register are skipped.

Required permission: Full Write 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.

Body Params

The selection criteria

ids

array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids

include

boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Responses

200

401

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