Get Open Checks

GET /o/op/1/order/table/getCheck

Returns all open receipts for the current day.

Query parameters

Responses

  • 200 application/json

    All open receipts for the current day.

    Hide response attributes Show response attributes object
    • clientCount integer(int32)

      The number of guests at the table.

    • identifier string Deprecated
    • uuid string

      The account uuid.

    • openDate string(date-time)

      The date this account was opened in UTC.

    • closeDate string(date-time)

      The date this account was closed in UTC.

    • The total of all payments on the check.

    • The service charge applied to the check.

    • name string

      The check name.

    • The current total amount on the check.

    • The name of the staff member assigned to the check.

    • staffId integer(int64)

      The unique ID of the staff member assigned to the check.

    • salesEntries array[object]

      Collection of check items.

      Hide salesEntries attributes Show salesEntries attributes object
      • id integer(int64)

        The unique ID assigned to the sale line.

      • uuid string

        The UUID assigned to the sale line.

      • itemName string

        The name given to the item.

      • itemSku string

        The SKU assigned to the item.

      • The price per unit.

      • quantity number(double)

        The quantity of the item for this sale line.

      • modifiers array[object]

        The modifiers of the item for this sale line

        Hide modifiers attributes Show modifiers attributes object
        • name string

          The name of the modifier.

        • quantity integer(int32)

          The quantity of the modifier.

      • The total price of the item including tax.

      • The total price of the item without tax.

      • The amount the item was discounted.

      • timeOfTransactionUtc string(date-time)

        The date and time in UTC when the transaction occurred.

      • active boolean Deprecated
      • subLineItems array[object]

        Collection of sub-line items associated with this sale line.

      • Indicates whether tax is included in the unit amount.

    • paymentEntries array[object]

      Payments associated with this check.

      Hide paymentEntries attributes Show paymentEntries attributes object
    • id string Deprecated
    • The system-generated account identifier for this check.(Applies to iKentoo V3+).

    • number integer(int32) Deprecated
    • tableNumber integer(int32)

      The table number assigned to the check.

    • posId integer(int64)

      The unique ID of the POS station that processed the check.

    • deviceId integer(int64) Deprecated
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • timestamp string(date-time)

      The date and time at which the error occurred.

    • status integer

      The HTTP status code associated with the error.

    • error string

      A short description of the HTTP status code meaning.

    • message string

      A human-readable message providing more details about the error.

    • path string

      The request path where the error occurred.

GET /o/op/1/order/table/getCheck
curl \
 -X GET https://api.lsk.lightspeed.app/o/op/1/order/table/getCheck?businessLocationId=45454565682155 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "clientCount": 4,
    "identifier": "string",
    "uuid": "a3bb189e-8f29-4cce-b0e9-f29b123dfe3d",
    "openDate": "2021-06-21T14:20:00Z",
    "closeDate": "2021-06-22T10:15:00Z",
    "paidAmount": 100.0,
    "serviceCharge": 10.0,
    "name": "ORDER A1C2E",
    "currentAmount": 110.0,
    "staffName": "Jane Smith",
    "staffId": 7701234,
    "salesEntries": [
      {
        "id": 1341648999023061,
        "uuid": "2c83b049-a2c1-4bc5-8479-eb152e5a54be",
        "itemName": "Burger",
        "itemSku": "14",
        "unitAmount": 10.0,
        "quantity": 1.0,
        "modifiers": [
          {
            "name": "Rare",
            "quantity": 1
          }
        ],
        "amountWithTax": 11.5,
        "amountLessTax": 10.0,
        "discountedAmount": 0.0,
        "timeOfTransactionUtc": "2023-11-07T21:24:44.741+0000",
        "active": true,
        "subLineItems": [
          {
            "id": 1341648999023062,
            "uuid": "2c83b049-a2c1-4bc5-8479-eb152e5a54be",
            "active": true,
            "itemSku": "35",
            "itemName": "Extra Cheese",
            "quantity": 1.0,
            "modifiers": [],
            "unitAmount": 1.0,
            "taxIncluded": false,
            "subLineItems": [],
            "amountLessTax": 1.0,
            "amountWithTax": 1.15,
            "grossUnitAmount": 1.0,
            "discountedAmount": 0.0,
            "timeOfTransactionUtc": "2023-11-07T21:24:44.755+0000"
          }
        ],
        "taxIncluded": false
      }
    ],
    "paymentEntries": [
      {
        "paymentMethodDescription": "API Payment",
        "externalReference": "12345678901234",
        "paymentMethodCode": "APM",
        "amountPaid": 12.65,
        "paymentDate": "2023-11-07T22:05:16.127+0000",
        "active": true
      }
    ],
    "id": "string",
    "ikaccountId": "A78094.48",
    "number": 42,
    "tableNumber": 2,
    "posId": 54321,
    "deviceId": 42
  }
]
Response examples (400)
{
  "timestamp": "2023-11-07T22:18:49.101+0000",
  "status": 400,
  "error": "Bad Request",
  "message": "Required request parameter 'businessLocationId' for method parameter type Long is not present",
  "path": "/o/op/1/order/table/getCheck"
}