• checkNotifications: array checkNotifications
  Array of past notifications for the check.
• checkPrintedLines: object checkPrintedLines
  Response contains an printed lines object.
• comboMeals: array comboMeals
  Array of combo meal items. If there were no combo meal items on the check the returned array will be empty.
• discounts: array discounts
  Array of discounts.
• extensions: array extensions
  Array of extension detail.
• header(required): object CheckHeaderRound
  The check header contains information describing the overall check.
• menuItems: array menuItems
  Array of menu items.
• notificationOptions: object CheckNotificationOptions

  Integrator-provided options for notifications. Following NotificationOptions are available "Inline" and "Subscription".

  Inline notifications options are used when Integrator is not registered and subscribed for notifications.

  Subscription notification options are used when Integrator is registered and subscribed for notifications.

  Check notifications are available for STS Cloud and STS Local (on-premises).

• serviceCharges: array serviceCharges
  Array of service charges.
• taxes: array taxes
  Array of tax item.
• tenders: array tenders
  Array of tender items.
• totals: object CheckTotals
  Contains a set of totals for aspects of the check. The values from the check total object relate in the following way:
  subtotal (sum of menu items sales - discounts)
  - discountTotal
  + autoServiceChargeTotal
  + serviceChargeTotal
  + taxTotal
  - paymentTotal
  = totalDue

{
    "description":"The model for a Check.",
    "type":"object",
    "required":[
        "header"
    ],
    "properties":{
        "header":{
            "$ref":"#/definitions/CheckHeaderRound"
        },
        "notificationOptions":{
            "$ref":"#/definitions/CheckNotificationOptions"
        },
        "checkNotifications":{
            "type":"array",
            "description":"Array of past notifications for the check.",
            "items":{
                "$ref":"#/definitions/CheckNotification"
            }
        },
        "menuItems":{
            "type":"array",
            "description":"Array of menu items.",
            "items":{
                "$ref":"#/definitions/CheckMenuItem"
            }
        },
        "comboMeals":{
            "type":"array",
            "description":"Array of combo meal items. If there were no combo meal items on the check the returned array will be empty.",
            "items":{
                "$ref":"#/definitions/CheckComboMealItem"
            }
        },
        "discounts":{
            "type":"array",
            "description":"Array of discounts.",
            "items":{
                "$ref":"#/definitions/CheckDiscountItemResponse"
            }
        },
        "serviceCharges":{
            "type":"array",
            "description":"Array of service charges.",
            "items":{
                "$ref":"#/definitions/CheckServiceChargeItem"
            }
        },
        "extensions":{
            "type":"array",
            "description":"Array of extension detail.",
            "items":{
                "$ref":"#/definitions/ExtensionItem"
            }
        },
        "taxes":{
            "type":"array",
            "description":"Array of tax item.",
            "items":{
                "$ref":"#/definitions/CheckTaxItem"
            }
        },
        "tenders":{
            "type":"array",
            "description":"Array of tender items.",
            "items":{
                "$ref":"#/definitions/CheckTenderItem"
            }
        },
        "checkPrintedLines":{
            "type":"object",
            "description":"Response contains an printed lines object.",
            "items":{
                "$ref":"#/definitions/checkPrintedLines"
            }
        },
        "totals":{
            "type":"object",
            "description":"The check totals.",
            "$ref":"#/definitions/CheckTotals"
        }
    }
}

• Array of: object CheckNotification
  A notifiable event that occurred on this check. Read-only; incoming values will be ignored.

{
    "type":"array",
    "description":"Array of past notifications for the check.",
    "items":{
        "$ref":"#/definitions/CheckNotification"
    }
}

• Array of: object checkPrintedLines
  Response contains printed lines object.

{
    "type":"object",
    "description":"Response contains an printed lines object.",
    "items":{
        "$ref":"#/definitions/checkPrintedLines"
    }
}

• Array of: object CheckComboMealItem
  A Combo Meal that can be ordered.

{
    "type":"array",
    "description":"Array of combo meal items. If there were no combo meal items on the check the returned array will be empty.",
    "items":{
        "$ref":"#/definitions/CheckComboMealItem"
    }
}

• Array of: object CheckDiscountItemResponse
  Definition of a discount that can be returned in the response.

{
    "type":"array",
    "description":"Array of discounts.",
    "items":{
        "$ref":"#/definitions/CheckDiscountItemResponse"
    }
}

• Array of: object ExtensionItem
  Object that can contain extensibility detail to be stored with the check.

{
    "type":"array",
    "description":"Array of extension detail.",
    "items":{
        "$ref":"#/definitions/ExtensionItem"
    }
}

• checkEmployeeRef(required): integer
  The identifier of the employee that is used for the operations.Simphony: the employee object number.
• checkName: string
  The reference for the check provided at time of check creation. This must be unique among all open checks at the revenue center. Note: The check name is being truncated on the POS client to 20 characters.
• checkNumber: integer
  A check identifier generated by the POS when the check is created.
• checkRef(required): string
  The unique check reference generated by the POS system when the check is created. Needs to match with the checkRef in the path parameters.
• fireTime: string(date-time)
  The time requested for the order to "fire" to the kitchen. This is when preparation will start. If not provided, the current time is assumed. The dateTime in requests should be reflected in the Location/RVCs localized time, while responses will be shown in Zulu/UTC+0.
• guestCount: integer
  The number of guests on the check.
• idempotencyId(required): string
  Pattern: [0-9a-f]{32}

  A unique identifier for the request generated by the integrator. This should be a UUID v4 formatted value minus dashes.
• informationLines: array informationLines
  An array of strings containing text that may appear on the guest check. Consult the POS administrator to determine what is supported by their configuration.
• isTrainingCheck: boolean
  Flag used to identify a training check.
• language: string
  The language culture reference associated with the check. This value is used to return "name" property of check items in a desired language.
• locRef(required): string
  The location identifier.
• openTime: string(date-time)
  The time the check is opened/created. Time is UTC.
• orderChannelRef: integer
  The order channel identifier from the revenue center configuration. Once the Order Channel is set by POST checks/ or from other source it cannot be changed or updated by /checks/{checkRef}/round.
• orderTypeRef(required): integer
  The order type identifier from the revenue center configuration.
• orgShortName(required): string
  The organization identifier.
• paymentStoreId: string
  An identifier of a payment store provided by the point of sale.
• pickupTime: string(date-time)
  The time requested for the order to be collected. If not provided the current time plus the Service Level Time for the given order type is assumed. Time is local in the request but UTC in the response.

  Service Level Time of the Order Channel takes priority (if non-zero) over the Service Level Time of the Order Type.

