DevelopersAPIReferencecategories
Create category
Create a category. plTypes decides where transactions in it land in the P&L, and order sets its position in the list.
Authentication
Checking whether you're signed in…
POST
header
Authorization<token>A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.
companyId*stringLength
1 <= lengthapplication/json- body
name*stringLength
1 <= lengthemoji?string|nullplTypes*array<>system?booleanDefault
falseorder*numberCreated category
application/json- response
id*stringFormat
uuidcompanyId*stringFormat
uuidname*stringThe name of the category.
emoji*|An emoji representing the category.
plTypes*array<>The P&L types that the category can be used for.
system*booleanFlag indicating if this is a system-defined category.
systemKey*|Semantic key for system categories (e.g., revRecurring, paymentFees).
order*numberA number used for ordering categories in the UI.
Range
-8388608 <= value <= 8388607createdTime*|Format
date-timecreatedUserId*string|nulllastUpdatedTime*|Format
date-timelastUpdatedUserId*string|nullcurl -X POST "https://example.com/companies/string/categories" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "plTypes": [ "revenue" ], "order": 0 }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda", "name": "string", "emoji": "string", "plTypes": [ "revenue" ], "system": true, "systemKey": "string", "order": -8388608, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string"}