post https://api-lib.bambu.life/api/v2/educationDecumulator/calcEducationDecumulation
The following table describes the parameters for Decumulator (kid's education):
| Name | Date Type | Description | Mandatory | Sample Value | List of possible values | No. of decimals | Notes |
|---|---|---|---|---|---|---|---|
| targetGoalAmount | Number | Goal Amount | Y | 100000 | >0 | 2 | User-defined goal amount |
| yearsInUni | Number | Duration of the course undertaken | Y | 4 | >0 | 0 | Number of years to decumulateDefault: 4 |
| annualisedSavingsAcctIntR | Number | Annualized Saving Account Interest Rate | N | 0.0005 | 6 | "savings_account_interest_rate" of a specific country can be used from the Country Rates APIs to populate this field"Country rates APIs by the country code"field to use - savings_account_interest_rateDefault: 0.005 | |
| annualisedInfR | Number | Annualized Inflation Rate | N | 0.03 | 6 | "inflation_rate_long_term" of a specific country can be used from the Country Rates APIs to populate this field"Country rates APIs by the country code"field to use - inflation_rate_long_termDefault : 0.03 | |
| period | String | PMT Start period | N | end | 'end', 'beg' | Values are eitherbeg - for the beginning of the yearend - for end of the year Default: beg | |
| currentYear | Number | Year to Date | Y | 2019 | 0 | System generated Year to Date |
The following table describes the ouput for Decumulator (kid's education):
| Name | Date Type | Description | Sample Value | No. of decimals | Notes |
|---|---|---|---|---|---|
| actualYear | Number | Projection year | 2020 | 0 | Current year in the projection |
| years | Number | nth year of decumulation | 2 | 0 | |
| futurePV | Number | Future value of the Target amount | 10446 | 2 | |
| futureAnnuity | Number | The future value of an annuity is the value of a group of recurring payments at a specified date in the future. | 2500 | 2 | |
| projectedValue | Number | Projected lump sum value of user's account balance after an outflow of payment | 7946 | 2 | |
| graphArray | Array, Decimal | Values on the graph user's account balance after every outflow of payment. | "graphArray": [10000,7946,5800.389999999999,3559.0899999999992,1217.83] | 2 |