Set a custom set of categories

POST

https://api.ntropy.com/v3/categories/:account_holder_type

POST

/v3/categories/:account_holder_type

1 from ntropy_sdk import SDK
2 
3 sdk = SDK("cd1H...Wmhl")
4 categories = sdk.categories.set(
5     "consumer",
6     {
7         "incoming": [
8             "transfer from investment app",
9             "transfer from stock broker",
10             "transfer from crypto broker",
11             "chargeback",
12             "freelance income",
13             "rideshare or delivery income",
14             "paycheck",
15             "benefits",
16             "interest earned",
17             "stock dividend",
18         ],
19         "outgoing": [
20             "digital content and streaming",
21             "vending machine",
22             "reversal",
23             "transfer to investment app",
24             "transfer to stock broker",
25             "transfer to crypto broker",
26             "adjustment",
27             "intra account transfer",
28             "inter account transfer",
29             "peer to peer transfer",
30             "funeral service",
31             "ATM withdrawal",
32             "teller withdrawal",
33         ],
34     },
35 )

Try it

200Successful

1 {
2   "incoming": [
3     "salary",
4     "investment income",
5     "other income"
6   ],
7   "outgoing": [
8     "rent",
9     "utilities",
10     "groceries",
11     "entertainment"
12   ]
13 }

Sets a custom set of categories. Transactions that don’t match a category will be categorized not enough information regardless of whether it is present in the set.

Path parameters

account_holder_typeenumRequired

An enumeration.

Allowed values:

Headers

X-Api-KeystringRequired

X-Application-IdstringRequired

Request

This endpoint expects an object.

incominglist of stringsRequired

outgoinglist of stringsRequired

Response

Custom categories successfully set.

incominglist of strings

outgoinglist of strings

Path parameters

Headers

Request

Response

Errors