Skip to content

Latest commit

 

History

History
69 lines (39 loc) · 2.47 KB

PayeeLocationsApi.md

File metadata and controls

69 lines (39 loc) · 2.47 KB

YNAB::PayeeLocationsApi

All URIs are relative to https://api.ynab.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

get_payee_location_by_id(budget_id, payee_location_id)

Single payee location

Returns a single payee location

Parameters

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.ynab.com/#oauth-default-budget).
payee_location_id String id of payee location

Return type

PayeeLocationResponse

get_payee_locations

get_payee_locations(budget_id)

List payee locations

Returns all payee locations

Parameters

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.ynab.com/#oauth-default-budget).

Return type

PayeeLocationsResponse

get_payee_locations_by_payee

get_payee_locations_by_payee(budget_id, payee_id)

List locations for a payee

Returns all payee locations for a specified payee

Parameters

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.ynab.com/#oauth-default-budget).
payee_id String id of payee

Return type

PayeeLocationsResponse