post https://sandbox.onebrick.io/v1/categorization
This API helps you to categorize transactions based on a description.
Request parameters
Key Parameter | Data Type | Description |
---|---|---|
transaction_description_text | String | Required Transaction description from the financial Statements |
bankId | String | Required Destination ID related to the transaction |
direction | String | Required The direction of fund. Should be either in or out. in is for money in & out is for money out. |
amount | long | Optional Amount of Transaction. To separate transaction with same description that happened in almost the same time |
reference_id | String | Optional Reference ID of certain transaction |
Response parameters
Key Parameter | Data type | Description |
---|---|---|
category | List | Category key |
category_id | Integer | Category identification number of the transaction |
category_name | String | Category Name |
classification_group_id | Integer | Category-group Identification |
classification_group | String | Name of the Category-group mapped with its id |
classification_subgroup_id | Integer | Category-subgroup Identification |
classification_subgroup | String | Name of the Category-subgroup mapped with its id |