Sign in

v4

OpenAPI 3.0.02026-07-314441026.8 MB
Employee Benefits

List employee benefits

get/employee_benefits

Query parameters

business_entity_idstring
pay_schedule_idstring
work_assignment_idstring
employee_idstring
has_business_presetboolean
business_preset_idstring
'accident_insurance_plan' | 'critical_illness' | 'debt_relief' | 'dental' | 'employee_assistance_program' | 'fondaction' | 'fondaction_rrsp' | 'fonds_solidarite_ftq' | 'fonds_solidarite_ftq_rrsp' | 'group_dependent_life_insurance' | 'group_term_life_insurance' | 'health' | 'health_spending_account' | 'long_term_disability' | 'non_group_long_term_disability' | 'non_group_short_term_disability' | 'pension_dbpp' | 'pension_dcpp' | 'pension_mfpp' | 'pension_prpp' | 'pension_restricted_rrsp' | 'pension_rrsp' | 'pension_rrsp_non_periodic' | 'pension_unregistered_prpp' | 'pension_vrsp' | 'profit_sharing_dpsp' | 'savings_tfsa' | 'second_opinion_medical_consultation' | 'short_term_disability' | 'virtual_health_service' | 'wellness_spending_account'
OR
string[]
'accident_insurance_plan' | 'critical_illness' | 'debt_relief' | 'dental' | 'employee_assistance_program' | 'fondaction' | 'fondaction_rrsp' | 'fonds_solidarite_ftq' | 'fonds_solidarite_ftq_rrsp' | 'group_dependent_life_insurance' | 'group_term_life_insurance' | 'health' | 'health_spending_account' | 'long_term_disability' | 'non_group_long_term_disability' | 'non_group_short_term_disability' | 'pension_dbpp' | 'pension_dcpp' | 'pension_mfpp' | 'pension_prpp' | 'pension_restricted_rrsp' | 'pension_rrsp' | 'pension_rrsp_non_periodic' | 'pension_unregistered_prpp' | 'pension_vrsp' | 'profit_sharing_dpsp' | 'savings_tfsa' | 'second_opinion_medical_consultation' | 'short_term_disability' | 'virtual_health_service' | 'wellness_spending_account'
OR
string[]
effective_onstring date
not_effective_onstring date
effective_fromobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_from=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31
effective_toobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_to=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31
external_refstring
search_payee_namesstring
sort'effective_from' | 'effective_to' | 'work_assignment.payee.default' | 'work_assignment.payee.first_name' | 'work_assignment.payee.last_name'

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

tag_idstring
tag_group_idstring
expandstring[]

Response

OK

objectstring

The type of the object in Nmbr ("list").