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

idstring
Integer rule ID. Immutable after creation.
namestring
Display name for the rule (e.g. "Tesco to Office Expenses"). Max 100 characters.
descriptionstring
Optional description of the rule's purpose. Max 500 characters.
fieldstring
The transaction field to match against: description, contact_name, amount, reference, or a metadata key (metadata.category, metadata.project, metadata.department, metadata.tag).
operatorstring
The match operator: contains, equals, starts_with, ends_with, greater_than, less_than, or regex.
valuestring
The value to match. For description rules the value is normalised before storage (uppercased, common bank prefixes stripped, trailing digits removed) so it matches across varying bank formats.
targetAccountIdstring
Prefixed ID of the target ledger account (e.g. acc_7400).
targetAccountCodestring
Account code of the target (e.g. 7400). Read-only, joined from the account.
targetAccountNamestring
Account name of the target (e.g. Office Expenses). Read-only, joined from the account.
prioritystring
User-assigned priority (0 to 999). Higher values are evaluated first.
activestring
Whether the rule is active. Inactive rules are ignored during matching.
isSeedstring
Whether this is a seed rule provided at organisation setup. Read-only. Seed rules may be edited or deleted freely.
createdAtstring
ISO 8601 creation timestamp.
updatedAtstring
ISO 8601 last-updated timestamp.