Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Employer Benefits

Create an employer benefit

post/employer_benefits

Request body

work_assignment_idstring required

Must belong to a work assignment associated with an entity of type Employee.

business_preset_idstring
employer_benefit_type'accident_insurance_plan' | 'critical_illness' | 'debt_relief' | 'dental' | 'employee_assistance_program' | 'fondaction' | 'fondaction_rrsp' | 'fonds_solidarite_ftq' | 'fonds_solidarite_ftq_rrsp' | 'gift_near_cash' | 'gift_non_cash_non_taxable' | 'gift_non_cash_taxable' | 'group_dependent_life_insurance' | 'group_term_life_insurance' | 'health' | 'health_spending_account' | 'long_term_disability' | 'meals_subsidized_non_cash' | 'non_group_long_term_disability' | 'non_group_short_term_disability' | 'parking' | 'pension_dbpp' | 'pension_dcpp' | 'pension_mfpp' | 'pension_prpp' | 'pension_restricted_rrsp' | 'pension_rrsp' | 'pension_unregistered_prpp' | 'pension_vrsp' | 'professional_membership' | 'profit_sharing_dpsp' | 'savings_tfsa' | 'second_opinion_medical_consultation' | 'short_term_disability' | 'transit_pass' | 'transportation_to_from_work' | 'vehicle_employer_provided' | 'virtual_health_service' | 'wellness_spending_account'

The type of employer benefit, which determines how it is categorized and reported.

Must be present when business_preset_id is either empty or not set.

employee_benefit_idstring
frequency'once' | 'per_month' | 'per_payroll' required

The frequency at which this benefit is applied to Pay Stubs. When per_month, the amount is distributed across the selected Payrolls in the calendar month. per_month requires amount_type to be fixed.

amountnumber required

The contribution amount per pay period. When amount_type is percent, this is interpreted as a percentage of the income basis (0-100); otherwise as a fixed dollar amount.

amount_type'fixed' | 'percent' required

Whether amount is a fixed dollar value (fixed) or a percentage of the income basis (percent).

income_basis'all_earnings' | 'none' | 'regular_earnings' | 'total_income'

Determines the income used as the base for percentage-based benefit calculations. regular_earnings includes only salary and wage earnings. all_earnings includes all earnings. total_income includes all earnings, taxable allowances, and taxable reimbursements. none doesn't include any line items, and can be used with income_includes for completely custom definitions of income.

max_annual_contributionnumber

The maximum dollar amount that will be contributed in a calendar year. Contributions stop once this limit is reached.

max_annual_contribution_basis'all_line_items_of_type' | 'this_benefit'

Whether max_annual_contribution accumulates across pay periods or applies as a fixed per-period cap.

coverage_multipliernumber

A multiplier applied to the Employee's earnings to determine the benefit coverage amount, used for coverage-based benefits such as life insurance.

effective_fromstring date required

The date from which this benefit is applied to Pay Stubs.

effective_tostring date

The date after which this benefit is no longer applied. null if the benefit applies indefinitely.

apply_sales_taxboolean

Whether provincial sales tax is applied to the benefit amount.

remittance_account_idstring

The remittance account to which collected benefit amounts are remitted.

expense_accounting_code_idstring
liability_accounting_code_idstring
titlestring nullable
external_refstring
date_basis'by_pay_date' | 'by_period_end_date' | 'by_period_start_date'

Which payroll date determines the calendar month for the allocation. Applies only to per_month benefits.

pay_period_cadenceinteger[]

Which pay periods within the month receive the allocation. An array of 1-based positions; -1 is the final period. Applies only to per_month benefits.

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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