All URIs are relative to https://api.ynab.com/v1
| Method | HTTP request | Description |
|---|---|---|
| get_budget_by_id | GET /budgets/{budget_id} | Single budget |
| get_budget_settings_by_id | GET /budgets/{budget_id}/settings | Budget Settings |
| get_budgets | GET /budgets | List budgets |
get_budget_by_id(budget_id, opts)
Single budget
Returns a single budget with all related entities. This resource is effectively a full budget export.
| 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). | |
| last_knowledge_of_server | Integer | The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. | [optional] |
get_budget_settings_by_id(budget_id)
Budget Settings
Returns settings for a budget
| 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). |
get_budgets(opts)
List budgets
Returns budgets list with summary information
| Name | Type | Description | Notes |
|---|---|---|---|
| include_accounts | Boolean | Whether to include the list of budget accounts | [optional] |