Category balances for a month
get_category_balancesRetrieve budgeted, spent, and available amounts per category for a month to see where money went and what's left.
Instructions
Budgeted, spent (activity) and available (balance) per category for a month.
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. Use get_budget_vs_actual for the share of each budget consumed.
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 |