PortfolioLinkApi

GetIncomeCashFlowRequest

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

**GetIncomeCashFlowRequest** Parameters:
Name	Parameter	Data Type	Required
KeyIndex	query	int	No
IncomeLabel	query	string	No
IncomeIncludeZeroIncomeYears	query	bool	No
Income	query	decimal	No
TaxRate	query	decimal	No
IncomeToLast	query	int	No
CurrentAge	query	int	No
IncomeGrowth	query	decimal	No
IncomeGrowthFrequency	query	decimal	No
PayoutFrequency	query	int	No
StartYear	query	int	No
HasAdhocCashFlow	query	bool	No
AdhocCashFlowAge1	query	int	No
AdhocCashFlow1	query	decimal	No
AdhocCashFlowAge2	query	int	No
AdhocCashFlow2	query	decimal	No
AdhocCashFlowAge3	query	int	No
AdhocCashFlow3	query	decimal	No
ApplySmile	query	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/income HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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
								}
							]
						}
					]
				}
			]
		}
	]
}