Budget vs actual
get_budget_vs_actualCompare each category's budget with actual spending for a month to reveal over-budget or nearly used-up categories.
Instructions
Share of each category's budget spent in a month, to see what is over or close.
Use it for "am I over budget?" or "which categories are nearly used up?". Give month as the first day of a month, YYYY-MM-01; any other day is refused. 'current' is the month in progress, where a share under 100 may only mean the month is not over. Amounts in currency units, spending as a positive number; utilization_pct above 100 means over budget. carried_over says what the months before left in the category, so budgeted plus carried_over is what the month had to spend: a category can be over its budget and still have something left. For what is still available in each category use get_category_balances; for the month's totals, get_monthly_summary; for the months before, get_spending_trends. One YNAB request; changes nothing.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"plan_id": "<plan_id>"
},
"name": "get_budget_vs_actual"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | No | ISO month 'YYYY-MM-01' or 'current'. | current |
| plan_id | Yes | YNAB plan id or 'last-used'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |