Search banking rules

get

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

Retrieve a list of banking rules matching the given filters. Rules automatically assign an account, fund, payee, or memo to imported bank transactions that match their conditions.

Required permission: Full Read Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return rules whose name contains the given text.

account

string

Comma-delimited list of bank account ids (from the chart of accounts). Returns rules limited to one of those accounts; rules that apply to all bank accounts always match.

amount.start

double

Return rules with an amount condition of at least this value.

amount.end

double

Return rules with an amount condition of at most this value.

description

string

Return rules with a description condition containing the given text.

category

string

Comma-delimited list of chart of account ids. Returns rules that assign one of those accounts to matching transactions.

payee

string

Return rules that assign a payee whose name or aliases contain each word of the given text.

memo

string

Return rules that assign a memo containing the given text.

auto

boolean

If true, returns only rules that auto-confirm matching transactions; if false, only rules that require manual review.

active

boolean

If true, returns only active rules; if false, only inactive rules.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK