employer_benefit_type'accident_insurance_plan' | 'board_and_lodging_insurable' | 'board_and_lodging_non_insurable' | '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.
remittance_account_idstring
The remittance account to which collected benefit amounts are remitted.
amountnumber
The contribution amount per pay period. When amount_type is percent, this is interpreted as a percentage of the income basis (0-100). When fixed_per_hour, it is multiplied by the hours on the Pay Stub's earning line items selected by hours_basis and hours_includes. Otherwise it is a fixed dollar amount.
Up to 2 decimal places.
amount_type'fixed' | 'fixed_per_hour' | 'percent'
Whether amount is a fixed dollar value (fixed), a dollar value per hour worked (fixed_per_hour), or a percentage of the income basis (percent).
hours_basis'all_earnings' | 'none' | 'regular_earnings'
Which earnings' hours a fixed_per_hour benefit multiplies amount by. all_earnings includes the hours on all earnings. regular_earnings includes only the hours on salary and wage earnings. none doesn't include any earnings, and can be used with hours_includes to count only the hours on specific earnings. Defaults to all_earnings, and can only be changed when amount_type is fixed_per_hour.
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.
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.
Up to 2 decimal places.
max_annual_contributionnumber
The most this benefit will contribute in a tax year, including sales tax when apply_sales_tax is true. Once the contributions on approved payrolls in the tax year reach this maximum, contributions stop until the next tax year, and the Pay Stub that reaches it contributes only the remainder. Changing it later changes the limit, not the remaining amount: contributions already made in the tax year still count toward it.
Up to 2 decimal places.
max_annual_contribution_basis'all_line_items_of_type' | 'this_benefit'
Which earlier contributions count toward max_annual_contribution. this_benefit counts only the contributions on line items created by this benefit earlier in the tax year. all_line_items_of_type counts every contribution of the same type on the Work Assignment earlier in the tax year, including those created by other benefits and those added directly to a Pay Stub.
frequency'once' | 'per_month' | 'per_payroll'
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.
effective_fromstring date
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.
expense_accounting_code_idstring
liability_accounting_code_idstring
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.