UKG · Schema

WfmEmployee

Employee record in WFM system

Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

Properties

Name Type Description
employeeId string Employee identifier
firstName string First name
lastName string Last name
badge string Badge or punch number
homeLocationId string Home location identifier
jobCode string Primary job code
workRule string Pay rule for overtime and break calculations
status string Employment status
View JSON Schema on GitHub

JSON Schema

pro-wfm-wfm-employee-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ukg/refs/heads/main/json-schema/pro-wfm-wfm-employee-schema.json",
  "title": "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"
    }
  }
}