PortfolioLinkApi

CalculatePostRetirement

The following routes are available for this service:
All Verbs	/calculator/postretirement

**CalculatePostRetirement** Parameters:
Name	Parameter	Data Type	Required
ClientId	query	int	No
CurrentSavings	query	double	No
LifeExpectancyAge	query	int	No
ExpectedInflationRate	query	double	No
WithdrawalAmount	query	double	No
WithdrawalGrowthRate	query	double	No
CashReserve	query	double	No
AdditionalSaProperty	query	double	No
GoalResultsId	query	int	No
StoreResults	query	bool	No
PortfolioId	query	int?	No

**CalculateProjectedBalancesResponse** Parameters:
Name	Parameter	Data Type	Required
ProjectedBalances	form	List<ProjectedBalance>	No
TargetPortfolio	form	PortfolioView	No
AgeRunOutOfMoney	form	int	No
AgeTargetIncomeNotMet	form	int	No
PessimisticAgeRunOutOfMoney	form	int	No
OptimisticAgeRunOutOfMoney	form	int	No
Status	form	string	No
Message	form	string	No
HtmlMessage	form	string	No
BalanceAtLifeExpectancy	form	double	No
PessimistiBalanceAtLifeExpectancy	form	double	No
OptimisticBalanceAtLifeExpectancy	form	double	No
LifeExpectancyAge	form	int	No
YearAtLifeExpectancy	form	int	No
CurrentAge	form	int	No
UpdatedAsAt	form	DateTime	No
ClientView	form	ClientView	No
RequestObject	form	Object	No
RequestType	form	string	No

**ProjectedBalance** Parameters:
Name	Parameter	Data Type	Required
Age	form	int	No
MedianAmount	form	double	No
OptimisticAmount	form	double	No
PessimisticAmount	form	double	No
OptimisticAmount2	form	double	No
PessimisticAmount2	form	double	No
OptimisticAmount3	form	double	No
PessimisticAmount3	form	double	No
MedianIncomeAmount	form	double	No
OptimisticIncomeAmount	form	double	No
PessimisticIncomeAmount	form	double	No
TargetIncomeAmount	form	double	No
MedianIncomeAmountPercent	form	double	No

**PortfolioView** Parameters:
Name	Parameter	Data Type	Required
MonthlyPerformances	form	List<WarehouseMonthlyPerformance>	No
YearlyPerformances	form	List<WarehouseMonthlyPerformance>	No
CumulativePerformances	form	List<WarehouseMonthlyPerformance>	No
MinAnnualPerformance	form	string	No
MaxAnnualPerformance	form	string	No
CurrentAssetAllocation	form	AssetAllocationView	No
Positions	form	List<PortfolioPosition>	No
AssetAllocationPoints	form	List<AssetAllocationPoints>	No
AssetAllocation	form	AssetAllocationView	No
CountIndex	form	int	No
Id	form	int	No
CustomPortfolioId	form	int	No
PartnerId	form	int	No
GoalTypeIds	form	int[]	No
PortfolioName	form	string	No
PortfolioShortName	form	string	No
Benchmark	form	string	No
RiskProfile	form	RiskProfile	No
RiskRating	form	int	No
RiskDescription	form	string	No
Cash	form	decimal	No
Bonds	form	decimal	No
Equity	form	decimal	No
Property	form	decimal	No
LocalCash	form	decimal	No
LocalBonds	form	decimal	No
LocalEquity	form	decimal	No
LocalProperty	form	decimal	No
ForeignCash	form	decimal	No
ForeignBonds	form	decimal	No
ForeignEquity	form	decimal	No
ForeignProperty	form	decimal	No
LocalCredit	form	decimal	No
LocalInfrastructure	form	decimal	No
GlobalCash	form	decimal	No
GlobalBonds	form	decimal	No
GlobalInvestmentGrade	form	decimal	No
GlobalHighYield	form	decimal	No
GlobalEmergingMarketBonds	form	decimal	No
AfricaEuroBondsExSouthAfrica	form	decimal	No
GlobalProperty	form	decimal	No
GlobalEquity	form	decimal	No
GlobalEquitySmallCapStocks	form	decimal	No
GlobalEmergingMarketEquity	form	decimal	No
GlobalHedgeFunds	form	decimal	No
ListedPrivateEquity	form	decimal	No
ListedInfrastructure	form	decimal	No
GlobalIncomeOpportunities	form	decimal	No
ExpectedReturn	form	decimal	No
AnnualisedStandardDeviation	form	decimal	No
TargetTic	form	decimal	No
WarehouseFundId	form	int	No
PctMdlAcr	form	string	No
AtoolsMdlAcr	form	string	No
SecurityPortfolioCode	form	string	No
PlatformModelId	form	int	No
StitchPerformance	form	bool	No
IsWithinRiskNumber	form	bool	No
WarehouseFundFactSheetSnapshot	form	WarehouseFundFactSheetSnapshot	No
Currency	form	string	No

**WarehouseMonthlyPerformance** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
ParentPortfolioId	form	int	No
EntityType	form	string	No
EntityId	form	int	No
EntityName	form	string	No
StartDate	form	string	No
EndDate	form	string	No
Trr	form	decimal	No
AsisaTrr	form	decimal	No
FundBenchmarkTrr	form	decimal	No
RiskFreeTrr	form	decimal	No
JseTrr	form	decimal	No
Year	form	int	No
Month	form	int	No
Weight	form	decimal	No

