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

Get a list of checks

get

{basePath}/checks

{basePath}/checks?checkEmployeeRef=65&sinceTime=2020-12-31T23:59Z

{basePath}/checks?orderTypeRef=2&includeClosed=true

{basePath}/checks?checkNum=976&sinceTime=2020-12-31T23:59Z&includeClosed=true

API returns the available open checks from the specified revenue center. Options to return all checks meeting a specified set of criteria is supported via query parameters. The details in these responses can then be used to retrieve the details of a specific check.

Request

Supported Media Types
Query Parameters
  • The reference number of the employee that owns the check. Allows returning of checks for only a targeted employee.
  • Only checks with these numbers are returned. It is possible to get more than one check with the same check number.

  • When includeClose is true then closed and open are returned.

    When includeClose is false then only open checks are returned.

    The default value of the includeClose parameter is false (i.e., if the parameter is not specified).

  • Only checks of this order type are included in the results.
  • Only checks created on or after this time are returned in the result. Date time is UTC.
  • A table reference to filter by the table number or table name. 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.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

A collection of check headers
Body ()
Root Schema : schema
Type: object
Show Source
  • items
    Array of Check Header JSON objects. If there are no checks that meet the criteria of the request this array will be empty.
Nested Schema : items
Type: array
Array of Check Header JSON objects. If there are no checks that meet the criteria of the request this array will be empty.
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. Note: The check name is being truncated on the POS client to 20 characters.
  • 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 channel identifier from the revenue center configuration.
  • 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.

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

  • Allowed Values: [ "Uninitialized", "Submitted", "Prepared", "Packaged" ]
    Information about the preparation status of the check.
    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 one or more items on the check have been fired to the kitchen.
    Preparedindicates that one or more items on the check have been prepared 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.
  • The revenue center identifier.
  • Allowed Values: [ "open", "closed" ]
    Information about the status of the check.
    StatusDescription
    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 : 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

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'

404 Response

404 Requested resource not found

521 Response

521 Service Timeout
Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

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


{
  "items": [
    {
      "orgShortName": "string",
      "locRef": "string",
      "rvcRef": 0,
      "checkRef": "string",
      "idempotencyId": "f0f75b7d416deafaf1757b471b06c0c1",
      "checkNumber": 0,
      "checkName": "string",
      "checkEmployeeRef": 0,
      "orderTypeRef": 0,
      "orderChannelRef": 0,
      "tableName": "string",
      "tableGroupNumber": 0,
      "openTime": "2023-06-01T18:02:09.376Z",
      "fireTime": "2023-06-01T18:02:09.376Z",
      "pickupTime": "2023-06-01T18:02:09.376Z",
      "guestCount": 0,
      "language": "string",
      "isTrainingCheck": true,
      "informationLines": [
        "string"
      ],
      "paymentStoreId": "string",
      "status": "open",
      "preparationStatus": "Submitted"
    }
  ]
}
Back to Top