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
Header Parameters
Body ()
Tax object for a v2 update.
Root Schema : schema
Type: object
Model for TaxObject
Show Source
  • breakpoints
    An array of breakpoints configured for the tax rate Applicable only if type = 1
  • 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
  • Unique reference of the hierarchy unit
    Example: 2
  • name
    Tax Rate Name
  • Object Number of the tax rate
    Example: 1
  • The tax percentage for the tax rate
    Example: 1
  • The field (1-32) when the incrementing pattern ends. Applicable only if type =1
    Example: 32
  • The field (1-32) when the incrementing pattern begins. Applicable only if type =1
    Example: 1
  • 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
  • The taxable sales amount that must be reached in a transaction before the tax rate is applied
    Example: 0.5
  • Optional identifier of the Tax Rate to update. It must match the supplied hierUnitId and objectNum.
    Example: 1001
  • Tax Code for the tax rate
    Example: aaa
  • 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
  • Minimum Value: 0
    Maximum Value: 21474836.47
    The taxable sales amount up to which the tax rate is applied in a transaction.
    Example: 100
Nested Schema : breakpoints
Type: array
An array of breakpoints configured for the tax rate Applicable only if type = 1
Show Source
Nested Schema : name
Type: object
Tax Rate Name
Example:
{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Tax Rate Updated.
Body ()
Root Schema : schema
Type: object
Model for the response
Show Source
Back to Top