**AssetAllocationView** Parameters:
Name	Parameter	Data Type	Required
LocalCash	form	decimal	No
LocalCredit	form	decimal	No
LocalBonds	form	decimal	No
LocalBondsHedge	form	decimal	No
LocalEquity	form	decimal	No
LocalEquityHedge	form	decimal	No
LocalProperty	form	decimal	No
LocalPropertyHedge	form	decimal	No
LocalInfrastructure	form	decimal	No
ForeignCash	form	decimal	No
ForeignBonds	form	decimal	No
ForeignBondsHedge	form	decimal	No
ForeignEquity	form	decimal	No
ForeignProperty	form	decimal	No
ForeignEquityHedge	form	decimal	No
ForeignPropertyHedge	form	decimal	No
Africa	form	decimal	No
Commodity	form	decimal	No
GlobalCash	form	decimal	No
GlobalBonds	form	decimal	No
GlobalInvestmentGrade	form	decimal	No
GlobalHighYield	form	decimal	No
GlobalEmergingMarketBonds	form	decimal	No
AfricaEuroBondsExSouthAfrica	form	decimal	No
GlobalProperty	form	decimal	No
GlobalEquity	form	decimal	No
GlobalEquitySmallCapStocks	form	decimal	No
GlobalEmergingMarketEquity	form	decimal	No
GlobalHedgeFunds	form	decimal	No
ListedPrivateEquity	form	decimal	No
ListedInfrastructure	form	decimal	No
GlobalIncomeOpportunities	form	decimal	No

**PortfolioPosition** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Date	form	string	No
PortfolioId	form	int	No
Name	form	string	No
Weight	form	decimal	No

**AssetAllocationPoints** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	double	No

**RiskProfile** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
PartnerId	form	int	No
RiskProfileName	form	string	No
LowerBound	form	int	No
UpperBound	form	int	No
RiskProfileDescription	form	string	No
Currency	form	string	No
Portfolios	form	List<Portfolio>	No
CreatedAsAt	form	DateTime	No
UpdatedAsAt	form	DateTime	No

**Portfolio** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
PartnerId	form	int	No
GoalTypeIds	form	int[]	No
PortfolioName	form	string	No
PortfolioShortName	form	string	No
RiskRating	form	int	No
RiskDescription	form	string	No
AsisaClassification	form	string	No
InvestmentObjective	form	string	No
CreatedAsAt	form	DateTime	No
UpdatedAsAt	form	DateTime	No
Benchmark	form	string	No
TargetTic	form	decimal	No
WarehouseFundId	form	int	No
PctMdlAcr	form	string	No
AtoolsMdlAcr	form	string	No
SecurityPortfolioCode	form	string	No
StitchPerformance	form	bool	No
PlatformModelId	form	int?	No
Currency	form	string	No
PartnerName	form	string	No

