Update a business entity

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. Rejected with a 422 for non-Canadian payroll.

The business entity's operating or trade name.

The business entity's registered legal name.

The provincial business registration number.

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.

Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

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.

Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

The city of the business entity's mailing address.

Up to 28 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

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.

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

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).

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

The name of the primary contact at the business entity.

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

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

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

The extension for the primary contact's phone number.

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.

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

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

The legal structure of the business entity. Optional; send null to clear it.

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

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

The unique identifier of the object in Nmbr.

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