PortfolioLinkApi

AdditionalGetIncomeCashFlowRequest

The following routes are available for this service:
All Verbs	/projections/additionalincome

**AdditionalGetIncomeCashFlowRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AdditionalGetIncomeCashFlowRequests	query	List<GetIncomeCashFlowRequest>	No

**GetIncomeCashFlowRequest** Parameters:
Name	Parameter	Data Type	Required
KeyIndex	form	int	No
IncomeLabel	form	string	No
IncomeIncludeZeroIncomeYears	form	bool	No
Income	form	decimal	No
TaxRate	form	decimal	No
IncomeToLast	form	int	No
CurrentAge	form	int	No
IncomeGrowth	form	decimal	No
IncomeGrowthFrequency	form	decimal	No
PayoutFrequency	form	int	No
StartYear	form	int	No
HasAdhocCashFlow	form	bool	No
AdhocCashFlowAge1	form	int	No
AdhocCashFlow1	form	decimal	No
AdhocCashFlowAge2	form	int	No
AdhocCashFlow2	form	decimal	No
AdhocCashFlowAge3	form	int	No
AdhocCashFlow3	form	decimal	No
ApplySmile	form	bool	No

**GetIncomeCashFlowResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Incomes	form	List<IncomeView>	No
IndividualIncomes	form	List<GetIncomeCashFlowResponse>	No

**IncomeView** Parameters:
Name	Parameter	Data Type	Required	Description
Year	form	int	No
Income	form	decimal	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /projections/additionalincome HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	additionalGetIncomeCashFlowRequests: 
	[
		{
			keyIndex: 0,
			incomeLabel: String,
			incomeIncludeZeroIncomeYears: False,
			income: 0,
			taxRate: 0,
			incomeToLast: 0,
			currentAge: 0,
			incomeGrowth: 0,
			incomeGrowthFrequency: 0,
			payoutFrequency: 0,
			startYear: 0,
			hasAdhocCashFlow: False,
			adhocCashFlowAge1: 0,
			adhocCashFlow1: 0,
			adhocCashFlowAge2: 0,
			adhocCashFlow2: 0,
			adhocCashFlowAge3: 0,
			adhocCashFlow3: 0,
			applySmile: False
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	incomes: 
	[
		{
			year: 0,
			income: 0
		}
	],
	individualIncomes: 
	[
		{
			incomes: 
			[
				{
					year: 0,
					income: 0
				}
			],
			individualIncomes: 
			[
				{
					incomes: 
					[
						{
							year: 0,
							income: 0
						}
					],
					individualIncomes: 
					[
						{
							incomes: 
							[
								{
									year: 0,
									income: 0
								}
							]
						}
					]
				}
			]
		}
	]
}