Skip to main content
PUT
/
business_entities
/
{business_entity}
Update a business entity
curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/business_entities/{business_entity} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_number": "136549169RP9916",
  "name": "Bobs Burgers (#39616)",
  "address_line_1": "13 Fake Street",
  "city": "Toronto",
  "administrative_area": "ON",
  "country_code": "CA",
  "postal_code": "M1M1M1",
  "contact_name": "Jean Smith",
  "contact_email": "smith@company.com",
  "contact_area_code": "111",
  "contact_phone_number": "2223333",
  "pay_day_movement_setting": "inherit",
  "vacation_pay_formula_setting": "pay_date",
  "remitter_type": "regular",
  "preferred_locale": "en",
  "resolve_journal_entry_stat_withholdings": true
}
'
import requests

url = "https://sandbox.nmbr.co/services/payroll/business_entities/{business_entity}"

payload = {
    "business_number": "136549169RP9916",
    "name": "Bobs Burgers (#39616)",
    "address_line_1": "13 Fake Street",
    "city": "Toronto",
    "administrative_area": "ON",
    "country_code": "CA",
    "postal_code": "M1M1M1",
    "contact_name": "Jean Smith",
    "contact_email": "smith@company.com",
    "contact_area_code": "111",
    "contact_phone_number": "2223333",
    "pay_day_movement_setting": "inherit",
    "vacation_pay_formula_setting": "pay_date",
    "remitter_type": "regular",
    "preferred_locale": "en",
    "resolve_journal_entry_stat_withholdings": True
}
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_number: '136549169RP9916',
    name: 'Bobs Burgers (#39616)',
    address_line_1: '13 Fake Street',
    city: 'Toronto',
    administrative_area: 'ON',
    country_code: 'CA',
    postal_code: 'M1M1M1',
    contact_name: 'Jean Smith',
    contact_email: 'smith@company.com',
    contact_area_code: '111',
    contact_phone_number: '2223333',
    pay_day_movement_setting: 'inherit',
    vacation_pay_formula_setting: 'pay_date',
    remitter_type: 'regular',
    preferred_locale: 'en',
    resolve_journal_entry_stat_withholdings: true
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/business_entities/{business_entity}', 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/business_entities/{business_entity}",
  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_number' => '136549169RP9916',
    'name' => 'Bobs Burgers (#39616)',
    'address_line_1' => '13 Fake Street',
    'city' => 'Toronto',
    'administrative_area' => 'ON',
    'country_code' => 'CA',
    'postal_code' => 'M1M1M1',
    'contact_name' => 'Jean Smith',
    'contact_email' => 'smith@company.com',
    'contact_area_code' => '111',
    'contact_phone_number' => '2223333',
    'pay_day_movement_setting' => 'inherit',
    'vacation_pay_formula_setting' => 'pay_date',
    'remitter_type' => 'regular',
    'preferred_locale' => 'en',
    'resolve_journal_entry_stat_withholdings' => true
  ]),
  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/business_entities/{business_entity}"

	payload := strings.NewReader("{\n  \"business_number\": \"136549169RP9916\",\n  \"name\": \"Bobs Burgers (#39616)\",\n  \"address_line_1\": \"13 Fake Street\",\n  \"city\": \"Toronto\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"M1M1M1\",\n  \"contact_name\": \"Jean Smith\",\n  \"contact_email\": \"smith@company.com\",\n  \"contact_area_code\": \"111\",\n  \"contact_phone_number\": \"2223333\",\n  \"pay_day_movement_setting\": \"inherit\",\n  \"vacation_pay_formula_setting\": \"pay_date\",\n  \"remitter_type\": \"regular\",\n  \"preferred_locale\": \"en\",\n  \"resolve_journal_entry_stat_withholdings\": true\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/business_entities/{business_entity}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_number\": \"136549169RP9916\",\n  \"name\": \"Bobs Burgers (#39616)\",\n  \"address_line_1\": \"13 Fake Street\",\n  \"city\": \"Toronto\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"M1M1M1\",\n  \"contact_name\": \"Jean Smith\",\n  \"contact_email\": \"smith@company.com\",\n  \"contact_area_code\": \"111\",\n  \"contact_phone_number\": \"2223333\",\n  \"pay_day_movement_setting\": \"inherit\",\n  \"vacation_pay_formula_setting\": \"pay_date\",\n  \"remitter_type\": \"regular\",\n  \"preferred_locale\": \"en\",\n  \"resolve_journal_entry_stat_withholdings\": true\n}")
  .asString();
