Sign in

v4

latestOpenAPI 3.0.02026-07-314441026.8 MB
Earnings

Update an earning

put/earnings/{earning}

Path parameters

earningstring required

Request body

business_preset_idstring
frequency'once' | 'per_month' | 'per_payroll'

The frequency at which this earning is applied to Pay Stubs. When per_month, the amount is distributed evenly across all Payrolls in the calendar month.

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' | 'vacation_pay' | 'vacation_pay_employee_terminated' | 'vacation_pay_no_time_taken' | 'vacation_pay_time_taken' | 'wage'

The type of earning, which determines how it is taxed.

amountnumber

The monetary amount applied each time this earning is included on a Pay Stub.

titlestring nullable
effective_fromstring date

The date from which this earning is applied to Pay Stubs.

effective_tostring date

The date after which this earning is no longer applied. null if the earning applies indefinitely.

expense_accounting_code_idstring
liability_accounting_code_idstring
external_refstring
date_basis'by_pay_date' | 'by_period_end_date' | 'by_period_start_date'

Which payroll date determines the calendar month for the allocation. Applies only to per_month recurrences.

pay_period_cadenceinteger[]

Which pay periods within the month receive the allocation. An array of 1-based positions; -1 is the final period. Applies only to per_month recurrences.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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