get_savings_rate
Compute savings rate as (income - spending) / income for a date range, showing the percentage saved. Identifies if spending exceeded income.
Instructions
Compute the user's savings rate over a period: (income − spending) / income, expressed as a percentage. Uses cash flow analytics. Higher is better; negative means the user spent more than they earned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End date (yyyy-MM-dd), defaults to today | |
| from | Yes | Start date (yyyy-MM-dd), required | |
| accountId | No | Cash account ID(s) (type '02_cash') to scope to; omit to use all cash accounts | |
| excludeTransfers | No | Exclude inter-account transfers from analytics |