UKG · JSON Structure

Pro Hcm Personnel Change Request Structure

Request for a personnel action change

Type: object Properties: 7 Required: 3
Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

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

Properties

employeeId actionType effectiveDate reason newDepartmentId newJobTitle newPayRate

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-hcm-personnel-change-request-structure.json",
  "name": "PersonnelChangeRequest",
  "description": "Request for a personnel action change",
  "type": "object",
  "required": [
    "employeeId",
    "actionType",
    "effectiveDate"
  ],
  "properties": {
    "employeeId": {
      "type": "string",
      "description": "Employee identifier",
      "example": "EMP001"
    },
    "actionType": {
      "type": "string",
      "description": "Type of personnel action",
      "example": "Job Change",
      "enum": [
        "Job Change",
        "Pay Change",
        "Status Change",
        "Department Transfer",
        "Termination",
        "Leave of Absence"
      ]
    },
    "effectiveDate": {
      "type": "date",
      "description": "Effective date of the change",
      "example": "2026-06-01"
    },
    "reason": {
      "type": "string",
      "description": "Reason for the change",
      "example": "Promotion"
    },
    "newDepartmentId": {
      "type": "string",
      "description": "New department identifier (for transfers)",
      "example": "EMP001"
    },
    "newJobTitle": {
      "type": "string",
      "description": "New job title (for job changes)",
      "example": "example-value"
    },
    "newPayRate": {
      "type": "double",
      "description": "New pay rate amount (for pay changes)",
      "example": 1.0
    }
  }
}