Sign in

v5

OpenAPI 3.0.02026-08-044441026.8 MB
Employer Benefit Line Items

Update an employer benefit line item

put/employer_benefit_line_items/{employer_benefit_line_item}

Path parameters

employer_benefit_line_itemstring required

Request body

business_preset_idstring

Writing may be blocked when entity is managed by a parent resource

Editing is prevented when is_editable is false

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 for this line item.

Writing may be blocked when entity is managed by a parent resource

Editing is prevented when is_editable is false

custom_amountnumber

An override for managed_amount. When set, amount reflects this value instead of managed_amount.

Editing is prevented when is_editable is false

accrued_vacation_paynumber

The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.

titlestring nullable

Writing may be blocked when entity is managed by a parent resource

Editing is prevented when is_editable is false

remittance_account_idstring

Writing may be blocked when entity is managed by a parent resource

Editing is prevented when is_editable is false

expense_accounting_code_idstring

Writing may be blocked when entity is managed by a parent resource

custom_expense_accounting_code_idstring
liability_accounting_code_idstring

Writing may be blocked when entity is managed by a parent resource

custom_liability_accounting_code_idstring
external_refstring

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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