Get Tax Rates

post

/config/sim/v2/sales/getTaxRates

Gets all the tax rates.

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, objectNum, name
  • If this value is specified, the include parameter is ignored.
    Value Description
    basic Forces the response to include all fields except option string details
    detailed Forces the response to include all fields including option string details
    Example: detailed
  • If specified, limits translated strings returned
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index. Not required if paging parameters are not supported
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria.
    Example: where equals(hierUnitId, 7)
Back to Top

Response

Supported Media Types

200 Response

A collection of tax rate entities.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Tax objects of the organization.
Show Source
Nested Schema : TaxResponsev2
Type: object
Model for TaxObject
Show Source
  • breakpoints
    An array of breakpoints configured for the tax rate Applicable only if type = 1
  • Object number of the effectivity group associated with the tax rate
    Example: 1
  • Unique reference of the hierarchy unit
    Example: 2
  • Object number of the hierarchy unit
    Example: 1
  • 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
  • Unique identifier of the tax rate.
    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