PortfolioLinkApi

<back to all web services

GetTaxInfo

The following routes are available for this service:
All Verbs/tax
GetTaxInfo Parameters:
NameParameterData TypeRequiredDescription
IncomequerydoubleNo
TaxableCapitalGainquerydoubleNo
LocalReitDividendsquerydoubleNo
LocalInterestquerydoubleNo
LocalDividendsquerydoubleNo
ForeignInterestquerydoubleNo
ForeignDividendsquerydoubleNo
PensionFundContributionsquerydoubleNo
DonationsquerydoubleNo
AgequeryintNo
NrDependantsqueryintNo
MedicalAidContributionquerydoubleNo
IsDisabledqueryboolNo
GetTaxInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IncomeformdoubleNo
PensionFundContributionsformdoubleNo
LocalInterestAfterExemptionformdoubleNo
TaxableCapitalGainformdoubleNo
DonationsformdoubleNo
TaxableIncomeformdoubleNo
TaxPayablePriorToRebatesformdoubleNo
RebateformdoubleNo
MedicalTaxCreditsformdoubleNo
AdditionalMedicalTaxCreditsformdoubleNo
TaxPayableformdoubleNo
WithholdingsTaxPayableformdoubleNo
NetIncomeformdoubleNo
TaxPayableOnIncomeformdoubleNo
TaxThresholdformdoubleNo
TaxExemptionformdoubleNo
TaxBracketformTaxBracketNo
TaxBracketsformList<TaxBracket>No
EffectiveTaxRateformdoubleNo
PostTaxIncomeformdoubleNo
TaxBracket Parameters:
NameParameterData TypeRequiredDescription
LowerformdecimalNo
UpperformdecimalNo
RateformdecimalNo

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

{
	income: 0,
	taxableCapitalGain: 0,
	localReitDividends: 0,
	localInterest: 0,
	localDividends: 0,
	foreignInterest: 0,
	foreignDividends: 0,
	pensionFundContributions: 0,
	donations: 0,
	age: 0,
	nrDependants: 0,
	medicalAidContribution: 0,
	isDisabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	income: 0,
	pensionFundContributions: 0,
	localInterestAfterExemption: 0,
	taxableCapitalGain: 0,
	donations: 0,
	taxableIncome: 0,
	taxPayablePriorToRebates: 0,
	rebate: 0,
	medicalTaxCredits: 0,
	additionalMedicalTaxCredits: 0,
	taxPayable: 0,
	withholdingsTaxPayable: 0,
	netIncome: 0,
	taxPayableOnIncome: 0,
	taxThreshold: 0,
	taxExemption: 0,
	taxBracket: 
	{
		lower: 0,
		upper: 0,
		rate: 0
	},
	taxBrackets: 
	[
		{
			lower: 0,
			upper: 0,
			rate: 0
		}
	],
	effectiveTaxRate: 0,
	postTaxIncome: 0
}