Category groups — Summary by month
category_groups_summary_by_monthRetrieve monthly totals of budgeted, activity, and balance by category group to check budget health at group level.
Instructions
[READ] Per-group, per-month totals of budgeted, activity and balance. Most 'is this budget healthy' questions live at group level, and a group view is small enough to read whole where a category view is not. from_month and to_month: 'YYYY-MM', an ISO date, or 'current'. to_month defaults to the current month. Hidden categories are included by default here, because excluding them would silently drop the credit-card payment group; pass include_hidden=false to leave them out. Amounts are in milliunits (1000 = $1.00). Costs one YNAB request per month in the range (limit 36 months); check overview_request_budget before a long range.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | No | ||
| to_month | No | ||
| from_month | Yes | ||
| include_hidden | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||