Sign in
Business Entities

Update a business entity

put/business_entities/{business_entity}

Path parameters

business_entitystring required

Request body

business_numberstring

The Canada Revenue Agency (CRA) Business Number (BN) for this business entity, used to identify the business for payroll tax remittances. 15 characters (BN15): a 9-digit Business Number root, the 2-letter RP payroll program identifier, and a 4-digit reference number starting at 0001. The root begins with 1, 7, or 8 and carries a Luhn check digit.

namestring

The business entity's operating or trade name.

legal_namestring

The business entity's registered legal name.

legal_registration_numberstring

The provincial business registration number.

address_line_1string nullable

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_2string nullable

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.

citystring nullable

The city of the business entity's mailing address.

administrative_areastring nullable

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.

province_codestring

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_codestring

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_codestring nullable

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

contact_namestring

The name of the primary contact at the business entity.

contact_emailstring

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

contact_area_codestring

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

contact_phone_numberstring

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

contact_extensionstring

The extension for the primary contact's phone number.

pay_day_movement_setting'inherit' | 'next_business_day' | 'previous_business_day'

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.

vacation_pay_formula_setting'pay_date' | 'period_end' | 'period_start'

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

remitter_type'accelerated_threshold_1' | 'accelerated_threshold_2' | 'quarterly' | 'regular'

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

in_previewboolean

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_refstring
default_bank_accounting_code_idstring
default_payroll_payable_accounting_code_idstring
preferred_locale'en' | 'fr'

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

hold_funding_for_verificationboolean
resolve_journal_entry_stat_withholdingsboolean
primary_tag_group_idstring

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes