Get Tax Breakpoints
post
/config/sim/v1/sales/gettaxbreakpoints
Gets all the breakpoints for a given tax
Request
Supported Media Types
- application/json
- multipart/form-data
Tax Break Point Body object of the organization
Root Schema : TaxBrkPointBodyv1
Type:
objectThe input Body model that needs to be given.
Show Source
-
hierUnitId(required):
integer
Unique hierarchy unit value
-
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 translated strings returnedExample:
en-US, de-DE -
limit:
integer
If using paging, number of results returned in this page.
-
objectNum(required):
integer
Object number of the tax
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.
-
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 breakpoints
Root Schema : TaxBreakpointsGetResponsev1
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 Breakpoint 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 Breakpoint objects of the organization.
Show Source
-
Array of:
object TaxBreakpointsResponsev1
Model for Tax Breakpoint object
Nested Schema : TaxBreakpointsResponsev1
Type:
objectModel for Tax Breakpoint object
Show Source
-
breakpoint:
integer
Tax BreakpointExample:
2 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
index:
integer
Tax breakpoint indexExample:
2 -
name:
object name
Name
-
objectNum:
integer
Object Number of the Tax rateExample:
1 -
repeatEnd:
integer
The field (1-32) when the incrementing pattern ends. Applicable only if type = 1Example:
2 -
repeatStart:
integer
The field (1-32) when the incrementing pattern begins. Applicable only if type = 1Example:
2
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"
}