v5

latestOpenAPI 3.0.02026-08-044441026.8 MB

Earning Line Items

Update an earning line item

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}

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_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' | 'unpaid_leave' | '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

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

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

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").