Skip to main content
POST
Create an employer benefit line item

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
pay_stub_id
string
required
business_preset_id
string
employer_benefit_type
enum<string>

The type of Employer Benefit for this line item.

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

Available options:
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
custom_amount
number<decimal>

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

Required range: x <= 99999
accrued_vacation_pay
number<decimal>

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

Required range: 0 <= x <= 99999
title
string | null
Maximum string length: 255
title_translations
object | null

Optional translations for the title property.

remittance_account_id
string
expense_accounting_code_id
string
custom_expense_accounting_code_id
string
liability_accounting_code_id
string
custom_liability_accounting_code_id
string
component_settings
object
external_ref
string
Maximum string length: 255
custom_tag_assignment
object

Response

201 - application/json

Created

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

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

data
Employer Benefit Line Item · object