v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Point of Sale
Closures

Get closure info for a specific day

Returns whether the closure was already done for a specific day or not

get/consumers/{consumer_id}/pos/closures/{date}

Path parameters

consumer_idstring uuid required
datestring date required

Filter based on the date of the closure

Query parameters

location_idstring nullable

Unique identifier of the location. If none passed, closures from all locations will be returned unless the location was selected by the end-user

Response

Successful Response

datestring date required

Date of the closure

status'open' | 'closed' required

Example response

{
  "date": "2025-01-01",
  "closures": [
    {
      "payments": [
        {
          "payment_method_id": "payment_method-1",
          "payment_method_name": "Cash",
          "tip": 1,
          "total": 11
        }
      ],
      "taxes": [
        {
          "tax_id": "371ca583-d218-4900-b236-397532cf0e39"
        }
      ]
    }
  ]
}