UKG · JSON Structure

Pro Wfm Punch Request Structure

Request to create a clock punch

Type: object Properties: 4 Required: 2
Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

PunchRequest is a JSON Structure definition published by UKG, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

punchTime punchType locationId jobCode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ukg/refs/heads/main/json-structure/pro-wfm-punch-request-structure.json",
  "name": "PunchRequest",
  "description": "Request to create a clock punch",
  "type": "object",
  "required": [
    "punchTime",
    "punchType"
  ],
  "properties": {
    "punchTime": {
      "type": "datetime",
      "description": "Punch timestamp",
      "example": "2026-01-15T09:00:00Z"
    },
    "punchType": {
      "type": "string",
      "description": "Type of punch",
      "example": "In",
      "enum": [
        "In",
        "Out",
        "Transfer"
      ]
    },
    "locationId": {
      "type": "string",
      "description": "Location identifier",
      "example": "EMP001"
    },
    "jobCode": {
      "type": "string",
      "description": "Job code for this punch",
      "example": "example-value"
    }
  }
}