post https://api-lib.bambu.life/api/generalCalculator/v2/retirements/expenditures/futureAmount
Return a list of expenditure amount for all categories in future dollars
Request Data
| Name | Data Type | Mandatory | Description | Sample Value | Remarks |
|---|---|---|---|---|---|
| country | string | Y | country | US | alpha-2 code |
| region | string | Y | region of the location in particular country | Midwest | Some countries may have no region. Thus the value will be null |
| currentYear | number | Y | current year | 2020 | |
| age | number | Y | current age | 32 | |
| retirementAge | number | Y | the age at which user wants to stop working | 65 | |
| inflationRate | number | Y | the rate at which prices increase over time | 0.017 | |
| expenditures | string | Y | expenditure category | Food | |
| band | number | Y | a grouping classification of the expenditure amount | 7 |
Response Data
| Name | Data Type | Description | Sample Value | Remarks | Remarks |
|---|---|---|---|---|---|
| yearsToRetirement | number | the number of years user will retire from his current age until the retirement year | 33 | alpha-2 code | |
| retirementYear | number | year when user will retire | 2053 | Some countries may have no region. Thus the value will be null | |
| futureExpenditures | array | contain list of expenditure amount of all categories of all bands | [ { "expenditures": "Alcoholic Beverages", "band": 1, "amount": 26.16, "currency": "USD", "ageRange": "65 and above", "region": "Northeast" }, { "expenditures": "Alcoholic Beverages", "band": 2, "amount": 15.69, "currency": "USD", "ageRange": "65 and above", "region": "Northeast" }, ... { "expenditures": "Transportation", "band": 9, "amount": 1562.78, "currency": "USD", "ageRange": "65 and above", "region": "Northeast" }, { "expenditures": "Transportation", "band": 10, "amount": 1937.78, "currency": "USD", "ageRange": "65 and above", "region": "Northeast" } ] | ||
| expenditures | string | category of expenditure | Alcoholic Beverages | ||
| band | number | a grouping classification of the expenditure amount | 1 | ||
| amount | number | expenditure amount for particular category | 26.16 | ||
| currency | string | currency code of particular country | USD | ||
| ageRange | string | age range | 65 and above | ||
| region | string | region of the location in particular country | Northeast | Some countries may have no region. Thus the value will be null |