• preparationStatus: string
  Allowed Values: [ "Uninitialized", "Submitted", "Prepared", "Packaged" ]

  Information about the preparation status of the check.

  Status	Description
  Uninitialized	indicates that the check was not fired. In use when pickupTime and fireTime is utilized in the request. Also returned when check status is "closed".
  Submitted	indicates that one or more items on the check have been fired to the kitchen.
  Prepared	indicates that one or more items on the check have been prepared and moved "bumped" to the next stage.
  Packaged	indicates that the check expedition was done.

  Expected for message Type: "CheckNotification". It is required to have the Kitchen Display System (KDS) configured to utilize the Check status notifications.
• rvcRef(required): integer
  The revenue center identifier.
• status: string
  Allowed Values: [ "open", "closed" ]

  Information about the status of the check.

  Status	Description
  open	indicates the check has a balance due and is 'open' (meaning it can be modified).
  closed	indicates the check has been paid in full and is 'closed' (meaning it cannot be modified).

• tableGroupNumber: integer
  The table-group of the check. Assigned by POS and indicates the number of checks open checks with the same table.
• tableName: string
  The table for the check from the revenue center configuration.tableName attribute can reflect either a single table number or a table name (in both cases represented by a string data type in the api). RVC option bit 18 is responsible for deciding if the value reflected in the tableName is utilized by the POS as the table name or the table number.

{
    "description":"The check header contains information describing the overall check.\n",
    "type":"object",
    "properties":{
        "orgShortName":{
            "description":"The organization identifier.\n",
            "type":"string"
        },
        "locRef":{
            "description":"The location identifier.\n",
            "type":"string"
        },
        "rvcRef":{
            "description":"The revenue center identifier.\n",
            "type":"integer"
        },
        "checkRef":{
            "description":"The unique check reference generated by the POS system when the check is created. Needs to match with the checkRef in the path parameters.\n",
            "type":"string"
        },
        "idempotencyId":{
            "description":"A unique identifier for the request generated by the integrator. This should be a UUID v4 formatted value minus dashes.\n",
            "type":"string",
            "pattern":"[0-9a-f]{32}"
        },
        "checkNumber":{
            "description":"A check identifier generated by the POS when the check is created.\n",
            "type":"integer"
        },
        "checkName":{
            "description":"The reference for the check provided at time of check creation. This must be unique among all open checks at the revenue center. Note: The check name is being truncated on the POS client to 20 characters.\n",
            "type":"string"
        },
        "checkEmployeeRef":{
            "description":"The identifier of the employee that is used for the operations.Simphony: the employee object number.\n",
            "type":"integer"
        },
        "orderTypeRef":{
            "description":"The order type identifier from the revenue center configuration.\n",
            "type":"integer"
        },
        "orderChannelRef":{
            "description":"The order channel identifier from the revenue center configuration.\n Once the Order Channel is set by POST checks/ or from other source it cannot be changed or updated by /checks/{checkRef}/round.\n",
            "type":"integer"
        },
        "tableName":{
            "description":"The table for the check from the revenue center configuration.tableName attribute can reflect either a single table number or a table name (in both cases represented by a string data type in the api). RVC option bit 18 is responsible for deciding if the value reflected in the tableName is utilized by the POS as the table name or the table number.\n",
            "type":"string"
        },
        "tableGroupNumber":{
            "description":"The table-group of the check. Assigned by POS and indicates the number of checks open checks with the same table.\n",
            "type":"integer"
        },
        "openTime":{
            "description":"The time the check is opened/created. Time is UTC.\n",
            "type":"string",
            "format":"date-time"
        },
        "fireTime":{
            "description":"The time requested for the order to \"fire\" to the kitchen. This is when preparation will start. If not provided, the current time is assumed. The dateTime in requests should be reflected in the Location/RVCs localized time, while responses will be shown in Zulu/UTC+0.\n",
            "type":"string",
            "format":"date-time"
        },
        "pickupTime":{
            "description":"The time requested for the order to be collected. If not provided the current time plus the Service Level Time for the given order type is assumed. Time is local in the request but UTC in the response.<p>Service Level Time of the Order Channel takes priority (if non-zero) over the Service Level Time of the Order Type.</p>\n",
            "type":"string",
            "format":"date-time"
        },
        "guestCount":{
            "description":"The number of guests on the check.\n",
            "type":"integer"
        },
        "language":{
            "description":"The language culture reference associated with the check. This value is used to return \"name\" property of check items in a desired language.\n",
            "type":"string"
        },
        "isTrainingCheck":{
            "description":"Flag used to identify a training check.\n",
            "type":"boolean"
        },
        "informationLines":{
            "description":"An array of strings containing text that may appear on the guest check. Consult the POS administrator to determine what is supported by their configuration.\n",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "paymentStoreId":{
            "description":"An identifier of a payment store provided by the point of sale.\n",
            "type":"string"
        },
        "status":{
            "description":"Information about the status of the check.\n<table><tr><th>Status</th><th>Description</th></tr><tr><td>open</td><td>indicates the check has a balance due and is 'open' (meaning it can be modified).</td></tr><tr><td>closed</td><td>indicates the check has been paid in full and is 'closed' (meaning it cannot be modified).</td></tr></table>\n",
            "type":"string",
            "enum":[
                "open",
                "closed"
            ]
        },
        "preparationStatus":{
            "description":"Information about the preparation status of the check.\n<table><tr><th>Status</th><th>Description</th></tr><tr><td>Uninitialized</td><td>indicates that the check was not fired. In use when pickupTime and fireTime is utilized in the request. Also returned when check status is \"closed\".</td></tr><tr><td>Submitted</td><td>indicates that one or more items on the check have been fired to the kitchen.</td></tr><tr><td>Prepared</td><td>indicates that one or more items on the check have been prepared and moved \"bumped\" to the next stage.</td></tr><tr><td>Packaged</td><td>indicates that the check expedition was done.</td></tr></table>\n Expected for message Type: \"CheckNotification\". It is required to have the Kitchen Display System (KDS) configured to utilize the Check status notifications.\n",
            "type":"string",
            "enum":[
                "Uninitialized",
                "Submitted",
                "Prepared",
                "Packaged"
            ]
        }
    },
    "required":[
        "orgShortName",
        "locRef",
        "rvcRef",
        "idempotencyId",
        "checkEmployeeRef",
        "orderTypeRef",
        "checkRef"
    ]
}

• Array of: object CheckMenuItem
  A menu item on the check represents an item that is purchased.

{
    "type":"array",
    "description":"Array of menu items.",
    "items":{
        "$ref":"#/definitions/CheckMenuItem"
    }
}

• enabled(required): boolean
  A flag indicating whether notifications should be sent for the check. Set to true to request notifications. NotificationOptions "Inline" and "Subscription"
• key: string(string)
  Integrator-provided HMAC SHA-256 key, with length 64 bytes. Base64 encoded string. Is required if 'enabled' is set to 'true' and per-check notifications are needed. NotificationOptions "Inline"
• keyId: string
  Integrator-provided id for key. Is required if 'enabled' is set to 'true' and per-check notifications are needed. NotificationOptions "Inline"
• url: string
  Integrator-provided web-hook callback URL. Must be able to accept POST requests. Is required if 'enabled' is set to 'true' and per-check notifications are needed. Must use port 443. NotificationOptions "Inline"

  Example: https://your_web_hook_url:443/

{
    "description":"<p>Integrator-provided options for notifications.\n Following NotificationOptions are available \"Inline\" and \"Subscription\".</p> <p>Inline notifications options are used when Integrator is not registered and subscribed for notifications.</p><p>Subscription notification options are used when Integrator is registered and subscribed for notifications.</p><p>Check notifications are available for STS Cloud and STS Local (on-premises).</p>\n",
    "type":"object",
    "required":[
        "enabled"
    ],
    "properties":{
        "enabled":{
            "description":"A flag indicating whether notifications should be sent for the check.\n Set to true to request notifications.\n NotificationOptions \"Inline\" and \"Subscription\"\n",
            "type":"boolean"
        },
        "url":{
            "description":"Integrator-provided web-hook callback URL. Must be able to accept POST requests. Is required if 'enabled' is set to 'true' and per-check notifications are needed.\n Must use port 443.\n NotificationOptions \"Inline\"\n",
            "type":"string",
            "example":"https://your_web_hook_url:443/"
        },
        "keyId":{
            "description":"Integrator-provided id for key.\n Is required if 'enabled' is set to 'true' and per-check notifications are needed.\n NotificationOptions \"Inline\"\n",
            "type":"string"
        },
        "key":{
            "description":"Integrator-provided HMAC SHA-256 key, with length 64 bytes. Base64 encoded string. Is required if 'enabled' is set to 'true' and per-check notifications are needed.\n NotificationOptions \"Inline\"\n",
            "type":"string",
            "format":"string"
        }
    }
}

• Array of: object CheckServiceChargeItem
  A service charge that can be applied to a transaction.

{
    "type":"array",
    "description":"Array of service charges.",
    "items":{
        "$ref":"#/definitions/CheckServiceChargeItem"
    }
}

• Array of: object CheckTaxItem
  Array of tax item. If there were no taxable items on the check the returned array will be empty.

{
    "type":"array",
    "description":"Array of tax item.",
    "items":{
        "$ref":"#/definitions/CheckTaxItem"
    }
}

• Array of: object CheckTenderItem

{
    "type":"array",
    "description":"Array of tender items.",
    "items":{
        "$ref":"#/definitions/CheckTenderItem"
    }
}

• autoServiceChargeTotal: number
  The total of service charges automatically added to the check.
• paymentTotal: number
  The total of the payments on the check.
• serviceChargeTotal: number
  The service charge total of the check.
• subtotal: number
  The subtotal of the check. This is the sum of net menu item totals. The net menu item total for a single menu item is (menu item total + item discounts + surcharge).
• subtotalDiscountTotal: number
  The total of discounts applied to the subtotal.
• taxTotal: number
  The tax total of the check. This value excludes any inclusive tax.
• totalDue: number
  The remaining balance due for the check.

{
    "description":"Contains a set of totals for aspects of the check. The values from the check total object relate in the following way: <br>subtotal (sum of menu items sales - discounts)\n <br>- discountTotal <br>+ autoServiceChargeTotal <br>+ serviceChargeTotal <br>+ taxTotal <br>- paymentTotal <br>= totalDue\n",
    "type":"object",
    "properties":{
        "subtotal":{
            "description":"The subtotal of the check. This is the sum of net menu item totals. The net menu item total for a single menu item is (menu item total + item discounts + surcharge).\n",
            "type":"number"
        },
        "subtotalDiscountTotal":{
            "description":"The total of discounts applied to the subtotal.\n",
            "type":"number"
        },
        "autoServiceChargeTotal":{
            "description":"The total of service charges automatically added to the check.\n",
            "type":"number"
        },
        "serviceChargeTotal":{
            "description":"The service charge total of the check.\n",
            "type":"number"
        },
        "taxTotal":{
            "description":"The tax total of the check. This value excludes any inclusive tax.\n",
            "type":"number"
        },
        "paymentTotal":{
            "description":"The total of the payments on the check.\n",
            "type":"number"
        },
        "totalDue":{
            "description":"The remaining balance due for the check.\n",
            "type":"number"
        }
    }
}

• creationDate(required): string
  Message created date and time.
• data(required): object CheckNotificationMessagesData
  The notification data.
• id(required): string
  Message identifier.
• messageType(required): object CheckMessageType
  Information about the type of message.
• resource(required): object CheckNotificationResource
  Information about the STS resource affected by this message.

{
    "description":"A notifiable event that occurred on this check. Read-only; incoming values will be ignored.",
    "type":"object",
    "required":[
        "id",
        "creationDate",
        "messageType",
        "resource",
        "data"
    ],
    "properties":{
        "id":{
            "description":"Message identifier.",
            "type":"string"
        },
        "creationDate":{
            "description":"Message created date and time.",
            "type":"string"
        },
        "messageType":{
            "$ref":"#/definitions/CheckMessageType"
        },
        "resource":{
            "$ref":"#/definitions/CheckNotificationResource"
        },
        "data":{
            "description":"The notification data.",
            "type":"object",
            "$ref":"#/definitions/CheckNotificationMessagesData"
        }
    }
}

• status: string
  Information about the preparation status of the check.
  

  Status	Description
  Uninitialized	indicates that the check was not fired. In use when pickupTime and fireTime is utilized in the request. Also returned when check status is "closed".
  Submitted	indicates that one or more items on the check have been fired to the kitchen.
  Prepared	indicates that one or more items on the check have been prepared and moved "bumped" to the next stage.
  Packaged	indicates that the check expedition was done.

  Expected for message Type: "CheckNotification". It is required to have the Kitchen Display System (KDS) configured to utilize the Check status notifications.
• timeStampUtc: string
  A timestamp indicating the date and time in UTC at which check status changed.Expected for message Type: "CheckNotification"

{
    "description":"The notification data.",
    "type":"object",
    "example":{
        "status":"Packaged",
        "timeStampUtc":"2021-12-08T19:57:12.045Z"
    },
    "properties":{
        "status":{
            "description":"Information about the preparation status of the check.\n<br><table><tr><th>Status</th><th>Description</th></tr><tr><td>Uninitialized</td><td>indicates that the check was not fired. In use when pickupTime and fireTime is utilized in the request. Also returned when check status is \"closed\".</td></tr><tr><td>Submitted</td><td>indicates that one or more items on the check have been fired to the kitchen.</td></tr><tr><td>Prepared</td><td>indicates that one or more items on the check have been prepared and moved \"bumped\" to the next stage.</td></tr><tr><td>Packaged</td><td>indicates that the check expedition was done.</td></tr></table>\n Expected for message Type: \"CheckNotification\". It is required to have the Kitchen Display System (KDS) configured to utilize the Check status notifications.\n",
            "type":"string"
        },
        "timeStampUtc":{
            "description":"A timestamp indicating the date and time in UTC at which check status changed.Expected for message Type: \"CheckNotification\"\n",
            "type":"string"
        }
    }
}

{
    "status":"Packaged",
    "timeStampUtc":"2021-12-08T19:57:12.045Z"
}

• id(required): string
  Identifier of the message type.

  Example: { "id":"CheckNotification" }

{
    "description":"Information about the type of message.",
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"Identifier of the message type.",
            "type":"string",
            "example":{
                "id":"CheckNotification"
            }
        }
    }
}

• checkRef: string
  The unique check reference generated by the POS system when the check is created.
• locRef: string
  The location identifier. (If present depending on the hierarchy level requested in subscription.)
• orgShortName: string
  The organization identifier.
• rvcRef: string
  The revenue center identifier.(If present depending on the hierarchy level requested in subscription.)

{
    "description":"Information about the STS resource affected by this message.",
    "type":"object",
    "properties":{
        "orgShortName":{
            "description":"The organization identifier.",
            "type":"string"
        },
        "locRef":{
            "description":"The location identifier. (If present depending on the hierarchy level requested in subscription.)",
            "type":"string"
        },
        "rvcRef":{
            "description":"The revenue center identifier.(If present depending on the hierarchy level requested in subscription.)",
            "type":"string"
        },
        "checkRef":{
            "description":"The unique check reference generated by the POS system when the check is created.",
            "type":"string"
        }
    }
}

• lines(required): array lines
  Response contains an array of strings formatted for printing.

{
    "description":"Response contains printed lines object.",
    "type":"object",
    "required":[
        "lines"
    ],
    "properties":{
        "lines":{
            "description":"Response contains an array of strings formatted for printing.\n",
            "type":"array",
            "example":[
                "12 STS                            Page 2",
                "----------------------------------------",
                "CHK 75                           TBL 2/1",
                "               11/3/2020                ",
                "----------------------------------------",
                "       DineIn                           ",
                " 1 Carrot Soup               10.00      ",
                " 1 Beetroot Roll             120.00     ",
                "   *SPECIAL REQUESTS*                   ",
                "   Please include extra sauce on side   ",
                " 1 Potato Tower              10.00      ",
                "   STS Open $ SC              1.23      ",
                " 1 Potato Tower              10.00      ",
                "   CashAuto                $151.23      ",
                "   Subtotal                $150.00      ",
                "   Other                     $1.23      ",
                "   Payment                 $151.23      ",
                "   Change Due                $0.00      ",
                "  ----------- Check Closed -----------  ",
                "           11/3/2020 5:02 PM            "
            ]
        }
    }
}

• comboItem(required): object CheckMenuItem
  A menu item on the check represents an item that is purchased.
• comboMealId(required): integer
  Combo meal object number.
• extensions: array extensions
  Array of extension detail
• mainItem(required): object CheckMenuItem
  A menu item on the check represents an item that is purchased.
• seat: integer
  Seat assignment for the item.
• sideItems(required): array sideItems
  Combo meal side items (for example, French Fries or Coke).

{
    "description":"A Combo Meal that can be ordered.",
    "type":"object",
    "required":[
        "comboMealId",
        "comboItem",
        "mainItem",
        "sideItems"
    ],
    "properties":{
        "comboMealId":{
            "description":"Combo meal object number.",
            "type":"integer"
        },
        "seat":{
            "description":"Seat assignment for the item.",
            "type":"integer"
        },
        "comboItem":{
            "description":"Combo meal menu item (for example, Burger Combo).",
            "type":"object",
            "$ref":"#/definitions/CheckMenuItem"
        },
        "mainItem":{
            "description":"Combo meal main item (for example, Hamburger).",
            "type":"object",
            "$ref":"#/definitions/CheckMenuItem"
        },
        "sideItems":{
            "description":"Combo meal side items (for example, French Fries or Coke).",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CheckMenuItem"
            }
        },
        "extensions":{
            "description":"Array of extension detail",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtensionItem"
            }
        }
    }
}

• condiments: array condiments
  Array of condiments represented in menu item JSON objects. If there are no condiments configured, this array will be empty.
• definitionSequence: integer
  The menu item definition sequence identifier. Indicates the definition of item that is used. This value is ignored on Oracle.RES platform.
• extensions: array extensions
  Array of extension detail.
• itemDiscounts: array itemDiscounts
  Array of discounts applied to the menu item.
• menuItemId(required): integer
  The menu item's POS identifier.
• name: string
  The name of the menu item defined in the POS.
• priceSequence: integer
  The price sequence number to set the appropriate price level.
• quantity: number
  The quantity of this menu item. If present minimum value is 1.
• referenceText: string
  Maximum Length: 20

  Additional text associated with the item.
• seat: integer
  Seat number of item on the check.

  Seat is ignored when set for comboItem, mainItem, and sideItems. Response will always return "seat": 0. Seat for the combo meals should be defined at the comboMeal level.

• surcharge: number
  The calculated surcharge amount based on the rate configured for the surcharge associated with the item.
• total: number
  The total cost of the item (extended to account for the quantity).
• unitPrice: number
  The price associated with the item.

{
    "description":"A menu item on the check represents an item that is purchased.\n",
    "type":"object",
    "required":[
        "menuItemId"
    ],
    "properties":{
        "menuItemId":{
            "description":"The menu item's POS identifier.\n",
            "type":"integer"
        },
        "definitionSequence":{
            "description":"The menu item definition sequence identifier. Indicates the definition of item that is used. This value is ignored on Oracle.RES platform.\n",
            "type":"integer"
        },
        "name":{
            "description":"The name of the menu item defined in the POS.\n",
            "type":"string"
        },
        "quantity":{
            "description":"The quantity of this menu item. If present minimum value is 1.\n",
            "type":"number"
        },
        "unitPrice":{
            "description":"The price associated with the item.\n",
            "type":"number",
            "x-nullable":true
        },
        "priceSequence":{
            "description":"The price sequence number to set the appropriate price level.\n",
            "type":"integer"
        },
        "total":{
            "description":"The total cost of the item (extended to account for the quantity).",
            "type":"number"
        },
        "seat":{
            "description":"Seat number of item on the check.<p>Seat is ignored when set for comboItem, mainItem, and sideItems. Response will always return \"seat\": 0. Seat for the combo meals should be defined at the comboMeal level.</p>",
            "type":"integer"
        },
        "referenceText":{
            "description":"Additional text associated with the item.",
            "type":"string",
            "maxLength":20
        },
        "surcharge":{
            "description":"The calculated surcharge amount based on the rate configured for the surcharge associated with the item.",
            "type":"number"
        },
        "itemDiscounts":{
            "description":"Array of discounts applied to the menu item.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CheckDiscountItem"
            }
        },
        "condiments":{
            "description":"Array of condiments represented in menu item JSON objects. If there are no condiments configured, this array will be empty.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CheckCondimentItem"
            }
        },
        "extensions":{
            "description":"Array of extension detail.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtensionItem"
            }
        }
    }
}

• Array of: object ExtensionItem
  Object that can contain extensibility detail to be stored with the check.

{
    "description":"Array of extension detail",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExtensionItem"
    }
}

• Array of: object CheckMenuItem
  A menu item on the check represents an item that is purchased.

{
    "description":"Combo meal side items (for example, French Fries or Coke).",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CheckMenuItem"
    }
}

• Array of: object CheckCondimentItem
  Check condiment items.

  When default condiments are included on a menu item when creating or appending to a check they will be flagged appropriately allowing OPS/order device/receipt output to choose to display or not display the items based on configuration (default condiments on menu item definition Option Bits, option 1 - select to display defaults, deselect to not display defaults)

{
    "description":"Array of condiments represented in menu item JSON objects. If there are no condiments configured, this array will be empty.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CheckCondimentItem"
    }
}

• Array of: object ExtensionItem
  Object that can contain extensibility detail to be stored with the check.

{
    "description":"Array of extension detail.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExtensionItem"
    }
}

• Array of: object CheckDiscountItem
  Definition of a discount that can be applied to a transaction.

{
    "description":"Array of discounts applied to the menu item.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CheckDiscountItem"
    }
}

• atDefaultSetting: boolean
  Flag indicating if condiment prefix was added by default by the configuration Default Count in Simphony. (response only)

  First Available Version: STS Gen2 1.7.1

• condimentId(required): integer
  The menu item's POS identifier.
• definitionSequence(required): integer
  The menu item definition sequence identifier. Indicates the definition of item that is used. This value is ignored on Oracle.RES platform.
• isDefault: boolean
  Flag indicating if condiment prefix is dafault. (response only)

  First Available Version: STS Gen2 1.7.1

• itemDiscounts: array itemDiscounts
  Array of discounts applied to the menu item.
• name: string
  The name of the menu item defined in the POS.
• prefixes: array prefixes
  Array of prefixes applied to the condiment.

  First Available Version: STS Gen2 1.7.1

• priceSequence: integer
  The price sequence number to set the appropriate price level.
• quantity: number
  The quantity of this item. If present minimum value is 1.
• referenceText: string
  Additional text associated with the item.
• seat: integer
  Seat number of item on the check.

  Seat is ignored when set for comboItem, mainItem, and sideItems. Response will always return "seat": 0. Seat for the combo meals should be defined at the comboMeal level.

• surcharge: number
  Surcharge amount.
• total: number
  Amount of item for the specified quantity.
• unitPrice: number
  The price that should be used for the item.

{
    "description":"Check condiment items.\n<p>When default condiments are included on a menu item when creating or appending to a check they will be flagged appropriately allowing OPS/order device/receipt output to choose to display or not display the items based on configuration (default condiments on menu item definition Option Bits, option 1 - select to display defaults, deselect to not display defaults)</p>\n",
    "type":"object",
    "required":[
        "condimentId",
        "definitionSequence"
    ],
    "properties":{
        "condimentId":{
            "description":"The menu item's POS identifier.",
            "type":"integer"
        },
        "prefixes":{
            "description":"Array of prefixes applied to the condiment.<p>First Available Version: STS Gen2 1.7.1</p>",
            "type":"array",
            "items":{
                "$ref":"#/definitions/prefixes"
            }
        },
        "definitionSequence":{
            "description":"The menu item definition sequence identifier. Indicates the definition of item that is used. This value is ignored on Oracle.RES platform.",
            "type":"integer"
        },
        "name":{
            "description":"The name of the menu item defined in the POS.",
            "type":"string"
        },
        "quantity":{
            "description":"The quantity of this item. If present minimum value is 1.",
            "type":"number"
        },
        "unitPrice":{
            "description":"The price that should be used for the item.",
            "type":"number"
        },
        "priceSequence":{
            "description":"The price sequence number to set the appropriate price level.",
            "type":"integer"
        },
        "total":{
            "description":"Amount of item for the specified quantity.",
            "type":"number"
        },
        "seat":{
            "description":"Seat number of item on the check. <p>Seat is ignored when set for comboItem, mainItem, and sideItems. Response will always return \"seat\": 0. Seat for the combo meals should be defined at the comboMeal level.</p>",
            "type":"integer"
        },
        "referenceText":{
            "description":"Additional text associated with the item.  ",
            "type":"string"
        },
        "surcharge":{
            "description":"Surcharge amount.",
            "type":"number"
        },
        "isDefault":{
            "description":"Flag indicating if condiment prefix is dafault. (response only) <p>First Available Version: STS Gen2 1.7.1</p>",
            "type":"boolean"
        },
        "atDefaultSetting":{
            "description":"Flag indicating if condiment prefix was added by default by the configuration Default Count in Simphony. (response only) <p>First Available Version: STS Gen2 1.7.1</p>",
            "type":"boolean"
        },
        "itemDiscounts":{
            "description":"Array of discounts applied to the menu item.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CheckDiscountItem"
            }
        }
    }
}

• Array of: object CheckDiscountItem
  Definition of a discount that can be applied to a transaction.

{
    "description":"Array of discounts applied to the menu item.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CheckDiscountItem"
    }
}

• Array of: object prefixes
  Array of condiment prefixes.

  First Available Version: STS Gen2 1.7.1

{
    "description":"Array of prefixes applied to the condiment.<p>First Available Version: STS Gen2 1.7.1</p>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/prefixes"
    }
}

• discountId(required): integer
  The discount identifier.
• extensions: array extensions
  Array of extension detail.
• isAutomatic: boolean
  Flag to indicate the item was applied by automatically by the POS system.
• name: string
  The name of the discount defined in the POS.
• referenceText: string
  Additional text associated with the discount.
• seat: integer
  Seat number of item on the check.
• total: number
  The value of the discount for the associated line number. In the request, if the discount is an open discount then set value to the amount (1.25) or percentage (0.1250 for 12.5%) that should be applied. For preset discounts the total property in the request is ignored. In the response, the total is the amount by which the transaction is discounted.

{
    "description":"Definition of a discount that can be applied to a transaction.",
    "type":"object",
    "required":[
        "discountId"
    ],
    "properties":{
        "discountId":{
            "description":"The discount identifier.",
            "type":"integer"
        },
        "name":{
            "description":"The name of the discount defined in the POS.",
            "type":"string"
        },
        "seat":{
            "description":"Seat number of item on the check.",
            "type":"integer"
        },
        "referenceText":{
            "description":"Additional text associated with the discount.",
            "type":"string"
        },
        "total":{
            "description":"The value of the discount for the associated line number. In the request, if the discount is an open discount then set value to \nthe amount (1.25) or percentage (0.1250 for 12.5%) that should be applied. For preset discounts\nthe total property in the request is ignored. In the response, the total is the amount by which \nthe transaction is discounted.\n",
            "type":"number"
        },
        "isAutomatic":{
            "description":"Flag to indicate the item was applied by automatically by the POS system.\n",
            "type":"boolean"
        },
        "extensions":{
            "description":"Array of extension detail.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtensionItem"
            }
        }
    }
}

• Array of: object ExtensionItem
  Object that can contain extensibility detail to be stored with the check.

{
    "description":"Array of extension detail.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExtensionItem"
    }
}

• appName: string
  The name of the application associated with this data (defined by the caller).
• data: string
  The data payload for the extensibility data.
• dataName: string
  Name of the data stored by this extensibility item.
• dataType: string
  Describes the type of data stored by this extensibility item (defined by the caller).
• displayName: string
  A string displayed and/or printed if this item is displayed or printed.
• options: array options
  Array of options that define behavior of the extension item.
  

  Option	Description
  printOnDisplay	When specified the displayName is shown on the display.
  printOnReceipt	When specified the displayName is printed on the receipt/check.
  printInKitchen	When specified the displayName is printed on the kitchen chit. Note: The printInKitchen option requires a custom extensibility application.
  includeInApiResponse	When specified the extension item is return as part of the check in the API responses.

{
    "description":"Object that can contain extensibility detail to be stored with the check.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"A string displayed and/or printed if this item is displayed or printed.",
            "type":"string"
        },
        "appName":{
            "description":"The name of the application associated with this data (defined by the caller).",
            "type":"string"
        },
        "dataName":{
            "description":"Name of the data stored by this extensibility item.",
            "type":"string"
        },
        "dataType":{
            "description":"Describes the type of data stored by this extensibility item (defined by the caller).",
            "type":"string"
        },
        "data":{
            "description":"The data payload for the extensibility data.",
            "type":"string"
        },
        "options":{
            "description":"Array of options that define behavior of the extension item.\n<br><table><tr><th>Option</th><th>Description</th></tr><tr><td>printOnDisplay</td><td>When specified the displayName is shown on the display.</td></tr><tr><td>printOnReceipt</td><td>When specified the displayName is printed on the receipt/check.</td></tr><tr><td>printInKitchen</td><td>When specified the displayName is printed on the kitchen chit.<p>Note: The printInKitchen option requires a custom extensibility application.</p></td></tr><tr><td>includeInApiResponse</td><td>When specified the extension item is return as part of the check in the API responses.</td></tr></table><p></p>\n",
            "example":[
                "printondisplay",
                "printonreceipt",
                "printInKitchen",
                "IncludeInApiResponse"
            ],
            "type":"array",
            "items":{
                "type":"string",
                "description":"Array of options. One or more of the following values are allowed: \"printOnDisplay\", \"printOnReceipt\", \"printInKitchen\", \"includeInApiResponse\"\n"
            }
        }
    }
}

• Array of: string
  Array of options. One or more of the following values are allowed: "printOnDisplay", "printOnReceipt", "printInKitchen", "includeInApiResponse"

{
    "description":"Array of options that define behavior of the extension item.\n<br><table><tr><th>Option</th><th>Description</th></tr><tr><td>printOnDisplay</td><td>When specified the displayName is shown on the display.</td></tr><tr><td>printOnReceipt</td><td>When specified the displayName is printed on the receipt/check.</td></tr><tr><td>printInKitchen</td><td>When specified the displayName is printed on the kitchen chit.<p>Note: The printInKitchen option requires a custom extensibility application.</p></td></tr><tr><td>includeInApiResponse</td><td>When specified the extension item is return as part of the check in the API responses.</td></tr></table><p></p>\n",
    "example":[
        "printondisplay",
        "printonreceipt",
        "printInKitchen",
        "IncludeInApiResponse"
    ],
    "type":"array",
    "items":{
        "type":"string",
        "description":"Array of options. One or more of the following values are allowed: \"printOnDisplay\", \"printOnReceipt\", \"printInKitchen\", \"includeInApiResponse\"\n"
    }
}

[
    "printondisplay",
    "printonreceipt",
    "printInKitchen",
    "IncludeInApiResponse"
]

• name: string
  The name of the prefix defined in the POS.(response only)
• prefixId(required): integer
  Identifier for a condiment prefix

{
    "description":"Array of condiment prefixes. <p>First Available Version: STS Gen2 1.7.1</p>",
    "type":"object",
    "required":[
        "prefixId"
    ],
    "properties":{
        "prefixId":{
            "description":"Identifier for a condiment prefix",
            "type":"integer"
        },
        "name":{
            "description":"The name of the prefix defined in the POS.(response only)",
            "type":"string"
        }
    }
}

• discountId(required): integer
  The discount identifier.
• extensions: array extensions
  Array of extension detail.
• isAutomatic: boolean
  Flag to indicate the item was applied by automatically by the POS system.
• isCoupon: boolean
  Flag to indicate if the item is a coupon.

  If coupon is sent in the request, then the response will return two discount entries in the array as seen in the example. The first entry is providing information that a coupon was provided. Discount at this point was not triggered, "isAutomatic" will be false and "isCoupon" will be true. Once eligible menu item which will trigger coupon will be added to the check the discount is triggered. The second discount entry in the array is then following standard discount behavior, and "isCoupon" will change to false as the discount is calculated.

  First Available Version: STS Gen2 1.7.1

  Example: { "discounts":[ { "discountId":1000, "name":"Coupon", "seat":0, "referenceText":"spring coupon", "total":0, "isAutomatic":false, "isCoupon":true }, { "discountId":1000, "name":"Coupon", "seat":0, "referenceText":"spring coupon", "total":-10, "isAutomatic":true, "isCoupon":false } ] }
• name: string
  The name of the discount defined in the POS.
• referenceText: string
  Additional text associated with the discount.
• seat: integer
  Seat number of item on the check.
• total: number
  The value of the discount for the associated line number. In the request, if the discount is an open discount then set value to the amount (1.25) or percentage (0.1250 for 12.5%) that should be applied. For preset discounts the total property in the request is ignored. In the response, the total is the amount by which the transaction is discounted.

{
    "description":"Definition of a discount that can be returned in the response.\n",
    "example":{
        "discounts":[
            {
                "discountId":1000,
                "name":"Coupon",
                "seat":0,
                "referenceText":"spring coupon",
                "total":0,
                "isAutomatic":false,
                "isCoupon":true
            },
            {
                "discountId":1000,
                "name":"Coupon",
                "seat":0,
                "referenceText":"spring coupon",
                "total":-10,
                "isAutomatic":true,
                "isCoupon":false
            }
        ]
    },
    "type":"object",
    "required":[
        "discountId"
    ],
    "properties":{
        "discountId":{
            "description":"The discount identifier.",
            "type":"integer"
        },
        "name":{
            "description":"The name of the discount defined in the POS.",
            "type":"string"
        },
        "seat":{
            "description":"Seat number of item on the check.",
            "type":"integer"
        },
        "referenceText":{
            "description":"Additional text associated with the discount.",
            "type":"string"
        },
        "total":{
            "description":"The value of the discount for the associated line number. In the request, if the discount is an open discount then set value to \nthe amount (1.25) or percentage (0.1250 for 12.5%) that should be applied. For preset discounts\nthe total property in the request is ignored. In the response, the total is the amount by which \nthe transaction is discounted.\n",
            "type":"number"
        },
        "isAutomatic":{
            "description":"Flag to indicate the item was applied by automatically by the POS system.\n",
            "type":"boolean"
        },
        "isCoupon":{
            "description":"Flag to indicate if the item is a coupon.\n <p>If coupon is sent in the request, then the response will return two discount entries in the array as seen in the example. The first entry is providing information that a coupon was provided. Discount at this point was not triggered, \"isAutomatic\" will be false and \"isCoupon\" will be true. Once eligible menu item which will trigger coupon will be added to the check the discount is triggered. The second discount entry in the array is then following standard discount behavior, and \"isCoupon\" will change to false as the discount is calculated.</p> <p>First Available Version: STS Gen2 1.7.1</p>\n",
            "example":{
                "discounts":[
                    {
                        "discountId":1000,
                        "name":"Coupon",
                        "seat":0,
                        "referenceText":"spring coupon",
                        "total":0,
                        "isAutomatic":false,
                        "isCoupon":true
                    },
                    {
                        "discountId":1000,
                        "name":"Coupon",
                        "seat":0,
                        "referenceText":"spring coupon",
                        "total":-10,
                        "isAutomatic":true,
                        "isCoupon":false
                    }
                ]
            },
            "type":"boolean"
        },
        "extensions":{
            "description":"Array of extension detail.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtensionItem"
            }
        }
    }
}

{
    "discounts":[
        {
            "discountId":1000,
            "name":"Coupon",
            "seat":0,
            "referenceText":"spring coupon",
            "total":0,
            "isAutomatic":false,
            "isCoupon":true
        },
        {
            "discountId":1000,
            "name":"Coupon",
            "seat":0,
            "referenceText":"spring coupon",
            "total":-10,
            "isAutomatic":true,
            "isCoupon":false
        }
    ]
}

• Array of: object ExtensionItem
  Object that can contain extensibility detail to be stored with the check.

{
    "description":"Array of extension detail.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExtensionItem"
    }
}

• Array of: string

{
    "description":"An array of strings containing text that may appear on the guest check. Consult the POS administrator to determine what is supported by their configuration.\n",
    "type":"array",
    "items":{
        "type":"string"
    }
}

• extensions: array extensions
  Array of extension detail.
• name: string
  The name of the service charge.
• referenceText: string
  Additional text associated with the service charge.
• seat: integer
  Seat number of item on the check.
• serviceChargeId(required): integer
  The service charge's object number reference.
• total: number
  The value of the service charge. In the request, if the service charge is an _open_ then set value to the amount (1.25) or percentage (0.1250 for 12.5%) that should be applied. For preset a service charge the total property in the request is ignored. In the response, the total is the amount of the service charge applied to the check.

{
    "description":"A service charge that can be applied to a transaction.",
    "type":"object",
    "required":[
        "serviceChargeId"
    ],
    "properties":{
        "serviceChargeId":{
            "description":"The service charge's object number reference.",
            "type":"integer"
        },
        "name":{
            "description":"The name of the service charge.",
            "type":"string"
        },
        "total":{
            "description":"The value of the service charge. In the request, if the service charge is an _open_ then set value to \nthe amount (1.25) or percentage (0.1250 for 12.5%) that should be applied. For preset a service charge\nthe total property in the request is ignored. In the response, the total is the amount of the service\ncharge applied to the check.\n",
            "type":"number"
        },
        "seat":{
            "description":"Seat number of item on the check.",
            "type":"integer"
        },
        "referenceText":{
            "description":"Additional text associated with the service charge.",
            "type":"string"
        },
        "extensions":{
            "description":"Array of extension detail.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtensionItem"
            }
        }
    }
}

• Array of: object ExtensionItem
  Object that can contain extensibility detail to be stored with the check.

{
    "description":"Array of extension detail.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExtensionItem"
    }
}

• name: string
  The name of the tax.
• taxRateId(required): string
  The tax rate identifier.
• total: number
  The total of the tax at for this rate.

{
    "description":"Array of tax item. If there were no taxable items on the check the returned array will be empty.",
    "required":[
        "taxRateId"
    ],
    "type":"object",
    "properties":{
        "taxRateId":{
            "description":"The tax rate identifier.",
            "type":"string"
        },
        "name":{
            "description":"The name of the tax.",
            "type":"string"
        },
        "total":{
            "description":"The total of the tax at for this rate.",
            "type":"number"
        }
    }
}

• chargedTipTotal: number
  The amount of charged tip to apply to the transaction. This amount is the portion of the payment that represents the charged tip. The chargedTipTotal field will not have an impact on a check if the "total" field is not specified.
• extensions: array extensions
  Array of extension detail.
• name: string
  The name of the tender defined in the POS.
• paymentData: object CheckPaymentData
  The Simphony Payment Interface (SPI) data.

  Only Oracle payment partners have the ability to utilise the SPI payemnt data.

• referenceText: string
  Additional text associated with the tender.
• tenderId(required): integer
  Tender identifier.
• total: number
  The total of the tender item. A value of zero will result payment for the full amount.

{
    "description":"",
    "type":"object",
    "required":[
        "tenderId"
    ],
    "properties":{
        "tenderId":{
            "description":"Tender identifier.\n",
            "type":"integer"
        },
        "name":{
            "description":"The name of the tender defined in the POS.",
            "type":"string"
        },
        "total":{
            "description":"The total of the tender item. A value of zero will result payment for the full amount.",
            "type":"number"
        },
        "chargedTipTotal":{
            "description":"The amount of charged tip to apply to the transaction. This amount is the portion of the payment that represents the charged tip. The chargedTipTotal field will not have an impact on a check if the \"total\" field is not specified.",
            "type":"number"
        },
        "referenceText":{
            "description":"Additional text associated with the tender.",
            "type":"string"
        },
        "paymentData":{
            "$ref":"#/definitions/CheckPaymentData"
        },
        "extensions":{
            "description":"Array of extension detail.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtensionItem"
            }
        }
    }
}

• Array of: object ExtensionItem
  Object that can contain extensibility detail to be stored with the check.

{
    "description":"Array of extension detail.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExtensionItem"
    }
}

• data(required): object data
  Object containing data for the type of payment.
• type(required): string
  Describes the type of data contained in this payment data object.

  Example: { "paymentData":{ "type":"spi.v1", "_comment_type":"string datatype, intended to identify the format of data in the \"data\" property. Valid value for initial release when using PSP Payments: \"spi.v1\"" } }

{
    "description":"The Simphony Payment Interface (SPI) data.<p>Only Oracle payment partners have the ability to utilise the SPI payemnt data.</p>\n",
    "type":"object",
    "required":[
        "type",
        "data"
    ],
    "properties":{
        "type":{
            "description":"Describes the type of data contained in this payment data object.",
            "type":"string",
            "example":{
                "paymentData":{
                    "type":"spi.v1",
                    "_comment_type":"string datatype, intended to identify the format of data in the \"data\" property. Valid value for initial release when using PSP Payments: \"spi.v1\""
                }
            }
        },
        "data":{
            "description":"Object containing data for the type of payment.",
            "type":"object",
            "example":{
                "data":{
                    "transDateTime":"2022-06-01T23:02:17+00:00",
                    "transType":"01",
                    "_comment_transType":"When using PSP Drop-in component with card not present eComm transaction, always send as \"01\" which maps to (sale/purchase)",
                    "transAmount":8100,
                    "_comment_transAmoun":"Include from PSP Drop-in response",
                    "tipTotal":700,
                    "_comment_tipTotal":"Include from the total tip value selected by the user",
                    "transCurrency":"USD",
                    "_comment_transCurrency":"Include from PSP Drop-in response",
                    "siteId":"Oracle_US_POS",
                    "_comment_siteId":"PSP Merchant Account provided as part of initial payment config from Oracle Micros Payment Cloud Service Ops team",
                    "transToken":"M451570400845136",
                    "_comment_transToken":"From PSP Response, \"alias\"",
                    "issuerId":"04",
                    "_comment_issuerId":"From PSP Response",
                    "pan":"8065",
                    "_comment_pan":"From PSP Response, \"cardSummary\"",
                    "expiryDate":"2312",
                    "_comment_expiryDate":"From PSP Response but format must be \"YYMM\" to meet SPI requirement (PSP response will be in the following format, \"12/2023\")",
                    "entryMode":"09",
                    "_comment_entryMode":"When using PSP Drop-in component with card not present eComm transaction, always send as \"09\"",
                    "cardPresent":"2",
                    "_comment_cardPresent":"When using PSP Drop-in component with card not present eComm transaction, always send as \"2\"",
                    "authCode":"195206",
                    "_comment_authCode":"From PSP Response",
                    "alternateTransRef":"322120172840322120",
                    "_comment_alternateTransRef":"From PSP Response, \"pspReference\"",
                    "modificationReference":"54099",
                    "_comment_modificationReference":"Identifier to be used as PSP Merchant Reference e.g., Order Number"
                }
            }
        }
    },
    "example":{
        "tenders":[
            {
                "tenderId":2,
                "_comment_tenderId":"When including a \"paymentData\" object, the SPI interface will replace this \"tenderId\" with the correct tender based on the \"issuerId\" in the \"data\" object so this can just be a valid tender with a type of \"payment\" from GET {{baseUrl}}/tenders/collection?OrgShortName={{OrgShortName}}&LocRef={{LocRef}}&RvcRef={{RvcRef}}. This behavior ensures proper tender reporting",
                "total":81,
                "chargeTipTotal":7,
                "paymentData":{
                    "type":"spi.v1",
                    "data":{
                        "transDateTime":"2022-06-01T23:02:17+00:00",
                        "transType":"01",
                        "transAmount":8100,
                        "tipTotal":700,
                        "transCurrency":"USD",
                        "siteId":"Oracle_US_POS",
                        "transToken":"M451570400845136",
                        "issuerId":"04",
                        "pan":"8065",
                        "expiryDate":"2312",
                        "entryMode":"09",
                        "cardPresent":"2",
                        "authCode":"195206",
                        "alternateTransRef":"322120172840322120",
                        "modificationReference":"54099"
                    }
                }
            }
        ]
    }
}

{
    "tenders":[
        {
            "tenderId":2,
            "_comment_tenderId":"When including a \"paymentData\" object, the SPI interface will replace this \"tenderId\" with the correct tender based on the \"issuerId\" in the \"data\" object so this can just be a valid tender with a type of \"payment\" from GET {{baseUrl}}/tenders/collection?OrgShortName={{OrgShortName}}&LocRef={{LocRef}}&RvcRef={{RvcRef}}. This behavior ensures proper tender reporting",
            "total":81,
            "chargeTipTotal":7,
            "paymentData":{
                "type":"spi.v1",
                "data":{
                    "transDateTime":"2022-06-01T23:02:17+00:00",
                    "transType":"01",
                    "transAmount":8100,
                    "tipTotal":700,
                    "transCurrency":"USD",
                    "siteId":"Oracle_US_POS",
                    "transToken":"M451570400845136",
                    "issuerId":"04",
                    "pan":"8065",
                    "expiryDate":"2312",
                    "entryMode":"09",
                    "cardPresent":"2",
                    "authCode":"195206",
                    "alternateTransRef":"322120172840322120",
                    "modificationReference":"54099"
                }
            }
        }
    ]
}

• details: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: The Check provided is not valid.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  Example: error:check_validation_failure
• posDetails: array posDetails
  (Problem Details Extension) Contains a list of the problem details from the POS System processing the request.
• title: string
  A short, human-readable summary of the problem type.

  Example: Check is invalid.
• type: string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: error:validation

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). \n\n  **Extensions**\n  * posDetails\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Check is invalid.",
        "details":"The Check provided is not valid.",
        "instance":"error:check_validation_failure",
        "posDetails":[
            {
                "code":"menu_item_invalid",
                "message":"invalid 'definitionSequence' value for menuItem '123'"
            }
        ]
    },
    "properties":{
        "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":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"Check is invalid."
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"The Check provided is not valid."
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string",
            "example":"error:check_validation_failure"
        },
        "posDetails":{
            "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "code":{
                        "description":"Short, unique identifier for the type of error",
                        "type":"string",
                        "example":"menu_item_invalid"
                    },
                    "message":{
                        "description":"A human-readable explanation specific to this occurrence of the problem.",
                        "type":"string",
                        "example":"invalid 'definitionSequence' value for menuItem '123'"
                    }
                }
            }
        }
    }
}

{
    "type":"error:validation",
    "title":"Check is invalid.",
    "details":"The Check provided is not valid.",
    "instance":"error:check_validation_failure",
    "posDetails":[
        {
            "code":"menu_item_invalid",
            "message":"invalid 'definitionSequence' value for menuItem '123'"
        }
    ]
}

• Array of: object items

{
    "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "code":{
                "description":"Short, unique identifier for the type of error",
                "type":"string",
                "example":"menu_item_invalid"
            },
            "message":{
                "description":"A human-readable explanation specific to this occurrence of the problem.",
                "type":"string",
                "example":"invalid 'definitionSequence' value for menuItem '123'"
            }
        }
    }
}

• code: string
  Short, unique identifier for the type of error

  Example: menu_item_invalid
• message: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: invalid 'definitionSequence' value for menuItem '123'

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Short, unique identifier for the type of error",
            "type":"string",
            "example":"menu_item_invalid"
        },
        "message":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"invalid 'definitionSequence' value for menuItem '123'"
        }
    }
}