Jump to

• Request
• Response

Add Tax Parameters

post

/config/sim/v1/sales/taxparameters

Add the Tax Parameter to a specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef(optional): string(string)
  Detail that Identifies that who made the change
• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

Tax Parameter object of the organization

Root Schema : TaxParameters

Type: object

Model for Tax Parameter object.

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 2
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

  Example: 1
• internationalOptions(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the currency parameter

  Example: 00000000
• internationalOptionsExt(optional): object internationalOptionsExt
  An object containing the descriptive international options list associated with the tax parameter
• options(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the tax parameter

  Example: 0000000000
• optionsExt(optional): object optionsExt
  An object containing the descriptive options list associated with the tax parameter
• printVATLineForTaxRate(optional): string
  A string value of 0???s & 1???s representing the enablement / disablement of printing the VAT lines for the tax rates.

  Example: 100000000000000000000000000000000
• printVATLineForTaxRateExt(optional): array printVATLineForTaxRateExt
  An object containing the descriptive list of the tax rates for which VAT lines are to be printed.

{
    "description":"Model for Tax Parameter object.",
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "internationalOptions":{
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the currency parameter",
            "type":"string",
            "example":"00000000"
        },
        "internationalOptionsExt":{
            "description":"An object containing the descriptive international options list associated with the tax parameter",
            "type":"object",
            "properties":{
                "printTaxItmzrs":{
                    "description":"A Boolean flag indicating to print tax itemizers on guest checks and receipts. This option must be selected for the Philippine tax.",
                    "type":"boolean",
                    "example":false
                },
                "enableCandianGST":{
                    "description":"A Boolean flag indicating to enable Canadian GST.",
                    "type":"boolean",
                    "example":false
                },
                "enableJapaneseTax":{
                    "description":"A Boolean flag indicating to enable Japanese tax options.",
                    "type":"boolean",
                    "example":false
                },
                "enableThailandTaxPrinting":{
                    "description":"A Boolean flag indicating to enable Thailand tax printing",
                    "type":"boolean",
                    "example":false
                },
                "roundJapaneseTaxAfterDecimal":{
                    "description":"A Boolean flag indicating to truncate digits after decimal; Set to false to round digits after decimal",
                    "type":"boolean",
                    "example":false
                },
                "printJapaneseTaxAmtDue":{
                    "description":"A Boolean flag indicating to print the amount of Japanese Tax Due, even if summary totals are suppressed for the tender media.",
                    "type":"boolean",
                    "example":false
                },
                "truncateInclusiveTaxes":{
                    "description":"A Boolean flag indicating to truncate inclusive tax amounts. Deselect to round inclusive tax amounts.",
                    "type":"boolean",
                    "example":false
                },
                "printItemInclTaxTotal":{
                    "description":"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.",
                    "type":"boolean",
                    "example":false
                },
                "printCheckInclTaxTotal":{
                    "description":"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.",
                    "type":"boolean",
                    "example":false
                },
                "printTaxRatePerItem":{
                    "description":"A Boolean flag indicating to print the applied tax rates for each menu item on guest checks, customer receipts, and in the journal.",
                    "type":"boolean",
                    "example":false
                },
                "enableTaxLabels":{
                    "description":"A Boolean flag indicating to consolidate tax reporting information based on defined Tax Labels configured under Tax Rates.",
                    "type":"boolean",
                    "example":false
                }
            }
        },
        "options":{
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the tax parameter",
            "type":"string",
            "example":"0000000000"
        },
        "optionsExt":{
            "description":"An object containing the descriptive options list associated with the tax parameter",
            "type":"object",
            "properties":{
                "dontIncludeTaxInTipReportTtl":{
                    "description":"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.",
                    "type":"boolean",
                    "example":false
                },
                "requireRefEntryWithTaxExemptions":{
                    "description":"A Boolean flag indicating to enforce workstation operators to enter an alphanumeric Reference Entry when using Exempt Tax keys.",
                    "type":"boolean",
                    "example":false
                },
                "printInclTaxBeforeSummaryTtls":{
                    "description":"A Boolean flag indicating to print inclusive tax totals before the summary totals on guest checks and customer receipts.",
                    "type":"boolean",
                    "example":false
                },
                "printInclTaxTtlsWhen0":{
                    "description":"A Boolean flag indicating to print inclusive totals on guest checks and customer receipts, even when the tax is zero.",
                    "type":"boolean",
                    "example":false
                },
                "printConslVATOnReceipts":{
                    "description":"A Boolean flag indicating to print a consolidated VAT line..",
                    "type":"boolean",
                    "example":false
                },
                "printVATNetTtlOnReceipts":{
                    "description":"A Boolean flag indicating to print a VAT Net Totals line on guest checks and customer receipts.",
                    "type":"boolean",
                    "example":false
                },
                "printTaxExmptVoucher":{
                    "description":"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..",
                    "type":"boolean",
                    "example":false
                },
                "postTxblSlsWhenTaxRateIs0":{
                    "description":"A Boolean flag indicating to post taxable sales when the tax rate is set to 0.00%.",
                    "type":"boolean",
                    "example":false
                },
                "prorateTaxForEachComboItemAsPercent":{
                    "description":"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.",
                    "type":"boolean",
                    "example":false
                }
            }
        },
        "printVATLineForTaxRate":{
            "description":"A string value of 0???s & 1???s representing the enablement / disablement of printing the VAT lines for the tax rates.",
            "type":"string",
            "example":"100000000000000000000000000000000"
        },
        "printVATLineForTaxRateExt":{
            "description":"An object containing the descriptive list  of the tax rates for which VAT lines are to be printed.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "taxObjNum":{
                        "description":"Object number of the tax rate for which VAT Line is to be printed.",
                        "type":"integer",
                        "example":1
                    }
                }
            }
        }
    }
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : internationalOptionsExt

