Get Income Expense Summary
get_income_expense_summaryRetrieve monthly income and expense summaries with savings rate, computed from non-transfer transactions, to analyze saving trends and month-end financial health.
Instructions
Read-only income vs. spending summary by month, computed from transaction history. Income counts non-transfer inflows to 'Inflow: Ready to Assign'; spending counts non-transfer outflows; transfers and deleted transactions are excluded, so credit card payments do not double-count. Includes per-month savings rate ((income - spending) / income). Use for savings-rate reports, month-end closes, and trend questions like 'am I saving enough'. Refunds appear as negative spending months' offsets, not income.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| budgetId | No | Budget ID (uses default if not provided) | |
| sinceDate | No | Start of the window (YYYY-MM-DD). Defaults to 6 full months back. | |
| untilDate | No | End of the window (YYYY-MM-DD). Defaults to today. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | Structured result returned by Get Income Expense Summary. |