GET api/v7/Taxes
Retrieve the list of tax for a given tenant.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
the list of tax
Collection of TaxDto| Name | Description | Type |
|---|---|---|
| taxCode |
Tax Code |
string |
| orgName |
Org Name |
string |
| locationName |
Location Name |
string |
| jurisdiction |
Jurisdiction |
string |
| taxRate |
Tax rate |
decimal number |
| taxRateMethod |
Tax Rate Method |
integer |
| roundingMethod |
Rounding Method |
integer |
| thresholdMethod |
Threshold Method |
integer |
| thresholdAmount |
Threshold Amount |
decimal number |
| exclusive |
exclusive |
boolean |
| returnTaxDays |
Return Tax Days |
integer |
| taxTypeCode |
Tax Type Code. If Tax Type code is for 'VAT', then 'Jurisdiction' field must be set |
string |
| taxTypeName |
Tax Type Name |
string |
| taxTypeCharacters |
Associated Character(s) of the tax type |
string |
| taxTableCode |
Taxtable Code |
string |
| filePath |
File path |
string |
| formula |
Formula |
string |
| activeDate |
The date from which the tax would be effective |
date |
| compoundTax |
Compound tax specific tax information |
Collection of CompoundTaxDto |
| taxClassInfo |
TaxClassInfo contains TaxClass associate with TaxType and also validate TaxRule if any associate with TaxClassCode This TaxClass Info does not support by Tax -PUT/POST API to create mapping. Please use TaxClassTaxType or TaxClassTaxRule API to create mapping |
Collection of TaxClassRuleDto |
| culture |
Culture Code. For example: en-US, fr, fr-CA, es, ja-JP etc. |
string |
| description |
Description Text (Culture specific) |
string |
| customerAuditDate |
Audit information |
date |
Response Formats
application/json, text/json
Sample:
[
{
"taxCode": "sample string 1",
"orgName": "sample string 2",
"locationName": "sample string 3",
"jurisdiction": "sample string 4",
"taxRate": 1.0,
"taxRateMethod": 1,
"roundingMethod": 1,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"exclusive": true,
"returnTaxDays": 1,
"taxTypeCode": "sample string 5",
"taxTypeName": "sample string 6",
"taxTypeCharacters": "sample string 7",
"taxTableCode": "sample string 8",
"filePath": "sample string 9",
"formula": "sample string 10",
"activeDate": "2018-01-01T00:00:00",
"compoundTax": [
{
"taxTypeCode": "sample string 1",
"sequence": 1,
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"taxTypeCode": "sample string 1",
"sequence": 1,
"customerAuditDate": "2018-01-01T00:00:00"
}
],
"taxClassInfo": [
{
"taxClassCode": "sample string 1",
"taxRules": [
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
}
]
},
{
"taxClassCode": "sample string 1",
"taxRules": [
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
}
]
}
],
"culture": "sample string 11",
"description": "sample string 12",
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"taxCode": "sample string 1",
"orgName": "sample string 2",
"locationName": "sample string 3",
"jurisdiction": "sample string 4",
"taxRate": 1.0,
"taxRateMethod": 1,
"roundingMethod": 1,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"exclusive": true,
"returnTaxDays": 1,
"taxTypeCode": "sample string 5",
"taxTypeName": "sample string 6",
"taxTypeCharacters": "sample string 7",
"taxTableCode": "sample string 8",
"filePath": "sample string 9",
"formula": "sample string 10",
"activeDate": "2018-01-01T00:00:00",
"compoundTax": [
{
"taxTypeCode": "sample string 1",
"sequence": 1,
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"taxTypeCode": "sample string 1",
"sequence": 1,
"customerAuditDate": "2018-01-01T00:00:00"
}
],
"taxClassInfo": [
{
"taxClassCode": "sample string 1",
"taxRules": [
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
}
]
},
{
"taxClassCode": "sample string 1",
"taxRules": [
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"taxRuleCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"isTaxHoliday": true,
"thresholdMethod": 1,
"thresholdAmount": 1.0,
"returnTaxDays": 1,
"customerAuditDate": "2018-01-01T00:00:00"
}
]
}
],
"culture": "sample string 11",
"description": "sample string 12",
"customerAuditDate": "2018-01-01T00:00:00"
}
]