Update banking rule

put

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

Full update of a banking rule; the rule's conditions replace the existing ones, and the rule is re-applied to pending bank transactions. First retrieve the current rule from /api/banking/rules/{id}, apply your changes, then send back the full object.

Required permission: Full Write Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the banking rule

Body Params

The details of the banking rule

name

string | null

required

The rule's name.

direction

object | null

required

The transaction direction the rule applies to: 1 = balance increases, 2 = balance decreases.

condition

object | null

required

How the rule's conditions combine: 1 = all of the following, 2 = any of the following.

account

object | null

required

The account (category) the rule assigns to matching transactions.

fund

object | null

required

The fund the rule assigns to matching transactions.

filters

array of objects | null

required

The rule's conditions. At least one is required.

filters*

int32

The rule's unique identifier.

accounts

array of objects | null

The bank accounts the rule applies to. Empty when the rule applies to all bank accounts.

accounts

type

object | null

How the rule is applied to transactions; always 1 (match).

destination

object | null

Where the rule applies: send id 1 to apply the rule to all bank accounts (ignoring accounts); any other value scopes it to the accounts list.

payee

object | null

A reference to an existing record by its id.

memo

string | null

The memo the rule assigns to matching transactions.

active

boolean | null

Whether the rule is active.

auto

boolean | null

Whether matching transactions are confirmed automatically without manual review.

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

404Not Found