diff options
Diffstat (limited to 'docs/MonthsApi.md')
| -rw-r--r-- | docs/MonthsApi.md | 39 |
1 files changed, 14 insertions, 25 deletions
diff --git a/docs/MonthsApi.md b/docs/MonthsApi.md index 337c03c..afa4884 100644 --- a/docs/MonthsApi.md +++ b/docs/MonthsApi.md @@ -11,23 +11,22 @@ Method | HTTP request | Description ## get_budget_month -> ::models::MonthDetailResponse get_budget_month(ctx, budget_id, month) +> crate::models::MonthDetailResponse get_budget_month(budget_id, month) Single budget month Returns a single budget month -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **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)) | +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 | ### Return type -[**::models::MonthDetailResponse**](MonthDetailResponse.md) +[**crate::models::MonthDetailResponse**](MonthDetailResponse.md) ### Authorization @@ -43,32 +42,22 @@ Name | Type | Description | Notes ## get_budget_months -> ::models::MonthSummariesResponse get_budget_months(ctx, budget_id, optional) +> crate::models::MonthSummariesResponse get_budget_months(budget_id, last_knowledge_of_server) List budget months Returns all budget months -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +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** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type -[**::models::MonthSummariesResponse**](MonthSummariesResponse.md) +[**crate::models::MonthSummariesResponse**](MonthSummariesResponse.md) ### Authorization |