hris
benefit

Retrieve a benefit

Changed on
get/hris/{connection_id}/benefit/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/benefit/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Benefit

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

e.g. "401(k) Plan"

descriptionstring

e.g. "Company 401(k) retirement plan"

company_idstring

(reference to HrisCompany)

type'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' | 'RETIREMENT_ROTH' | 'COMMUTER' | 'DEPENDENT_CARE' | 'PENSION'
tax'PRE_TAX' | 'POST_TAX' | 'TAXABLE' | 'NON_TAXABLE' | 'TAX'

Tax describes the tax treatment of the benefit

frequency'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'

Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).

is_activeboolean
employer_contribution_type'PERCENTAGE' | 'FIXED'
employer_contribution_amountnumber

percentage or money

employer_contribution_max_amountnumber

always money

coverage_level'EMPLOYEE_ONLY' | 'EMPLOYEE_SPOUSE' | 'EMPLOYEE_CHILD' | 'EMPLOYEE_CHILDREN' | 'EMPLOYEE_FAMILY' | 'FAMILY' | 'OTHER'
currencystring
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 07678e2ad542Revision changes
    • warning

      added the new BIWEEKLY enum value to the response property for the response status

    • warning

      added the new COMMUTER enum value to the response property for the response status

    • warning

      added the new DEPENDENT_CARE enum value to the response property for the response status

    • warning

      added the new PENSION enum value to the response property for the response status

    • warning

      added the new RETIREMENT_ROTH enum value to the response property for the response status

    • warning

      added the new SEMIMONTHLY enum value to the response property for the response status