Get Tax Parameters
post
/config/sim/v1/sales/gettaxparameters
Gets all the tax parameters
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : TaxParameterGetRequestBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in response
-
includeAll:
string
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 -
languages:
string
If specified, limits translated strings returned
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
orderBy:
string
Sorts the response by the specified field name and sort order.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of tax parameters entities in an organization.
Root Schema : TaxParametersGetResponse
Type:
objectModel for Tax Parameter object.
Show Source
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName(required):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
internationalOptions(required):
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the currency parameterExample:
00000000000000000000000000000000 -
internationalOptionsExt(required):
object internationalOptionsExt
An object containing the descriptive international options list associated with the tax parameter
-
options(required):
string
A string value of 0s & 1s of length 9 representing the enablement or disablement of the options associated with the tax parameterExample:
000000000 -
optionsExt(required):
object optionsExt
An object containing the descriptive options list associated with the tax parameter
-
printVATLineForTaxRates(required):
string
A string value of 0s & 1s of length 64 representing the enablement / disablement of printing the VAT lines for the tax rates.Example:
0000000001011110000000000000000000000000000000000000000000000000 -
printVATLineForTaxRatesExt(required):
array printVATLineForTaxRatesExt
An object containing the descriptive list of the tax rates for which VAT lines are to be printed.
Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : internationalOptionsExt
Type:
objectAn object containing the descriptive international options list associated with the tax parameter
Show Source
-
enableCandianGST:
boolean
A Boolean flag indicating to enable Canadian GST.Example:
false -
enableJapaneseTax:
boolean
A Boolean flag indicating to enable Japanese tax options.Example:
false -
enableTaxLabels:
boolean
A Boolean flag indicating to consolidate tax reporting information based on defined Tax Labels configured under Tax Rates.Example:
false -
enableThailandTaxPrinting:
boolean
A Boolean flag indicating to enable Thailand tax printingExample:
false -
printCheckInclTaxTotal:
boolean
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 -
printItemInclTaxTotal:
boolean
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 -
printJapaneseTaxAmtDue:
boolean
A Boolean flag indicating to print the amount of Japanese Tax Due, even if summary totals are suppressed for the tender media.Example:
false -
printTaxItmzrs:
boolean
A Boolean flag indicating to print tax itemizers on guest checks and receipts. This option must be selected for the Philippine tax.Example:
false -
printTaxRatePerItem:
boolean
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 -
roundJapaneseTaxAfterDecimal:
boolean
A Boolean flag indicating to truncate digits after decimal; Set to false to round digits after decimalExample:
false -
truncateInclusiveTaxes:
boolean
A Boolean flag indicating to truncate inclusive tax amounts. Deselect to round inclusive tax amounts.Example:
false
Nested Schema : optionsExt
Type:
objectAn object containing the descriptive options list associated with the tax parameter
Show Source
-
dontIncludeTaxInTipReportTtl:
boolean
A Boolean flag indicating to prevent a transaction's calculated tax amount from posting to the Gross Receipts and Charged Receipts totals on Tip Reports.Example:
false -
postTxblSlsWhenTaxRateIs0:
boolean
A Boolean flag indicating to post taxable sales when the tax rate is set to 0.00%.Example:
false -
printConslVATOnReceipts:
boolean
A Boolean flag indicating to print a consolidated VAT line..Example:
false -
printInclTaxBeforeSummaryTtls:
boolean
A Boolean flag indicating to print inclusive tax totals before the summary totals on guest checks and customer receipts.Example:
false -
printInclTaxTtlsWhen0:
boolean
A Boolean flag indicating to print inclusive totals on guest checks and customer receipts, even when the tax is zero.Example:
false -
printTaxExmptVoucher:
boolean
A Boolean flag indicating to print a voucher when a tax is exempted using a Tax Exempt key or by a Tender key that is programmed to exempt tax. Deselect to suppress printing the tax exempt voucher..Example:
false -
printVATNetTtlOnReceipts:
boolean
A Boolean flag indicating to print a VAT Net Totals line on guest checks and customer receipts.Example:
false -
prorateTaxForEachComboItemAsPercent:
boolean
A Boolean flag indicating to prorate the menu item price of each combo meal item as a percentage of the total combo meal price in order to apply the correct amount of tax to each item.Example:
false -
requireRefEntryWithTaxExemptions:
boolean
A Boolean flag indicating to enforce workstation operators to enter an alphanumeric Reference Entry when using Exempt Tax keys.Example:
false
Nested Schema : printVATLineForTaxRatesExt
Type:
arrayAn object containing the descriptive list of the tax rates for which VAT lines are to be printed.
Show Source
Nested Schema : items
Type:
Show Source
object-
taxObjNum:
integer
Object number of the tax rate for which VAT Line is to be printed.Example:
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
404 Response
404 Requested resource not found