Transactions Category Rules Resource - v1.0

Entity: transactionsCategoryRules

Attribute Name Container Type Description
userDefinedRuleId bank
creditCard
investment
insurance
loan
long Unique identifier 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 get executed on transactions.
categoryLevelId bank
creditCard
investment
insurance
loan
integer The level of the category for which the rule is created.
ruleClauses bank
creditCard
investment
insurance
loan
entity Details of rules. 


Entity: ruleClauses

Attribute Name Container Type Description
ruleClauseId bank
creditCard
investment
insurance
loan
long Unique identifier generated for the rule clause.
userDefinedRuleId bank
creditCard
investment
insurance
loan
long Unique identifier generated for every rule the user creates.
field bank
creditCard
investment
insurance
loan
string Field for which the clause is created.
operation bank
creditCard
investment
insurance
loan
string Operation for which the clause is created.
fieldValue bank
creditCard
investment
insurance
loan
string The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause.


Enums: Category Rules Operation

Operation Description
numberGreaterThan The rule gets applied only when the amount field is greater than the specified value.
numberLessThanEquals The rule gets applied only when the amount field is less than or equal to the specified value.
numberEquals The rule gets applied only when the amount field is equal to the specified value.
numberLessThan The rule gets applied only when the amount field is lesser than the specified value.
numberGreaterThanEquals The rule gets applied only when the amount field is greater than or equal to the specified value.
stringContains The rule gets applied only when the description field contains the specified value.
stringEquals  The rule gets 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 system defined category.
4 Denotes that the category rule is created for sub category.