Workday Benefits · JSON Structure

Workday Benefits Benefit Plan Structure

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

Type: object Properties: 11 Required: 5

Workday Benefits Benefit Plan Structure is a JSON Structure definition published by Workday Benefits, describing 11 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id name type carrier status effectiveDate endDate employeePremium employerContribution currency description

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-benefits/refs/heads/main/json-structure/workday-benefits-benefit-plan-structure.json",
  "title": "Benefit Plan",
  "description": "A Workday benefit plan including health, dental, vision, life, or retirement benefits",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique benefit plan identifier",
      "type": "string"
    },
    "name": {
      "description": "Benefit plan name",
      "type": "string"
    },
    "type": {
      "description": "Type of benefit plan",
      "type": "string",
      "enum": [
        "HEALTH",
        "DENTAL",
        "VISION",
        "LIFE",
        "RETIREMENT",
        "DISABILITY",
        "FSA",
        "HSA"
      ]
    },
    "carrier": {
      "description": "Insurance carrier or plan provider name",
      "type": "string"
    },
    "status": {
      "description": "Plan status",
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE",
        "PENDING"
      ]
    },
    "effectiveDate": {
      "description": "Plan effective date",
      "type": "date"
    },
    "endDate": {
      "description": "Plan end date",
      "type": "date"
    },
    "employeePremium": {
      "description": "Employee monthly premium cost",
      "type": "double"
    },
    "employerContribution": {
      "description": "Employer monthly contribution amount",
      "type": "double"
    },
    "currency": {
      "description": "Currency code",
      "type": "string"
    },
    "description": {
      "description": "Plan description",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "type",
    "status",
    "effectiveDate"
  ]
}