Workday Benefits · Schema

Benefit Enrollment

An employee benefit enrollment election

Properties

Name Type Description
id string Unique enrollment identifier
employeeId string Employee identifier
planId string Benefit plan identifier
coverageLevel string Coverage level selected
effectiveDate string Enrollment effective date
endDate string Enrollment end date
status string Enrollment status
employeePremium number Employee monthly premium amount
currency string Currency code
dependentIds array List of enrolled dependent IDs
View JSON Schema on GitHub

JSON Schema

workday-benefits-benefit-enrollment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-benefits/refs/heads/main/json-schema/workday-benefits-benefit-enrollment-schema.json",
  "title": "Benefit Enrollment",
  "description": "An employee benefit enrollment election",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique enrollment identifier"
    },
    "employeeId": {
      "type": "string",
      "description": "Employee identifier"
    },
    "planId": {
      "type": "string",
      "description": "Benefit plan identifier"
    },
    "coverageLevel": {
      "type": "string",
      "enum": [
        "EMPLOYEE_ONLY",
        "EMPLOYEE_PLUS_SPOUSE",
        "EMPLOYEE_PLUS_CHILDREN",
        "EMPLOYEE_PLUS_FAMILY"
      ],
      "description": "Coverage level selected"
    },
    "effectiveDate": {
      "type": "string",
      "format": "date",
      "description": "Enrollment effective date"
    },
    "endDate": {
      "type": "string",
      "format": "date",
      "description": "Enrollment end date"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "PENDING",
        "CANCELLED",
        "WAIVED"
      ],
      "description": "Enrollment status"
    },
    "employeePremium": {
      "type": "number",
      "description": "Employee monthly premium amount"
    },
    "currency": {
      "type": "string",
      "description": "Currency code"
    },
    "dependentIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of enrolled dependent IDs"
    }
  },
  "required": [
    "id",
    "employeeId",
    "planId",
    "coverageLevel",
    "effectiveDate",
    "status"
  ]
}