**WarehouseFundFactSheetSnapshot** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
WarehousePartnerId	form	int	No
Partner	form	string	No
PortfolioType	form	string	No
WarehouseFundId	form	int	No
MonthYear	form	DateTime	No
FundName	form	string	No
AsisaClassification	form	string	No
Benchmark	form	string	No
Benchmark2	form	string	No
SaCash	form	double	No
SaBonds	form	double	No
SaBondsDerivatives	form	double	No
SaEquity	form	double	No
SaEquityDerivatives	form	double	No
SaProperty	form	double	No
SaPropertyDerivatives	form	double	No
ForeignCash	form	double	No
ForeignBonds	form	double	No
ForeignBondsDerivatives	form	double	No
ForeignEquity	form	double	No
ForeignEquityDerivatives	form	double	No
ForeignProperty	form	double	No
ForeignPropertyDerivatives	form	double	No
Africa	form	double	No
Commodity	form	double	No
SaCashName	form	string	No
SaBondsName	form	string	No
SaEquityName	form	string	No
SaPropertyName	form	string	No
SaBondsDerivativesName	form	string	No
SaEquityDerivativesName	form	string	No
SaPropertyDerivativesName	form	string	No
ForeignCashName	form	string	No
ForeignBondsName	form	string	No
ForeignBondsDerivativesName	form	string	No
ForeignEquityName	form	string	No
ForeignEquityDerivativesName	form	string	No
ForeignPropertyName	form	string	No
ForeignPropertyDerivativesName	form	string	No
AfricaName	form	string	No
CommodityName	form	string	No
LaunchDate	form	DateTime	No
InvestmentObjective	form	string	No
FundClass	form	string	No
JseCode	form	string	No
PortfolioManager	form	string	No
InvestmentStrategy	form	string	No
RiskProfile	form	string	No
EquityExposure	form	string	No
ForeignExposure	form	string	No
Top1001Equity	form	string	No
Top1002Equity	form	string	No
Top1003Equity	form	string	No
Top1004Equity	form	string	No
Top1005Equity	form	string	No
Top1006Equity	form	string	No
Top1007Equity	form	string	No
Top1008Equity	form	string	No
Top1009Equity	form	string	No
Top1010Equity	form	string	No
Top1001EquityPercentage	form	string	No
Top1002EquityPercentage	form	string	No
Top1003EquityPercentage	form	string	No
Top1004EquityPercentage	form	string	No
Top1005EquityPercentage	form	string	No
Top1006EquityPercentage	form	string	No
Top1007EquityPercentage	form	string	No
Top1008EquityPercentage	form	string	No
Top1009EquityPercentage	form	string	No
Top1010EquityPercentage	form	string	No
FundSize	form	string	No
TotalExpenseRatio	form	string	No
TransactionCost	form	string	No
TotalInvestmentCharge	form	string	No
TotalExpenseRatioTwoClasses	form	string	No
TransactionCostTwoClasses	form	string	No
TotalInvestmentChargeTwoClasses	form	string	No
TotalExpenseRatioThreeClasses	form	string	No
TransactionCostThreeClasses	form	string	No
TotalInvestmentChargeThreeClasses	form	string	No
CalculationPeriod	form	string	No
InitialFee	form	string	No
IncomeDeclarationDates	form	string	No
ReinvestmentAndPayoutDates	form	string	No
InitialAdvisoryFee	form	string	No
TransactionCutoffTime	form	string	No
AnnualServiceFee	form	string	No
ValuationTime	form	string	No
AnnualAdvisoryFee	form	string	No
PricingFrequency	form	string	No
Characteristics	form	string	No
RiskRewardProfile	form	string	No
Disclaimer1	form	string	No
Disclaimer2	form	string	No
Disclaimer3	form	string	No
Disclaimer4	form	string	No
Disclaimer5	form	string	No
ConflictsOfInterest	form	string	No
OpeningNavPrice	form	string	No
IncomeAsPercentOfPrice	form	string	No
PrimaryClassName	form	string	No
FundMtdPerf	form	string	No
FundQtdPerf	form	string	No
FundYtdPerf	form	string	No
Fund1YearPerf	form	string	No
Fund2YearPerf	form	string	No
Fund3YearPerf	form	string	No
Fund5YearPerf	form	string	No
Fund10YearPerf	form	string	No
FundSinceInceptionPerf	form	string	No
SecondaryClassClassName	form	string	No
Fund1YearPerfSecondaryClass	form	string	No
Fund2YearPerfSecondaryClass	form	string	No
Fund3YearPerfSecondaryClass	form	string	No
Fund5YearPerfSecondaryClass	form	string	No
Fund10YearPerfSecondaryClass	form	string	No
FundSinceInceptionPerfSecondaryClass	form	string	No
BenchmarkMtdPerf	form	string	No
BenchmarkQtdPerf	form	string	No
BenchmarkYtdPerf	form	string	No
Benchmark1YearPerf	form	string	No
Benchmark2YearPerf	form	string	No
Benchmark3YearPerf	form	string	No
Benchmark5YearPerf	form	string	No
Benchmark10YearPerf	form	string	No
BenchmarkSinceInceptionPerf	form	string	No
Benchmark2_MtdPerf	form	string	No
Benchmark2_QtdPerf	form	string	No
Benchmark2_YtdPerf	form	string	No
Benchmark2_1YearPerf	form	string	No
Benchmark2_2YearPerf	form	string	No
Benchmark2_3YearPerf	form	string	No
Benchmark2_5YearPerf	form	string	No
Benchmark2_10YearPerf	form	string	No
Benchmark2_SinceInceptionPerf	form	string	No
AsisaMtdPerf	form	string	No
AsisaQtdPerf	form	string	No
AsisaYtdPerf	form	string	No
Asisa1YearPerf	form	string	No
Asisa2YearPerf	form	string	No
Asisa3YearPerf	form	string	No
Asisa5YearPerf	form	string	No
Asisa10YearPerf	form	string	No
AsisaSinceInceptionPerf	form	string	No
Lowest1YearRollingReturn	form	string	No
Highest1YearRollingReturn	form	string	No
Lowest1YearRollingReturnSecondaryClass	form	string	No
Highest1YearRollingReturnSecondaryClass	form	string	No
PublishedDate	form	DateTime	No
Previous12MonthsDistributions	form	string	No
Previous12MonthsDistributions2	form	string	No
UnderlyingHoldingsCount	form	int	No
UnderlyingHoldings01	form	string	No
UnderlyingHoldings02	form	string	No
UnderlyingHoldings03	form	string	No
UnderlyingHoldings04	form	string	No
UnderlyingHoldings05	form	string	No
UnderlyingHoldings06	form	string	No
UnderlyingHoldings07	form	string	No
UnderlyingHoldings08	form	string	No
UnderlyingHoldings09	form	string	No
UnderlyingHoldings10	form	string	No
UnderlyingHoldings11	form	string	No
UnderlyingHoldings12	form	string	No
UnderlyingHoldings13	form	string	No
UnderlyingHoldings14	form	string	No
UnderlyingHoldings15	form	string	No
UnderlyingHoldings16	form	string	No
UnderlyingHoldings17	form	string	No
UnderlyingHoldings18	form	string	No
UnderlyingHoldings19	form	string	No
UnderlyingHoldings20	form	string	No
UnderlyingHoldings01Percentage	form	string	No
UnderlyingHoldings02Percentage	form	string	No
UnderlyingHoldings03Percentage	form	string	No
UnderlyingHoldings04Percentage	form	string	No
UnderlyingHoldings05Percentage	form	string	No
UnderlyingHoldings06Percentage	form	string	No
UnderlyingHoldings07Percentage	form	string	No
UnderlyingHoldings08Percentage	form	string	No
UnderlyingHoldings09Percentage	form	string	No
UnderlyingHoldings10Percentage	form	string	No
UnderlyingHoldings11Percentage	form	string	No
UnderlyingHoldings12Percentage	form	string	No
UnderlyingHoldings13Percentage	form	string	No
UnderlyingHoldings14Percentage	form	string	No
UnderlyingHoldings15Percentage	form	string	No
UnderlyingHoldings16Percentage	form	string	No
UnderlyingHoldings17Percentage	form	string	No
UnderlyingHoldings18Percentage	form	string	No
UnderlyingHoldings19Percentage	form	string	No
UnderlyingHoldings20Percentage	form	string	No
TargetHoldingsCount	form	int	No
TargetHoldings01	form	string	No
TargetHoldings02	form	string	No
TargetHoldings03	form	string	No
TargetHoldings04	form	string	No
TargetHoldings05	form	string	No
TargetHoldings06	form	string	No
TargetHoldings07	form	string	No
TargetHoldings08	form	string	No
TargetHoldings09	form	string	No
TargetHoldings10	form	string	No
TargetHoldings11	form	string	No
TargetHoldings12	form	string	No
TargetHoldings13	form	string	No
TargetHoldings14	form	string	No
TargetHoldings15	form	string	No
TargetHoldings16	form	string	No
TargetHoldings17	form	string	No
TargetHoldings18	form	string	No
TargetHoldings19	form	string	No
TargetHoldings20	form	string	No
TargetHoldings01Percentage	form	string	No
TargetHoldings02Percentage	form	string	No
TargetHoldings03Percentage	form	string	No
TargetHoldings04Percentage	form	string	No
TargetHoldings05Percentage	form	string	No
TargetHoldings06Percentage	form	string	No
TargetHoldings07Percentage	form	string	No
TargetHoldings08Percentage	form	string	No
TargetHoldings09Percentage	form	string	No
TargetHoldings10Percentage	form	string	No
TargetHoldings11Percentage	form	string	No
TargetHoldings12Percentage	form	string	No
TargetHoldings13Percentage	form	string	No
TargetHoldings14Percentage	form	string	No
TargetHoldings15Percentage	form	string	No
TargetHoldings16Percentage	form	string	No
TargetHoldings17Percentage	form	string	No
TargetHoldings18Percentage	form	string	No
TargetHoldings19Percentage	form	string	No
TargetHoldings20Percentage	form	string	No
ModelPortfolioManagementFee	form	string	No
AnnualConsultingFee	form	string	No
AverageWeightedCostOfUnderlying	form	string	No
Classification	form	string	No
Domicile	form	string	No
BaseCurrency	form	string	No
MinimumInitialInvestment	form	string	No
DistributorFee	form	string	No
AdministrationFee	form	string	No
DepositoryFee	form	string	No
RegistrarAndTransferAgentFee	form	string	No
AifmAndImFee	form	string	No
InvestmentAdvisorFee	form	string	No
PerformanceFee	form	string	No
InitialAdviceFee	form	string	No
AnnualAdviceFee	form	string	No
TerDisclaimer	form	string	No
DailyPricingPublication	form	string	No
AnnualisedPerformances	form	List<AnnualisedPerformance>	No
StaticPdfUrl	form	string	No
WarehousePerformance	form	WarehousePerformance	No
Fund	form	Fund	No
CreatedAsAt	form	DateTime	No
SubmittedAsAt	form	DateTime?	No
WarehousePerformancesDto	form	WarehousePerformance	No

