Benefit Plan

A Workday benefit plan including health, dental, vision, life, or retirement benefits

Properties

Name	Type	Description
id	string	Unique benefit plan identifier
name	string	Benefit plan name
type	string	Type of benefit plan
carrier	string	Insurance carrier or plan provider name
status	string	Plan status
effectiveDate	string	Plan effective date
endDate	string	Plan end date
employeePremium	number	Employee monthly premium cost
employerContribution	number	Employer monthly contribution amount
currency	string	Currency code
description	string	Plan description

View JSON Schema on GitHub

JSON Schema

{
  "$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-plan-schema.json",
  "title": "Benefit Plan",
  "description": "A Workday benefit plan including health, dental, vision, life, or retirement benefits",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique benefit plan identifier"
    },
    "name": {
      "type": "string",
      "description": "Benefit plan name"
    },
    "type": {
      "type": "string",
      "enum": [
        "HEALTH",
        "DENTAL",
        "VISION",
        "LIFE",
        "RETIREMENT",
        "DISABILITY",
        "FSA",
        "HSA"
      ],
      "description": "Type of benefit plan"
    },
    "carrier": {
      "type": "string",
      "description": "Insurance carrier or plan provider name"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE",
        "PENDING"
      ],
      "description": "Plan status"
    },
    "effectiveDate": {
      "type": "string",
      "format": "date",
      "description": "Plan effective date"
    },
    "endDate": {
      "type": "string",
      "format": "date",
      "description": "Plan end date"
    },
    "employeePremium": {
      "type": "number",
      "description": "Employee monthly premium cost"
    },
    "employerContribution": {
      "type": "number",
      "description": "Employer monthly contribution amount"
    },
    "currency": {
      "type": "string",
      "description": "Currency code"
    },
    "description": {
      "type": "string",
      "description": "Plan description"
    }
  },
  "required": [
    "id",
    "name",
    "type",
    "status",
    "effectiveDate"
  ]
}