Get Tax Rates
post
/config/sim/v1/sales/gettaxrates
Gets all the tax rates.
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : TaxRatesGetRequestBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
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.
-
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 rate entities in an organization.
Root Schema : TaxGetResponse
Type:
objectModel for TaxObject
Show Source
-
breakpoints(required):
array breakpoints
An array of breakpoints configured for the tax rate Applicable only if type = 1
-
effGrpName(required):
object TranslatedString_EffGrpName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the effectivity group associated with the tax rate in configured languages.
-
effGrpObjNum(required):
integer
Object number of the effectivity group associated with the tax rateExample:
1 -
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 -
name(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
objectNum(required):
integer
Object Number of the family groupExample:
1 -
percent(required):
number
The tax percentage for the tax rateExample:
1 -
repeatEnd(required):
integer
The field (1-32) when the incrementing pattern ends. Applicable only if type =1Example:
32 -
repeatStart(required):
integer
The field (1-32) when the incrementing pattern begins. Applicable only if type =1Example:
1 -
reportGroup(required):
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(required):
number
Example:
0.5 -
taxLabel(required):
string
Tax Code for the tax rateExample:
aaa -
type(required):
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 : TranslatedString_EffGrpName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the effectivity group associated with the tax rate in configured languages.
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}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"
}Nested Schema : items
Type:
Show Source
object-
breakpoint:
integer
Tax BreakpointExample:
1 -
index:
integer
Tax breakpoint indexExample:
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