Update an earning

Authorizations

Authorization

string

header

required

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

Path Parameters

earning

string

required

Body

application/json

business_preset_id

string

frequency

enum<string>

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.

Available options:

once,

per_month,

per_payroll

earning_type

enum<string>

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

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_domestic_and_sexual_violence,

leave_general,

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,

vacation_pay,

vacation_pay_employee_terminated,

vacation_pay_no_time_taken,

vacation_pay_time_taken,

wage

amount

number<decimal>

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

Required range: 0 <= x <= 9999

title

string | null

Maximum string length: 255

title_translations

object

Optional translations for the title property.

Hide child attributes

title_translations.en

string

Maximum string length: 255

title_translations.fr

string

Maximum string length: 255

effective_from

string<date>

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

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

Hide child attributes

tag_assignment.unit

enum<string>

Available options:

percentage

tag_assignment.is_component_locked

boolean

tag_assignment.tag_allocations

object[]

Hide child attributes

tag_assignment.tag_allocations.tags

string[]

tag_assignment.tag_allocations.value

number<decimal>

Required range: x >= 0

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

200 - application/json

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

Hide child attributes

data.work_assignment

object

Hide child attributes

data.work_assignment.id

string

read-only

The unique identifier of the object in Nmbr.

data.work_assignment.object

string

read-only

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

data.earning_type

object

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

Hide child attributes

data.earning_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.earning_type.object

string

read-only

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

data.earning_type.data

Earning Type · object

Hide child attributes

data.earning_type.data.type

string | null

The string identifier for this earning type.

data.earning_type.data.label

string | null

The human-readable display name for this earning type.

data.earning_type.data.supported_payroll_types

object

A map of Payroll types to whether this earning type is available on that Payroll type.

Hide child attributes

data.earning_type.data.supported_payroll_types.regular

boolean

data.earning_type.data.supported_payroll_types.historical

boolean

data.earning_type.data.supported_payroll_types.off_cycle

boolean

data.title

string | null

Maximum string length: 255

data.title_translations

object

Optional translations for the title property.

Hide child attributes

data.title_translations.en

string

Maximum string length: 255

data.title_translations.fr

string

Maximum string length: 255

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

number<decimal>

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

data.frequency

enum<string>

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.

Available options:

once,

per_month,

per_payroll

data.date_basis

enum<string> | null

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

data.pay_period_cadence

object

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.

data.effective_from

string<date>

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

data.effective_to

string<date> | null

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

data.business_preset

any

data.expense_accounting_code

any

data.liability_accounting_code

any

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

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

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