Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Deductions

Create a deduction

post/deductions

Request body

work_assignment_idstring required

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

business_preset_idstring
deduction_type'charitable_donation' | 'garnishment_order' | 'income_tax' | 'other_deduction' | 'union_dues' | 'union_dues_post_tax'

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.

titlestring nullable
frequency'once' | 'per_month' | 'per_payroll' 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.

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

amount_type'fixed' | 'fixed_per_hour' | 'percent' required

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

income_basis'all_earnings' | 'none' | 'regular_earnings' | 'total_income'

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.

income_statutory_withholdings'all' | 'none'

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

income_exemption_amountnumber

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

income_exemption_percentnumber

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

effective_fromstring date required

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

effective_tostring date

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

remittance_account_idstring

The remittance account to which collected deduction amounts are remitted.

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

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

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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