income_summary
Retrieve year-to-date payroll earnings, including net pay and payroll savings, to calculate disposable income for expense coverage analysis.
Instructions
Year-to-date earnings from payroll. IMPORTANT: net_pay_ytd is only what reached a bank account; payroll_savings_ytd (401k/Roth/HSA/ESPP) also belongs to the user. Use disposable_ytd = net_pay + payroll_savings when judging whether income covers spending. imputed_offset_ytd is booked as both an earning and a deduction and nets to zero.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| year | No |