\CategoriesApi
All URIs are relative to https://api.youneedabudget.com/v1
| Method | HTTP request | Description |
|---|---|---|
| get_categories | get /budgets/{budget_id}/categories | List categories |
| get_category_by_id | get /budgets/{budget_id}/categories/{category_id} | Single category |
| get_month_category_by_id | get /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month |
| update_month_category | patch /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month |
get_categories
crate::models::CategoriesResponse get_categories(budget_id, last_knowledge_of_server) List categories
Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| budget_id | String | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | |
| last_knowledge_of_server | Option<i64> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. |
Return type
crate::models::CategoriesResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_category_by_id
crate::models::CategoryResponse get_category_by_id(budget_id, category_id) Single category
Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| budget_id | String | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | |
| category_id | String | The id of the category | [required] |
Return type
crate::models::CategoryResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_month_category_by_id
crate::models::CategoryResponse get_month_category_by_id(budget_id, month, category_id) Single category for a specific budget month
Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| budget_id | String | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | |
| month | String | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | [required] | |
| category_id | String | The id of the category | [required] |
Return type
crate::models::CategoryResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_month_category
crate::models::SaveCategoryResponse update_month_category(budget_id, month, category_id, data) Update a category for a specific month
Update a category for a specific month
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| budget_id | String | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | |
| month | String | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | [required] | |
| category_id | String | The id of the category | [required] | |
| data | SaveMonthCategoryWrapper | The category to update | [required] |
Return type
crate::models::SaveCategoryResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]