spending_summary
Aggregate net spending over a date range, grouped by category, account, month, or envelope. Excludes transfers and income by default to reflect real spending.
Instructions
Aggregate net spending over a date range, grouped for budgeting.
group_by is category (default), account, org, month, or
envelope. Categories come from a local rules engine plus manual
overrides. Internal transfers and income (payroll, benefits, investment
income) are excluded by default so the totals reflect real spending; set
exclude_transfers=False or exclude_income=False to include them.
Per group, outflow is spend, inflow is refunds/returns that net
against it, and unclassified_inflow is positive amounts with no spending
category (surfaced but not netted). net is outflow plus refunds.
envelope rolls spend up by the configured budget envelope that owns each
account (so spend on a non-envelope account such as a loan or brokerage falls
into an (unmapped) bucket). It needs at least one envelope in the budget
config; with none configured it returns an error rather than an empty view.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | ||
| group_by | No | category | |
| start_date | No | ||
| exclude_income | No | ||
| include_pending | No | ||
| exclude_transfers | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||