require 'uri'
require 'net/http'

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

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_number\": \"136549169RP9916\",\n  \"name\": \"Bobs Burgers (#39616)\",\n  \"address_line_1\": \"13 Fake Street\",\n  \"city\": \"Toronto\",\n  \"administrative_area\": \"ON\",\n  \"country_code\": \"CA\",\n  \"postal_code\": \"M1M1M1\",\n  \"contact_name\": \"Jean Smith\",\n  \"contact_email\": \"smith@company.com\",\n  \"contact_area_code\": \"111\",\n  \"contact_phone_number\": \"2223333\",\n  \"pay_day_movement_setting\": \"inherit\",\n  \"vacation_pay_formula_setting\": \"pay_date\",\n  \"remitter_type\": \"regular\",\n  \"preferred_locale\": \"en\",\n  \"resolve_journal_entry_stat_withholdings\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<id>",
  "object": "business_entity",
  "data": {
    "business_number": "136549169RP9916",
    "name": "Bobs Burgers (#39616)",
    "legal_name": null,
    "legal_registration_number": null,
    "address_line_1": "13 Fake Street",
    "address_line_2": null,
    "city": "Toronto",
    "in_preview": false,
    "administrative_area": "ON",
    "province_code": "ON",
    "country_code": "CA",
    "postal_code": "M1M1M1",
    "contact_name": "Jean Smith",
    "contact_email": "smith@company.com",
    "contact_area_code": "111",
    "contact_phone_number": "2223333",
    "contact_extension": null,
    "pay_day_movement_setting": "inherit",
    "vacation_pay_formula_setting": "pay_date",
    "remitter_type": "regular",
    "status": "approved",
    "company": {
      "id": "<id>",
      "object": "company",
      "links": {
        "self": "/companies/<id>"
      }
    },
    "warnings": {
      "object": "list",
      "data": [
        {
          "object": "warning",
          "data": {
            "namespace": "onboarding",
            "type": "business_legal_information_not_provided"
          }
        },
        {
          "object": "warning",
          "data": {
            "namespace": "onboarding",
            "type": "bank_account_doesnt_exists"
          }
        },
        {
          "object": "warning",
          "data": {
            "namespace": "onboarding",
            "type": "bank_account_pad_not_signed"
          }
        }
      ]
    },
    "external_ref": null,
    "available_tax_properties": [
      "ca::tax_id",
      "ca::qc::tax_id",
      "ca::province_of_employment",
      "ca::federal_oc_surtax_exempt",
      "ca::on::eht",
      "ca::mb::eht",
      "ca::nl::eht",
      "ca::bc::eht",
      "ca::qc::eht"
    ],
    "effective_processing_speed": "three_day",
    "processing_speed": "inherit",
    "has_bank_accounts": false,
    "has_pay_schedules": false,
    "has_payrolls": false,
    "current_tax_jurisdiction": "ca_on",
    "ca_settings": {
      "roe_submission_setting": "manual"
    },
    "accounting_settings": {
      "default_bank_accounting_code": null,
      "default_payroll_payable_accounting_code": null,
      "resolve_journal_entry_stat_withholdings": true,
      "primary_tag_group": null,
      "block_approval_on_incomplete_journal_entries": false,
      "block_approval_on_missing_export_identifiers": false
    },
    "default_bank_accounting_code": null,
    "default_payroll_payable_accounting_code": null,
    "preferred_locale": {
      "id": "<id>",
      "object": "locale",
      "data": {
        "label": "English"
      }
    },
    "hold_funding_for_verification": false,
    "resolve_journal_entry_stat_withholdings": true,
    "primary_tag_group": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/business_entities/<id>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
business_entity
string
required

Body

application/json
​
business_number
string

The Canada Revenue Agency (CRA) Business Number (BN) for this business entity, used to identify the business for payroll tax remittances.

​
name
string

The business entity's operating or trade name.

Maximum string length: 255
​
legal_name
string

The business entity's registered legal name.

Maximum string length: 255
​
legal_registration_number
string

The provincial business registration number.

Maximum string length: 255
​
address_line_1
string | null

The first line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.

​
address_line_2
string | null

The second line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.

​
city
string | null

The city of the business entity's mailing address.

​
administrative_area
string | null

The region of the business entity's mailing address — the province, state, or county, depending on the country. For Canadian business entities this is the province.

Maximum string length: 255
​
province_code
string
deprecated

This attribute is deprecated and will be removed.

A deprecated alias of administrative_area that mirrors its value. Use administrative_area instead.

In Canada, must be an uppercase 2-letter province code: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT

​
country_code
string

The country code for the business entity's mailing address.

Must be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., CA).

​
postal_code
string | null

The postal code for the business entity's mailing address.

Maximum string length: 10
​
contact_name
string

The name of the primary contact at the business entity.

Maximum string length: 255
​
contact_email
string

The email address of the primary contact at the business entity.

​
contact_area_code
string

The area code for the primary contact's phone number.

Maximum string length: 3
​
contact_phone_number
string

The primary contact's phone number, excluding area code.

Maximum string length: 7
​
contact_extension
string

The extension for the primary contact's phone number.

Maximum string length: 5
​
pay_day_movement_setting
enum<string>

The business entity-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to inherit, the Company's setting is used.

Available options:
inherit,
next_business_day,
previous_business_day
​
vacation_pay_formula_setting
enum<string>

The formula used to calculate vacation pay for Employees in this business entity.

Available options:
pay_date,
period_end,
period_start
​
remitter_type
enum<string>

The Canada Revenue Agency (CRA) remitter type, which determines the frequency of payroll tax remittances to the CRA.

Available options:
accelerated_threshold_1,
accelerated_threshold_2,
quarterly,
regular
​
in_preview
boolean

When true, the business entity is in preview mode. In preview mode, Payrolls can be run and approved but no real money movement occurs.

​
external_ref
string
Maximum string length: 255
​
default_bank_accounting_code_id
string
​
default_payroll_payable_accounting_code_id
string
​
preferred_locale
enum<string>

The locale used for payroll communications sent to Employees and Contractors within this business entity. If not set, the Company's locale is used.

Available options:
en,
fr
​
hold_funding_for_verification
boolean
​
resolve_journal_entry_stat_withholdings
boolean
​
primary_tag_group_id
string
​
accounting_settings
object

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

​
data
Business Entity · object