NMnmbr
Business Entities

Create a business entity

Changed on
post/business_entities

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

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

namestring required

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.

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

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.

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

citystring nullable

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.

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.

For a Canadian business entity, provide the province (e.g. ON).

province_codestring nullable

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 nullable

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

contact_phone_numberstring nullable

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' | 'annual' | 'quarterly' | 'regular'

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

business_type'ca_incorporated' | 'ca_non_profit' | 'ca_partnership' | 'ca_sole_proprietor_individual' | 'ca_sole_proprietor_tradename' | 'ca_trust'

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

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

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

  • fd2d967d9df4Revision changes
    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255

  • 353210c3786cRevision changes
    • warning

      added the new annual enum value to the / response property for the response status

    • info

      added the new annual enum value to the request property /

    • info

      added the new uk::has_irregular_payment enum value to the request property ///

    • info

      added the new uk::has_postgraduate_loan enum value to the request property ///

    • info

      added the new uk::ni_category enum value to the request property ///

    • info

      added the new uk::p45 enum value to the request property ///

    • info

      added the new uk::payroll_id enum value to the request property ///

    • info

      added the new uk::starter_declaration enum value to the request property ///

    • info

      added the new uk::student_loan_plan enum value to the request property ///

    • info

      added the new uk::tax_basis enum value to the request property ///

    • info

      added the new uk::tax_code enum value to the request property ///