Skip to main content
POST
Create a Platform rule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Body

application/json
expression
string
required

A pattern matching expression using the match(pattern, field) function. Use t to access the Transaction object. The pattern supports regular expression syntax.

Read more: Categorization guide

Example:

"match(\".*(?i)SHELL GAS\", t.description)"

ledger_name
string
required

The name of the destination ledger.

Example:

"Fuel Expenses"

name
string
required

An arbitrary string to name the rule.

Example:

"Shell to Fuel Expenses"

priority
integer
required

The priority of the rule.

Example:

"100"

Response

Successful Response

id
string
required

The unique ID of the object.

Example:

"N6ntpvTtiA4L31vVyVat5n"

expression
string
required

A pattern matching expression using the match(pattern, field) function. Use t to access the Transaction object. The pattern supports regular expression syntax.

Read more: Categorization guide

Example:

"match(\".*(?i)SHELL GAS\", t.description)"

ledger_name
string
required

The name of the destination ledger.

Example:

"Fuel Expenses"

name
string
required

An arbitrary string to name the rule.

Example:

"Shell to Fuel Expenses"

priority
integer
required

The priority of the rule.

Example:

"100"