Reference: Payees
A payee is who a transaction was paid to or received from. This group covers listing, reading, and
renaming payees, plus the GPS locations the YNAB mobile app records for some of them
(list_payee_locations, get_payee_location, payee_locations) — those are read-only; nothing
here can set a location, only read what the app already recorded.
create_payee WRITE
Section titled “create_payee WRITE”Create a payee.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_id |
string | Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID. | |
name |
string | ✓ |
YNAB API
- POST
/budgets/{budget_id}/payees→ Payees/createPayee
get_payee READ
Section titled “get_payee READ”Get one payee by id.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_id |
string | Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID. | |
payee_id |
string | ✓ |
YNAB API
- GET
/budgets/{budget_id}/payees/{payee_id}→ Payees/getPayeeById
get_payee_location READ
Section titled “get_payee_location READ”Get one payee location by id.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_id |
string | Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID. | |
payee_location_id |
string | ✓ |
YNAB API
- GET
/budgets/{budget_id}/payee_locations/{payee_location_id}→ PayeeLocations/getPayeeLocationById
list_payee_locations READ
Section titled “list_payee_locations READ”List all payee GPS locations (set by the YNAB mobile app).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_id |
string | Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID. |
YNAB API
- GET
/budgets/{budget_id}/payee_locations→ PayeeLocations/getPayeeLocations
list_payees READ
Section titled “list_payees READ”List payees in a budget.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_id |
string | Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID. | |
last_knowledge_of_server |
number |
YNAB API
- GET
/budgets/{budget_id}/payees→ Payees/getPayees
payee_locations READ
Section titled “payee_locations READ”List the GPS locations recorded for one payee.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_id |
string | Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID. | |
payee_id |
string | ✓ |
YNAB API
- GET
/budgets/{budget_id}/payees/{payee_id}/payee_locations→ PayeeLocations/getPayeeLocationsByPayee
update_payee WRITE
Section titled “update_payee WRITE”Rename a payee.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_id |
string | Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID. | |
payee_id |
string | ✓ | |
name |
string | ✓ |
YNAB API
- PATCH
/budgets/{budget_id}/payees/{payee_id}→ Payees/updatePayee