Get Tax Classes
post
/config/sim/v1/sales/gettaxclasses
Gets all the tax classes
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
0 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Tax class entities.
Root Schema : TaxClassGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Tax Class objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Tax Class objects of the organization.
Show Source
-
Array of:
object TaxClassv1
Model for Tax Class Object
Nested Schema : TaxClassv1
Type:
objectModel for Tax Class Object
Show Source
-
dataExtensions:
array dataExtensions
An array of data extensions for the Tax Class
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
name:
object name
Name
-
objectNum:
integer
Object Number of the family groupExample:
1 -
taxes:
array taxes
An array of taxes configured for the tax class
Nested Schema : dataExtensions
Type:
arrayAn array of data extensions for the Tax Class
Show Source
Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extension fieldExample:
extension column 1 -
value:
string
Value of the extension fieldExample:
Value1
Nested Schema : items
Type:
Show Source
object-
taxObjNum:
integer
Object Number of the taxExample:
1