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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TaxList":[{"TaxMaster":{"AcTaxID":"String","AcTaxDesc":"String","TaxOption":"String","TaxPercent":0,"TaxRemark":"String","CreateBy":"String","CreateDate":"\/Date(-62135596800000-0000)\/","EditBy":"String","EditDate":"\/Date(-62135596800000-0000)\/","Stamp":0,"AcSystemTaxID":"String","IsActive":"String","TaxType":"String"},"TaxEffectiveAs":[{"AcTaxEffectiveAsID":"String","AcTaxID":"String","EffectiveFrom":"\/Date(-62135596800000-0000)\/","EffectiveTo":"\/Date(-62135596800000-0000)\/","TaxPercent":0,"AcSystemTaxID":"String","CreateBy":"String","CreateDate":"\/Date(-62135596800000-0000)\/","EditBy":"String","EditDate":"\/Date(-62135596800000-0000)\/","Stamp":"String","EffectiveFromFormatted":"0001-01-01 00:00:00","EffectiveToFormatted":"0001-01-01 00:00:00"}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"TotalRecords":0,"TotalRecordsInPage":0}