Skip to main content
POST
Create an earning

Authorizations

Authorization
string
header
required

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

Body

application/json
work_assignment_id
string
required
amount
number<decimal>
required

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

Required range: 0 <= x <= 9999
frequency
enum<string>
required

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.

The frequency that the earning is added to an Employees PayStub.

Available options:
once,
per_month,
per_payroll
effective_from
string<date>
required

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

business_preset_id
string
earning_type
enum<string>

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

Must be present when business_preset_id is either empty or not set.

Available options:
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
title
string | null
Maximum string length: 255
title_translations
object | null

Optional translations for the title property.

effective_to
string<date>

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

expense_accounting_code_id
string
liability_accounting_code_id
string
external_ref
string
Maximum string length: 255
tag_assignment
object
date_basis
enum<string>

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

Available options:
by_pay_date,
by_period_end_date,
by_period_start_date
pay_period_cadence
integer[]

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.

Minimum array length: 1

Response

201 - application/json

Created

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

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

data
Earning · object