action yodlee_create_or_run_transaction_categorization_rules {
label: "Create or Run Transaction Categorization Rule"
description: "The Create or Run Transaction Categorization Rule endpoint is used to:
Create transaction categorization rules for both system and user-defined categories.
Run all the transaction categorization rules to categorize transactions by calling the endpoint with action=run as the query parameter.
The input body parameters to create transaction categorization rules follow:
categoryId - This field is mandatory and numeric
priority - This field is optional and numeric. Priority decides the order in which the rule gets applied on transactions.
ruleClause - This field is mandatory and should contain at least one rule
field - The value can be description or amount
If the field value is description then,
1. operation - value can be stringEquals or stringContains
2. value - value should be min of 3 and max of 50 characters
If the field value is amount then,
1. operation - value can be numberEquals, numberLessThan, numberLessThanEquals, numberGreaterThan or numberGreaterThanEquals
2. value - min value 0 and a max value of 99999999999.99 is allowed
The HTTP response code is 201 (Created Successfully)."
provider: yodlee
method: POST
path: "/transactions/categories/rules"
encoding: json
input: {
type: "object"
properties: {
action: {
type: "string"
}
ruleParam: {
type: "string"
}
}
additionalProperties: false
}
output: {
type: "object"
additionalProperties: true
}
}