Create a remittance account
curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/remittance_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"business_entity_id": "<string>",
"label": "<string>",
"linked_remittance_account_id": "<string>",
"label_translations": {
"en": "<string>",
"fr": "<string>"
},
"addressee": "<string>",
"account_identifier": "<string>",
"is_default": true,
"note": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"province_code": "<string>",
"country_code": "<string>",
"postal_code": "<string>",
"metadata": {
"last_payment_amount": "<string>"
},
"tax_properties": [
{
"value": "<string>",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25",
"note": "<string>",
"owner_id": "<string>"
}
]
}
'import requests
url = "https://sandbox.nmbr.co/services/payroll/remittance_accounts"
payload = {
"business_entity_id": "<string>",
"label": "<string>",
"linked_remittance_account_id": "<string>",
"label_translations": {
"en": "<string>",
"fr": "<string>"
},
"addressee": "<string>",
"account_identifier": "<string>",
"is_default": True,
"note": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"province_code": "<string>",
"country_code": "<string>",
"postal_code": "<string>",
"metadata": { "last_payment_amount": "<string>" },
"tax_properties": [
{
"value": "<string>",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25",
"note": "<string>",
"owner_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
business_entity_id: '<string>',
label: '<string>',
linked_remittance_account_id: '<string>',
label_translations: {en: '<string>', fr: '<string>'},
addressee: '<string>',
account_identifier: '<string>',
is_default: true,
note: '<string>',
address_line_1: '<string>',
address_line_2: '<string>',
city: '<string>',
administrative_area: '<string>',
province_code: '<string>',
country_code: '<string>',
postal_code: '<string>',
metadata: {last_payment_amount: '<string>'},
tax_properties: [
{
value: '<string>',
effective_from: '2023-12-25',
effective_to: '2023-12-25',
note: '<string>',
owner_id: '<string>'
}
]
})
};
fetch('https://sandbox.nmbr.co/services/payroll/remittance_accounts', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'business_entity_id' => '<string>',
'label' => '<string>',
'linked_remittance_account_id' => '<string>',
'label_translations' => [
'en' => '<string>',
'fr' => '<string>'
],
'addressee' => '<string>',
'account_identifier' => '<string>',
'is_default' => true,
'note' => '<string>',
'address_line_1' => '<string>',
'address_line_2' => '<string>',
'city' => '<string>',
'administrative_area' => '<string>',
'province_code' => '<string>',
'country_code' => '<string>',
'postal_code' => '<string>',
'metadata' => [
'last_payment_amount' => '<string>'
],
'tax_properties' => [
[
'value' => '<string>',
'effective_from' => '2023-12-25',
'effective_to' => '2023-12-25',
'note' => '<string>',
'owner_id' => '<string>'
]
]
]),
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"
payload := strings.NewReader("{\n \"business_entity_id\": \"<string>\",\n \"label\": \"<string>\",\n \"linked_remittance_account_id\": \"<string>\",\n \"label_translations\": {\n \"en\": \"<string>\",\n \"fr\": \"<string>\"\n },\n \"addressee\": \"<string>\",\n \"account_identifier\": \"<string>\",\n \"is_default\": true,\n \"note\": \"<string>\",\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"administrative_area\": \"<string>\",\n \"province_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"metadata\": {\n \"last_payment_amount\": \"<string>\"\n },\n \"tax_properties\": [\n {\n \"value\": \"<string>\",\n \"effective_from\": \"2023-12-25\",\n \"effective_to\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"owner_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.nmbr.co/services/payroll/remittance_accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"business_entity_id\": \"<string>\",\n \"label\": \"<string>\",\n \"linked_remittance_account_id\": \"<string>\",\n \"label_translations\": {\n \"en\": \"<string>\",\n \"fr\": \"<string>\"\n },\n \"addressee\": \"<string>\",\n \"account_identifier\": \"<string>\",\n \"is_default\": true,\n \"note\": \"<string>\",\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"administrative_area\": \"<string>\",\n \"province_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"metadata\": {\n \"last_payment_amount\": \"<string>\"\n },\n \"tax_properties\": [\n {\n \"value\": \"<string>\",\n \"effective_from\": \"2023-12-25\",\n \"effective_to\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"owner_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.nmbr.co/services/payroll/remittance_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_entity_id\": \"<string>\",\n \"label\": \"<string>\",\n \"linked_remittance_account_id\": \"<string>\",\n \"label_translations\": {\n \"en\": \"<string>\",\n \"fr\": \"<string>\"\n },\n \"addressee\": \"<string>\",\n \"account_identifier\": \"<string>\",\n \"is_default\": true,\n \"note\": \"<string>\",\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"administrative_area\": \"<string>\",\n \"province_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"metadata\": {\n \"last_payment_amount\": \"<string>\"\n },\n \"tax_properties\": [\n {\n \"value\": \"<string>\",\n \"effective_from\": \"2023-12-25\",\n \"effective_to\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"owner_id\": \"<string>\"\n }\n ]\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": true,
"is_editable": true,
"is_deletable": true,
"linked_remittance_account": null,
"category": "ca_tax_agency",
"label": "CRA Payroll Account",
"label_translations": null,
"label_translated": "CRA Payroll Account",
"addressee": null,
"account_identifier": "123456789RP0001",
"superseded_by": null,
"superseded_on": null,
"remitter_type": "regular",
"remittance_management": "automatic",
"note": "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>"
}
}Remittance Accounts
Create a remittance account
POST
/
remittance_accounts
Create a remittance account
curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/remittance_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"business_entity_id": "<string>",
"label": "<string>",
"linked_remittance_account_id": "<string>",
"label_translations": {
"en": "<string>",
"fr": "<string>"
},
"addressee": "<string>",
"account_identifier": "<string>",
"is_default": true,
"note": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"province_code": "<string>",
"country_code": "<string>",
"postal_code": "<string>",
"metadata": {
"last_payment_amount": "<string>"
},
"tax_properties": [
{
"value": "<string>",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25",
"note": "<string>",
"owner_id": "<string>"
}
]
}
'import requests
url = "https://sandbox.nmbr.co/services/payroll/remittance_accounts"
payload = {
"business_entity_id": "<string>",
"label": "<string>",
"linked_remittance_account_id": "<string>",
"label_translations": {
"en": "<string>",
"fr": "<string>"
},
"addressee": "<string>",
"account_identifier": "<string>",
"is_default": True,
"note": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"province_code": "<string>",
"country_code": "<string>",
"postal_code": "<string>",
"metadata": { "last_payment_amount": "<string>" },
"tax_properties": [
{
"value": "<string>",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25",
"note": "<string>",
"owner_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
business_entity_id: '<string>',
label: '<string>',
linked_remittance_account_id: '<string>',
label_translations: {en: '<string>', fr: '<string>'},
addressee: '<string>',
account_identifier: '<string>',
is_default: true,
note: '<string>',
address_line_1: '<string>',
address_line_2: '<string>',
city: '<string>',
administrative_area: '<string>',
province_code: '<string>',
country_code: '<string>',
postal_code: '<string>',
metadata: {last_payment_amount: '<string>'},
tax_properties: [
{
value: '<string>',
effective_from: '2023-12-25',
effective_to: '2023-12-25',
note: '<string>',
owner_id: '<string>'
}
]
})
};
fetch('https://sandbox.nmbr.co/services/payroll/remittance_accounts', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'business_entity_id' => '<string>',
'label' => '<string>',
'linked_remittance_account_id' => '<string>',
'label_translations' => [
'en' => '<string>',
'fr' => '<string>'
],
'addressee' => '<string>',
'account_identifier' => '<string>',
'is_default' => true,
'note' => '<string>',
'address_line_1' => '<string>',
'address_line_2' => '<string>',
'city' => '<string>',
'administrative_area' => '<string>',
'province_code' => '<string>',
'country_code' => '<string>',
'postal_code' => '<string>',
'metadata' => [
'last_payment_amount' => '<string>'
],
'tax_properties' => [
[
'value' => '<string>',
'effective_from' => '2023-12-25',
'effective_to' => '2023-12-25',
'note' => '<string>',
'owner_id' => '<string>'
]
]
]),
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"
payload := strings.NewReader("{\n \"business_entity_id\": \"<string>\",\n \"label\": \"<string>\",\n \"linked_remittance_account_id\": \"<string>\",\n \"label_translations\": {\n \"en\": \"<string>\",\n \"fr\": \"<string>\"\n },\n \"addressee\": \"<string>\",\n \"account_identifier\": \"<string>\",\n \"is_default\": true,\n \"note\": \"<string>\",\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"administrative_area\": \"<string>\",\n \"province_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"metadata\": {\n \"last_payment_amount\": \"<string>\"\n },\n \"tax_properties\": [\n {\n \"value\": \"<string>\",\n \"effective_from\": \"2023-12-25\",\n \"effective_to\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"owner_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.nmbr.co/services/payroll/remittance_accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"business_entity_id\": \"<string>\",\n \"label\": \"<string>\",\n \"linked_remittance_account_id\": \"<string>\",\n \"label_translations\": {\n \"en\": \"<string>\",\n \"fr\": \"<string>\"\n },\n \"addressee\": \"<string>\",\n \"account_identifier\": \"<string>\",\n \"is_default\": true,\n \"note\": \"<string>\",\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"administrative_area\": \"<string>\",\n \"province_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"metadata\": {\n \"last_payment_amount\": \"<string>\"\n },\n \"tax_properties\": [\n {\n \"value\": \"<string>\",\n \"effective_from\": \"2023-12-25\",\n \"effective_to\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"owner_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.nmbr.co/services/payroll/remittance_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_entity_id\": \"<string>\",\n \"label\": \"<string>\",\n \"linked_remittance_account_id\": \"<string>\",\n \"label_translations\": {\n \"en\": \"<string>\",\n \"fr\": \"<string>\"\n },\n \"addressee\": \"<string>\",\n \"account_identifier\": \"<string>\",\n \"is_default\": true,\n \"note\": \"<string>\",\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"administrative_area\": \"<string>\",\n \"province_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"metadata\": {\n \"last_payment_amount\": \"<string>\"\n },\n \"tax_properties\": [\n {\n \"value\": \"<string>\",\n \"effective_from\": \"2023-12-25\",\n \"effective_to\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"owner_id\": \"<string>\"\n }\n ]\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": true,
"is_editable": true,
"is_deletable": true,
"linked_remittance_account": null,
"category": "ca_tax_agency",
"label": "CRA Payroll Account",
"label_translations": null,
"label_translated": "CRA Payroll Account",
"addressee": null,
"account_identifier": "123456789RP0001",
"superseded_by": null,
"superseded_on": null,
"remitter_type": "regular",
"remittance_management": "automatic",
"note": "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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Maximum string length:
255Available 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, uk_hmrc 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.
Available options:
ca_benefit_provider, ca_provincial_government, ca_tax_agency, ca_union, ca_workers_compensation, uk_tax_agency Maximum string length:
255Maximum string length:
255Available options:
accelerated_threshold_1, accelerated_threshold_2, annual, quarterly, regular Available options:
automatic, manual Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.
Maximum string length:
255Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.
Maximum string length:
255Up to 28 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.
Maximum string length:
255Maximum string length:
255In Canada, must be an uppercase 2-letter province code: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT
Must be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., CA).
Maximum string length:
10Additional 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
Hide child attributes
The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. "1250.00").
Hide child attributes
Hide child attributes
Available options:
ca::ab::claim_amount, ca::ab::total_income_less_than_total_claim_amount, ca::ab::workers_compensation_class, ca::authorized_province, ca::bc::claim_amount, ca::bc::eht, ca::bc::total_income_less_than_total_claim_amount, ca::bc::workers_compensation_class, ca::cpp_exempt, ca::ei_exempt, ca::ei_premium_reduction, ca::federal::additional_tax, ca::federal::annual_deduction_at_source, ca::federal::claim_amount, ca::federal::commission_expenses, ca::federal::commission_total_income, ca::federal::income_tax_rate, ca::federal::total_income_less_than_total_claim_amount, ca::federal_oc_surtax_exempt, ca::first_nation_exemptions, ca::mb::claim_amount, ca::mb::eht, ca::mb::total_income_less_than_total_claim_amount, ca::mb::workers_compensation_class, ca::nb::claim_amount, ca::nb::total_income_less_than_total_claim_amount, ca::nb::workers_compensation_class, ca::nl::claim_amount, ca::nl::eht, ca::nl::total_income_less_than_total_claim_amount, ca::nl::workers_compensation_class, ca::ns::claim_amount, ca::ns::total_income_less_than_total_claim_amount, ca::ns::workers_compensation_class, ca::nt::claim_amount, ca::nt::territorial_payroll_tax, ca::nt::total_income_less_than_total_claim_amount, ca::nt::workers_compensation_class, ca::nu::claim_amount, ca::nu::territorial_payroll_tax, ca::nu::total_income_less_than_total_claim_amount, ca::nu::workers_compensation_class, ca::on::claim_amount, ca::on::dependent_children_credit, ca::on::eht, ca::on::impaired_dependants_credit, ca::on::total_income_less_than_total_claim_amount, ca::on::workers_compensation_class, ca::pe::claim_amount, ca::pe::total_income_less_than_total_claim_amount, ca::pe::workers_compensation_class, ca::province_of_employment, ca::province_of_work, ca::provincial::income_tax_rate, ca::qc::additional_tax, ca::qc::claim_amount, ca::qc::commission_percentage_taxed, ca::qc::eht, ca::qc::income_tax_rate, ca::qc::qpip_exempt, ca::qc::qpp_exempt, ca::qc::tax_id, ca::qc::total_income_less_than_total_claim_amount, ca::qc::workers_compensation_class, ca::sk::claim_amount, ca::sk::total_income_less_than_total_claim_amount, ca::sk::workers_compensation_class, ca::statutory_holiday_pay, ca::tax_id, ca::yt::claim_amount, ca::yt::total_income_less_than_total_claim_amount, ca::yt::workers_compensation_class, uk::has_irregular_payment, uk::has_postgraduate_loan, uk::ni_category, uk::p45, uk::payroll_id, uk::starter_declaration, uk::student_loan_plan, uk::tax_basis, uk::tax_code Response
201 - application/json
Created
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("remittance_account").
Hide child attributes
Hide child attributes
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. uk_hmrc is a UK business entity's PAYE scheme with HM Revenue & Customs (HMRC), and a UK business entity can hold more than one. An account's authority has to be in its business entity's country.
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, uk_hmrc 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. Only CRA and Revenu Québec accounts have a default: a work assignment is only in an HMRC PAYE scheme it's enrolled in.
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.
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.
The CRA remittance account whose enrollments this account follows, when it is a linked account; otherwise null.
Available options:
ca_benefit_provider, ca_provincial_government, ca_tax_agency, ca_union, ca_workers_compensation, uk_tax_agency Maximum string length:
255The 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.
The employer name shown on pay stubs paid under this account, in place of the business entity name. When null or empty, pay stubs show the business entity name. Applies to CRA accounts on pay stubs outside Quebec, and Revenu Québec accounts on Quebec pay stubs.
Maximum string length:
255The account's number with its authority. For a CRA account, the 15-character program account number (e.g. 123456789RP0001); for a Revenu Québec account, the 16-character identification number and file number (e.g. 1234567890RS0001). For an HMRC PAYE scheme, the Employer PAYE Reference: a 3-digit tax office number, a slash, then the employer's reference of 1 to 10 characters (e.g. 123/AB456). Required for a PAYE scheme.
Maximum string length:
255The 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.
The date this account was replaced by its successor. Null when no successor has been recorded.
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, annual, quarterly, regular 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 Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
2Maximum string length:
10Additional 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
Hide child attributes
The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. "1250.00").
The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.