Update Tax Rates
post
/config/sim/v2/sales/updateTaxRates
Updates the tax. The API identifies a Tax Rate by taxId when provided, then verifies hierUnitId and objectNum; otherwise, it uses hierUnitId, objectNum, and effGrpObjNum.
Request
Supported Media Types
- multipart/form-data
- application/json
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Tax object for a v2 update.
Root Schema : schema
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
To update effGrpObjNum, provide taxId so the API can target the existing Tax Rate before applying the new effectivity group. Without taxId, effGrpObjNum is part of the record identity and cannot be used to select the existing Tax Rate for that change.Example:
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 tax rateExample:
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
The taxable sales amount that must be reached in a transaction before the tax rate is appliedExample:
0.5 -
taxId:
integer
Optional identifier of the Tax Rate to update. It must match the supplied hierUnitId and objectNum.Example:
1001 -
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 -
upToAmount:
number
Minimum Value:
0Maximum Value:21474836.47The taxable sales amount up to which the tax rate is applied in a transaction.Example:100
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 Rate Updated.
Root Schema : schema
Type:
objectModel for the response
Show Source
-
effGrpObjNum:
integer
Object number of the effectivity group associated with the tax rateExample:
1 -
hierUnitId:
integer
Unique hierarchy unit valueExample:
1 -
objectNum:
integer
Object number of the tax rateExample:
1 -
taxId:
integer
Unique identifier of the updated tax rate.Example:
1001