Create a deduction

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

Must belong to a work assignment associated with an entity of type Employee.

frequency

enum<string>

required

The frequency at which this deduction is applied to Pay Stubs. When per_month, the amount is distributed across selected Payrolls in the calendar month. per_month is only valid when amount_type is fixed; percent and per-hour deductions apply to every paycheque regardless of frequency.

Available options:

once,

per_month,

per_payroll

amount

number<decimal>

required

The deduction amount per occurrence. When amount_type is percentage, this is interpreted as a percentage of the income basis rather than a fixed dollar amount.

Required range: x >= 0

amount_type

enum<string>

required

Whether amount is a fixed dollar value (fixed) or a percentage of the income basis (percentage).

Available options:

fixed,

fixed_per_hour,

percent

effective_from

string<date>

required

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

business_preset_id

string

deduction_type

enum<string>

The type of deduction, which determines how it is categorized and remitted.

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

Available options:

charitable_donation,

garnishment_order,

income_tax,

other_deduction,

union_dues,

union_dues_post_tax

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

income_basis

enum<string>

Determines the income used as the base for percentage-based deductions. regular_earnings includes only salary and wage earnings. all_earnings includes all earnings. total_income includes all earnings, taxable allowances, and taxable reimbursements. none doesn't include any line items, and can be used with income_includes for completely custom definitions of income.

Available options:

all_earnings,

none,

regular_earnings,

total_income

income_includes

object[]

An optional list of specific earnings, allowances, and other line item types to include in the income calculation in addition to those included via income_basis.

Hide child attributes

income_includes.type

enum<string>

Available options:

allowance,

earning,

employer_benefit,

reimbursement

income_includes.subtype

string

income_subtractions

object[]

An optional list of deductions and benefits to subtract from the income before the deduction amount is calculated.

Hide child attributes

income_subtractions.type

enum<string>

Available options:

deduction,

employee_benefit

income_subtractions.subtype

string

income_statutory_withholdings

enum<string>

Whether to subtract statutory withholdings (CPP, EI, income tax) from the income before the deduction amount is calculated.

Available options:

all,

none

income_exemption_amount

number<decimal>

A fixed dollar amount to exempt from the income before calculating the deduction.

Required range: 0 <= x <= 99999

income_exemption_percent

number<decimal>

A percentage of the income to exempt before calculating the deduction amount.

Required range: 0 <= x <= 100

effective_to

string<date>

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

remittance_account_id

string

The remittance account to which collected deduction amounts are remitted.

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 fixed-amount per_month deductions.

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 fixed-amount per_month deductions.

Minimum array length: 1

Response

201 - application/json

Created

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Deduction · 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.frequency

enum<string>

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 fixed-amount per_month deductions.

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 fixed-amount per_month deductions.

data.deduction_type

object

The type of deduction, which determines how it is categorized and remitted.

Hide child attributes

data.deduction_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.deduction_type.object

string

read-only

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

data.deduction_type.data

Deduction Type · object

Hide child attributes

data.deduction_type.data.type

string | null

The string identifier for this deduction type.

data.deduction_type.data.label

string | null

The human-readable display name for this deduction type.

data.deduction_type.data.locale

string | null

data.amount

number<decimal>

The deduction amount per occurrence. When amount_type is percentage, this is interpreted as a percentage of the income basis rather than a fixed dollar amount.

data.amount_type

enum<string>

Whether amount is a fixed dollar value (fixed) or a percentage of the income basis (percentage).

Available options:

fixed,

fixed_per_hour,

percent

data.income_basis

enum<string>

Available options:

all_earnings,

none,

regular_earnings,

total_income

data.income_includes

object

An optional list of specific earnings, allowances, and other line item types to include in the income calculation in addition to those included via income_basis.

data.income_subtractions

object

An optional list of deductions and benefits to subtract from the income before the deduction amount is calculated.

data.income_statutory_withholdings

enum<string>

Whether to subtract statutory withholdings (CPP, EI, income tax) from the income before the deduction amount is calculated.

Available options:

all,

none

data.income_exemption_amount

number<decimal> | null

A fixed dollar amount to exempt from the income before calculating the deduction.

data.income_exemption_percent

number<decimal> | null

A percentage of the income to exempt before calculating the deduction amount.

data.effective_from

string<date>

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

data.effective_to

string<date> | null

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

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

any

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.