aboutsummaryrefslogtreecommitdiffstats
path: root/docs/PayeeLocationsApi.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/PayeeLocationsApi.md')
-rw-r--r--docs/PayeeLocationsApi.md106
1 files changed, 106 insertions, 0 deletions
diff --git a/docs/PayeeLocationsApi.md b/docs/PayeeLocationsApi.md
new file mode 100644
index 0000000..e51787a
--- /dev/null
+++ b/docs/PayeeLocationsApi.md
@@ -0,0 +1,106 @@
+# \PayeeLocationsApi
+
+All URIs are relative to *https://api.youneedabudget.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_payee_location_by_id**](PayeeLocationsApi.md#get_payee_location_by_id) | **get** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location
+[**get_payee_locations**](PayeeLocationsApi.md#get_payee_locations) | **get** /budgets/{budget_id}/payee_locations | List payee locations
+[**get_payee_locations_by_payee**](PayeeLocationsApi.md#get_payee_locations_by_payee) | **get** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee
+
+
+
+## get_payee_location_by_id
+
+> ::models::PayeeLocationResponse get_payee_location_by_id(ctx, budget_id, payee_location_id)
+Single payee location
+
+Returns a single payee location
+
+### 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_location_id** | **String**| id of payee location |
+
+### Return type
+
+[**::models::PayeeLocationResponse**](PayeeLocationResponse.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_payee_locations
+
+> ::models::PayeeLocationsResponse get_payee_locations(ctx, budget_id)
+List payee locations
+
+Returns all payee locations
+
+### 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) |
+
+### Return type
+
+[**::models::PayeeLocationsResponse**](PayeeLocationsResponse.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_payee_locations_by_payee
+
+> ::models::PayeeLocationsResponse get_payee_locations_by_payee(ctx, budget_id, payee_id)
+List locations for a payee
+
+Returns all payee locations for the specified 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**| id of payee |
+
+### Return type
+
+[**::models::PayeeLocationsResponse**](PayeeLocationsResponse.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)
+