UKG · JSON Structure

Pro Hcm Benefits Election Structure

Employee benefits enrollment information

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

BenefitsElection 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 planId planName benefitType enrollmentStatus coverageTier employeeContribution effectiveDate

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-benefits-election-structure.json",
  "name": "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": "double",
      "description": "Employee contribution amount per pay period",
      "example": 1.0
    },
    "effectiveDate": {
      "type": "date",
      "description": "Coverage effective date",
      "example": "2026-01-15"
    }
  }
}