List employee benefit line items

Authorizations

Authorization

string

header

required

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

Query Parameters

pay_stub_id

string

Only return line items on the specified Pay Stub.

payroll_id

string

Only return line items on Pay Stubs on the specified Payroll.

payroll_status

enum<string>

Available options:

approved,

draft,

failed,

paid,

partially_paid,

processing

payroll_type

enum<string>

Available options:

correction,

historical,

off_cycle,

regular

payroll_period_start

object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payroll_period_start=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

gt (greater than)
gte (greater than or equal to)
lte (less than or equal to)
lt (less than) Example: payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31

payroll_period_end

object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payroll_period_end=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

gt (greater than)
gte (greater than or equal to)
lte (less than or equal to)
lt (less than) Example: payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31

payroll_pay_date

object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payroll_pay_date=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

gt (greater than)
gte (greater than or equal to)
lte (less than or equal to)
lt (less than) Example: payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31

pay_schedule_id

string

Only return line items on Pay Stubs on the specified Pay Schedule.

work_assignment_id

string

Only return line items on Pay Stubs for the specified Work Assignment.

employee_id

string

Only return line items on pay stubs for the specified Employee.

contractor_id

string

Only return line items on pay stubs for the specified Contractor.

business_entity_id

string

Only return line items on Pay Stubs under the specified Business Entity.

has_business_preset

boolean

business_preset_id

string

include_types

enum<string>

Only return line items with the specified types.

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

exclude_types

enum<string>

Only return line items without the specified types.

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

external_ref

string

expand

enum<string>[]

Available options:

business_preset,

custom_expense_accounting_code,

custom_liability_accounting_code,

custom_tag_assignment,

expense_accounting_code,

liability_accounting_code,

managed_expense_accounting_code,

managed_liability_accounting_code,

managed_tag_assignment,

pay_stub,

recurrence,

remittance_account,

source_adjustment,

tag_assignment,

tag_assignment_amounts

Response

200 - application/json

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.data

Default · object

Default
With pay_stub expanded
With recurrence expanded
With remittance_account expanded
With business_preset expanded
With source_adjustment expanded
With expense_accounting_code expanded
With managed_expense_accounting_code expanded
With custom_expense_accounting_code expanded
With liability_accounting_code expanded
With managed_liability_accounting_code expanded
With custom_liability_accounting_code expanded
With tag_assignment expanded
With managed_tag_assignment expanded
With custom_tag_assignment expanded
With tag_assignment_amounts expanded

Hide child attributes

data.data.pay_stub

object

Hide child attributes

data.data.pay_stub.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.pay_stub.object

string

read-only

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

data.data.line_item_type

string | null

data.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.data.amount

number<decimal> | null

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

data.data.custom_amount

number<decimal> | null

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

data.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.data.employee_benefit_type

object

The type of Employee Benefit for this line item.

Hide child attributes

data.data.employee_benefit_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.employee_benefit_type.object

string

read-only

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

data.data.employee_benefit_type.data

Employee Benefit Type · object

Hide child attributes

data.data.employee_benefit_type.data.type

string | null

The string identifier for this employee benefit type.

data.data.employee_benefit_type.data.label

string | null

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

data.data.recurrence

any

data.data.title

string | null

Maximum string length: 255

data.data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.data.title_translations.en

string

Maximum string length: 255

data.data.title_translations.fr

string

Maximum string length: 255

data.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.data.remittance_account_id

string | null

Maximum string length: 32

data.data.remittance_account

any

data.data.business_preset

any

data.data.source_adjustment

any

data.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.data.managed_expense_accounting_code

any

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

data.data.custom_expense_accounting_code

any

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

data.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.data.managed_liability_accounting_code

any

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

data.data.custom_liability_accounting_code

any

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

data.data.component_settings

object

Settings specific to the Nmbr component.

Hide child attributes

data.data.component_settings.attributes_locked

boolean

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

data.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.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

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