get_budget_report
Compare actual spending against budget, highlighting categories that exceed the budgeted amount.
Instructions
Compare actual spending against budget.
Returns a compact text table by default with ⚠ markers on categories exceeding budget. Use verbose=true for the full structured dict.
Args: budget_name: Name of the budget. period: Which period to report: - None: Current period based on today's date (default) - Integer 0-11: Specific period - "ytd": Year to date (all periods up to current) - "all": All periods account: Optional filter to specific account or parent account. include_children: If True and account specified, include child accounts. verbose: If true, return the structured dict.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | ||
| account | No | ||
| verbose | No | ||
| budget_name | Yes | ||
| include_children | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |