| Required permission: | TaxCodeListing-Enquiry.GET |
| GET | /Taxes | ||
|---|---|---|---|
| GET | /Taxes/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /Taxes/AcTaxID/{AcTaxID} | Get record for given Tax ID | |
| GET | /Taxes/TaxType/{TaxType} | Get records for given Tax Type | Each page consists of 20 records |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| AcTaxID | path | string | No | Tax ID (Tax Code) |
| TaxType | path | string | No | Tax Type (SVT: Service Tax; SLT; Sales Tax; GST; Goods & Service Tax) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TaxList | form | List<Tax> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TaxMaster | form | AcTax | No | |
| TaxEffectiveAs | form | List<AcTaxEffectiveAs> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcTaxID | form | string | Yes | AcTaxID |
| AcTaxDesc | form | string | Yes | AcTaxDesc |
| TaxOption | form | string | Yes | TaxOption |
| TaxPercent | form | decimal | Yes | TaxPercent |
| TaxRemark | form | string | No | TaxRemark |
| CreateBy | form | string | No | CreateBy |
| CreateDate | form | DateTime | No | CreateDate |
| EditBy | form | string | No | EditBy |
| EditDate | form | DateTime | No | EditDate |
| Stamp | form | int | Yes | Stamp |
| AcSystemTaxID | form | string | Yes | AcSystemTaxID |
| IsActive | form | string | Yes | IsActive |
| TaxType | form | string | Yes | TaxType |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcTaxEffectiveAsID | form | string | Yes | |
| AcTaxID | form | string | Yes | AcTaxID |
| EffectiveFrom | form | DateTime | Yes | Effective Date From |
| EffectiveTo | form | DateTime | Yes | Effective Date To |
| TaxPercent | form | decimal | Yes | Tax Percent |
| AcSystemTaxID | form | string | Yes | AcSystemTaxID |
| CreateBy | form | string | No | CreateBy |
| CreateDate | form | DateTime | No | CreateDate |
| EditBy | form | string | No | EditBy |
| EditDate | form | DateTime | No | EditDate |
| Stamp | form | string | Yes | Stamp |
| EffectiveFromFormatted | form | string | Yes | Effective Date From (Formatted) |
| EffectiveToFormatted | form | string | Yes | Effective Date To (Formatted) |
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.
GET /Taxes HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
TaxList:
[
{
TaxMaster:
{
AcTaxID: String,
AcTaxDesc: String,
TaxOption: String,
TaxPercent: 0,
TaxRemark: String,
CreateBy: String,
CreateDate: 0001-01-01,
EditBy: String,
EditDate: 0001-01-01,
Stamp: 0,
AcSystemTaxID: String,
IsActive: String,
TaxType: String
},
TaxEffectiveAs:
[
{
AcTaxEffectiveAsID: String,
AcTaxID: String,
EffectiveFrom: 0001-01-01,
EffectiveTo: 0001-01-01,
TaxPercent: 0,
AcSystemTaxID: String,
CreateBy: String,
CreateDate: 0001-01-01,
EditBy: String,
EditDate: 0001-01-01,
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
}