Unified.to · Schema

HrisBenefit

Company-wide benefit plans available to employees.

IntegrationsUnified API

Properties

Name Type Description
company_id string
coverage_level string
created_at string
currency string
description string
employer_contribution_amount number
employer_contribution_max_amount number
employer_contribution_type string
frequency string
id string
is_active boolean
name string
raw object
tax string
type string
updated_at string
View JSON Schema on GitHub

JSON Schema

unified-to-hrisbenefit-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HrisBenefit",
  "title": "HrisBenefit",
  "description": "Company-wide benefit plans available to employees.",
  "properties": {
    "company_id": {
      "type": "string"
    },
    "coverage_level": {
      "enum": [
        "EMPLOYEE_ONLY",
        "EMPLOYEE_SPOUSE",
        "EMPLOYEE_CHILD",
        "EMPLOYEE_CHILDREN",
        "EMPLOYEE_FAMILY",
        "FAMILY",
        "OTHER"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "employer_contribution_amount": {
      "type": "number"
    },
    "employer_contribution_max_amount": {
      "type": "number"
    },
    "employer_contribution_type": {
      "enum": [
        "PERCENTAGE",
        "FIXED"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "frequency": {
      "enum": [
        "ONE_TIME",
        "DAY",
        "QUARTER",
        "YEAR",
        "HOUR",
        "MONTH",
        "WEEK"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "id": {
      "type": "string"
    },
    "is_active": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    },
    "raw": {
      "additionalProperties": true,
      "type": "object"
    },
    "tax": {
      "enum": [
        "PRE_TAX",
        "POST_TAX",
        "TAXABLE",
        "NON_TAXABLE",
        "TAX"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "type": {
      "enum": [
        "RETIREMENT",
        "HEALTH",
        "DENTAL",
        "VISION",
        "LIFE",
        "HSA",
        "FSA",
        "SHORT_TERM_DISABILITY",
        "LONG_TERM_DISABILITY",
        "WORKERS_COMP",
        "HOUSING_STIPEND",
        "EMPLOYER_TAX_CONTRIBUTION",
        "GARNISHMENT",
        "LOAN_REPAYMENT",
        "CHARITABLE_CONTRIBUTION",
        "OTHER"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}