income_by_source
Retrieve income totals by source for a date range, with optional grouping by month, quarter, or year and configurable category depth.
Instructions
Get income breakdown by source for a period.
Returns a compact aligned text table by default. Use verbose=true for the structured dict.
Args: start_date: Start of period (YYYY-MM-DD) end_date: End of period (YYYY-MM-DD) depth: Hierarchy depth for grouping (1 = top-level categories, 2 = subcategories) verbose: If false (default), compact text output — optimized for reading and token efficiency. If true, structured JSON, for when you need machine-readable fields rather than a report. group_by: Optional "month", "quarter", or "year" — split the range into sub-period columns and return a multi-period TSV table (source rows, one column per period plus Total and Avg). Overrides verbose.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | ||
| verbose | No | ||
| end_date | Yes | ||
| group_by | No | ||
| start_date | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |