Create an employee 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

employee_benefit_type

enum<string>

The type of Employee 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,

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

custom_amount

number<decimal>

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

Required range: x <= 99999

title

string | null

Maximum string length: 255

title_translations

object

Optional translations for the title property.

Hide child attributes

title_translations.en

string

Maximum string length: 255

title_translations.fr

string

Maximum string length: 255

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

Hide child attributes

component_settings.attributes_locked

boolean

external_ref

string

Maximum string length: 255

custom_tag_assignment

object

Hide child attributes

custom_tag_assignment.unit

enum<string>

Available options:

amount,

percentage

custom_tag_assignment.is_component_locked

boolean

custom_tag_assignment.tag_allocations

object[]

Hide child attributes

custom_tag_assignment.tag_allocations.tags

string[]

custom_tag_assignment.tag_allocations.value

number<decimal>

Required range: x >= 0

Response

201 - application/json

Created

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Employee Benefit Line Item · object

Hide child attributes

data.pay_stub

object

Hide child attributes

data.pay_stub.id

string

read-only

The unique identifier of the object in Nmbr.

data.pay_stub.object

string

read-only

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

data.line_item_type

string | null

data.is_managed

boolean

Whether this line item was generated by an Employee Benefit recurrence and calculated automatically. When true, only custom_amount can be modified and the line item cannot be deleted.

data.amount

number<decimal> | null

The effective amount for this line item. Returns custom_amount if set, otherwise managed_amount. Read-only.

data.custom_amount

number<decimal> | null

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

data.managed_amount

number<decimal> | null

The amount calculated by the system or set by the linked Employee Benefit recurrence. Read-only; set custom_amount to override.

data.employee_benefit_type

object

The type of Employee Benefit for this line item.

Hide child attributes

data.employee_benefit_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.employee_benefit_type.object

string

read-only

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

data.employee_benefit_type.data

Employee Benefit Type · object

Hide child attributes

data.employee_benefit_type.data.type

string | null

The string identifier for this employee benefit type.

data.employee_benefit_type.data.label

string | null

The human-readable display name for this employee benefit type.

data.recurrence

any

data.title

string | null

Maximum string length: 255

data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.title_translations.en

string

Maximum string length: 255

data.title_translations.fr

string

Maximum string length: 255

data.title_translated

string

read-only

The translation of the title property for the request locale. Computed using the values in title and title_translations and the value of the request's Accept-Language header.

data.remittance_account_id

string | null

Maximum string length: 32

data.remittance_account

any

data.business_preset

any

data.source_adjustment

any

data.expense_accounting_code

any

The effective expense accounting code. Returns the user-set value if present, otherwise the system-derived value. Writes to this field set the user override.

data.managed_expense_accounting_code

any

The expense accounting code derived by the system from accounting code rules and presets. Read-only.

data.custom_expense_accounting_code

any

User-set expense accounting code that overrides the system-derived value.

data.liability_accounting_code

any

The effective liability accounting code. Returns the user-set value if present, otherwise the system-derived value. Writes to this field set the user override.

data.managed_liability_accounting_code

any

The liability accounting code derived by the system from accounting code rules and presets. Read-only.

data.custom_liability_accounting_code

any

User-set liability accounting code that overrides the system-derived value.

data.component_settings

object

Settings specific to the Nmbr component.

Hide child attributes

data.component_settings.attributes_locked

boolean

Whether the line item is locked and cannot be edited in the component.

data.external_ref

string | null

A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.

Maximum string length: 255

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.