Show Source

• active: boolean
  A Boolean flag indicating the order type is active

  Example: false
• hierUnitId(required): integer
  Unique hierarchy unit reference

  Example: 2
• kdsHighlightSchemeName: object kdsHighlightSchemeName
  KDS Highlight Scheme Name
• kdsHighlightSchemeObjNum: integer
  Object number of the KDS Highlight Scheme to use for the order type parameter

  Example: 0
• objectNum(required): integer
  Unique reference of the Order Type

  Example: 1
• options: string
  A string value of 0s & 1s of length 16 representing enabled or disabled options

  Example: 0000000000000000
• orderDeviceMask: string
  A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Type parameter

  Example: 00000000000000000000000000000000
• slaTime: integer
  Service Level Agreement Time

  Example: 0
• taxMask: string
  A string value of 0s & 1s of length 64 representing the enablement or disablement of the tax mask associated with the Order Type parameter

  Example: 1000000000000000000000000000000000000000000000000000000000000000
• tipAmount1: number
  Guest Pay - Suggested Tip Amount 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true.

  Example: 21.22
• tipAmount2: number
  Guest Pay - Suggested Tip Amount 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true.

  Example: 4.87
• tipAmount3: number
  Guest Pay - Suggested Tip Amount 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true.

  Example: 51.11
• tipPercent1: integer
  Guest Pay - Suggested Tip Percentage 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false.

  Example: 10
• tipPercent2: integer
  Guest Pay - Suggested Tip Percentage 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false.

  Example: 15
• tipPercent3: integer
  Guest Pay - Suggested Tip Percentage 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false.

  Example: 5

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the Order Type"
        },
        "options":{
            "type":"string",
            "example":"0000000000000000",
            "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options"
        },
        "taxMask":{
            "type":"string",
            "example":"1000000000000000000000000000000000000000000000000000000000000000",
            "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the tax mask associated with the Order Type parameter"
        },
        "active":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating the order type is active"
        },
        "orderDeviceMask":{
            "type":"string",
            "example":"00000000000000000000000000000000",
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Type parameter"
        },
        "kdsHighlightSchemeObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the KDS Highlight Scheme to use for the order type parameter"
        },
        "kdsHighlightSchemeName":{
            "type":"object",
            "description":"KDS Highlight Scheme Name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        },
        "slaTime":{
            "type":"integer",
            "example":0,
            "description":"Service Level Agreement Time"
        },
        "tipPercent1":{
            "type":"integer",
            "example":10,
            "description":"Guest Pay - Suggested Tip Percentage 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false."
        },
        "tipPercent2":{
            "type":"integer",
            "example":15,
            "description":"Guest Pay - Suggested Tip Percentage 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false."
        },
        "tipPercent3":{
            "type":"integer",
            "example":5,
            "description":"Guest Pay - Suggested Tip Percentage 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false."
        },
        "tipAmount1":{
            "type":"number",
            "example":21.22,
            "description":"Guest Pay - Suggested Tip Amount 1. If set to 0, Guest Pay will not display the button.  Used when useAmountForTip is true."
        },
        "tipAmount2":{
            "type":"number",
            "example":4.87,
            "description":"Guest Pay - Suggested Tip Amount 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true."
        },
        "tipAmount3":{
            "type":"number",
            "example":51.11,
            "description":"Guest Pay - Suggested Tip Amount 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true."
        }
    }
}