Skip to main content
PUT
/
deductions
/
{deduction}
Update a deduction
curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/deductions/{deduction} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "frequency": "per_month",
  "deduction_type": "income_tax",
  "amount": "35",
  "amount_type": "fixed",
  "income_basis": "all_earnings",
  "income_statutory_withholdings": "none",
  "effective_from": "2026-01-01",
  "date_basis": "by_period_start_date",
  "pay_period_cadence": [
    1
  ]
}
'
import requests

url = "https://sandbox.nmbr.co/services/payroll/deductions/{deduction}"

payload = {
"frequency": "per_month",
"deduction_type": "income_tax",
"amount": "35",
"amount_type": "fixed",
"income_basis": "all_earnings",
"income_statutory_withholdings": "none",
"effective_from": "2026-01-01",
"date_basis": "by_period_start_date",
"pay_period_cadence": [1]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
frequency: 'per_month',
deduction_type: 'income_tax',
amount: '35',
amount_type: 'fixed',
income_basis: 'all_earnings',
income_statutory_withholdings: 'none',
effective_from: '2026-01-01',
date_basis: 'by_period_start_date',
pay_period_cadence: [1]
})
};

fetch('https://sandbox.nmbr.co/services/payroll/deductions/{deduction}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/deductions/{deduction}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'frequency' => 'per_month',
'deduction_type' => 'income_tax',
'amount' => '35',
'amount_type' => 'fixed',
'income_basis' => 'all_earnings',
'income_statutory_withholdings' => 'none',
'effective_from' => '2026-01-01',
'date_basis' => 'by_period_start_date',
'pay_period_cadence' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.nmbr.co/services/payroll/deductions/{deduction}"

payload := strings.NewReader("{\n \"frequency\": \"per_month\",\n \"deduction_type\": \"income_tax\",\n \"amount\": \"35\",\n \"amount_type\": \"fixed\",\n \"income_basis\": \"all_earnings\",\n \"income_statutory_withholdings\": \"none\",\n \"effective_from\": \"2026-01-01\",\n \"date_basis\": \"by_period_start_date\",\n \"pay_period_cadence\": [\n 1\n ]\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://sandbox.nmbr.co/services/payroll/deductions/{deduction}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"frequency\": \"per_month\",\n \"deduction_type\": \"income_tax\",\n \"amount\": \"35\",\n \"amount_type\": \"fixed\",\n \"income_basis\": \"all_earnings\",\n \"income_statutory_withholdings\": \"none\",\n \"effective_from\": \"2026-01-01\",\n \"date_basis\": \"by_period_start_date\",\n \"pay_period_cadence\": [\n 1\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/deductions/{deduction}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"frequency\": \"per_month\",\n \"deduction_type\": \"income_tax\",\n \"amount\": \"35\",\n \"amount_type\": \"fixed\",\n \"income_basis\": \"all_earnings\",\n \"income_statutory_withholdings\": \"none\",\n \"effective_from\": \"2026-01-01\",\n \"date_basis\": \"by_period_start_date\",\n \"pay_period_cadence\": [\n 1\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "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

Authorization
string
header
required

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

Path Parameters

deduction
string
required

Body

application/json
business_preset_id
string
frequency
enum<string>

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
deduction_type
enum<string>

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

Available options:
charitable_donation,
garnishment_order,
income_tax,
other_deduction,
union_dues,
union_dues_post_tax
remittance_account_id
string

The remittance account to which collected deduction amounts are remitted.

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.

Required range: x >= 0
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
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.

income_subtractions
object[]

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

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_from
string<date>

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

effective_to
string<date>

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

title
string | null
Maximum string length: 255
title_translations
object | null

Optional translations for the title property.

expense_accounting_code_id
string
liability_accounting_code_id
string
external_ref
string
Maximum string length: 255
tag_assignment
object
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

200 - application/json

OK

id
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