UKG · Schema

Punch

Clock punch record

Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

Properties

Name	Type	Description
punchId	string	Punch identifier
employeeId	string	Employee identifier
punchTime	string	Punch date and time
punchType	string	Type of punch
locationId	string	Location where punch occurred
jobCode	string	Job code for this punch

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ukg/refs/heads/main/json-schema/pro-wfm-punch-schema.json",
  "title": "Punch",
  "description": "Clock punch record",
  "type": "object",
  "properties": {
    "punchId": {
      "type": "string",
      "description": "Punch identifier",
      "example": "EMP001"
    },
    "employeeId": {
      "type": "string",
      "description": "Employee identifier",
      "example": "EMP001"
    },
    "punchTime": {
      "type": "string",
      "format": "date-time",
      "description": "Punch date and time",
      "example": "2026-01-15T09:00:00Z"
    },
    "punchType": {
      "type": "string",
      "description": "Type of punch",
      "example": "In",
      "enum": [
        "In",
        "Out",
        "Transfer",
        "Meal Start",
        "Meal End"
      ]
    },
    "locationId": {
      "type": "string",
      "description": "Location where punch occurred",
      "example": "EMP001"
    },
    "jobCode": {
      "type": "string",
      "description": "Job code for this punch",
      "example": "example-value"
    }
  }
}