aboutsummaryrefslogtreecommitdiffstats
path: root/docs/MonthsApi.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/MonthsApi.md')
-rw-r--r--docs/MonthsApi.md83
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/MonthsApi.md b/docs/MonthsApi.md
new file mode 100644
index 0000000..337c03c
--- /dev/null
+++ b/docs/MonthsApi.md
@@ -0,0 +1,83 @@
+# \MonthsApi
+
+All URIs are relative to *https://api.youneedabudget.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_budget_month**](MonthsApi.md#get_budget_month) | **get** /budgets/{budget_id}/months/{month} | Single budget month
+[**get_budget_months**](MonthsApi.md#get_budget_months) | **get** /budgets/{budget_id}/months | List budget months
+
+
+
+## get_budget_month
+
+> ::models::MonthDetailResponse get_budget_month(ctx, budget_id, month)
+Single budget month
+
+Returns a single budget month
+
+### Required 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)) |
+
+### Return type
+
+[**::models::MonthDetailResponse**](MonthDetailResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_budget_months
+
+> ::models::MonthSummariesResponse get_budget_months(ctx, budget_id, optional)
+List budget months
+
+Returns all budget months
+
+### Required 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. |
+
+### Return type
+
+[**::models::MonthSummariesResponse**](MonthSummariesResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+