GetMonth
Ynab_GetMonthGet a plan month's Ready to Assign, income, category balances, activity, and goal progress to assess monthly budget performance.
Instructions
Get one plan month: Ready to Assign, age of money, income, total assigned and activity, plus every category's assigned, activity and available amounts and goal progress.
Month totals cover all categories. When hidden categories are left out of the list, their combined amounts are in omitted_hidden_categories. Categories marked internal are YNAB system categories (e.g. Inflow: Ready to Assign), not budget lines.
This is the best single call for "how is my budget doing this month?".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | No | The plan month: 'current', or a date in the month such as '2026-03' or '2026-03-01'. | |
| plan_id | No | The YNAB plan (budget) ID. Defaults to 'last-used', the plan the user opened most recently. Use ListPlans to find other plan IDs. | |
| include_hidden | No | Include hidden categories. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||