Type: object

An object containing the descriptive international options list associated with the tax parameter

Show Source

• enableCandianGST(optional): boolean
  A Boolean flag indicating to enable Canadian GST.

  Example: false
• enableJapaneseTax(optional): boolean
  A Boolean flag indicating to enable Japanese tax options.

  Example: false
• enableTaxLabels(optional): boolean
  A Boolean flag indicating to consolidate tax reporting information based on defined Tax Labels configured under Tax Rates.

  Example: false
• enableThailandTaxPrinting(optional): boolean
  A Boolean flag indicating to enable Thailand tax printing

  Example: false
• printCheckInclTaxTotal(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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(optional): boolean
  A Boolean flag indicating to truncate digits after decimal; Set to false to round digits after decimal

  Example: false
• truncateInclusiveTaxes(optional): boolean
  A Boolean flag indicating to truncate inclusive tax amounts. Deselect to round inclusive tax amounts.

  Example: false

{
    "description":"An object containing the descriptive international options list associated with the tax parameter",
    "type":"object",
    "properties":{
        "printTaxItmzrs":{
            "description":"A Boolean flag indicating to print tax itemizers on guest checks and receipts. This option must be selected for the Philippine tax.",
            "type":"boolean",
            "example":false
        },
        "enableCandianGST":{
            "description":"A Boolean flag indicating to enable Canadian GST.",
            "type":"boolean",
            "example":false
        },
        "enableJapaneseTax":{
            "description":"A Boolean flag indicating to enable Japanese tax options.",
            "type":"boolean",
            "example":false
        },
        "enableThailandTaxPrinting":{
            "description":"A Boolean flag indicating to enable Thailand tax printing",
            "type":"boolean",
            "example":false
        },
        "roundJapaneseTaxAfterDecimal":{
            "description":"A Boolean flag indicating to truncate digits after decimal; Set to false to round digits after decimal",
            "type":"boolean",
            "example":false
        },
        "printJapaneseTaxAmtDue":{
            "description":"A Boolean flag indicating to print the amount of Japanese Tax Due, even if summary totals are suppressed for the tender media.",
            "type":"boolean",
            "example":false
        },
        "truncateInclusiveTaxes":{
            "description":"A Boolean flag indicating to truncate inclusive tax amounts. Deselect to round inclusive tax amounts.",
            "type":"boolean",
            "example":false
        },
        "printItemInclTaxTotal":{
            "description":"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.",
            "type":"boolean",
            "example":false
        },
        "printCheckInclTaxTotal":{
            "description":"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.",
            "type":"boolean",
            "example":false
        },
        "printTaxRatePerItem":{
            "description":"A Boolean flag indicating to print the applied tax rates for each menu item on guest checks, customer receipts, and in the journal.",
            "type":"boolean",
            "example":false
        },
        "enableTaxLabels":{
            "description":"A Boolean flag indicating to consolidate tax reporting information based on defined Tax Labels configured under Tax Rates.",
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : optionsExt

Type: object

An object containing the descriptive options list associated with the tax parameter

Show Source

• dontIncludeTaxInTipReportTtl(optional): 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(optional): boolean
  A Boolean flag indicating to post taxable sales when the tax rate is set to 0.00%.

  Example: false
• printConslVATOnReceipts(optional): boolean
  A Boolean flag indicating to print a consolidated VAT line..

  Example: false
• printInclTaxBeforeSummaryTtls(optional): boolean
  A Boolean flag indicating to print inclusive tax totals before the summary totals on guest checks and customer receipts.

  Example: false
• printInclTaxTtlsWhen0(optional): boolean
  A Boolean flag indicating to print inclusive totals on guest checks and customer receipts, even when the tax is zero.

  Example: false
• printTaxExmptVoucher(optional): 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(optional): boolean
  A Boolean flag indicating to print a VAT Net Totals line on guest checks and customer receipts.

  Example: false
• prorateTaxForEachComboItemAsPercent(optional): 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(optional): boolean
  A Boolean flag indicating to enforce workstation operators to enter an alphanumeric Reference Entry when using Exempt Tax keys.

  Example: false

{
    "description":"An object containing the descriptive options list associated with the tax parameter",
    "type":"object",
    "properties":{
        "dontIncludeTaxInTipReportTtl":{
            "description":"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.",
            "type":"boolean",
            "example":false
        },
        "requireRefEntryWithTaxExemptions":{
            "description":"A Boolean flag indicating to enforce workstation operators to enter an alphanumeric Reference Entry when using Exempt Tax keys.",
            "type":"boolean",
            "example":false
        },
        "printInclTaxBeforeSummaryTtls":{
            "description":"A Boolean flag indicating to print inclusive tax totals before the summary totals on guest checks and customer receipts.",
            "type":"boolean",
            "example":false
        },
        "printInclTaxTtlsWhen0":{
            "description":"A Boolean flag indicating to print inclusive totals on guest checks and customer receipts, even when the tax is zero.",
            "type":"boolean",
            "example":false
        },
        "printConslVATOnReceipts":{
            "description":"A Boolean flag indicating to print a consolidated VAT line..",
            "type":"boolean",
            "example":false
        },
        "printVATNetTtlOnReceipts":{
            "description":"A Boolean flag indicating to print a VAT Net Totals line on guest checks and customer receipts.",
            "type":"boolean",
            "example":false
        },
        "printTaxExmptVoucher":{
            "description":"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..",
            "type":"boolean",
            "example":false
        },
        "postTxblSlsWhenTaxRateIs0":{
            "description":"A Boolean flag indicating to post taxable sales when the tax rate is set to 0.00%.",
            "type":"boolean",
            "example":false
        },
        "prorateTaxForEachComboItemAsPercent":{
            "description":"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.",
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : printVATLineForTaxRateExt

Type: array

An object containing the descriptive list of the tax rates for which VAT lines are to be printed.

Show Source

• Array of: object items

{
    "description":"An object containing the descriptive list  of the tax rates for which VAT lines are to be printed.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "taxObjNum":{
                "description":"Object number of the tax rate for which VAT Line is to be printed.",
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• taxObjNum(optional): integer
  Object number of the tax rate for which VAT Line is to be printed.

  Example: 1

{
    "type":"object",
    "properties":{
        "taxObjNum":{
            "description":"Object number of the tax rate for which VAT Line is to be printed.",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Tax Parameters object of the organization

Body ()

Root Schema : TaxParameterResponse

Type: object

Model for the tax Parameter response

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1

{
    "description":"Model for the tax Parameter response",
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top