UKG · JSON Structure

Pro Wfm Wfm Employee Structure

Employee record in WFM system

Type: object Properties: 8
Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

WfmEmployee is a JSON Structure definition published by UKG, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

employeeId firstName lastName badge homeLocationId jobCode workRule status

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-wfm-employee-structure.json",
  "name": "WfmEmployee",
  "description": "Employee record in WFM system",
  "type": "object",
  "properties": {
    "employeeId": {
      "type": "string",
      "description": "Employee identifier",
      "example": "EMP001"
    },
    "firstName": {
      "type": "string",
      "description": "First name",
      "example": "Jane"
    },
    "lastName": {
      "type": "string",
      "description": "Last name",
      "example": "Smith"
    },
    "badge": {
      "type": "string",
      "description": "Badge or punch number",
      "example": "12345"
    },
    "homeLocationId": {
      "type": "string",
      "description": "Home location identifier",
      "example": "LOC-NYC"
    },
    "jobCode": {
      "type": "string",
      "description": "Primary job code",
      "example": "CASHIER"
    },
    "workRule": {
      "type": "string",
      "description": "Pay rule for overtime and break calculations",
      "example": "Standard-40hr"
    },
    "status": {
      "type": "string",
      "description": "Employment status",
      "example": "Active"
    }
  }
}