**AnnualisedPerformance** Parameters:
Name	Parameter	Data Type	Required
TypeDescription	form	string	No
Name	form	string	No
MtdPerf	form	string	No
QtdPerf	form	string	No
YtdPerf	form	string	No
OneYearPerf	form	string	No
TwoYearPerf	form	string	No
ThreeYearPerf	form	string	No
FiveYearPerf	form	string	No
TenYearPerf	form	string	No
SinceInceptionPerf	form	string	No

**WarehousePerformance** Parameters:
Name	Parameter	Data Type	Required
WarehouseFundId	form	int	No
MonthlyPerformances	form	List<WarehouseMonthlyPerformance>	No
CumulativePerformances	form	CumulativePerformanceView	No
MaxDrawdownSinceInception	form	decimal	No
MaxDrawdownBenchmarkSinceInception	form	decimal	No
MaxDrawdownAsisaSinceInception	form	decimal	No
StandardDeviationAnnualised	form	decimal	No
StandardDeviationBenchmarkAnnualised	form	decimal	No
StandardDeviationAsisaAnnualised	form	decimal	No
SharpeRatioSinceInception	form	decimal	No
SharpeRatioBenchmarkSinceInception	form	decimal	No
SharpeRatioAsisaSinceInception	form	decimal	No
ReturnFundSinceInception	form	decimal	No
ReturnBenchmarkSinceInception	form	decimal	No
ReturnAsisaSinceInception	form	decimal	No
ReturnJseSinceInception	form	decimal	No
StandardDeviationJseAnnualised	form	decimal	No

**CumulativePerformanceView** Parameters:
Name	Parameter	Data Type	Required	Description
SeriesCollection	form	List<SeriesCollection>	No

**SeriesCollection** Parameters:
Name	Parameter	Data Type	Required
DateLabel	form	string	No
Fund	form	decimal	No
Benchmark	form	decimal	No
Sector	form	decimal	No

**Fund** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
FundName	form	string	No
Partner	form	string	No
WarehouseClientId	form	int	No
FundTemplate	form	string	No
WarehouseId	form	int	No
SaCashName	form	string	No
SaCashColour	form	string	No
SaBondsName	form	string	No
SaBondsColour	form	string	No
SaEquityName	form	string	No
SaEquityColour	form	string	No
SaPropertyName	form	string	No
SaPropertyColour	form	string	No
SaBondsDerivativesName	form	string	No
SaBondsDerivativesColour	form	string	No
SaEquityDerivativesName	form	string	No
SaEquityDerivativesColour	form	string	No
SaPropertyDerivativesName	form	string	No
SaPropertyDerivativesColour	form	string	No
ForeignCashName	form	string	No
ForeignCashColour	form	string	No
ForeignBondsName	form	string	No
ForeignBondsColour	form	string	No
ForeignBondsDerivativesName	form	string	No
ForeignBondsDerivativesColour	form	string	No
ForeignEquityName	form	string	No
ForeignEquityColour	form	string	No
ForeignEquityDerivativesName	form	string	No
ForeignEquityDerivativesColour	form	string	No
ForeignPropertyName	form	string	No
ForeignPropertyColour	form	string	No
ForeignPropertyDerivativesName	form	string	No
ForeignPropertyDerivativesColour	form	string	No
AfricaName	form	string	No
AfricaColour	form	string	No
CommodityName	form	string	No
CommodityColour	form	string	No
UnderlyingHoldingsTemplate	form	string	No
TargetedHoldingsTemplate	form	string	No
MonthlyPerformanceTemplate	form	string	No
CumulativePerformanceTemplate	form	string	No
RiskScatterTemplate	form	string	No

**ClientView** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
UserId	form	string	No
PartnerId	form	int	No
PrimaryEmail	form	string	No
SecondaryEmail	form	string	No
FirstName	form	string	No
MiddleNames	form	string	No
LastName	form	string	No
FullName	form	string	No
Alias	form	string	No
Phone	form	string	No
Mobile	form	string	No
IdNumber	form	string	No
Status	form	string	No
ClientType	form	string	No
BirthdaySk	form	string	No
Birthday	form	DateTime	No
CreatedAsAt	form	DateTime	No
UpdatedAsAt	form	DateTime	No
Goals	form	List<ClientGoalsView>	No

**ClientGoalsView** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
PortfolioId	form	int	No
ClientId	form	int	No
ClientFullName	form	string	No
ClientIdNumber	form	string	No
ClientPrimaryEmail	form	string	No
ClientMobile	form	string	No
ClientGoalId	form	int	No
ClientGoalResultsId	form	int	No
GoalName	form	string	No
PortfolioName	form	string	No
Status	form	string	No
InputLifeExpectancyAge	form	int	No
InputCurrentSavingsDate	form	string	No
InputCurrentSavings	form	double	No
InputExpectedInflationRate	form	double	No
InputWithdrawalAmount	form	double	No
InputWithdrawalGrowthRate	form	double	No
CashReserve	form	double	No
AdditionalSaProperty	form	double	No
Results	form	Object	No
PartnerSettings	form	PartnerSettings	No

