SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

Taxes

Common Module - Enquiry

Tax API

Requires Authentication
Required permission:TaxCodeListing-Enquiry.GET
The following routes are available for this service:
GET/Taxes
GET/Taxes/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/Taxes/AcTaxID/{AcTaxID}Get record for given Tax ID
GET/Taxes/TaxType/{TaxType}Get records for given Tax TypeEach page consists of 20 records
Taxes Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?NoPage Number. Default 1.
RecordsPerPagequeryint?NoRecords Per Page. Default 20 Records.
AcTaxIDpathstringNoTax ID (Tax Code)
TaxTypepathstringNoTax Type (SVT: Service Tax; SLT; Sales Tax; GST; Goods & Service Tax)
TaxesResponse Parameters:
NameParameterData TypeRequiredDescription
TaxListformList<Tax>No
ResponseStatusformResponseStatusNo
TotalRecordsformintNoTotal records in all pages.
TotalRecordsInPageformintNoTotal records in current page.
Tax Parameters:
NameParameterData TypeRequiredDescription
TaxMasterformAcTaxNo
TaxEffectiveAsformList<AcTaxEffectiveAs>No
AcTax Parameters:
NameParameterData TypeRequiredDescription
AcTaxIDformstringYesAcTaxID
AcTaxDescformstringYesAcTaxDesc
TaxOptionformstringYesTaxOption
TaxPercentformdecimalYesTaxPercent
TaxRemarkformstringNoTaxRemark
CreateByformstringNoCreateBy
CreateDateformDateTimeNoCreateDate
EditByformstringNoEditBy
EditDateformDateTimeNoEditDate
StampformintYesStamp
AcSystemTaxIDformstringYesAcSystemTaxID
IsActiveformstringYesIsActive
TaxTypeformstringYesTaxType
AcTaxEffectiveAs Parameters:
NameParameterData TypeRequiredDescription
AcTaxEffectiveAsIDformstringYes
AcTaxIDformstringYesAcTaxID
EffectiveFromformDateTimeYesEffective Date From
EffectiveToformDateTimeYesEffective Date To
TaxPercentformdecimalYesTax Percent
AcSystemTaxIDformstringYesAcSystemTaxID
CreateByformstringNoCreateBy
CreateDateformDateTimeNoCreateDate
EditByformstringNoEditBy
EditDateformDateTimeNoEditDate
StampformstringYesStamp
EffectiveFromFormattedformstringYesEffective Date From (Formatted)
EffectiveToFormattedformstringYesEffective Date To (Formatted)

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 /Taxes HTTP/1.1 
Host: snr2u.com 
Accept: application/xml

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

<TaxesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TaxList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:Tax>
      <d2p1:TaxEffectiveAs>
        <d2p1:AcTaxEffectiveAs>
          <d2p1:AcSystemTaxID>String</d2p1:AcSystemTaxID>
          <d2p1:AcTaxEffectiveAsID>String</d2p1:AcTaxEffectiveAsID>
          <d2p1:AcTaxID>String</d2p1:AcTaxID>
          <d2p1:CreateBy>String</d2p1:CreateBy>
          <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
          <d2p1:EditBy>String</d2p1:EditBy>
          <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
          <d2p1:EffectiveFrom>0001-01-01T00:00:00</d2p1:EffectiveFrom>
          <d2p1:EffectiveTo>0001-01-01T00:00:00</d2p1:EffectiveTo>
          <d2p1:Stamp>String</d2p1:Stamp>
          <d2p1:TaxPercent>0</d2p1:TaxPercent>
        </d2p1:AcTaxEffectiveAs>
      </d2p1:TaxEffectiveAs>
      <d2p1:TaxMaster>
        <d2p1:AcSystemTaxID>String</d2p1:AcSystemTaxID>
        <d2p1:AcTaxDesc>String</d2p1:AcTaxDesc>
        <d2p1:AcTaxID>String</d2p1:AcTaxID>
        <d2p1:CreateBy>String</d2p1:CreateBy>
        <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
        <d2p1:EditBy>String</d2p1:EditBy>
        <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
        <d2p1:IsActive>String</d2p1:IsActive>
        <d2p1:Stamp>0</d2p1:Stamp>
        <d2p1:TaxOption>String</d2p1:TaxOption>
        <d2p1:TaxPercent>0</d2p1:TaxPercent>
        <d2p1:TaxRemark>String</d2p1:TaxRemark>
        <d2p1:TaxType>String</d2p1:TaxType>
      </d2p1:TaxMaster>
    </d2p1:Tax>
  </TaxList>
  <TotalRecords>0</TotalRecords>
  <TotalRecordsInPage>0</TotalRecordsInPage>
</TaxesResponse>