NMnmbr
Earning Line Items

Update an earning line item

Changed on

Earning Line Items on non-draft Pay Stubs will not be able to update attributes.

Any Earning Line Item with is_managed set to true will only be able to update custom_amount and custom_hours

put/earning_line_items/{earning_line_item}

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Path parameters

earning_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

earning_type'bonus_discretionary' | 'bonus_non_discretionary' | 'bonus_non_taxable' | 'commission' | 'commission_periodic' | 'commission_self_employed' | 'death_benefit' | 'gift_cash' | 'gratuity' | 'in_lieu_wages' | 'income_replacement_indemnity_non_taxable' | 'income_replacement_indemnity_taxable' | 'invoice_payment' | 'invoice_sales_tax' | 'leave_bereavement' | 'leave_citizenship' | 'leave_domestic_and_sexual_violence' | 'leave_general' | 'leave_jury_duty' | 'leave_maternity' | 'leave_organ_donor' | 'leave_parental' | 'leave_paternity' | 'leave_personal' | 'leave_sick' | 'leave_sick_discretionary' | 'leave_unpaid' | 'leave_voting' | 'leave_wedding' | 'overtime' | 'parental_top_up_insurable' | 'parental_top_up_non_insurable' | 'pension' | 'retiring_allowance' | 'retiring_allowance_eligible' | 'retroactive_pay' | 'retroactive_pay_increase' | 'salary' | 'salary_continuance' | 'severance_pay' | 'statutory_holiday_pay' | 'supplemental_unemployment' | 'time_off_in_lieu' | 'time_off_in_lieu_overtime' | 'tips_allocated' | 'tips_controlled' | 'tips_direct' | 'vacation_accrual_adjustment' | 'vacation_pay' | 'vacation_pay_employee_terminated' | 'vacation_pay_no_time_taken' | 'vacation_pay_time_taken' | 'wage'

The type of earning for this line item.

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

Editing is prevented when is_editable is false

pay_rate_idstring

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

Editing is prevented when is_editable is false

overtime_rate_idstring

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

Up to 2 decimal places.

custom_hoursnumber

An override for managed_hours. When set, hours reflects this value instead of managed_hours. Can be used to prorate the dollar amount on salary line items.

Editing is prevented when is_editable is false

Up to 2 decimal places.

custom_ratenumber

The hourly rate this line item is paid at when it isn't paid under a Pay Rate. managed_amount is calculated as hours x custom_rate, or with custom_rate_multiplier, hours x (custom_rate x custom_rate_multiplier, rounded to the cent), the same way a Pay Rate and Overtime Rate calculate it. The pay stub shows this rate (with its multiplier applied) in the rate column. A line item has either a Pay Rate (and optionally an Overtime Rate) or a custom_rate, not both.

Accepted on the earning types that accept a pay_rate_id and have an amount. Rejected while the line item has a pay_rate_id or overtime_rate_id: to switch, send them as null in the same request. To switch back, send custom_rate and custom_rate_multiplier as null.

Editing is prevented when is_editable is false

Up to 2 decimal places.

custom_rate_multipliernumber

A multiplier applied to custom_rate on overtime line items, such as 1.5. The pay stub shows it alongside the rate.

Accepted on overtime and time_off_in_lieu_overtime line items with a custom_rate.

Editing is prevented when is_editable is false

Up to 3 decimal places.

accrued_vacation_paynumber

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

Up to 2 decimal places.

titlestring nullable

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

Editing is prevented when is_editable is false

expense_accounting_code_idstring

Editing is prevented when is_editable is false

custom_expense_accounting_code_idstring

Editing is prevented when is_editable is false

liability_accounting_code_idstring

Editing is prevented when is_editable is false

custom_liability_accounting_code_idstring

Editing is prevented when is_editable is false

custom_earned_onstring date

Editing is prevented when is_editable is false

external_refstring

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

  • 394112d11e70Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 80c1694d9e87Revision changes
    • info

      added the new tips_allocated enum value to the request property