Retirement income gap
calculate_retirement_income_gapRetirement income gap for one of 35 countries (nl, se, dk, no, fi, is, cz, at, ch, pt, us, cn, de, jp, in, fr, it, ca, br, ru, kr, mx, es, id, tr, sa, pl, be, ar, ie, ae, sg, il, th, nz): from accessible savings, monthly saving, retirement spending and up to three pension streams the user enters (after tax, in today's money), the savings at retirement, the capital needed, the capital gap, the first-year monthly gap and the age the money runs out. It does not calculate national pension entitlements. All fields are required; amounts in the country's currency (see list_retirement_calculators), rates in percent per year; use monthly 0 for unused pension streams.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| age | Yes | Current age; whole years. | |
| endAge | Yes | Projection end age; must exceed retirement age; whole years. | |
| balance | Yes | Accessible savings in country currency; exclude capital behind entered pension payments | |
| country | Yes | Country code from list_retirement_calculators (not uk or au, which have their own tools). | |
| incomes | Yes | Exactly three user-supplied pension streams. Use zero monthly amount for unused streams. No entitlement or tax estimation. | |
| spending | Yes | Monthly retirement spending in today's country currency | |
| inflation | Yes | Annual inflation, percent | |
| netReturn | Yes | Nominal annual return after taxes and fees, percent; inflation is deducted by the model | |
| monthlySaving | Yes | Monthly savings in today's country currency | |
| retirementAge | Yes | Work-stop age; at least current age; not an entitlement age; whole years. | |
| include_projection | No | Also return annual cash-flow rows (default false: a compact summary). |