Get Budget
get_budgetRetrieve a budget summary including name, currency, and counts of accounts, categories, and payees. Pass lastKnowledgeOfServer for a delta export.
Instructions
Get a budget summary including name, currency format, and account/category/payee counts. Pass lastKnowledgeOfServer to get a delta export instead: every entity (accounts, payees, categories, months, transactions, scheduled transactions, ...) that changed since that server knowledge, plus the new server_knowledge for the next delta request. A delta request with lastKnowledgeOfServer: 0 returns the full budget export, which can be very large — responses over the YNAB_MAX_RESPONSE_BYTES cap (default 8 MB) are rejected; on big budgets prefer incremental deltas or the dedicated list tools.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| budgetId | No | Budget ID (uses default if not provided) | |
| lastKnowledgeOfServer | No | Delta request server knowledge. When provided, returns changed entities and server_knowledge instead of the summary. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | Structured result returned by Get Budget. |