Register Collection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-register-collection-schema.json",
  "title": "Register Collection",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-registers-api-openapi.yml#/components/schemas/RegisterCollection",
  "properties": {
    "data": {
      "description": "An array Register objects wrapped in a top level `data` object.",
      "items": {
        "$ref": "#/$defs/Register"
      },
      "type": "array"
    },
    "version": {
      "$ref": "#/$defs/Version"
    }
  },
  "type": "object",
  "$defs": {
    "Register": {
      "properties": {
        "ask_for_note_on_save": {
          "description": "`0` for **Never**, `1` for **On Save/Layby/Account/Return**, `2` for **Always**.",
          "format": "double",
          "type": "number"
        },
        "ask_for_user_on_sale": {
          "type": "boolean"
        },
        "button_layout_id": {
          "description": "Register ID.",
          "type": [
            "string",
            "null"
          ]
        },
        "cash_managed_payment_type_id": {
          "description": "**internal** The ID of the payment type used for cash management transactions in this regsiter.",
          "type": [
            "string",
            "null"
          ]
        },
        "deleted_at": {
          "description": "Deletion timestamp in UTC.",
          "type": [
            "string",
            "null"
          ]
        },
        "email_receipt": {
          "description": "Indicates whether a receipt should be emailed after a sale.",
          "type": "boolean"
        },
        "id": {
          "description": "Auto-generated object ID.",
          "type": "string"
        },
        "invoice_prefix": {
          "description": "Invoice number prefix.",
          "type": "string"
        },
        "invoice_sequence": {
          "description": "The numeric part of the last issued invoice.",
          "format": "double",
          "type": "number"
        },
        "invoice_suffix": {
          "description": "Invoice number suffix.",
          "type": "string"
        },
        "is_open": {
          "description": "Indicates if the Register is currently open.",
          "type": "boolean"
        },
        "name": {
          "description": "The Register name.",
          "type": "string"
        },
        "outlet_id": {
          "description": "A valid ID of an Outlet that this register is associated with.",
          "type": "string"
        },
        "print_note_on_receipt": {
          "type": "boolean"
        },
        "print_receipt": {
          "description": "Indicates whether a receipt should be printed after a sale.",
          "type": "boolean"
        },
        "receipt_template_id": {
          "description": "Default receipt template ID used for this register.",
          "type": "string"
        },
        "register_close_time": {
          "description": "Date/time when the register was closed. Null if currently open.",
          "type": [
            "string",
            "null"
          ]
        },
        "register_open_sequence_id": {
          "description": "**internal** The ID of the current register closure object.",
          "type": [
            "string",
            "null"
          ]
        },
        "register_open_time": {
          "description": "Date/time when the register was open. Always in UTC.",
          "type": [
            "string",
            "null"
          ]
        },
        "show_discounts_on_receipts": {
          "type": "boolean"
        },
        "version": {
          "description": "Auto-incrementing object version number.",
          "format": "int64",
          "type": "integer"
        }
      },
      "title": "Register",
      "type": "object"
    },
    "Version": {
      "description": "An object containing the highest and lowest version numbers for all items of the returned collection.",
      "properties": {
        "max": {
          "description": "Highest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "min": {
          "description": "Lowest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "max",
        "min"
      ],
      "type": "object"
    }
  }
}