Add Tax Rates
post
/config/sim/v2/sales/taxRates
Add the tax to the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
Tax object of the organization
Root Schema : TaxCURequestBodyv2
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(required):
integer
Unique reference of the hierarchy unitExample:
2 -
name(required):
object name
Tax Rate Name
-
objectNum(required):
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:
integer
Tax Rate Type
Type 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 Example:1
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
Response
Supported Media Types
- application/json
200 Response
Tax object of the organization
Root Schema : TaxResponse
Type:
objectModel for the response
Show Source
-
effGrpObjNum(required):
integer
Object number of the effectivity group associated with the tax rateExample:
1 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the tax classExample:
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