SpotOn · Schema

TimeClockEntry

An employee shift clock-in and clock-out record.

RestaurantPoint of SalePaymentsOnline OrderingReservationsReporting

Properties

Name Type Description
id string Unique time clock entry identifier.
locationId string Associated location identifier.
deleted boolean Whether the entry is marked as deleted.
voided boolean Whether the entry is voided.
employeeId string Associated employee identifier.
jobPositionId string Associated job position identifier.
payRateAmount string Hourly pay rate in US dollars, as a decimal string.
declaredCashTipsAmount string Declared cash tips collected, as a decimal string.
declaredCashTipsToOthersAmount string Declared cash tips given to others, as a decimal string.
inAt string RFC 3339 shift start (clock-in) time.
outAt string RFC 3339 shift end (clock-out) time. May be null if the shift is open.
breaks array Break records taken during the shift.
lastUpdatedAt string RFC 3339 timestamp of the last update.
View JSON Schema on GitHub

JSON Schema

restaurant-pos-export-time-clock-entry-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TimeClockEntry",
  "description": "An employee shift clock-in and clock-out record.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/spoton/refs/heads/main/json-schema/restaurant-pos-export-time-clock-entry-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique time clock entry identifier."
    },
    "locationId": {
      "type": "string",
      "description": "Associated location identifier."
    },
    "deleted": {
      "type": "boolean",
      "description": "Whether the entry is marked as deleted."
    },
    "voided": {
      "type": "boolean",
      "description": "Whether the entry is voided."
    },
    "employeeId": {
      "type": "string",
      "description": "Associated employee identifier."
    },
    "jobPositionId": {
      "type": "string",
      "description": "Associated job position identifier."
    },
    "payRateAmount": {
      "type": "string",
      "description": "Hourly pay rate in US dollars, as a decimal string."
    },
    "declaredCashTipsAmount": {
      "type": "string",
      "description": "Declared cash tips collected, as a decimal string."
    },
    "declaredCashTipsToOthersAmount": {
      "type": "string",
      "description": "Declared cash tips given to others, as a decimal string."
    },
    "inAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 shift start (clock-in) time."
    },
    "outAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 shift end (clock-out) time. May be null if the shift is open."
    },
    "breaks": {
      "type": "array",
      "description": "Break records taken during the shift.",
      "items": {
        "type": "object",
        "description": "A break taken during a time clock shift.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique break identifier."
          },
          "startedAt": {
            "type": "string",
            "format": "date-time",
            "description": "RFC 3339 timestamp when the break started."
          },
          "endedAt": {
            "type": "string",
            "format": "date-time",
            "description": "RFC 3339 timestamp when the break ended. May be null if the break is ongoing."
          },
          "kind": {
            "type": "string",
            "description": "Whether the break is paid or unpaid.",
            "enum": [
              "PAID",
              "UNPAID"
            ]
          }
        }
      }
    },
    "lastUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 timestamp of the last update."
    }
  }
}