Get Tax Rates
post
/config/sim/v2/sales/getTaxRates
Gets all the tax rates.
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
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of tax rate entities.
Root Schema : schema
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 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 objects of the organization.
Show Source
-
Array of:
object TaxResponsev2
Model for TaxObject
Nested Schema : TaxResponsev2
Type:
objectModel for TaxObject
Show Source
-
breakpoints:
array breakpoints
An array of breakpoints configured for the tax rate Applicable only if type = 1
-
effGrpObjNum:
integer
Object number of the effectivity group associated with the tax rateExample:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
name:
object name
Tax Rate Name
-
objectNum:
integer
Object Number of the family groupExample:
1 -
percent:
number
The tax percentage for the tax rateExample:
1 -
repeatEnd:
integer
The field (1-32) when the incrementing pattern ends. Applicable only if type =1Example:
32 -
repeatStart:
integer
The field (1-32) when the incrementing pattern begins. Applicable only if type =1Example:
1 -
reportGroup:
integer
The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.Example:
0 -
start:
number
Example:
0.5 -
taxLabel:
string
Tax Code for the tax rateExample:
aaa -
type:
Tax Rate Type
type: integer example: 1Type Type Description 0 Disabled for Tax Rates that are not in use. 1 Add On Breakpoint 2 Add On Percentage 3 Included 4 Surcharge 6 Add on, Excludes Start Amount
Nested Schema : breakpoints
Type:
arrayAn array of breakpoints configured for the tax rate Applicable only if type = 1
Show Source
Nested Schema : name
Type:
objectTax Rate Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : items
Type:
Show Source
object-
breakpoint:
integer
Tax BreakpointExample:
1 -
index:
integer
Tax breakpoint indexExample:
1