Update a statutory withholding line item

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/statutory_withholding_line_items/{statutory_withholding_line_item} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_preset_id": "<id>",
  "statutory_withholding_type": "federal_income_tax",
  "title": "Federal Income Tax",
  "title_translations": {
    "en": "Federal Income Tax",
    "fr": "Impôt fédéral"
  },
  "remittance_account_id": "<id>"
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/statutory_withholding_line_items/{statutory_withholding_line_item}"

payload = {
    "business_preset_id": "<id>",
    "statutory_withholding_type": "federal_income_tax",
    "title": "Federal Income Tax",
    "title_translations": {
        "en": "Federal Income Tax",
        "fr": "Impôt fédéral"
    },
    "remittance_account_id": "<id>"
}
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({
    business_preset_id: '<id>',
    statutory_withholding_type: 'federal_income_tax',
    title: 'Federal Income Tax',
    title_translations: {en: 'Federal Income Tax', fr: 'Impôt fédéral'},
    remittance_account_id: '<id>'
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/statutory_withholding_line_items/{statutory_withholding_line_item}', 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/statutory_withholding_line_items/{statutory_withholding_line_item}",
  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([
    'business_preset_id' => '<id>',
    'statutory_withholding_type' => 'federal_income_tax',
    'title' => 'Federal Income Tax',
    'title_translations' => [
        'en' => 'Federal Income Tax',
        'fr' => 'Impôt fédéral'
    ],
    'remittance_account_id' => '<id>'
  ]),
  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/statutory_withholding_line_items/{statutory_withholding_line_item}"

	payload := strings.NewReader("{\n  \"business_preset_id\": \"<id>\",\n  \"statutory_withholding_type\": \"federal_income_tax\",\n  \"title\": \"Federal Income Tax\",\n  \"title_translations\": {\n    \"en\": \"Federal Income Tax\",\n    \"fr\": \"Impôt fédéral\"\n  },\n  \"remittance_account_id\": \"<id>\"\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/statutory_withholding_line_items/{statutory_withholding_line_item}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_preset_id\": \"<id>\",\n  \"statutory_withholding_type\": \"federal_income_tax\",\n  \"title\": \"Federal Income Tax\",\n  \"title_translations\": {\n    \"en\": \"Federal Income Tax\",\n    \"fr\": \"Impôt fédéral\"\n  },\n  \"remittance_account_id\": \"<id>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"business_preset_id\": \"<id>\",\n  \"statutory_withholding_type\": \"federal_income_tax\",\n  \"title\": \"Federal Income Tax\",\n  \"title_translations\": {\n    \"en\": \"Federal Income Tax\",\n    \"fr\": \"Impôt fédéral\"\n  },\n  \"remittance_account_id\": \"<id>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<id>",
  "object": "statutory_withholding_line_item",
  "data": {
    "pay_stub": {
      "id": "<id>",
      "object": "pay_stub",
      "links": {
        "self": "/pay_stubs/<id>"
      }
    },
    "line_item_type": "statutory_withholding",
    "is_system": true,
    "is_managed": true,
    "amount": 500,
    "custom_amount": null,
    "managed_amount": 500,
    "statutory_withholding_type": {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "federal_income_tax",
        "label": "Federal Income Tax"
      },
      "links": {
        "self": "/statutory_withholding_types/federal_income_tax"
      }
    },
    "title": "Federal Income Tax",
    "title_translations": {
      "en": "Federal Income Tax",
      "fr": "Impôt fédéral"
    },
    "title_translated": "Federal Income Tax",
    "remittance_account": {
      "id": "<id>",
      "object": "remittance_account",
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    "source_adjustment": null,
    "business_preset": {
      "id": "<id>",
      "object": "business_preset",
      "links": {
        "self": "/business_presets/<id>"
      }
    },
    "expense_accounting_code": null,
    "managed_expense_accounting_code": null,
    "custom_expense_accounting_code": null,
    "liability_accounting_code": null,
    "managed_liability_accounting_code": null,
    "custom_liability_accounting_code": null,
    "component_settings": {
      "attributes_locked": false
    },
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/statutory_withholding_line_items/<id>"
  }
}

PUT

statutory_withholding_line_items

{statutory_withholding_line_item}

Update a statutory withholding line item

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/statutory_withholding_line_items/{statutory_withholding_line_item} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_preset_id": "<id>",
  "statutory_withholding_type": "federal_income_tax",
  "title": "Federal Income Tax",
  "title_translations": {
    "en": "Federal Income Tax",
    "fr": "Impôt fédéral"
  },
  "remittance_account_id": "<id>"
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/statutory_withholding_line_items/{statutory_withholding_line_item}"

payload = {
    "business_preset_id": "<id>",
    "statutory_withholding_type": "federal_income_tax",
    "title": "Federal Income Tax",
    "title_translations": {
        "en": "Federal Income Tax",
        "fr": "Impôt fédéral"
    },
    "remittance_account_id": "<id>"
}
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({
    business_preset_id: '<id>',
    statutory_withholding_type: 'federal_income_tax',
    title: 'Federal Income Tax',
    title_translations: {en: 'Federal Income Tax', fr: 'Impôt fédéral'},
    remittance_account_id: '<id>'
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/statutory_withholding_line_items/{statutory_withholding_line_item}', 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/statutory_withholding_line_items/{statutory_withholding_line_item}",
  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([
    'business_preset_id' => '<id>',
    'statutory_withholding_type' => 'federal_income_tax',
    'title' => 'Federal Income Tax',
    'title_translations' => [
        'en' => 'Federal Income Tax',
        'fr' => 'Impôt fédéral'
    ],
    'remittance_account_id' => '<id>'
  ]),
  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/statutory_withholding_line_items/{statutory_withholding_line_item}"

	payload := strings.NewReader("{\n  \"business_preset_id\": \"<id>\",\n  \"statutory_withholding_type\": \"federal_income_tax\",\n  \"title\": \"Federal Income Tax\",\n  \"title_translations\": {\n    \"en\": \"Federal Income Tax\",\n    \"fr\": \"Impôt fédéral\"\n  },\n  \"remittance_account_id\": \"<id>\"\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/statutory_withholding_line_items/{statutory_withholding_line_item}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_preset_id\": \"<id>\",\n  \"statutory_withholding_type\": \"federal_income_tax\",\n  \"title\": \"Federal Income Tax\",\n  \"title_translations\": {\n    \"en\": \"Federal Income Tax\",\n    \"fr\": \"Impôt fédéral\"\n  },\n  \"remittance_account_id\": \"<id>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"business_preset_id\": \"<id>\",\n  \"statutory_withholding_type\": \"federal_income_tax\",\n  \"title\": \"Federal Income Tax\",\n  \"title_translations\": {\n    \"en\": \"Federal Income Tax\",\n    \"fr\": \"Impôt fédéral\"\n  },\n  \"remittance_account_id\": \"<id>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<id>",
  "object": "statutory_withholding_line_item",
  "data": {
    "pay_stub": {
      "id": "<id>",
      "object": "pay_stub",
      "links": {
        "self": "/pay_stubs/<id>"
      }
    },
    "line_item_type": "statutory_withholding",
    "is_system": true,
    "is_managed": true,
    "amount": 500,
    "custom_amount": null,
    "managed_amount": 500,
    "statutory_withholding_type": {
      "id": "<id>",
      "object": "statutory_withholding_type",
      "data": {
        "type": "federal_income_tax",
        "label": "Federal Income Tax"
      },
      "links": {
        "self": "/statutory_withholding_types/federal_income_tax"
      }
    },
    "title": "Federal Income Tax",
    "title_translations": {
      "en": "Federal Income Tax",
      "fr": "Impôt fédéral"
    },
    "title_translated": "Federal Income Tax",
    "remittance_account": {
      "id": "<id>",
      "object": "remittance_account",
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    "source_adjustment": null,
    "business_preset": {
      "id": "<id>",
      "object": "business_preset",
      "links": {
        "self": "/business_presets/<id>"
      }
    },
    "expense_accounting_code": null,
    "managed_expense_accounting_code": null,
    "custom_expense_accounting_code": null,
    "liability_accounting_code": null,
    "managed_liability_accounting_code": null,
    "custom_liability_accounting_code": null,
    "component_settings": {
      "attributes_locked": false
    },
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/statutory_withholding_line_items/<id>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

statutory_withholding_line_item

string

required

Body

application/json

business_preset_id

string

Editing is prevented when is_editable is false

statutory_withholding_type

enum<string>

The type of statutory withholding for this line item.

Editing is prevented when is_editable is false

Available options:

cpp,

cpp_2,

ei,

federal_income_tax,

provincial_income_tax,

qpip,

qpp,

qpp_2,

territorial_income_tax

custom_amount

number<decimal>

An override for managed_amount. When set, amount reflects this value instead of managed_amount.

Editing is prevented when is_editable is false

Required range: x <= 999999

title

string | null

Editing is prevented when is_editable is false

Maximum string length: 255

title_translations

object | null

Optional translations for the title property.

Editing is prevented when is_editable is false

Hide child attributes

title_translations.en

string

Maximum string length: 255

title_translations.fr

string

Maximum string length: 255

remittance_account_id

string

Editing is prevented when is_editable is false

expense_accounting_code_id

string

Editing is prevented when is_editable is false

custom_expense_accounting_code_id

string

Editing is prevented when is_editable is false

liability_accounting_code_id

string

Editing is prevented when is_editable is false

custom_liability_accounting_code_id

string

Editing is prevented when is_editable is false

external_ref

string

Maximum string length: 255

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Statutory Withholding Line Item · object

Hide child attributes

data.pay_stub

object

Hide child attributes

data.pay_stub.id

string

read-only

The unique identifier of the object in Nmbr.

data.pay_stub.object

string

read-only

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

data.line_item_type

string | null

data.is_system

boolean

Whether this line item was generated automatically by the payroll engine. System line items cannot be deleted.

data.is_managed

boolean

Always true. Statutory withholding line items are fully managed by the payroll engine and cannot be created, updated, or deleted.

data.amount

number<decimal> | null

The effective amount for this line item. Returns custom_amount if set, otherwise managed_amount. Read-only.

data.custom_amount

number<decimal> | null

An override for managed_amount. When set, amount reflects this value instead of managed_amount.

data.managed_amount

number<decimal>

The withholding amount calculated by the payroll engine. Read-only; set custom_amount to override.

data.statutory_withholding_type

object

The type of statutory withholding for this line item.

Hide child attributes

data.statutory_withholding_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.statutory_withholding_type.object

string

read-only

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

data.statutory_withholding_type.data

Statutory Withholding Type · object

Hide child attributes

data.statutory_withholding_type.data.type

string | null

The string identifier for this employee statutory withholding type.

data.statutory_withholding_type.data.label

string | null

The human-readable display name for this employee statutory withholding type.

data.title

string | null

Maximum string length: 255

data.title_translations

object | null

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

object

Hide child attributes

data.remittance_account.id

string

read-only

The unique identifier of the object in Nmbr.

data.remittance_account.object

string

read-only

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

data.source_adjustment

any

data.business_preset

object

Hide child attributes

data.business_preset.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_preset.object

string

read-only

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

data.expense_accounting_code

any

The effective expense accounting code. Returns the user-set value if present, otherwise the system-derived value. Writes to this field set the user override.

data.managed_expense_accounting_code

any

The expense accounting code derived by the system from accounting code rules and presets. Read-only.

data.custom_expense_accounting_code

any

User-set expense accounting code that overrides the system-derived value.

data.liability_accounting_code

any

The effective liability accounting code. Returns the user-set value if present, otherwise the system-derived value. Writes to this field set the user override.

data.managed_liability_accounting_code

any

The liability accounting code derived by the system from accounting code rules and presets. Read-only.

data.custom_liability_accounting_code

any

User-set liability accounting code that overrides the system-derived value.

data.component_settings

object | null

Settings specific to the Nmbr component.

Hide child attributes

data.component_settings.attributes_locked

boolean

Whether the line item is locked and cannot be edited in the component.

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.

Retrieve a statutory withholding line item Delete a statutory withholding line item

⌘I

Overview

Bulk & Batch Operations

Partner

Companies

Employees

Contractors

Payrolls

Line Items

Banking

Reporting

Forms

Vacation Pay

Lookups

Calculations

Miscellaneous

Update a statutory withholding line item

Authorizations

Path Parameters

Body

Response