**PartnerSettings** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
PartnerId	form	int	No
PartnerLogoUrl	form	string	No
PartnerBackgroundType	form	string	No
PartnerBackgroundUrl	form	string	No
ExpectedInflationRate	form	decimal	No
WithdrawalIncomeGrowthRate	form	decimal	No
Hellosignapikey	form	string	No
EnableCashReserve	form	bool	No
EnableProperty	form	bool	No
PartnerDefaultSettings	form	PartnerDefaultSettings	No
PartnerContactDetails	form	PartnerContactDetails	No

**PartnerDefaultSettings** Parameters:
Name	Parameter	Data Type	Required
SettingsId	form	int	No
PartnerId	form	int	No
PartnerName	form	string	No
AaType	form	string	No
ThemeId	form	int	No
InitialFee	form	decimal	No
AdvisorFee	form	decimal	No
PlatformFee	form	decimal	No
MoreLikelyZScore	form	decimal	No
LessLikelyZScore	form	decimal	No
ShowLowestProjectedOutcome	form	bool	No
IsFundAlphaEqualToFees	form	bool	No
ShowAdvisoryFees	form	bool	No
ShowCashflowTable	form	bool	No
XAxisLabel	form	string	No
AppearanceSettings	form	AppearanceSettings	No

**AppearanceSettings** Parameters:
Name	Parameter	Data Type	Required
AppearanceSchema	form	AppearanceSchema	No
ProjectedComponentName	form	string	No
ShowMedianOutcome	form	bool	No
MedianLineColor	form	string	No
BottomScenarioLineColor	form	string	No
ShowLowestProjectedOutcome	form	bool	No

**AppearanceSchema** Parameters:
Name	Parameter	Data Type	Required
FontColor	form	string	No
AxisColor	form	string	No
AxisGridColor	form	string	No
GraphColor	form	string	No
GraphColorOpacity	form	double	No
GraphColorRange2	form	string	No
GraphColorOpacity2	form	double	No
AverageLineColor	form	string	No
BarColor1	form	string	No
BarColor2	form	string	No
LogoHeight	form	string	No
LogoUrl	form	string	No
LogoBackground	form	string	No
TopBarBackground	form	string	No
TopBarFontColor	form	string	No
H2Color	form	string	No
LinkColor	form	string	No
ProposalBackgroundUrl	form	string	No
ProposalBackgroundUrl2	form	string	No
ProposalBackgroundUrl3	form	string	No
ProposalBackgroundUrl4	form	string	No

