Skip to main content
POST
/
v0
/
categorization
/
rules
Create an Instance rule
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/categorization/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '
{
  "expression": "<string>",
  "ledger_name": "<string>",
  "name": "<string>",
  "priority": 123
}
'
{
  "id": "<string>",
  "expression": "<string>",
  "ledger_name": "<string>",
  "name": "<string>",
  "priority": 123
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
teal-instance-id
string
required

The Teal instance ID

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"