The Categorisation Rules object

A categorisation rule defines a match condition (field, operator, value) and a target account. When a bank import transaction matches the condition, the target account is suggested for categorisation.

Attributes

id string
Integer rule ID. Immutable after creation.
name string
Display name for the rule (e.g. "Tesco — Office Expenses"). Max 100 characters.
description string
Optional description of the rule's purpose. Max 500 characters.
field string
The transaction field to match against: description, contact_name, amount, reference, or a metadata key (e.g. metadata.category).
operator string
The match operator: contains, equals, starts_with, ends_with, greater_than, less_than, or regex.
value string
The value to match. For description rules, this is normalised (uppercase, common prefixes stripped, trailing digits removed).
targetAccountId string
Prefixed ID of the target ledger account (e.g. acc_7400).
targetAccountCode string
Account code of the target (e.g. 7400). Read-only, joined from accounts.
targetAccountName string
Account name of the target (e.g. Office Expenses). Read-only, joined from accounts.
priority string
User-assigned priority (0–999). Higher values are evaluated first within the same provenance level.
active string
Whether the rule is active. Inactive rules are ignored during matching.
isSeed string
Whether this is a verified seed rule created during organisation setup. Read-only.
createdAt string
ISO 8601 creation timestamp.
updatedAt string
ISO 8601 last-updated timestamp.