Sorry, you need to enable JavaScript to visit this website.
Skip to main content

Transactions - Category Rules Resource

Entity: categoryRules

Attribute Name Container Type Description
userDefinedRuleId bank
creditCard
investment
insurance
loan
long A unique identifier is generated for every rule the user creates.
memId bank
creditCard
investment
insurance
loan
long Unique identifier of the user.
transactionCategorisationId bank
creditCard
investment
insurance
loan
long Category ID that is assigned to the transaction when the transaction matches the rule clause. This is the id field of the transaction category resource.
rulePriority bank
creditCard
investment
insurance
loan
integer The order in which the rules are executed on transactions.
categoryLevelId bank
creditCard
investment
insurance
loan
integer The level of category for which the rule is created.
Valid Values: Category Level
ruleClauses bank
creditCard
investment
insurance
loan
entity Details of rules. 

Entity: ruleClauses

Attribute Name Container Type Description
ruleClauseId bank
creditCard
investment
insurance
loan
long A unique identifier was generated for the rule clause.
userDefinedRuleId bank
creditCard
investment
insurance
loan
long A unique identifier is generated for every rule the user creates.
field bank
creditCard
investment
insurance
loan
string The field for which the clause is created.
Valid Values: Category Rules Field
operation bank
creditCard
investment
insurance
loan
string Operation for which the clause is created.
Valid Values: Category Rules Operation
fieldValue bank
creditCard
investment
insurance
loan
string The value would be the amount in the event of an amount-based rule clause or the string value when there is a description-based rule clause.

Enums: Category Rules Operation

Operation Description
numberGreaterThan The rule applies only when the amount field exceeds the specified value.
numberLessThanEquals The rule is applied only when the amount field is less than or equal to the specified value.
numberEquals The rule is applied only when the amount field is equal to the specified value.
numberLessThan The rule is applied only when the amount field is lesser than the specified value.
numberGreaterThanEquals The rule is applied only when the amount field is greater than or equal to the specified value.
stringContains The rule is applied only when the description field contains the specified value.
stringEquals  The rule is applied only when the description field equals the specified value.

Enums: Category Rules Field

Field Description
amount The rule created will be based on the amount field.
description The rule created will be based on the description field.

Enums: Category Level

Value Description
3 Denotes that the category rule is created for a system-defined category.
4 Denotes that the category rule is created for subcategory.