curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/deductions/{deduction} \
--header 'Authorization: Bearer <token>'{
"id": "<id>",
"object": "deduction",
"data": {
"work_assignment": {
"id": "<id>",
"object": "work_assignment",
"links": {
"self": "/work_assignments/<id>"
}
},
"frequency": "per_month",
"date_basis": "by_period_start_date",
"pay_period_cadence": [
1
],
"deduction_type": {
"id": "<id>",
"object": "deduction_type",
"data": {
"type": "income_tax",
"label": "Income tax debt",
"locale": "en"
},
"links": {
"self": "/deduction_types/income_tax"
}
},
"amount": 35,
"amount_type": "fixed",
"income_basis": "all_earnings",
"income_includes": [],
"income_subtractions": [],
"income_statutory_withholdings": "none",
"income_exemption_amount": null,
"income_exemption_percent": null,
"effective_from": "2026-01-01",
"effective_to": null,
"title": null,
"title_translations": null,
"title_translated": null,
"remittance_account": null,
"business_preset": null,
"expense_accounting_code": null,
"liability_accounting_code": null,
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/deductions/<id>"
}
}Retrieve a deduction
curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/deductions/{deduction} \
--header 'Authorization: Bearer <token>'{
"id": "<id>",
"object": "deduction",
"data": {
"work_assignment": {
"id": "<id>",
"object": "work_assignment",
"links": {
"self": "/work_assignments/<id>"
}
},
"frequency": "per_month",
"date_basis": "by_period_start_date",
"pay_period_cadence": [
1
],
"deduction_type": {
"id": "<id>",
"object": "deduction_type",
"data": {
"type": "income_tax",
"label": "Income tax debt",
"locale": "en"
},
"links": {
"self": "/deduction_types/income_tax"
}
},
"amount": 35,
"amount_type": "fixed",
"income_basis": "all_earnings",
"income_includes": [],
"income_subtractions": [],
"income_statutory_withholdings": "none",
"income_exemption_amount": null,
"income_exemption_percent": null,
"effective_from": "2026-01-01",
"effective_to": null,
"title": null,
"title_translations": null,
"title_translated": null,
"remittance_account": null,
"business_preset": null,
"expense_accounting_code": null,
"liability_accounting_code": null,
"external_ref": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/deductions/<id>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
business_preset, expense_accounting_code, liability_accounting_code, remittance_account, tag_assignment, work_assignment Response
OK
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("deduction").
- Default
- With work_assignment expanded
- With remittance_account expanded
- With business_preset expanded
- With expense_accounting_code expanded
- With liability_accounting_code expanded
- With tag_assignment expanded
Hide child attributes
Hide child attributes
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.
once, per_month, per_payroll Which payroll date determines the calendar month for the allocation. Applies only to fixed-amount per_month deductions.
by_pay_date, by_period_end_date, by_period_start_date 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.
The type of deduction, which determines how it is categorized and remitted.
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("deduction_type").
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.
Whether amount is a fixed dollar value (fixed) or a percentage of the income basis (percentage).
fixed, fixed_per_hour, percent 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.
all_earnings, none, regular_earnings, total_income 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.
An optional list of deductions and benefits to subtract from the income before the deduction amount is calculated.
Whether to subtract statutory withholdings (CPP, EI, income tax) from the income before the deduction amount is calculated.
all, none A fixed dollar amount to exempt from the income before calculating the deduction.
A percentage of the income to exempt before calculating the deduction amount.
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.
255The 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.
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.
255The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.