Sign in

v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
hris
benefit

List all benefits

get/hris/{connection_id}/benefit

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

company_idstring

The company ID to filter by (reference to HrisCompany)

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
updated_atstring date-time
namestring
descriptionstring
company_idstring
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'
tax'PRE_TAX' | 'POST_TAX' | 'TAXABLE' | 'NON_TAXABLE' | 'TAX'
frequency'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK'
is_activeboolean
employer_contribution_type'PERCENTAGE' | 'FIXED'
employer_contribution_amountnumber
employer_contribution_max_amountnumber
coverage_level'EMPLOYEE_ONLY' | 'EMPLOYEE_SPOUSE' | 'EMPLOYEE_CHILD' | 'EMPLOYEE_CHILDREN' | 'EMPLOYEE_FAMILY' | 'FAMILY' | 'OTHER'
currencystring
rawobject