Category balances for a month
get_category_balancesFetch every visible category's budgeted, spent and available amounts for a specified month to reveal what remains and highlight possible overspending.
Instructions
Budgeted, spent (activity) and available (balance) per category for a month.
Use it for "how much is left in Groceries?" or to list every category's money. Amounts in currency units; activity is negative for spending. Hidden and internal categories are left out, and so are categories with nothing budgeted, spent or available unless include_empty is true. For the share of each budget consumed use get_budget_vs_actual; for the month's totals, get_monthly_summary. One YNAB request; changes nothing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | No | 'YYYY-MM-01' or 'current'. | current |
| plan_id | Yes | YNAB plan id or 'last-used'. | |
| include_empty | No | Also list categories with no amount at all. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |