1. Simphony Transaction Services Gen2 API Guide
  2. Tasks
  3. Checks API

Post a new check

post

{basePath}/checks

API to create a new check.

The orgShortName, locRef, and rvcRef values in the check header are used to define the location and revenue center where the operation will occur.

Request

Supported Media Types
Header Parameters
Body ()
The Check
Root Schema : Check
Type: object
The model for a Check.
Show Source
Nested Schema : checkNotifications
Type: array
Array of past notifications for the check.
Show Source
Nested Schema : comboMeals
Type: array
Array of combo meal items. If there were no combo meal items on the check the returned array will be empty.
Show Source
Nested Schema : discounts
Type: array
Array of discounts.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : CheckHeader
Type: object
The check header contains information describing the overall check.
Show Source
  • The identifier of the employee that is used for the operations.Simphony: the employee object number.
  • The reference for the check provided at time of check creation. This must be unique among all open checks at the revenue center.
  • A check identifier generated by the POS when the check is created.
  • The unique check reference generated by the POS system when the check is created.
  • 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.
  • The number of guests on the check.
  • 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
    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.
  • Flag used to identify a training check.
  • The language culture reference associated with the check. This value is used to return "name" property of check items in a desired language.
  • The location identifier.
  • The time the check is opened/created. Time is UTC.
  • The order type identifier from the revenue center configuration.
  • The organization identifier.
  • An identifier of a payment store provided by the point of sale.
  • 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.
  • The revenue center identifier.
  • Allowed Values: [ "open", "closed" ]
    Information about the status of the check. Status options: openindicates the check has a balance due and is 'open' (meaning it can be modified).closedindicates the check has been paid in full and is 'closed' (meaning it cannot be modified).
  • The table-group of the check. Assigned by POS and indicates the number of checks open checks with the same table.
  • 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.
Nested Schema : menuItems
Type: array
Array of menu items.
Show Source
Nested Schema : CheckNotificationOptions
Type: object

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).

Show Source
  • A flag indicating whether notifications should be sent for the check. Set to true to request notifications. NotificationOptions "Inline" and "Subscription"
  • 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"
  • Integrator-provided id for key. Is required if 'enabled' is set to 'true' and per-check notifications are needed. NotificationOptions "Inline"
  • 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/
Nested Schema : serviceCharges
Type: array
Array of service charges.
Show Source
Nested Schema : taxes
Type: array
Array of tax item.
Show Source
Nested Schema : tenders
Type: array
Array of tender items.
Show Source
Nested Schema : CheckTotals
Type: object
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
Show Source
Nested Schema : CheckNotification
Type: object
A notifiable event that occurred on this check. Read-only; incoming values will be ignored.
Show Source
Nested Schema : CheckNotificationMessagesData
Type: object
The notification data.
Show Source
  • Information about the preparation status of the check. Status options:
    StatusDescription
    Uninitializedindicates that the check was not fired. In use when pickupTime and fireTime is utilized in the request. Also returned when check status is "closed".
    Submittedindicates that the check preparation started.
    Preparedindicates that the check preparation was done. And moved "bumped" to the next stage.
    Packagedindicates 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.
  • A timestamp indicating the date and time in UTC at which check status changed.Expected for message Type: "CheckNotification"
Example:
{
    "status":"Packaged",
    "timeStampUtc":"2021-12-08T19:57:12.045Z"
}
Nested Schema : CheckMessageType
Type: object
Information about the type of message.
Show Source
  • Identifier of the message type.
    Example: { "id":"CheckNotification" }
Nested Schema : CheckNotificationResource
Type: object
Information about the STS resource affected by this message.
Show Source
Nested Schema : CheckComboMealItem
Type: object
A Combo Meal that can be ordered.
Show Source
Nested Schema : CheckMenuItem
Type: object
A menu item on the check represents an item that is purchased.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail
Show Source
Nested Schema : sideItems
Type: array
Combo meal side items (for example, French Fries or Coke).
Show Source
Nested Schema : condiments
Type: array
Array of condiments represented in menu item JSON objects. If there are no condiments configured, this array will be empty.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : itemDiscounts
Type: array
Array of discounts applied to the menu item.
Show Source
Nested Schema : CheckCondimentItem
Type: object
Show Source
Nested Schema : itemDiscounts
Type: array
Array of discounts applied to the menu item.
Show Source
Nested Schema : CheckDiscountItem
Type: object
Definition of a discount that can be applied to a transaction.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : ExtensionItem
Type: object
Object that can contain extensibility detail to be stored with the check.
Show Source
  • The name of the application associated with this data (defined by the caller).
  • The data payload for the extensibility data.
  • Name of the data stored by this extensibility item.
  • Describes the type of data stored by this extensibility item (defined by the caller).
  • A string displayed and/or printed if this item is displayed or printed.
  • options
    Array of options that define behavior of the extension item.
    OptionDescription
    printOnDisplayWhen specified the displayName is shown on the display
    printOnReceiptWhen specified the displayName is printed on the receipt/check
    printInKitchenWhen specified the displayName is printed on the kitchen chit
    includeInApiResponseWhen specified the extension item is return as part of the check in the API responses.
Nested Schema : options
Type: array
Array of options that define behavior of the extension item.
OptionDescription
printOnDisplayWhen specified the displayName is shown on the display
printOnReceiptWhen specified the displayName is printed on the receipt/check
printInKitchenWhen specified the displayName is printed on the kitchen chit
includeInApiResponseWhen specified the extension item is return as part of the check in the API responses.
Show Source
  • Array of options. One or more of the following values are allowed: "printOnDisplay", "printOnReceipt", "printInKitchen", "includeInApiResponse"
Example:
[
    "printondisplay",
    "printonreceipt",
    "printInKitchen",
    "IncludeInApiResponse"
]
Nested Schema : informationLines
Type: array
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.
Show Source
Nested Schema : CheckServiceChargeItem
Type: object
A service charge that can be applied to a transaction.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : CheckTaxItem
Type: object
Array of tax item. If there were no taxable items on the check the returned array will be empty.
Show Source
Nested Schema : CheckTenderItem
Type: object
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : CheckPaymentData
Type: object
You can access Oracle Payment Interface documentation through the following Oracle Hospitality documentation page: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html
Show Source
  • data
    Object containing data for the type of payment.
  • Describes the type of data contained in this payment data object.Type structure identifier, format identifier values can be found at link provided in the description.
Nested Schema : data
Type: object
Object containing data for the type of payment.
Back to Top

Response

Supported Media Types

200 Response

A check that was created. The checkRef is the check identifier.
Body ()
Root Schema : Check
Type: object
The model for a Check.
Show Source
Nested Schema : checkNotifications
Type: array
Array of past notifications for the check.
Show Source
Nested Schema : comboMeals
Type: array
Array of combo meal items. If there were no combo meal items on the check the returned array will be empty.
Show Source
Nested Schema : discounts
Type: array
Array of discounts.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : CheckHeader
Type: object
The check header contains information describing the overall check.
Show Source
  • The identifier of the employee that is used for the operations.Simphony: the employee object number.
  • The reference for the check provided at time of check creation. This must be unique among all open checks at the revenue center.
  • A check identifier generated by the POS when the check is created.
  • The unique check reference generated by the POS system when the check is created.
  • 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.
  • The number of guests on the check.
  • 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
    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.
  • Flag used to identify a training check.
  • The language culture reference associated with the check. This value is used to return "name" property of check items in a desired language.
  • The location identifier.
  • The time the check is opened/created. Time is UTC.
  • The order type identifier from the revenue center configuration.
  • The organization identifier.
  • An identifier of a payment store provided by the point of sale.
  • 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.
  • The revenue center identifier.
  • Allowed Values: [ "open", "closed" ]
    Information about the status of the check. Status options: openindicates the check has a balance due and is 'open' (meaning it can be modified).closedindicates the check has been paid in full and is 'closed' (meaning it cannot be modified).
  • The table-group of the check. Assigned by POS and indicates the number of checks open checks with the same table.
  • 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.
Nested Schema : menuItems
Type: array
Array of menu items.
Show Source
Nested Schema : CheckNotificationOptions
Type: object

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).

Show Source
  • A flag indicating whether notifications should be sent for the check. Set to true to request notifications. NotificationOptions "Inline" and "Subscription"
  • 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"
  • Integrator-provided id for key. Is required if 'enabled' is set to 'true' and per-check notifications are needed. NotificationOptions "Inline"
  • 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/
Nested Schema : serviceCharges
Type: array
Array of service charges.
Show Source
Nested Schema : taxes
Type: array
Array of tax item.
Show Source
Nested Schema : tenders
Type: array
Array of tender items.
Show Source
Nested Schema : CheckTotals
Type: object
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
Show Source
Nested Schema : CheckNotification
Type: object
A notifiable event that occurred on this check. Read-only; incoming values will be ignored.
Show Source
Nested Schema : CheckNotificationMessagesData
Type: object
The notification data.
Show Source
  • Information about the preparation status of the check. Status options:
    StatusDescription
    Uninitializedindicates that the check was not fired. In use when pickupTime and fireTime is utilized in the request. Also returned when check status is "closed".
    Submittedindicates that the check preparation started.
    Preparedindicates that the check preparation was done. And moved "bumped" to the next stage.
    Packagedindicates 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.
  • A timestamp indicating the date and time in UTC at which check status changed.Expected for message Type: "CheckNotification"
Example:
{
    "status":"Packaged",
    "timeStampUtc":"2021-12-08T19:57:12.045Z"
}
Nested Schema : CheckMessageType
Type: object
Information about the type of message.
Show Source
  • Identifier of the message type.
    Example: { "id":"CheckNotification" }
Nested Schema : CheckNotificationResource
Type: object
Information about the STS resource affected by this message.
Show Source
Nested Schema : CheckComboMealItem
Type: object
A Combo Meal that can be ordered.
Show Source
Nested Schema : CheckMenuItem
Type: object
A menu item on the check represents an item that is purchased.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail
Show Source
Nested Schema : sideItems
Type: array
Combo meal side items (for example, French Fries or Coke).
Show Source
Nested Schema : condiments
Type: array
Array of condiments represented in menu item JSON objects. If there are no condiments configured, this array will be empty.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : itemDiscounts
Type: array
Array of discounts applied to the menu item.
Show Source
Nested Schema : CheckCondimentItem
Type: object
Show Source
Nested Schema : itemDiscounts
Type: array
Array of discounts applied to the menu item.
Show Source
Nested Schema : CheckDiscountItem
Type: object
Definition of a discount that can be applied to a transaction.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : ExtensionItem
Type: object
Object that can contain extensibility detail to be stored with the check.
Show Source
  • The name of the application associated with this data (defined by the caller).
  • The data payload for the extensibility data.
  • Name of the data stored by this extensibility item.
  • Describes the type of data stored by this extensibility item (defined by the caller).
  • A string displayed and/or printed if this item is displayed or printed.
  • options
    Array of options that define behavior of the extension item.
    OptionDescription
    printOnDisplayWhen specified the displayName is shown on the display
    printOnReceiptWhen specified the displayName is printed on the receipt/check
    printInKitchenWhen specified the displayName is printed on the kitchen chit
    includeInApiResponseWhen specified the extension item is return as part of the check in the API responses.
Nested Schema : options
Type: array
Array of options that define behavior of the extension item.
OptionDescription
printOnDisplayWhen specified the displayName is shown on the display
printOnReceiptWhen specified the displayName is printed on the receipt/check
printInKitchenWhen specified the displayName is printed on the kitchen chit
includeInApiResponseWhen specified the extension item is return as part of the check in the API responses.
Show Source
  • Array of options. One or more of the following values are allowed: "printOnDisplay", "printOnReceipt", "printInKitchen", "includeInApiResponse"
Example:
[
    "printondisplay",
    "printonreceipt",
    "printInKitchen",
    "IncludeInApiResponse"
]
Nested Schema : informationLines
Type: array
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.
Show Source
Nested Schema : CheckServiceChargeItem
Type: object
A service charge that can be applied to a transaction.
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : CheckTaxItem
Type: object
Array of tax item. If there were no taxable items on the check the returned array will be empty.
Show Source
Nested Schema : CheckTenderItem
Type: object
Show Source
Nested Schema : extensions
Type: array
Array of extension detail.
Show Source
Nested Schema : CheckPaymentData
Type: object
You can access Oracle Payment Interface documentation through the following Oracle Hospitality documentation page: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html
Show Source
  • data
    Object containing data for the type of payment.
  • Describes the type of data contained in this payment data object.Type structure identifier, format identifier values can be found at link provided in the description.
Nested Schema : data
Type: object
Object containing data for the type of payment.

400 Response

400 Bad Request
Body ()
Root Schema : ChecksApiProblemDetails
Type: object
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). **Extensions** * posDetails
Show Source
  • A human-readable explanation specific to this occurrence of the problem.
    Example: The Check provided is not valid.
  • 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
    (Problem Details Extension) Contains a list of the problem details from the POS System processing the request.
  • A short, human-readable summary of the problem type.
    Example: Check is invalid.
  • 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
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'"
        }
    ]
}
Nested Schema : posDetails
Type: array
(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.
Show Source
Nested Schema : items
Type: object
Show Source
  • Short, unique identifier for the type of error
    Example: menu_item_invalid
  • A human-readable explanation specific to this occurrence of the problem.
    Example: invalid 'definitionSequence' value for menuItem '123'

521 Response

521 Service Timeout
Back to Top

Examples

Example Request Body

The following example shows the contents of the request body in JSON format:


{
  "header": {
    "orgShortName": "string",
    "locRef": "string",
    "rvcRef": 0,
    "checkRef": "string",
    "idempotencyId": "13747214c7eaa7a9668189bbc737e63b",
    "checkNumber": 0,
    "checkName": "string",
    "checkEmployeeRef": 0,
    "orderTypeRef": 0,
    "tableName": "string",
    "tableGroupNumber": 0,
    "openTime": "2023-06-01T10:55:30.092Z",
    "fireTime": "2023-06-01T10:55:30.092Z",
    "pickupTime": "2023-06-01T10:55:30.092Z",
    "guestCount": 0,
    "language": "string",
    "isTrainingCheck": true,
    "informationLines": [
      "string"
    ],
    "paymentStoreId": "string",
    "status": "open"
  },
  "notificationOptions": {
    "enabled": true,
    "url": "https://example.com/wh/sim/notify",
    "keyId": "string",
    "key": "string"
  },
  "checkNotifications": [
    {
      "messageType": {
        "id": "'check-update', 'check-ready'"
      },
      "resource": {
        "orgShortName": "string",
        "locRef": "string",
        "rvcRef": "string",
        "checkRef": "string",
        "menuId": "string"
      },
      "data": {}
    }
  ],
  "menuItems": [
    {
      "menuItemId": 0,
      "definitionSequence": 0,
      "name": "string",
      "quantity": 0,
      "unitPrice": 0,
      "priceSequence": 0,
      "total": 0,
      "seat": 0,
      "referenceText": "string",
      "surcharge": 0,
      "itemDiscounts": [
        {
          "discountId": 0,
          "name": "string",
          "seat": 0,
          "referenceText": "string",
          "total": 0,
          "isAutomatic": true,
          "extensions": [
            {
              "displayName": "string",
              "appName": "string",
              "dataName": "string",
              "dataType": "string",
              "data": "string",
              "options": [
                "printOnDisplay",
                "printOnReceipt"
              ]
            }
          ]
        }
      ],
      "condiments": [
        {
          "condimentId": 0,
          "definitionSequence": 0,
          "name": "string",
          "quantity": 0,
          "unitPrice": 0,
          "priceSequence": 0,
          "total": 0,
          "seat": 0,
          "referenceText": "string",
          "surcharge": 0,
          "itemDiscounts": [
            {
              "discountId": 0,
              "name": "string",
              "seat": 0,
              "referenceText": "string",
              "total": 0,
              "isAutomatic": true,
              "extensions": [
                {
                  "displayName": "string",
                  "appName": "string",
                  "dataName": "string",
                  "dataType": "string",
                  "data": "string",
                  "options": [
                    "printOnDisplay",
                    "printOnReceipt"
                  ]
                }
              ]
            }
          ]
        }
      ],
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "comboMeals": [
    {
      "comboMealId": 0,
      "seat": 0,
      "comboItem": {
        "menuItemId": 0,
        "definitionSequence": 0,
        "name": "string",
        "quantity": 0,
        "unitPrice": 0,
        "priceSequence": 0,
        "total": 0,
        "seat": 0,
        "referenceText": "string",
        "surcharge": 0,
        "itemDiscounts": [
          {
            "discountId": 0,
            "name": "string",
            "seat": 0,
            "referenceText": "string",
            "total": 0,
            "isAutomatic": true,
            "extensions": [
              {
                "displayName": "string",
                "appName": "string",
                "dataName": "string",
                "dataType": "string",
                "data": "string",
                "options": [
                  "printOnDisplay",
                  "printOnReceipt"
                ]
              }
            ]
          }
        ],
        "condiments": [
          {
            "condimentId": 0,
            "definitionSequence": 0,
            "name": "string",
            "quantity": 0,
            "unitPrice": 0,
            "priceSequence": 0,
            "total": 0,
            "seat": 0,
            "referenceText": "string",
            "surcharge": 0,
            "itemDiscounts": [
              {
                "discountId": 0,
                "name": "string",
                "seat": 0,
                "referenceText": "string",
                "total": 0,
                "isAutomatic": true,
                "extensions": [
                  {
                    "displayName": "string",
                    "appName": "string",
                    "dataName": "string",
                    "dataType": "string",
                    "data": "string",
                    "options": [
                      "printOnDisplay",
                      "printOnReceipt"
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "extensions": [
          {
            "displayName": "string",
            "appName": "string",
            "dataName": "string",
            "dataType": "string",
            "data": "string",
            "options": [
              "printOnDisplay",
              "printOnReceipt"
            ]
          }
        ]
      },
      "mainItem": {
        "menuItemId": 0,
        "definitionSequence": 0,
        "name": "string",
        "quantity": 0,
        "unitPrice": 0,
        "priceSequence": 0,
        "total": 0,
        "seat": 0,
        "referenceText": "string",
        "surcharge": 0,
        "itemDiscounts": [
          {
            "discountId": 0,
            "name": "string",
            "seat": 0,
            "referenceText": "string",
            "total": 0,
            "isAutomatic": true,
            "extensions": [
              {
                "displayName": "string",
                "appName": "string",
                "dataName": "string",
                "dataType": "string",
                "data": "string",
                "options": [
                  "printOnDisplay",
                  "printOnReceipt"
                ]
              }
            ]
          }
        ],
        "condiments": [
          {
            "condimentId": 0,
            "definitionSequence": 0,
            "name": "string",
            "quantity": 0,
            "unitPrice": 0,
            "priceSequence": 0,
            "total": 0,
            "seat": 0,
            "referenceText": "string",
            "surcharge": 0,
            "itemDiscounts": [
              {
                "discountId": 0,
                "name": "string",
                "seat": 0,
                "referenceText": "string",
                "total": 0,
                "isAutomatic": true,
                "extensions": [
                  {
                    "displayName": "string",
                    "appName": "string",
                    "dataName": "string",
                    "dataType": "string",
                    "data": "string",
                    "options": [
                      "printOnDisplay",
                      "printOnReceipt"
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "extensions": [
          {
            "displayName": "string",
            "appName": "string",
            "dataName": "string",
            "dataType": "string",
            "data": "string",
            "options": [
              "printOnDisplay",
              "printOnReceipt"
            ]
          }
        ]
      },
      "sideItems": [
        {
          "menuItemId": 0,
          "definitionSequence": 0,
          "name": "string",
          "quantity": 0,
          "unitPrice": 0,
          "priceSequence": 0,
          "total": 0,
          "seat": 0,
          "referenceText": "string",
          "surcharge": 0,
          "itemDiscounts": [
            {
              "discountId": 0,
              "name": "string",
              "seat": 0,
              "referenceText": "string",
              "total": 0,
              "isAutomatic": true,
              "extensions": [
                {
                  "displayName": "string",
                  "appName": "string",
                  "dataName": "string",
                  "dataType": "string",
                  "data": "string",
                  "options": [
                    "printOnDisplay",
                    "printOnReceipt"
                  ]
                }
              ]
            }
          ],
          "condiments": [
            {
              "condimentId": 0,
              "definitionSequence": 0,
              "name": "string",
              "quantity": 0,
              "unitPrice": 0,
              "priceSequence": 0,
              "total": 0,
              "seat": 0,
              "referenceText": "string",
              "surcharge": 0,
              "itemDiscounts": [
                {
                  "discountId": 0,
                  "name": "string",
                  "seat": 0,
                  "referenceText": "string",
                  "total": 0,
                  "isAutomatic": true,
                  "extensions": [
                    {
                      "displayName": "string",
                      "appName": "string",
                      "dataName": "string",
                      "dataType": "string",
                      "data": "string",
                      "options": [
                        "printOnDisplay",
                        "printOnReceipt"
                      ]
                    }
                  ]
                }
              ]
            }
          ],
          "extensions": [
            {
              "displayName": "string",
              "appName": "string",
              "dataName": "string",
              "dataType": "string",
              "data": "string",
              "options": [
                "printOnDisplay",
                "printOnReceipt"
              ]
            }
          ]
        }
      ],
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "discounts": [
    {
      "discountId": 0,
      "name": "string",
      "seat": 0,
      "referenceText": "string",
      "total": 0,
      "isAutomatic": true,
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "serviceCharges": [
    {
      "serviceChargeId": 0,
      "name": "string",
      "total": 0,
      "seat": 0,
      "referenceText": "string",
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "extensions": [
    {
      "displayName": "string",
      "appName": "string",
      "dataName": "string",
      "dataType": "string",
      "data": "string",
      "options": [
        "printOnDisplay",
        "printOnReceipt"
      ]
    }
  ],
  "taxes": [
    {
      "taxRateId": "string",
      "name": "string",
      "total": 0
    }
  ],
  "tenders": [
    {
      "tenderId": 0,
      "name": "string",
      "total": 0,
      "chargedTipTotal": 0,
      "referenceText": "string",
      "paymentData": {
        "type": "string",
        "data": {}
      }

Example Response Body

The following example shows the contents of the response body in JSON format:


{
  "header": {
    "orgShortName": "string",
    "locRef": "string",
    "rvcRef": 0,
    "checkRef": "string",
    "idempotencyId": "d4e082b4b4670be183abdec21a6c5382",
    "checkNumber": 0,
    "checkName": "string",
    "checkEmployeeRef": 0,
    "orderTypeRef": 0,
    "tableName": "string",
    "tableGroupNumber": 0,
    "openTime": "2023-06-01T17:48:50.823Z",
    "fireTime": "2023-06-01T17:48:50.823Z",
    "pickupTime": "2023-06-01T17:48:50.823Z",
    "guestCount": 0,
    "language": "string",
    "isTrainingCheck": true,
    "informationLines": [
      "string"
    ],
    "paymentStoreId": "string",
    "status": "open"
  },
  "notificationOptions": {
    "enabled": true,
    "url": "https://example.com/wh/sim/notify",
    "keyId": "string",
    "key": "string"
  },
  "checkNotifications": [
    {
      "messageType": {
        "id": "'check-update', 'check-ready'"
      },
      "resource": {
        "orgShortName": "string",
        "locRef": "string",
        "rvcRef": "string",
        "checkRef": "string",
        "menuId": "string"
      },
      "data": {}
    }
  ],
  "menuItems": [
    {
      "menuItemId": 0,
      "definitionSequence": 0,
      "name": "string",
      "quantity": 0,
      "unitPrice": 0,
      "priceSequence": 0,
      "total": 0,
      "seat": 0,
      "referenceText": "string",
      "surcharge": 0,
      "itemDiscounts": [
        {
          "discountId": 0,
          "name": "string",
          "seat": 0,
          "referenceText": "string",
          "total": 0,
          "isAutomatic": true,
          "extensions": [
            {
              "displayName": "string",
              "appName": "string",
              "dataName": "string",
              "dataType": "string",
              "data": "string",
              "options": [
                "printOnDisplay",
                "printOnReceipt"
              ]
            }
          ]
        }
      ],
      "condiments": [
        {
          "condimentId": 0,
          "definitionSequence": 0,
          "name": "string",
          "quantity": 0,
          "unitPrice": 0,
          "priceSequence": 0,
          "total": 0,
          "seat": 0,
          "referenceText": "string",
          "surcharge": 0,
          "itemDiscounts": [
            {
              "discountId": 0,
              "name": "string",
              "seat": 0,
              "referenceText": "string",
              "total": 0,
              "isAutomatic": true,
              "extensions": [
                {
                  "displayName": "string",
                  "appName": "string",
                  "dataName": "string",
                  "dataType": "string",
                  "data": "string",
                  "options": [
                    "printOnDisplay",
                    "printOnReceipt"
                  ]
                }
              ]
            }
          ]
        }
      ],
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "comboMeals": [
    {
      "comboMealId": 0,
      "seat": 0,
      "comboItem": {
        "menuItemId": 0,
        "definitionSequence": 0,
        "name": "string",
        "quantity": 0,
        "unitPrice": 0,
        "priceSequence": 0,
        "total": 0,
        "seat": 0,
        "referenceText": "string",
        "surcharge": 0,
        "itemDiscounts": [
          {
            "discountId": 0,
            "name": "string",
            "seat": 0,
            "referenceText": "string",
            "total": 0,
            "isAutomatic": true,
            "extensions": [
              {
                "displayName": "string",
                "appName": "string",
                "dataName": "string",
                "dataType": "string",
                "data": "string",
                "options": [
                  "printOnDisplay",
                  "printOnReceipt"
                ]
              }
            ]
          }
        ],
        "condiments": [
          {
            "condimentId": 0,
            "definitionSequence": 0,
            "name": "string",
            "quantity": 0,
            "unitPrice": 0,
            "priceSequence": 0,
            "total": 0,
            "seat": 0,
            "referenceText": "string",
            "surcharge": 0,
            "itemDiscounts": [
              {
                "discountId": 0,
                "name": "string",
                "seat": 0,
                "referenceText": "string",
                "total": 0,
                "isAutomatic": true,
                "extensions": [
                  {
                    "displayName": "string",
                    "appName": "string",
                    "dataName": "string",
                    "dataType": "string",
                    "data": "string",
                    "options": [
                      "printOnDisplay",
                      "printOnReceipt"
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "extensions": [
          {
            "displayName": "string",
            "appName": "string",
            "dataName": "string",
            "dataType": "string",
            "data": "string",
            "options": [
              "printOnDisplay",
              "printOnReceipt"
            ]
          }
        ]
      },
      "mainItem": {
        "menuItemId": 0,
        "definitionSequence": 0,
        "name": "string",
        "quantity": 0,
        "unitPrice": 0,
        "priceSequence": 0,
        "total": 0,
        "seat": 0,
        "referenceText": "string",
        "surcharge": 0,
        "itemDiscounts": [
          {
            "discountId": 0,
            "name": "string",
            "seat": 0,
            "referenceText": "string",
            "total": 0,
            "isAutomatic": true,
            "extensions": [
              {
                "displayName": "string",
                "appName": "string",
                "dataName": "string",
                "dataType": "string",
                "data": "string",
                "options": [
                  "printOnDisplay",
                  "printOnReceipt"
                ]
              }
            ]
          }
        ],
        "condiments": [
          {
            "condimentId": 0,
            "definitionSequence": 0,
            "name": "string",
            "quantity": 0,
            "unitPrice": 0,
            "priceSequence": 0,
            "total": 0,
            "seat": 0,
            "referenceText": "string",
            "surcharge": 0,
            "itemDiscounts": [
              {
                "discountId": 0,
                "name": "string",
                "seat": 0,
                "referenceText": "string",
                "total": 0,
                "isAutomatic": true,
                "extensions": [
                  {
                    "displayName": "string",
                    "appName": "string",
                    "dataName": "string",
                    "dataType": "string",
                    "data": "string",
                    "options": [
                      "printOnDisplay",
                      "printOnReceipt"
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "extensions": [
          {
            "displayName": "string",
            "appName": "string",
            "dataName": "string",
            "dataType": "string",
            "data": "string",
            "options": [
              "printOnDisplay",
              "printOnReceipt"
            ]
          }
        ]
      },
      "sideItems": [
        {
          "menuItemId": 0,
          "definitionSequence": 0,
          "name": "string",
          "quantity": 0,
          "unitPrice": 0,
          "priceSequence": 0,
          "total": 0,
          "seat": 0,
          "referenceText": "string",
          "surcharge": 0,
          "itemDiscounts": [
            {
              "discountId": 0,
              "name": "string",
              "seat": 0,
              "referenceText": "string",
              "total": 0,
              "isAutomatic": true,
              "extensions": [
                {
                  "displayName": "string",
                  "appName": "string",
                  "dataName": "string",
                  "dataType": "string",
                  "data": "string",
                  "options": [
                    "printOnDisplay",
                    "printOnReceipt"
                  ]
                }
              ]
            }
          ],
          "condiments": [
            {
              "condimentId": 0,
              "definitionSequence": 0,
              "name": "string",
              "quantity": 0,
              "unitPrice": 0,
              "priceSequence": 0,
              "total": 0,
              "seat": 0,
              "referenceText": "string",
              "surcharge": 0,
              "itemDiscounts": [
                {
                  "discountId": 0,
                  "name": "string",
                  "seat": 0,
                  "referenceText": "string",
                  "total": 0,
                  "isAutomatic": true,
                  "extensions": [
                    {
                      "displayName": "string",
                      "appName": "string",
                      "dataName": "string",
                      "dataType": "string",
                      "data": "string",
                      "options": [
                        "printOnDisplay",
                        "printOnReceipt"
                      ]
                    }
                  ]
                }
              ]
            }
          ],
          "extensions": [
            {
              "displayName": "string",
              "appName": "string",
              "dataName": "string",
              "dataType": "string",
              "data": "string",
              "options": [
                "printOnDisplay",
                "printOnReceipt"
              ]
            }
          ]
        }
      ],
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "discounts": [
    {
      "discountId": 0,
      "name": "string",
      "seat": 0,
      "referenceText": "string",
      "total": 0,
      "isAutomatic": true,
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "serviceCharges": [
    {
      "serviceChargeId": 0,
      "name": "string",
      "total": 0,
      "seat": 0,
      "referenceText": "string",
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "extensions": [
    {
      "displayName": "string",
      "appName": "string",
      "dataName": "string",
      "dataType": "string",
      "data": "string",
      "options": [
        "printOnDisplay",
        "printOnReceipt"
      ]
    }
  ],
  "taxes": [
    {
      "taxRateId": "string",
      "name": "string",
      "total": 0
    }
  ],
  "tenders": [
    {
      "tenderId": 0,
      "name": "string",
      "total": 0,
      "chargedTipTotal": 0,
      "referenceText": "string",
      "paymentData": {
        "type": "string",
        "data": {}
      },
      "extensions": [
        {
          "displayName": "string",
          "appName": "string",
          "dataName": "string",
          "dataType": "string",
          "data": "string",
          "options": [
            "printOnDisplay",
            "printOnReceipt"
          ]
        }
      ]
    }
  ],
  "totals": {
    "subtotal": 0,
    "subtotalDiscountTotal": 0,
    "autoServiceChargeTotal": 0,
    "serviceChargeTotal": 0,
    "taxTotal": 0,
    "paymentTotal": 0,
    "totalDue": 0
  }
}
Back to Top