PortfolioLinkApi

<back to all web services

AdditionalGetContributionCashFlowRequest

Requires Authentication
The following routes are available for this service:
All Verbs/projections/additionalcontribution
AdditionalGetContributionCashFlowRequest Parameters:
NameParameterData TypeRequiredDescription
AdditionalGetContributionCashFlowRequestsqueryList<GetContributionCashFlowRequest>No
GetContributionCashFlowRequest Parameters:
NameParameterData TypeRequiredDescription
KeyIndexformintNo
ContributionLabelformstringNo
ApplyContributionformboolNo
ContributionformdecimalNo
ContributionGrowthformdecimalNo
ContributionGrowthFrequencyformdecimalNo
ContributionFrequencyformintNo
ContributionStartYearformintNo
ContributionToLastformintNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /projections/additionalcontribution HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"additionalGetContributionCashFlowRequests":[{"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: application/json
Content-Length: length

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