get_budget_summary
View spending against budget across categories for any date range. Optionally break down by budget period.
Instructions
Get a summary of the user's budget for a specified date range. Returns per-category totals (other_activity, recurring_activity, budgeted, available, recurring_remaining, recurring_expected). Set include_occurrences=true for a per-period breakdown matching the account's budget periodicity. (Backed by the v2 GET /summary endpoint.)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| start_date | Yes | Start date in YYYY-MM-DD format. For aligned results use a valid budget period start (e.g. first day of month). | |
| end_date | Yes | End date in YYYY-MM-DD format. For aligned results use a valid budget period end (e.g. last day of month). | |
| include_exclude_from_budgets | No | Include categories that have the 'Exclude from Budgets' flag set in the returned categories array. | |
| include_occurrences | No | Include an `occurrences` array on each category, with one entry per budget period in the range. | |
| include_past_budget_dates | No | Include the three budget occurrences prior to start_date in `occurrences`. Ignored unless include_occurrences is also true. | |
| include_totals | No | Include a top-level `totals` section summarizing inflow and outflow across all transactions in the range. | |
| include_rollover_pool | No | Include a `rollover_pool` section summarizing the current rollover pool balance and previous adjustments. |