PortfolioLinkApi

<back to all web services

GetContributionCashFlowRequest

Requires Authentication
The following routes are available for this service:
All Verbs/projections/contribution
GetContributionCashFlowRequest Parameters:
NameParameterData TypeRequiredDescription
KeyIndexqueryintNo
ContributionLabelquerystringNo
ApplyContributionqueryboolNo
ContributionquerydecimalNo
ContributionGrowthquerydecimalNo
ContributionGrowthFrequencyquerydecimalNo
ContributionFrequencyqueryintNo
ContributionStartYearqueryintNo
ContributionToLastqueryintNo
GetContributionCashFlowResponse Parameters:
NameParameterData TypeRequiredDescription
IncomesformList<IncomeView>No
IncomeView Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
IncomeformdecimalNo

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/contribution HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	keyIndex: 0,
	contributionLabel: String,
	applyContribution: False,
	contribution: 0,
	contributionGrowth: 0,
	contributionGrowthFrequency: 0,
	contributionFrequency: 0,
	contributionStartYear: 0,
	contributionToLast: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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