\PayeeLocationsApi
All URIs are relative to https://api.youneedabudget.com/v1
Method | HTTP request | Description |
---|---|---|
get_payee_location_by_id | get /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location |
get_payee_locations | get /budgets/{budget_id}/payee_locations | List payee locations |
get_payee_locations_by_payee | get /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee |
get_payee_location_by_id
crate::models::PayeeLocationResponse get_payee_location_by_id(budget_id, payee_location_id) Single payee location
Returns a single payee location
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] | |
payee_location_id | String | id of payee location | [required] |
Return type
crate::models::PayeeLocationResponse
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_payee_locations
crate::models::PayeeLocationsResponse get_payee_locations(budget_id) List payee locations
Returns all payee locations
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] |
Return type
crate::models::PayeeLocationsResponse
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_payee_locations_by_payee
crate::models::PayeeLocationsResponse get_payee_locations_by_payee(budget_id, payee_id) List locations for a payee
Returns all payee locations for the specified payee
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] | |
payee_id | String | id of payee | [required] |
Return type
crate::models::PayeeLocationsResponse
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]