1. Configuration and Content API Guide
  2. Tasks
  3. v1
  4. Sales
  5. Tax Parameters

Get Tax Parameters

post

/config/sim/v1/sales/gettaxparameters

Gets all the tax parameters

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • Objects included in the response.
    Example: hierUnitId
  • 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
  • If specified, limits the translated strings returned.
    Example: en-US, es-ES, es-MX
  • If using paging, number of results returned in this page.
    Example: 0
  • 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: objectNum:asc
  • Search criteria to filter results based on field value.
    Example: where equals(objectNum,1)
Back to Top

Response

Supported Media Types

200 Response

A collection of Tax parameters.
Body ()
Root Schema : TaxParametersGetResponsev1
Type: object
Show Source
Nested Schema : items
Type: array
Array of Tax Parameter objects of the organization.
Show Source
Nested Schema : TaxParametersResponsev1
Type: object
Model for Tax Parameter object.
Show Source
Nested Schema : hierUnitName
Type: object
Hier Unit Name
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : internationalOptionsExt
Type: object
An object containing the descriptive international options list associated with the tax parameter
Show Source
  • A Boolean flag indicating to enable Canadian GST.
    Example: false
  • A Boolean flag indicating to enable Japanese tax options.
    Example: false
  • A Boolean flag indicating to consolidate tax reporting information based on defined Tax Labels configured under Tax Rates.
    Example: false
  • A Boolean flag indicating to enable Thailand tax printing
    Example: false
  • A Boolean flag indicating Post Inclusive Tax to Net Sales Total.
    Example: false
  • A Boolean flag indicating to print the total inclusive tax calculated on the total sales for each tax rate on guest checks when a check has items with inclusive taxes.
    Example: false
  • A Boolean flag indicating to print the total inclusive tax calculated on the total sales for each tax rate on guest checks when a check has items with inclusive taxes.
    Example: false
  • A Boolean flag indicating to print the amount of Japanese Tax Due, even if summary totals are suppressed for the tender media.
    Example: false
  • A Boolean flag indicating to print tax itemizers on guest checks and receipts. This option must be selected for the Philippine tax.
    Example: false
  • A Boolean flag indicating to print the applied tax rates for each menu item on guest checks, customer receipts, and in the journal.
    Example: false
  • A Boolean flag indicating to truncate digits after decimal; Set to false to round digits after decimal
    Example: false
  • A Boolean flag indicating Service Charge Itemizer is Net of Inclusive Tax. This option bit is supoorted from Simphony 19.8 and above.
    Example: false
  • A Boolean flag indicating to truncate inclusive tax amounts. Deselect to round inclusive tax amounts.
    Example: false
Nested Schema : optionsExt
Type: object
An object containing the descriptive options list associated with the tax parameter
Show Source
Nested Schema : printVATLineForTaxRatesExt
Type: object
An object containing the descriptive list of the tax rates for which VAT lines are to be printed.
Show Source
Back to Top