Update a remittance account

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "CRA Payroll Account - Main",
  "account_identifier": "123456789RP0002",
  "remitter_type": "accelerated_threshold_1",
  "remittance_management": "automatic",
  "note": "Updated main payroll remittance account",
  "address_line_1": "555 MacKenzie Ave",
  "city": "Ottawa",
  "administrative_area": "ON",
  "country_code": "CA",
  "postal_code": "K1A 0L5"
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account}"

payload = {
    "label": "CRA Payroll Account - Main",
    "account_identifier": "123456789RP0002",
    "remitter_type": "accelerated_threshold_1",
    "remittance_management": "automatic",
    "note": "Updated main payroll remittance account",
    "address_line_1": "555 MacKenzie Ave",
    "city": "Ottawa",
    "administrative_area": "ON",
    "country_code": "CA",
    "postal_code": "K1A 0L5"
}
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({
    label: 'CRA Payroll Account - Main',
    account_identifier: '123456789RP0002',
    remitter_type: 'accelerated_threshold_1',
    remittance_management: 'automatic',
    note: 'Updated main payroll remittance account',
    address_line_1: '555 MacKenzie Ave',
    city: 'Ottawa',
    administrative_area: 'ON',
    country_code: 'CA',
    postal_code: 'K1A 0L5'
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account}', 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/remittance_accounts/{remittance_account}",
  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([
    'label' => 'CRA Payroll Account - Main',
    'account_identifier' => '123456789RP0002',
    'remitter_type' => 'accelerated_threshold_1',
    'remittance_management' => 'automatic',
    'note' => 'Updated main payroll remittance account',
    'address_line_1' => '555 MacKenzie Ave',
    'city' => 'Ottawa',
    'administrative_area' => 'ON',
    'country_code' => 'CA',
    'postal_code' => 'K1A 0L5'
  ]),
  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/remittance_accounts/{remittance_account}"

	payload := strings.NewReader("{\n  \"label\": \"CRA Payroll Account - Main\",\n  \"account_identifier\": \"123456789RP0002\",\n  \"remitter_type\": \"accelerated_threshold_1\",\n  \"remittance_management\": \"automatic\",\n  \"note\": \"Updated main payroll remittance account\",\n  \"address_line_1\": \"555 MacKenzie Ave\",\n  \"city\": \"Ottawa\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"K1A 0L5\"\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/remittance_accounts/{remittance_account}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"CRA Payroll Account - Main\",\n  \"account_identifier\": \"123456789RP0002\",\n  \"remitter_type\": \"accelerated_threshold_1\",\n  \"remittance_management\": \"automatic\",\n  \"note\": \"Updated main payroll remittance account\",\n  \"address_line_1\": \"555 MacKenzie Ave\",\n  \"city\": \"Ottawa\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"K1A 0L5\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"label\": \"CRA Payroll Account - Main\",\n  \"account_identifier\": \"123456789RP0002\",\n  \"remitter_type\": \"accelerated_threshold_1\",\n  \"remittance_management\": \"automatic\",\n  \"note\": \"Updated main payroll remittance account\",\n  \"address_line_1\": \"555 MacKenzie Ave\",\n  \"city\": \"Ottawa\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"K1A 0L5\"\n}"

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

{
  "id": "<id>",
  "object": "remittance_account",
  "data": {
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "source_tax_property": {
      "id": "<id>",
      "object": "tax_property",
      "links": {
        "self": "/tax_properties/<id>"
      }
    },
    "account_provider": "ca_cra",
    "is_default": false,
    "is_editable": true,
    "is_deletable": true,
    "linked_remittance_account": null,
    "category": "ca_tax_agency",
    "label": "CRA Payroll Account - Main",
    "label_translations": null,
    "label_translated": "CRA Payroll Account - Main",
    "account_identifier": "123456789RP0002",
    "superseded_by": null,
    "superseded_on": null,
    "remitter_type": "accelerated_threshold_1",
    "remittance_management": "automatic",
    "note": "Updated main payroll remittance account",
    "address_line_1": "555 MacKenzie Ave",
    "address_line_2": null,
    "city": "Ottawa",
    "administrative_area": "ON",
    "province_code": "ON",
    "country_code": "CA",
    "postal_code": "K1A 0L5",
    "has_payments": false,
    "current_enrollments_count": 0,
    "pending_enrollments_count": 0,
    "metadata": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/remittance_accounts/<id>"
  }
}

PUT

remittance_accounts

{remittance_account}

Update a remittance account

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "CRA Payroll Account - Main",
  "account_identifier": "123456789RP0002",
  "remitter_type": "accelerated_threshold_1",
  "remittance_management": "automatic",
  "note": "Updated main payroll remittance account",
  "address_line_1": "555 MacKenzie Ave",
  "city": "Ottawa",
  "administrative_area": "ON",
  "country_code": "CA",
  "postal_code": "K1A 0L5"
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account}"

payload = {
    "label": "CRA Payroll Account - Main",
    "account_identifier": "123456789RP0002",
    "remitter_type": "accelerated_threshold_1",
    "remittance_management": "automatic",
    "note": "Updated main payroll remittance account",
    "address_line_1": "555 MacKenzie Ave",
    "city": "Ottawa",
    "administrative_area": "ON",
    "country_code": "CA",
    "postal_code": "K1A 0L5"
}
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({
    label: 'CRA Payroll Account - Main',
    account_identifier: '123456789RP0002',
    remitter_type: 'accelerated_threshold_1',
    remittance_management: 'automatic',
    note: 'Updated main payroll remittance account',
    address_line_1: '555 MacKenzie Ave',
    city: 'Ottawa',
    administrative_area: 'ON',
    country_code: 'CA',
    postal_code: 'K1A 0L5'
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account}', 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/remittance_accounts/{remittance_account}",
  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([
    'label' => 'CRA Payroll Account - Main',
    'account_identifier' => '123456789RP0002',
    'remitter_type' => 'accelerated_threshold_1',
    'remittance_management' => 'automatic',
    'note' => 'Updated main payroll remittance account',
    'address_line_1' => '555 MacKenzie Ave',
    'city' => 'Ottawa',
    'administrative_area' => 'ON',
    'country_code' => 'CA',
    'postal_code' => 'K1A 0L5'
  ]),
  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/remittance_accounts/{remittance_account}"

	payload := strings.NewReader("{\n  \"label\": \"CRA Payroll Account - Main\",\n  \"account_identifier\": \"123456789RP0002\",\n  \"remitter_type\": \"accelerated_threshold_1\",\n  \"remittance_management\": \"automatic\",\n  \"note\": \"Updated main payroll remittance account\",\n  \"address_line_1\": \"555 MacKenzie Ave\",\n  \"city\": \"Ottawa\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"K1A 0L5\"\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/remittance_accounts/{remittance_account}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"CRA Payroll Account - Main\",\n  \"account_identifier\": \"123456789RP0002\",\n  \"remitter_type\": \"accelerated_threshold_1\",\n  \"remittance_management\": \"automatic\",\n  \"note\": \"Updated main payroll remittance account\",\n  \"address_line_1\": \"555 MacKenzie Ave\",\n  \"city\": \"Ottawa\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"K1A 0L5\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"label\": \"CRA Payroll Account - Main\",\n  \"account_identifier\": \"123456789RP0002\",\n  \"remitter_type\": \"accelerated_threshold_1\",\n  \"remittance_management\": \"automatic\",\n  \"note\": \"Updated main payroll remittance account\",\n  \"address_line_1\": \"555 MacKenzie Ave\",\n  \"city\": \"Ottawa\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"K1A 0L5\"\n}"

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

{
  "id": "<id>",
  "object": "remittance_account",
  "data": {
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "source_tax_property": {
      "id": "<id>",
      "object": "tax_property",
      "links": {
        "self": "/tax_properties/<id>"
      }
    },
    "account_provider": "ca_cra",
    "is_default": false,
    "is_editable": true,
    "is_deletable": true,
    "linked_remittance_account": null,
    "category": "ca_tax_agency",
    "label": "CRA Payroll Account - Main",
    "label_translations": null,
    "label_translated": "CRA Payroll Account - Main",
    "account_identifier": "123456789RP0002",
    "superseded_by": null,
    "superseded_on": null,
    "remitter_type": "accelerated_threshold_1",
    "remittance_management": "automatic",
    "note": "Updated main payroll remittance account",
    "address_line_1": "555 MacKenzie Ave",
    "address_line_2": null,
    "city": "Ottawa",
    "administrative_area": "ON",
    "province_code": "ON",
    "country_code": "CA",
    "postal_code": "K1A 0L5",
    "has_payments": false,
    "current_enrollments_count": 0,
    "pending_enrollments_count": 0,
    "metadata": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/remittance_accounts/<id>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

remittance_account

string

required

Body

application/json

is_default

boolean

superseding_remittance_account_id

string

The account that replaces this one after a business-number change or correction. With superseded_on set, employees enrolled in this account are enrolled in the successor from the changeover date onward, and a work assignment created afterwards is enrolled in whichever account covers each part of its dates. Without a date, the replacement is recorded and enrollments are left as they are. Clearing the value, or the date, also leaves enrollments as they are. Only one account in a line of accounts can have a replacement waiting to take effect at a time.

May be set without superseded_on, in which case no enrollments are moved.

superseded_on

string<date>

The date this account was replaced by its successor, from which its enrolled employees move to the superseding account. Optional: left unset, the successor is recorded and no enrollments are moved. Must be today or later, and later than the most recent pay date already paid through this account.

Requires superseding_remittance_account_id; a date without a superseding account is rejected.

linked_remittance_account_id

string

The id of a CRA remittance account in the same business entity whose enrollments this account should follow. When set, work assignments enrolled in that CRA account are automatically enrolled in this account with matching effective dates, and manual enrollments on this account become unavailable. Only a Revenue Québec account may be linked, and only to a CRA account. An account that is the default for its authority cannot be linked; set is_default to false in the same request to link it. Clearing the value releases the generated enrollments, which stay in place and become editable and deletable again.

account_provider

string

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 ("remittance_account").

data

Remittance Account · object

Hide child attributes

data.business_entity

object

Hide child attributes

data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_entity.object

string

read-only

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

data.source_tax_property

object

Hide child attributes

data.source_tax_property.id

string

read-only

The unique identifier of the object in Nmbr.

data.source_tax_property.object

string

read-only

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

data.account_provider

enum<string> | null

The authority to which remittances are made for this account. This is used to determine how to remit payments for this account. Employer Health Tax (EHT) and Workers' Compensation (WCB) authorities are limited to one account, per province, per business entity; creating a second for an authority that already has one is rejected.

Available options:

ca_ab_workers_compensation,

ca_bc_eht,

ca_bc_workers_compensation,

ca_cra,

ca_mb_eht,

ca_mb_workers_compensation,

ca_nb_workers_compensation,

ca_nl_eht,

ca_nl_workers_compensation,

ca_ns_workers_compensation,

ca_nt_government,

ca_nt_workers_compensation,

ca_nu_government,

ca_nu_workers_compensation,

ca_on_eht,

ca_on_workers_compensation,

ca_pe_workers_compensation,

ca_rq,

ca_sk_workers_compensation,

ca_yt_workers_compensation

data.is_default

boolean

When true, this account is used for auto-enrollment of new work-assignments, and work-assignments without an existing enrollment for this authority. Only one account per authority per business may be the default at a time.

data.is_editable

boolean

When false, the account's account_identifier cannot be updated. Becomes false once the account is used on a non-draft payroll and an account_identifier is set; returns to true when every referencing payroll is reverted to draft or deleted.

data.is_deletable

boolean

When false, the account cannot be deleted. Becomes false once the account is referenced by any non-draft payroll; returns to true when every referencing payroll is reverted to draft or deleted.

data.linked_remittance_account

any

The CRA remittance account whose enrollments this account follows, when it is a linked account; otherwise null.

data.category

enum<string> | null

Available options:

ca_benefit_provider,

ca_provincial_government,

ca_tax_agency,

ca_union,

ca_workers_compensation

data.label

string

Maximum string length: 255

data.label_translations

object | null

Optional translations for the label property.

Hide child attributes

data.label_translations.en

string

Maximum string length: 255

data.label_translations.fr

string

Maximum string length: 255

data.label_translated

string

read-only

The translation of the label property for the request locale. Computed using the values in label and label_translations and the value of the request's Accept-Language header.

data.account_identifier

string | null

Maximum string length: 255

data.superseded_by

any

The account that has replaced this one, set when this account's business number was changed or corrected and a successor account took over. Null when no successor has been recorded.

data.superseded_on

string<date> | null

The date this account was replaced by its successor. Null when no successor has been recorded.

data.remitter_type

enum<string> | null

The CRA remitter type for this account, which determines remittance due dates and reporting frequency. When null, falls back to the business entity's remitter type.

Available options:

accelerated_threshold_1,

accelerated_threshold_2,

quarterly,

regular

data.remittance_management

enum<string>

Whether remittances for this account are filed manually by the employer (manual) or handled automatically by Nmbr (automatic). Only accounts Nmbr can remit on your behalf (CRA, RQ, and Employer Health Tax authorities) may be set to automatic; all others are always manual.

Available options:

automatic,

manual

data.note

string | null

data.address_line_1

string | null

Maximum string length: 255

data.address_line_2

string | null

Maximum string length: 255

data.city

string | null

Maximum string length: 255

data.administrative_area

string | null

Maximum string length: 255

data.province_code

string | null

data.country_code

string | null

Maximum string length: 2

data.postal_code

string | null

Maximum string length: 10

data.has_payments

boolean

data.current_enrollments_count

number<decimal> | null

data.pending_enrollments_count

number<decimal> | null

data.metadata

Workers’ compensation · object

Additional data points for this account. The available fields depend on the account's category; null for categories that capture no metadata.

Workers’ compensation
Other categories

Hide child attributes

data.metadata.last_payment_amount

string<decimal> | null

The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. "1250.00").

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.

Overview

Bulk & Batch Operations

Partner

Companies

Employees

Contractors

Payrolls

Line Items

Banking

Reporting

Forms

Vacation Pay

Lookups

Calculations

Miscellaneous

Update a remittance account

Authorizations

Path Parameters

Body

Response