ynab_get_month
Retrieve a single YNAB budget month to view income, assigned, activity, Ready to Assign, age of money, and per-category assigned, activity, and available balances.
Instructions
Get one budget month: totals (income, assigned, activity, Ready to Assign, age of money) plus per-category assigned/activity/available for that month.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "ynab_get_month"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | No | Only categories whose group name contains this text. | |
| month | No | Month as 'current', 'YYYY-MM' or 'YYYY-MM-01'. | current |
| plan_id | No | Plan (budget) id from ynab_list_plans. Omit to use the configured default plan. | |
| include_zero | No | Include categories with nothing assigned, spent or available. | |
| only_overspent | No | Only categories with a negative available balance. | |
| include_categories | No | Set False to return only the month totals. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||