| All Verbs | /tax |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Income | query | double | No | |
| TaxableCapitalGain | query | double | No | |
| LocalReitDividends | query | double | No | |
| LocalInterest | query | double | No | |
| LocalDividends | query | double | No | |
| ForeignInterest | query | double | No | |
| ForeignDividends | query | double | No | |
| PensionFundContributions | query | double | No | |
| Donations | query | double | No | |
| Age | query | int | No | |
| NrDependants | query | int | No | |
| MedicalAidContribution | query | double | No | |
| IsDisabled | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Income | form | double | No | |
| PensionFundContributions | form | double | No | |
| LocalInterestAfterExemption | form | double | No | |
| TaxableCapitalGain | form | double | No | |
| Donations | form | double | No | |
| TaxableIncome | form | double | No | |
| TaxPayablePriorToRebates | form | double | No | |
| Rebate | form | double | No | |
| MedicalTaxCredits | form | double | No | |
| AdditionalMedicalTaxCredits | form | double | No | |
| TaxPayable | form | double | No | |
| WithholdingsTaxPayable | form | double | No | |
| NetIncome | form | double | No | |
| TaxPayableOnIncome | form | double | No | |
| TaxThreshold | form | double | No | |
| TaxExemption | form | double | No | |
| TaxBracket | form | TaxBracket | No | |
| TaxBrackets | form | List<TaxBracket> | No | |
| EffectiveTaxRate | form | double | No | |
| PostTaxIncome | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Lower | form | decimal | No | |
| Upper | form | decimal | No | |
| Rate | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}