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 : TaxBrkPointBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
hierUnitId(required):
integer
Unique hierarchy unit value
-
include:
string
Objects included in response
-
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 returned
-
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.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of tax breakpoint entities for a given tax in an organization.
Root Schema : TaxBreakpointsGetResponse
Type:
objectModel for Tax Breakpoint object
Show Source
-
breakpoint(required):
integer
Tax BreakpointExample:
2 -
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName(required):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
index(required):
integer
Tax breakpoint indexExample:
2 -
name(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
objectNum(required):
integer
Object Number of the Tax rateExample:
1 -
repeatEnd(required):
integer
The field (1-32) when the incrementing pattern ends. Applicable only if type = 1Example:
2 -
repeatStart(required):
integer
The field (1-32) when the incrementing pattern begins. Applicable only if type = 1Example:
2
Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : TranslatedString_Name
Type:
objectAdditional Properties Allowed
Show Source
A group of translated names
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found