Delete banking rules

delete

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

Delete banking rules in bulk. Provide ids, or explicitly set include to false to delete every rule matching the filters (and every rule outright when no filters are given); an empty body is rejected. The values the rules assigned to pending bank transactions are cleared.

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

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!