UKG · Schema

BenefitsElection

Employee benefits enrollment information

Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

Properties

Name	Type	Description
employeeId	string	Employee identifier
planId	string	Benefits plan identifier
planName	string	Benefits plan name
benefitType	string	Type of benefit
enrollmentStatus	string	Enrollment status
coverageTier	string	Coverage tier
employeeContribution	number	Employee contribution amount per pay period
effectiveDate	string	Coverage effective date

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-hcm-benefits-election-schema.json",
  "title": "BenefitsElection",
  "description": "Employee benefits enrollment information",
  "type": "object",
  "properties": {
    "employeeId": {
      "type": "string",
      "description": "Employee identifier",
      "example": "EMP001"
    },
    "planId": {
      "type": "string",
      "description": "Benefits plan identifier",
      "example": "PLAN-MED-001"
    },
    "planName": {
      "type": "string",
      "description": "Benefits plan name",
      "example": "Medical Plan - PPO"
    },
    "benefitType": {
      "type": "string",
      "description": "Type of benefit",
      "example": "Medical",
      "enum": [
        "Medical",
        "Dental",
        "Vision",
        "Life",
        "Disability",
        "401k",
        "HSA",
        "FSA"
      ]
    },
    "enrollmentStatus": {
      "type": "string",
      "description": "Enrollment status",
      "example": "Active",
      "enum": [
        "Active",
        "Waived",
        "Terminated"
      ]
    },
    "coverageTier": {
      "type": "string",
      "description": "Coverage tier",
      "example": "Employee + Spouse"
    },
    "employeeContribution": {
      "type": "number",
      "format": "double",
      "description": "Employee contribution amount per pay period",
      "example": 1.0
    },
    "effectiveDate": {
      "type": "string",
      "format": "date",
      "description": "Coverage effective date",
      "example": "2026-01-15"
    }
  }
}