| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| taxCode * |
Tax Code |
string |
Yes |
String length: between 1 and 16, inclusive |
| orgName * |
Org Name |
string |
Conditional |
Conditionally required: Either orgName or locationName should be set. String length: between 1 and 50, inclusive |
| locationName * |
Location Name |
string |
Conditional |
Conditionally required: Either orgName or locationName should be set. String length: between 1 and 128, inclusive |
| jurisdiction * |
Jurisdiction |
string |
Conditional |
Conditionally required: If TaxType is 'VAT', 'Jurisdiction' must be set. String length: between 1 and 64, inclusive |
| taxRate * |
Tax rate |
decimal number |
Conditional |
Conditionally required: If adding new tax details, 'Tax Rate' must be set. |
| taxRateMethod |
Tax Rate Method |
integer |
No |
None. |
| roundingMethod |
Rounding Method |
integer |
No |
None. |
| thresholdMethod |
Threshold Method |
integer |
No |
None. |
| thresholdAmount |
Threshold Amount |
decimal number |
No |
None. |
| exclusive |
exclusive |
boolean |
No |
None. |
| returnTaxDays |
Return Tax Days |
integer |
No |
None. |
| taxTypeCode * |
Tax Type Code. If Tax Type code is for 'VAT', then 'Jurisdiction' field must be set |
string |
Yes |
String length: between 1 and 24, inclusive |
| taxTypeName |
Tax Type Name |
string |
No |
String length: between 1 and 64, inclusive |
| taxTypeCharacters |
Associated Character(s) of the tax type |
string |
No |
String length: between 1 and 3, inclusive |
| taxTableCode |
Taxtable Code |
string |
No |
String length: between 1 and 16, inclusive |
| filePath |
File path |
string |
No |
String length: between 1 and 256, inclusive |
| formula |
Formula |
string |
No |
String length: between 1 and 256, inclusive |
| activeDate * |
The date from which the tax would be effective |
date |
Yes |
None. |
| compoundTax |
Compound tax specific tax information |
Collection of CompoundTaxDto |
No |
None. |
| 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 |
No |
None. |
| culture * |
Culture Code. For example: en-US, fr, fr-CA, es, ja-JP etc. |
string |
Conditional |
Conditionally required: Required if you wish to associate description with culture. If not provided, in most cases 'Organizational Culture' is taken String length: between 1 and 10, inclusive |
| description * |
Description Text (Culture specific) |
string |
Yes |
String length: between 1 and 30, inclusive |
| customerAuditDate |
Audit information |
date |
No |
None. |