JiwaAPI

<back to all web services

TaxRateGETRequest

Requires Authentication
The following routes are available for this service:
GET/TaxRates/{TaxID}Retrieves a tax rate.
TaxRateGETRequest Parameters:
NameParameterData TypeRequiredDescription
TaxIDpathstringNo
TaxRate Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
TaxIDformstringNo
DescriptionformstringNo
GSTTaxGroupformTaxRateTypes?No
Rateformdecimal?No
IsDefaultRateformbool?No
BASCodeformdecimal?No
IsDefaultRateInGroupformbool?No
IsEnabledformbool?No
LedgerAccountformAccountNo
Account Parameters:
NameParameterData TypeRequiredDescription
LedgerIDformstringNo
AccountNoformstringNo
DescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

GET /TaxRates/{TaxID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TaxRate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tax">
  <_x003C_BASCode_x003E_k__BackingField>0</_x003C_BASCode_x003E_k__BackingField>
  <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
  <_x003C_GSTTaxGroup_x003E_k__BackingField>WST</_x003C_GSTTaxGroup_x003E_k__BackingField>
  <_x003C_IsDefaultRateInGroup_x003E_k__BackingField>false</_x003C_IsDefaultRateInGroup_x003E_k__BackingField>
  <_x003C_IsDefaultRate_x003E_k__BackingField>false</_x003C_IsDefaultRate_x003E_k__BackingField>
  <_x003C_IsEnabled_x003E_k__BackingField>false</_x003C_IsEnabled_x003E_k__BackingField>
  <_x003C_LedgerAccount_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.GeneralLedger">
    <d2p1:_x003C_AccountNo_x003E_k__BackingField>String</d2p1:_x003C_AccountNo_x003E_k__BackingField>
    <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_LedgerID_x003E_k__BackingField>String</d2p1:_x003C_LedgerID_x003E_k__BackingField>
  </_x003C_LedgerAccount_x003E_k__BackingField>
  <_x003C_Rate_x003E_k__BackingField>0</_x003C_Rate_x003E_k__BackingField>
  <_x003C_RecID_x003E_k__BackingField>String</_x003C_RecID_x003E_k__BackingField>
  <_x003C_TaxID_x003E_k__BackingField>String</_x003C_TaxID_x003E_k__BackingField>
</TaxRate>