Categories
Categories endpoint can be used to interact with users categories.
Resource representation
{
"id": "42",
"name": "Entertainment",
"modified": "2012-09-04T13:55:15Z",
"type": "expense",
"deleted": false,
"counts": {
"entries": 21,
"tags": 5
}
}Properties
|
id readonly string
|
Category id. |
|
name read, write string
|
Category name. Max length:100 |
|
read, write boolean
|
Is true if name is overriden with a custom name. |
|
modified readonly string
|
Specifies when the category was last modified. |
|
type read, write string
|
Category type. Possible values:expense, income, system |
|
deleted readonly boolean
|
Is object deleted. |
|
counts read, write object
|
Category usage stats. |
|
entries readonly integer
|
Number of entries with category. |
|
income_entries readonly integer
|
Number of income entries with category. Given only for unsorted category. |
|
expense_entries readonly integer
|
Number of expense entries with category. Given only for unsorted category. |
|
tags_used_with_category readonly integer
|
Number of tags used with category. |
|
income_tags_used_with_category readonly integer
|
Number of income tags used with category. Given only for unsorted category. |
|
expense_tags_used_with_category readonly integer
|
Number of expense tags used with category. Given only for unsorted category. |
|
tags readonly integer
|
Number of tags used with category. |
|
income_tags readonly integer
|
Number of income tags used with category. Given only for unsorted category. |
|
expense_tags readonly integer
|
Number of expense tags used with category. Given only for unsorted category. |
|
budgets readonly integer
|
Number of budgets with category. |
|
extra read, write object
|
A custom JSON object that you can use to extend Toshl API. Whatever you save into this field you will get back whenever you fetch it later. |
* denotes required field/parameter.