---
title: "Retrieve a business entity"
method: GET
path: "/business_entities/{business_entity}"
tags: ["Business Entities"]
---

# Retrieve a business entity

`GET /business_entities/{business_entity}`

If the `tax_properties` are expanded, only Tax Properties active on the current date will be returned.

## Path parameters

- `business_entity` string, required

## Query parameters

- `expand` string[]

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"business_entity"`).
  - `data` BusinessEntity
    - `business_number` string, nullable — 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.
    - `legal_name` string, nullable — The business entity's registered legal name.
    - `legal_registration_number` string, nullable — The provincial business registration number.
    - `address_line_1` string, 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_2` string, 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.
    - `city` string, nullable — The city of the business entity's mailing address.
    - `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.
    - `administrative_area` string, 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_code` string, nullable — This attribute is deprecated and will be removed. A deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead.
    - `country_code` string, nullable — The country code for the business entity's mailing address.
    - `postal_code` string, nullable — The postal code for the business entity's mailing address.
    - `contact_name` string, nullable — The name of the primary contact at the business entity.
    - `contact_email` string, nullable — The email address of the primary contact at the business entity.
    - `contact_area_code` string, nullable — The area code for the primary contact's phone number.
    - `contact_phone_number` string, nullable — The primary contact's phone number, excluding area code.
    - `contact_extension` string, nullable — 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', nullable — The Canada Revenue Agency (CRA) remitter type, which determines the frequency of payroll tax remittances to the CRA.
    - `status` 'approved' | 'onboarding' | 'suspended' — The business entity's current status. A business entity must reach `approved` status before live Payrolls can be processed.
    - `company` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"company"`).
    - `warnings` object, nullable — A collection of data validation warnings for this business entity. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing.
      - `object` string, nullable
      - `data` object[], nullable
        - `object` string, nullable
        - `data` object, nullable
          - `namespace` string, nullable
          - `type` string, nullable
    - `external_ref` string, nullable — A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.
    - `available_tax_properties` string[], nullable — A list of Tax Property template identifiers supported for this business entity, based on its jurisdiction.
    - `effective_processing_speed` string, nullable — The resolved processing speed after applying inheritance from the Partner if `processing_speed` is `inherit`.
    - `processing_speed` 'five_day' | 'four_day' | 'inherit' | 'one_day' | 'three_day' | 'two_day' — The business entity-level processing speed setting. If set to `inherit`, the Partner's processing speed is used.
    - `has_bank_accounts` boolean — Whether this business entity has any Bank Accounts configured.
    - `has_pay_schedules` boolean — Whether this business entity has any Pay Schedules configured.
    - `has_payrolls` boolean — Whether this business entity has any Payrolls.
    - `current_tax_jurisdiction` string, nullable — The current tax jurisdiction for the business entity, derived from its `ca::province_of_employment` Tax Property.
    - `ca_settings` object, nullable — Canada-specific settings for this business entity. Only present for business entities with a Canadian address.
      - `roe_submission_setting` string, nullable — Indicates whether Record of Employment (ROE) submissions are managed by Nmbr (`managed`) or by the employer directly (`manual`).
    - `accounting_settings` object, nullable — Accounting-related settings for this business entity. New clients should read and write these through this object; the top-level `default_bank_accounting_code`, `default_payroll_payable_accounting_code`, `resolve_journal_entry_stat_withholdings`, and `primary_tag_group` fields are retained as aliases for backwards compatibility.
      - `default_bank_accounting_code` unknown
      - `default_payroll_payable_accounting_code` unknown
      - `resolve_journal_entry_stat_withholdings` boolean — When `true`, statutory withholding line items (employee and employer) are split across tracking dimensions derived from their applicable source earnings. When `false`, each statutory withholding appears as a single unsplit row in journal entries.
      - `primary_tag_group` unknown
      - `block_approval_on_incomplete_journal_entries` boolean — When `true`, payroll approval is blocked if any exportable journal entry row has no Accounting Code.
      - `block_approval_on_missing_export_identifiers` boolean — When `true`, payroll approval is blocked if any exportable journal entry row has no Accounting Code OR has one that lacks the enabled integration's external identifier.
    - `default_bank_accounting_code` unknown
    - `default_payroll_payable_accounting_code` unknown
    - `preferred_locale` 'en' | 'fr', nullable — 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_verification` boolean — When `true`, funding payments will be automatically held after settlement for verification. Downstream payments (employee, CRA, RQ) will not be processed until the funding payment hold is released.
    - `resolve_journal_entry_stat_withholdings` boolean — This attribute is deprecated and will be removed. Use `accounting_settings.resolve_journal_entry_stat_withholdings`.
    - `primary_tag_group` unknown
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/01cd9c45a923/schema)