Cash Flow Inputs
Cash flows are a core component of the RISE API object model. Nearly everything (savings, income, expenses) can and should be expressed as a cash flow. Some examples include:
Pension Cash Flow
Note the use of an optional profile tag to help identify the request round-trip (the tag is echoed in the response).
{
"data": [
{
"id": "100",
"type": "profile",
"attributes": {
"strategy": null
"portfolio": [
{
"categorization": {
"income": true,
"type": "Other Retirement Income",
"subtype": "Pension Income"
},
"cashflows": {
"type": "pension",
"timeStep": "annual",
"startTime": 12,
"amount": 85216.14,
"benefitAfterSpouseDies": 0.50,
"socialSecurityReduction": true
}
}
],
"primary": {
"name": "John Doe",
"gender": "M",
"age": 53,
"retirementAge": 65
},
"secondary": {
"name": "Mary Doe",
"gender": "F",
"age": 49,
"retirementAge": 67
},
"tag": "passthrough"
}
}
]
}
Multiple Accounts
The following example illustrates the structure for three accounts under the profile (two income and one expense), using explicit, parameterized and healthcare cashflow types, for a single investor as well as explicit strategy overrides to include both a variable annuity and a deferred income annuity in the second strategy.
{
"data": [
{
"id": "200",
"type": "profile",
"attributes": {
"strategy": {
"strategy1":[{
"productId": 1,
"allocation": 0,
"issueAge": 65,
"withdrawalAge": 65,
"equityAllocation": 0.6,
"bondAllocation": 0.4,
"fundFees": 0.01,
"meCharge": 0.003,
"riderCharge": 0.0085,
"riderChargeBasis": 1,
"withdrawalRate": 0.05,
"ratchet": true,
"bonusPeriod": 1,
"bonusPercentage": 0,
"bonusType": 1,
},{
"productId": 2,
"allocation": 0,
"issueAge": 65,
"withdrawalAge": 65
}],
"strategy2":[{
"productId": 1,
"allocation": 0.1,
"issueAge": 65,
"withdrawalAge": 65,
"equityAllocation": 0.6,
"bondAllocation": 0.4,
"fundFees": 0.01,
"meCharge": 0.003,
"riderCharge": 0.0085,
"riderChargeBasis": 1,
"withdrawalRate": 0.05,
"ratchet": true,
"bonusPeriod": 1,
"bonusPercentage": 0,
"bonusType": 1,
},{
"productId": 2,
"allocation": 0.1,
"issueAge": 65,
"withdrawalAge": 65
}],
"portfolio": [
{
"categorization": {
"income": true,
"type": "Other Retirement Income",
"subtype": "Rental Property Income"
},
"cashflows": {
"type": "explicit",
"timeStep": "monthly",
"startTime": 12,
"itemKey": "MGP-A1B2C3",
"vector": [
2317.33,
2317.33,
2317.34,
2317.33,
2317.33,
2317.34,
2317.33,
2317.33,
2317.34,
2317.33,
2317.33,
2317.34,
2317.33,
2317.33,
2317.34,
2317.33,
2317.33,
2317.34,
2317.33,
2317.33,
2317.34,
2317.33,
2317.33,
2317.34
]
}
},
{
"categorization": {
"income": true,
"type": "Investment Assets - Individual Retirement Accounts",
"subtype": "Roth IRA - Inherited IRA"
},
"cashflows": {
"type": "parameterized",
"timeStep": "annual",
"startTime": 8,
"itemKey": "ROTHINH",
"amount": 343262.38,
}
},
{
"categorization": {
"income": false,
"type": "Medical Expense",
"subtype": "Hospice Care"
},
"cashflows": {
"type": "healthcare",
"timeStep": "annual",
"startTime": 14,
"itemKey": "MGPD4E5F6",
"amount": 10500.00,
"timeSteps": 15,
"inflationRate": "scenario",
"increase": 0.0005
}
}
],
"primary": {
"name": "Jo Sowinsoe",
"gender": "F",
"age": 49,
"retirementAge": 60
},
"tag": "DEBUG00223"
}
}
]
}
Joint Investors
The following example illustrates cashflow types of annuity, deferredCompensation and livingExpenses for joint investors.
{
"data": [
{
"id": "300",
"type": "profile",
"attributes": {
"strategy": null
"portfolio": [
{
"categorization": {
"income": true,
"type": "Other Retirement Income",
"subtype": "Annuity Income"
},
"cashflows": {
"type": "annuity",
"timeStep": "annual",
"startTime": 14,
"itemKey": "MGPG8H9I10",
"amount": 125336.68,
"inflationSpread": 0.0002,
"jointLife": false,
"benefitAfterSpouseDies": true,
"exclusionRatio": 0.1,
"incomeGuarantee": "Lifetime Only"
}
},
{
"categorization": {
"income": true,
"type": "Other Assets - Pension and Deferred Compensation",
"subtype": "Deferred Compensation (Future)"
},
"cashflows": {
"type": "deferredCompensation",
"timeStep": "annual",
"startTime": 7,
"itemKey": "DC-PLAN-XYZ123",
"amount": 314245.19,
"timeSteps": 20,
"payToSpouse": false
}
},
{
"categorization": {
"income": false,
"type": "Goal",
"subtype": "Living Expenses"
},
"cashflows": {
"type": "livingExpenses",
"timeStep": "annual",
"startTime": 10,
"itemKey": "LIVEX",
"amount": 143000,
"timeSteps": 120,
"inflationSpread": 0.0003,
"residencyChangeAtRetirement": true
}
}
],
"primary": {
"name": "Jane Dough",
"gender": "F",
"age": 53,
"retirementAge": 63
},
"secondary": {
"name": "Clay Dough",
"gender": "M",
"age": 55,
"retirementAge": 65
}
}
}
]
}