diff options
Diffstat (limited to 'ynab-api/docs/PayeesApi.md')
| -rw-r--r-- | ynab-api/docs/PayeesApi.md | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/ynab-api/docs/PayeesApi.md b/ynab-api/docs/PayeesApi.md deleted file mode 100644 index 173c79d..0000000 --- a/ynab-api/docs/PayeesApi.md +++ /dev/null @@ -1,83 +0,0 @@ -# \PayeesApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **get** /budgets/{budget_id}/payees/{payee_id} | Single payee -[**get_payees**](PayeesApi.md#get_payees) | **get** /budgets/{budget_id}/payees | List payees - - - -## get_payee_by_id - -> ::models::PayeeResponse get_payee_by_id(ctx, budget_id, payee_id) -Single payee - -Returns single payee - -### 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) | - **payee_id** | **String**| The id of the payee | - -### Return type - -[**::models::PayeeResponse**](PayeeResponse.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_payees - -> ::models::PayeesResponse get_payees(ctx, budget_id, optional) -List payees - -Returns all payees - -### 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::PayeesResponse**](PayeesResponse.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) - |