PUT
/
api
/
banking
/
rules
/
{id}

Headers

Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

id
number
required

Body

application/json
name
string
required

The name of the bank rule

Example:

"Monthly Salary"

order
number
required

The order of the bank rule

Example:

1

applyIfAccountId
number
required

The account ID to apply the rule if

Example:

1

applyIfTransactionType
string
required

The transaction type to apply the rule if

Example:

"deposit"

conditionsType
string
required

The conditions type to apply the rule if

Example:

"and"

conditions
string[]
required

The conditions to apply the rule if

Example:
[
{
"field": "description",
"comparator": "contains",
"value": "Salary"
}
]
assignCategory
string
required

The category to assign the rule if

Example:

"Income:Salary"

assignAccountId
number
required

The account ID to assign the rule if

Example:

1

assignPayee
string
required

The payee to assign the rule if

Example:

"Employer Inc."

assignMemo
string
required

The memo to assign the rule if

Example:

"Monthly Salary"