Reference: Budgets

YNAB calls the top-level thing you’re working in a Budget — its own accounts, categories, and transactions, addressable by id or the aliases last-used / default. (The YNAB API itself has since renamed this resource “Plan”; this server and its docs keep calling it a Budget, and the API still accepts the older /budgets/... paths these tools use.) Most other tools take an optional budget_id — leave it out and the server falls back to YNAB_BUDGET_ID (default last-used).

get_user lives in this group too: it just confirms which YNAB account the server is authenticated as.

Tools

budget_settings READ

Currency and date-format settings for a budget.

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}/settings → Plans/getPlanSettingsById

get_budget READ

Get one full budget export, optionally as a delta from server knowledge.

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} → Plans/getPlanById

get_user READ

Get the authenticated YNAB user’s id.

Parameters

No parameters.

YNAB API

• GET /user → User/getUser

list_budgets READ

List all budgets on the account (id, name, currency, date range).

Parameters

Name	Type	Required	Description
include_accounts	boolean		Include account summaries in each budget.

YNAB API

• GET /budgets → Plans/getPlans