**PartnerContactDetails** Parameters:
Name	Parameter	Data Type	Required
Website	form	string	No
Email	form	string	No
Telephone	form	string	No
Fax	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressLine3	form	string	No
AddressLine4	form	string	No

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 /calculator/postretirement HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"clientId":0,"currentSavings":0,"lifeExpectancyAge":0,"expectedInflationRate":0,"withdrawalAmount":0,"withdrawalGrowthRate":0,"cashReserve":0,"additionalSaProperty":0,"goalResultsId":0,"storeResults":false,"portfolioId":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"projectedBalances":[{"age":0,"medianAmount":0,"optimisticAmount":0,"pessimisticAmount":0,"optimisticAmount2":0,"pessimisticAmount2":0,"optimisticAmount3":0,"pessimisticAmount3":0,"medianIncomeAmount":0,"optimisticIncomeAmount":0,"pessimisticIncomeAmount":0,"targetIncomeAmount":0,"medianIncomeAmountPercent":0}],"targetPortfolio":{"monthlyPerformances":[{"id":"String","parentPortfolioId":0,"entityType":"String","entityId":0,"entityName":"String","startDate":"String","endDate":"String","trr":0,"asisaTrr":0,"fundBenchmarkTrr":0,"riskFreeTrr":0,"jseTrr":0,"year":0,"month":0,"weight":0}],"yearlyPerformances":[{"id":"String","parentPortfolioId":0,"entityType":"String","entityId":0,"entityName":"String","startDate":"String","endDate":"String","trr":0,"asisaTrr":0,"fundBenchmarkTrr":0,"riskFreeTrr":0,"jseTrr":0,"year":0,"month":0,"weight":0}],"cumulativePerformances":[{"id":"String","parentPortfolioId":0,"entityType":"String","entityId":0,"entityName":"String","startDate":"String","endDate":"String","trr":0,"asisaTrr":0,"fundBenchmarkTrr":0,"riskFreeTrr":0,"jseTrr":0,"year":0,"month":0,"weight":0}],"minAnnualPerformance":"String","maxAnnualPerformance":"String","currentAssetAllocation":{"localCash":0,"localCredit":0,"localBonds":0,"localBondsHedge":0,"localEquity":0,"localEquityHedge":0,"localProperty":0,"localPropertyHedge":0,"localInfrastructure":0,"foreignCash":0,"foreignBonds":0,"foreignBondsHedge":0,"foreignEquity":0,"foreignProperty":0,"foreignEquityHedge":0,"foreignPropertyHedge":0,"africa":0,"commodity":0,"globalCash":0,"globalBonds":0,"globalInvestmentGrade":0,"globalHighYield":0,"globalEmergingMarketBonds":0,"africaEuroBondsExSouthAfrica":0,"globalProperty":0,"globalEquity":0,"globalEquitySmallCapStocks":0,"globalEmergingMarketEquity":0,"globalHedgeFunds":0,"listedPrivateEquity":0,"listedInfrastructure":0,"globalIncomeOpportunities":0},"positions":[{"id":0,"date":"String","portfolioId":0,"name":"String","weight":0}],"assetAllocationPoints":[{"name":"String","value":0}],"assetAllocation":{"localCash":0,"localCredit":0,"localBonds":0,"localBondsHedge":0,"localEquity":0,"localEquityHedge":0,"localProperty":0,"localPropertyHedge":0,"localInfrastructure":0,"foreignCash":0,"foreignBonds":0,"foreignBondsHedge":0,"foreignEquity":0,"foreignProperty":0,"foreignEquityHedge":0,"foreignPropertyHedge":0,"africa":0,"commodity":0,"globalCash":0,"globalBonds":0,"globalInvestmentGrade":0,"globalHighYield":0,"globalEmergingMarketBonds":0,"africaEuroBondsExSouthAfrica":0,"globalProperty":0,"globalEquity":0,"globalEquitySmallCapStocks":0,"globalEmergingMarketEquity":0,"globalHedgeFunds":0,"listedPrivateEquity":0,"listedInfrastructure":0,"globalIncomeOpportunities":0},"countIndex":0,"id":0,"customPortfolioId":0,"partnerId":0,"goalTypeIds":[0],"portfolioName":"String","portfolioShortName":"String","benchmark":"String","riskProfile":{"id":0,"partnerId":0,"riskProfileName":"String","lowerBound":0,"upperBound":0,"riskProfileDescription":"String","currency":"String","portfolios":[{"id":0,"partnerId":0,"goalTypeIds":[0],"portfolioName":"String","portfolioShortName":"String","riskRating":0,"riskDescription":"String","asisaClassification":"String","investmentObjective":"String","createdAsAt":"0001-01-01T00:00:00.0000000","updatedAsAt":"0001-01-01T00:00:00.0000000","benchmark":"String","targetTic":0,"warehouseFundId":0,"pctMdlAcr":"String","atoolsMdlAcr":"String","securityPortfolioCode":"String","stitchPerformance":false,"platformModelId":0,"currency":"String","partnerName":"String"}],"createdAsAt":"0001-01-01T00:00:00.0000000","updatedAsAt":"0001-01-01T00:00:00.0000000"},"riskRating":0,"riskDescription":"String","cash":0,"bonds":0,"equity":0,"property":0,"localCash":0,"localBonds":0,"localEquity":0,"localProperty":0,"foreignCash":0,"foreignBonds":0,"foreignEquity":0,"foreignProperty":0,"localCredit":0,"localInfrastructure":0,"globalCash":0,"globalBonds":0,"globalInvestmentGrade":0,"globalHighYield":0,"globalEmergingMarketBonds":0,"africaEuroBondsExSouthAfrica":0,"globalProperty":0,"globalEquity":0,"globalEquitySmallCapStocks":0,"globalEmergingMarketEquity":0,"globalHedgeFunds":0,"listedPrivateEquity":0,"listedInfrastructure":0,"globalIncomeOpportunities":0,"expectedReturn":0,"annualisedStandardDeviation":0,"targetTic":0,"warehouseFundId":0,"pctMdlAcr":"String","atoolsMdlAcr":"String","securityPortfolioCode":"String","platformModelId":0,"stitchPerformance":false,"isWithinRiskNumber":false,"warehouseFundFactSheetSnapshot":{"id":0,"warehousePartnerId":0,"partner":"String","portfolioType":"String","warehouseFundId":0,"monthYear":"0001-01-01T00:00:00.0000000","fundName":"String","asisaClassification":"String","benchmark":"String","benchmark2":"String","saCash":0,"saBonds":0,"saBondsDerivatives":0,"saEquity":0,"saEquityDerivatives":0,"saProperty":0,"saPropertyDerivatives":0,"foreignCash":0,"foreignBonds":0,"foreignBondsDerivatives":0,"foreignEquity":0,"foreignEquityDerivatives":0,"foreignProperty":0,"foreignPropertyDerivatives":0,"africa":0,"commodity":0,"saCashName":"String","saBondsName":"String","saEquityName":"String","saPropertyName":"String","saBondsDerivativesName":"String","saEquityDerivativesName":"String","saPropertyDerivativesName":"String","foreignCashName":"String","foreignBondsName":"String","foreignBondsDerivativesName":"String","foreignEquityName":"String","foreignEquityDerivativesName":"String","foreignPropertyName":"String","foreignPropertyDerivativesName":"String","africaName":"String","commodityName":"String","launchDate":"0001-01-01T00:00:00.0000000","investmentObjective":"String","fundClass":"String","jseCode":"String","portfolioManager":"String","investmentStrategy":"String","riskProfile":"String","equityExposure":"String","foreignExposure":"String","top1001Equity":"String","top1002Equity":"String","top1003Equity":"String","top1004Equity":"String","top1005Equity":"String","top1006Equity":"String","top1007Equity":"String","top1008Equity":"String","top1009Equity":"String","top1010Equity":"String","top1001EquityPercentage":"String","top1002EquityPercentage":"String","top1003EquityPercentage":"String","top1004EquityPercentage":"String","top1005EquityPercentage":"String","top1006EquityPercentage":"String","top1007EquityPercentage":"String","top1008EquityPercentage":"String","top1009EquityPercentage":"String","top1010EquityPercentage":"String","fundSize":"String","totalExpenseRatio":"String","transactionCost":"String","totalInvestmentCharge":"String","totalExpenseRatioTwoClasses":"String","transactionCostTwoClasses":"String","totalInvestmentChargeTwoClasses":"String","totalExpenseRatioThreeClasses":"String","transactionCostThreeClasses":"String","totalInvestmentChargeThreeClasses":"String","calculationPeriod":"String","initialFee":"String","incomeDeclarationDates":"String","reinvestmentAndPayoutDates":"String","initialAdvisoryFee":"String","transactionCutoffTime":"String","annualServiceFee":"String","valuationTime":"String","annualAdvisoryFee":"String","pricingFrequency":"String","characteristics":"String","riskRewardProfile":"String","disclaimer1":"String","disclaimer2":"String","disclaimer3":"String","disclaimer4":"String","disclaimer5":"String","conflictsOfInterest":"String","openingNavPrice":"String","incomeAsPercentOfPrice":"String","primaryClassName":"String","fundMtdPerf":"String","fundQtdPerf":"String","fundYtdPerf":"String","fund1YearPerf":"String","fund2YearPerf":"String","fund3YearPerf":"String","fund5YearPerf":"String","fund10YearPerf":"String","fundSinceInceptionPerf":"String","secondaryClassClassName":"String","fund1YearPerfSecondaryClass":"String","fund2YearPerfSecondaryClass":"String","fund3YearPerfSecondaryClass":"String","fund5YearPerfSecondaryClass":"String","fund10YearPerfSecondaryClass":"String","fundSinceInceptionPerfSecondaryClass":"String","benchmarkMtdPerf":"String","benchmarkQtdPerf":"String","benchmarkYtdPerf":"String","benchmark1YearPerf":"String","benchmark2YearPerf":"String","benchmark3YearPerf":"String","benchmark5YearPerf":"String","benchmark10YearPerf":"String","benchmarkSinceInceptionPerf":"String","benchmark2_MtdPerf":"String","benchmark2_QtdPerf":"String","benchmark2_YtdPerf":"String","benchmark2_1YearPerf":"String","benchmark2_2YearPerf":"String","benchmark2_3YearPerf":"String","benchmark2_5YearPerf":"String","benchmark2_10YearPerf":"String","benchmark2_SinceInceptionPerf":"String","asisaMtdPerf":"String","asisaQtdPerf":"String","asisaYtdPerf":"String","asisa1YearPerf":"String","asisa2YearPerf":"String","asisa3YearPerf":"String","asisa5YearPerf":"String","asisa10YearPerf":"String","asisaSinceInceptionPerf":"String","lowest1YearRollingReturn":"String","highest1YearRollingReturn":"String","lowest1YearRollingReturnSecondaryClass":"String","highest1YearRollingReturnSecondaryClass":"String","publishedDate":"0001-01-01T00:00:00.0000000","previous12MonthsDistributions":"String","previous12MonthsDistributions2":"String","underlyingHoldingsCount":0,"underlyingHoldings01":"String","underlyingHoldings02":"String","underlyingHoldings03":"String","underlyingHoldings04":"String","underlyingHoldings05":"String","underlyingHoldings06":"String","underlyingHoldings07":"String","underlyingHoldings08":"String","underlyingHoldings09":"String","underlyingHoldings10":"String","underlyingHoldings11":"String","underlyingHoldings12":"String","underlyingHoldings13":"String","underlyingHoldings14":"String","underlyingHoldings15":"String","underlyingHoldings16":"String","underlyingHoldings17":"String","underlyingHoldings18":"String","underlyingHoldings19":"String","underlyingHoldings20":"String","underlyingHoldings01Percentage":"String","underlyingHoldings02Percentage":"String","underlyingHoldings03Percentage":"String","underlyingHoldings04Percentage":"String","underlyingHoldings05Percentage":"String","underlyingHoldings06Percentage":"String","underlyingHoldings07Percentage":"String","underlyingHoldings08Percentage":"String","underlyingHoldings09Percentage":"String","underlyingHoldings10Percentage":"String","underlyingHoldings11Percentage":"String","underlyingHoldings12Percentage":"String","underlyingHoldings13Percentage":"String","underlyingHoldings14Percentage":"String","underlyingHoldings15Percentage":"String","underlyingHoldings16Percentage":"String","underlyingHoldings17Percentage":"String","underlyingHoldings18Percentage":"String","underlyingHoldings19Percentage":"String","underlyingHoldings20Percentage":"String","targetHoldingsCount":0,"targetHoldings01":"String","targetHoldings02":"String","targetHoldings03":"String","targetHoldings04":"String","targetHoldings05":"String","targetHoldings06":"String","targetHoldings07":"String","targetHoldings08":"String","targetHoldings09":"String","targetHoldings10":"String","targetHoldings11":"String","targetHoldings12":"String","targetHoldings13":"String","targetHoldings14":"String","targetHoldings15":"String","targetHoldings16":"String","targetHoldings17":"String","targetHoldings18":"String","targetHoldings19":"String","targetHoldings20":"String","targetHoldings01Percentage":"String","targetHoldings02Percentage":"String","targetHoldings03Percentage":"String","targetHoldings04Percentage":"String","targetHoldings05Percentage":"String","targetHoldings06Percentage":"String","targetHoldings07Percentage":"String","targetHoldings08Percentage":"String","targetHoldings09Percentage":"String","targetHoldings10Percentage":"String","targetHoldings11Percentage":"String","targetHoldings12Percentage":"String","targetHoldings13Percentage":"String","targetHoldings14Percentage":"String","targetHoldings15Percentage":"String","targetHoldings16Percentage":"String","targetHoldings17Percentage":"String","targetHoldings18Percentage":"String","targetHoldings19Percentage":"String","targetHoldings20Percentage":"String","modelPortfolioManagementFee":"String","annualConsultingFee":"String","averageWeightedCostOfUnderlying":"String","classification":"String","domicile":"String","baseCurrency":"String","minimumInitialInvestment":"String","distributorFee":"String","administrationFee":"String","depositoryFee":"String","registrarAndTransferAgentFee":"String","aifmAndImFee":"String","investmentAdvisorFee":"String","performanceFee":"String","initialAdviceFee":"String","annualAdviceFee":"String","terDisclaimer":"String","dailyPricingPublication":"String","annualisedPerformances":[{"typeDescription":"String","name":"String","mtdPerf":"String","qtdPerf":"String","ytdPerf":"String","oneYearPerf":"String","twoYearPerf":"String","threeYearPerf":"String","fiveYearPerf":"String","tenYearPerf":"String","sinceInceptionPerf":"String"}],"staticPdfUrl":"String","warehousePerformance":{"warehouseFundId":0,"monthlyPerformances":[{"id":"String","parentPortfolioId":0,"entityType":"String","entityId":0,"entityName":"String","startDate":"String","endDate":"String","trr":0,"asisaTrr":0,"fundBenchmarkTrr":0,"riskFreeTrr":0,"jseTrr":0,"year":0,"month":0,"weight":0}],"cumulativePerformances":{"seriesCollection":[{"dateLabel":"String","fund":0,"benchmark":0,"sector":0}]},"maxDrawdownSinceInception":0,"maxDrawdownBenchmarkSinceInception":0,"maxDrawdownAsisaSinceInception":0,"standardDeviationAnnualised":0,"standardDeviationBenchmarkAnnualised":0,"standardDeviationAsisaAnnualised":0,"sharpeRatioSinceInception":0,"sharpeRatioBenchmarkSinceInception":0,"sharpeRatioAsisaSinceInception":0,"returnFundSinceInception":0,"returnBenchmarkSinceInception":0,"returnAsisaSinceInception":0,"returnJseSinceInception":0,"standardDeviationJseAnnualised":0},"fund":{"id":0,"fundName":"String","partner":"String","warehouseClientId":0,"fundTemplate":"String","warehouseId":0,"saCashName":"String","saCashColour":"String","saBondsName":"String","saBondsColour":"String","saEquityName":"String","saEquityColour":"String","saPropertyName":"String","saPropertyColour":"String","saBondsDerivativesName":"String","saBondsDerivativesColour":"String","saEquityDerivativesName":"String","saEquityDerivativesColour":"String","saPropertyDerivativesName":"String","saPropertyDerivativesColour":"String","foreignCashName":"String","foreignCashColour":"String","foreignBondsName":"String","foreignBondsColour":"String","foreignBondsDerivativesName":"String","foreignBondsDerivativesColour":"String","foreignEquityName":"String","foreignEquityColour":"String","foreignEquityDerivativesName":"String","foreignEquityDerivativesColour":"String","foreignPropertyName":"String","foreignPropertyColour":"String","foreignPropertyDerivativesName":"String","foreignPropertyDerivativesColour":"String","africaName":"String","africaColour":"String","commodityName":"String","commodityColour":"String","underlyingHoldingsTemplate":"String","targetedHoldingsTemplate":"String","monthlyPerformanceTemplate":"String","cumulativePerformanceTemplate":"String","riskScatterTemplate":"String"},"createdAsAt":"0001-01-01T00:00:00.0000000","submittedAsAt":"0001-01-01T00:00:00.0000000","warehousePerformancesDto":{"warehouseFundId":0,"monthlyPerformances":[{"id":"String","parentPortfolioId":0,"entityType":"String","entityId":0,"entityName":"String","startDate":"String","endDate":"String","trr":0,"asisaTrr":0,"fundBenchmarkTrr":0,"riskFreeTrr":0,"jseTrr":0,"year":0,"month":0,"weight":0}],"cumulativePerformances":{"seriesCollection":[{"dateLabel":"String","fund":0,"benchmark":0,"sector":0}]},"maxDrawdownSinceInception":0,"maxDrawdownBenchmarkSinceInception":0,"maxDrawdownAsisaSinceInception":0,"standardDeviationAnnualised":0,"standardDeviationBenchmarkAnnualised":0,"standardDeviationAsisaAnnualised":0,"sharpeRatioSinceInception":0,"sharpeRatioBenchmarkSinceInception":0,"sharpeRatioAsisaSinceInception":0,"returnFundSinceInception":0,"returnBenchmarkSinceInception":0,"returnAsisaSinceInception":0,"returnJseSinceInception":0,"standardDeviationJseAnnualised":0}},"currency":"String"},"ageRunOutOfMoney":0,"ageTargetIncomeNotMet":0,"pessimisticAgeRunOutOfMoney":0,"optimisticAgeRunOutOfMoney":0,"status":"String","message":"String","htmlMessage":"String","balanceAtLifeExpectancy":0,"pessimistiBalanceAtLifeExpectancy":0,"optimisticBalanceAtLifeExpectancy":0,"lifeExpectancyAge":0,"yearAtLifeExpectancy":0,"currentAge":0,"updatedAsAt":"0001-01-01T00:00:00.0000000","clientView":{"id":0,"userId":"String","partnerId":0,"primaryEmail":"String","secondaryEmail":"String","firstName":"String","middleNames":"String","lastName":"String","fullName":"String","alias":"String","phone":"String","mobile":"String","idNumber":"String","status":"String","clientType":"String","birthdaySk":"String","birthday":"0001-01-01T00:00:00.0000000","createdAsAt":"0001-01-01T00:00:00.0000000","updatedAsAt":"0001-01-01T00:00:00.0000000","goals":[{"userId":"String","portfolioId":0,"clientId":0,"clientFullName":"String","clientIdNumber":"String","clientPrimaryEmail":"String","clientMobile":"String","clientGoalId":0,"clientGoalResultsId":0,"goalName":"String","portfolioName":"String","status":"String","inputLifeExpectancyAge":0,"inputCurrentSavingsDate":"String","inputCurrentSavings":0,"inputExpectedInflationRate":0,"inputWithdrawalAmount":0,"inputWithdrawalGrowthRate":0,"cashReserve":0,"additionalSaProperty":0,"results":{},"partnerSettings":{"id":0,"name":"String","partnerId":0,"partnerLogoUrl":"String","partnerBackgroundType":"String","partnerBackgroundUrl":"String","expectedInflationRate":0,"withdrawalIncomeGrowthRate":0,"hellosignapikey":"String","enableCashReserve":false,"enableProperty":false,"partnerDefaultSettings":{"settingsId":0,"partnerId":0,"partnerName":"String","aaType":"String","themeId":0,"initialFee":0,"advisorFee":0,"platformFee":0,"moreLikelyZScore":0,"lessLikelyZScore":0,"showLowestProjectedOutcome":false,"isFundAlphaEqualToFees":false,"showAdvisoryFees":false,"showCashflowTable":false,"xAxisLabel":"String","appearanceSettings":{"appearanceSchema":{"fontColor":"String","axisColor":"String","axisGridColor":"String","graphColor":"String","graphColorOpacity":0,"graphColorRange2":"String","graphColorOpacity2":0,"averageLineColor":"String","barColor1":"String","barColor2":"String","logoHeight":"String","logoUrl":"String","logoBackground":"String","topBarBackground":"String","topBarFontColor":"String","h2Color":"String","linkColor":"String","proposalBackgroundUrl":"String","proposalBackgroundUrl2":"String","proposalBackgroundUrl3":"String","proposalBackgroundUrl4":"String"},"projectedComponentName":"String","showMedianOutcome":false,"medianLineColor":"String","bottomScenarioLineColor":"String","showLowestProjectedOutcome":false}},"partnerContactDetails":{"website":"String","email":"String","telephone":"String","fax":"String","addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String"}}}]},"requestObject":{},"requestType":"String"}