Create a deduction

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

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.

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.

The deduction amount per occurrence. When amount_type is percent, this is interpreted as a percentage of the income basis. When fixed_per_hour, it is multiplied by the hours on the Pay Stub's earning line items selected by hours_basis and hours_includes. Otherwise it is a fixed dollar amount.

Up to 2 decimal places.

Whether amount is a fixed dollar value (fixed), a dollar value per hour worked (fixed_per_hour), or a percentage of the income basis (percent).

Which earnings' hours a fixed_per_hour deduction multiplies amount by. all_earnings includes the hours on all earnings. regular_earnings includes only the hours on salary and wage earnings. none doesn't include any earnings, and can be used with hours_includes to count only the hours on specific earnings. Defaults to all_earnings, and can only be changed when amount_type is fixed_per_hour.

The most this deduction will ever deduct, such as the balance owed on a loan or advance. Once the amounts it deducted on approved payrolls reach this maximum, it stops deducting, and the Pay Stub that reaches it deducts only the remainder. Amounts repaid before the deduction was created aren't counted, so set it to the balance still owed when creating the deduction. Changing it later changes the total, not the remaining balance: amounts already deducted still count toward it. null if there is no maximum.

Up to 2 decimal places.

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.

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

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

Up to 2 decimal places.

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

Up to 2 decimal places.

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

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

The remittance account to which collected deduction amounts are remitted.

Which payroll date determines the calendar month for the allocation. Applies only to fixed-amount per_month deductions.

The unique identifier of the object in Nmbr.

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