> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a business entity > If the `tax_properties` are expanded, only Tax Properties active on the current date will be returned. ## OpenAPI ````yaml /spec/openapi.json get /business_entities/{business_entity} openapi: 3.0.0 info: title: Nmbr API description: API to interact with Nmbr Payroll version: 1.0.0 servers: - url: https://sandbox.nmbr.co/services/payroll security: - CompanyToken: [] tags: - name: Accounting Codes - name: Accounting Code Rules - name: Adjustments - name: Allowances - name: Allowance Line Items - name: Allowance Types - name: Async Tasks - name: Bank Accounts - name: Business Entities - name: Business Entity Verifications - name: Business Entity ROE Authorizations - name: Business Presets - name: Calculations - name: Companies - name: Contractors - name: Deductions - name: Deduction Line Items - name: Deduction Types - name: Earnings - name: Earning Line Items - name: Earning Types - name: Effective Tax Properties - name: Employees - name: Employee Benefits - name: Employee Benefit Line Items - name: Employee Benefit Types - name: Employer Benefits - name: Employer Benefit Line Items - name: Employer Benefit Types - name: Employer Statutory Withholding Line Items - name: Employer Statutory Withholding Types - name: Forms - name: Form Batches - name: Form Types - name: Holidays - name: Integrations - name: Journal Entries - name: Overtime Rates - name: Partners - name: Pay Rates - name: Pay Schedules - name: Pay Splits - name: Pay Stubs - name: Payments - name: Payrolls - name: Reimbursements - name: Reimbursement Line Items - name: Reimbursement Types - name: Remittance Accounts - name: Remittance Account Enrollments - name: Reports - name: Statutory Withholding Line Items - name: Statutory Withholding Types - name: Tags - name: Tag Groups - name: Tax Properties - name: Tax Property Templates - name: Tokens - name: Usage Records - name: Usage Summaries - name: Vacation Pay - name: Vacation Pay Settings - name: Webhooks - name: Work Assignments paths: /business_entities/{business_entity}: get: tags: - Business Entities summary: Retrieve a business entity description: >- If the `tax_properties` are expanded, only Tax Properties active on the current date will be returned. operationId: business-entities-show parameters: - name: business_entity in: path schema: type: string required: true - name: expand in: query schema: type: array items: type: string enum: - accounting_settings.default_bank_accounting_code - accounting_settings.default_payroll_payable_accounting_code - accounting_settings.primary_tag_group - bank_accounts - business_presets - company - default_bank_accounting_code - default_payroll_payable_accounting_code - effective_tax_properties - pay_schedules - payrolls - primary_tag_group - tax_properties required: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/BusinessEntity' anyOf: - type: object title: Default - type: object title: With company expanded properties: company: type: object properties: data: $ref: '#/components/schemas/Company' - type: object title: With pay_schedules expanded properties: pay_schedules: type: object nullable: true properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: '#/components/schemas/PaySchedule' - type: object title: With payrolls expanded properties: payrolls: type: object nullable: true properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: '#/components/schemas/Payroll' - type: object title: With bank_accounts expanded properties: bank_accounts: type: object nullable: true properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: '#/components/schemas/BankAccount' - type: object title: With business_presets expanded properties: business_presets: type: object nullable: true properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: '#/components/schemas/BusinessPreset' - type: object title: With tax_properties expanded properties: tax_properties: type: object nullable: true properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: '#/components/schemas/TaxProperty' - type: object title: With effective_tax_properties expanded properties: effective_tax_properties: type: object nullable: true properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: >- #/components/schemas/EffectiveTaxProperty - type: object title: With default_bank_accounting_code expanded properties: default_bank_accounting_code: type: object properties: data: $ref: '#/components/schemas/DefaultBankAccountingCode' - type: object title: With default_payroll_payable_accounting_code expanded properties: default_payroll_payable_accounting_code: type: object properties: data: $ref: >- #/components/schemas/DefaultPayrollPayableAccountingCode - type: object title: With primary_tag_group expanded properties: primary_tag_group: type: object properties: data: $ref: '#/components/schemas/PrimaryTagGroup' - type: object title: >- With accounting_settings.default_bank_accounting_code expanded properties: accounting_settings: type: object properties: default_bank_accounting_code: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: >- #/components/schemas/DefaultBankAccountingCode - type: object title: >- With accounting_settings.default_payroll_payable_accounting_code expanded properties: accounting_settings: type: object properties: default_payroll_payable_accounting_code: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: >- #/components/schemas/DefaultPayrollPayableAccountingCode - type: object title: With accounting_settings.primary_tag_group expanded properties: accounting_settings: type: object properties: primary_tag_group: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: '#/components/schemas/PrimaryTagGroup' example: 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: object: company links: self: /companies/ 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: 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/ components: schemas: BusinessEntity: type: object title: Business Entity properties: business_number: type: string description: >- The Canada Revenue Agency (CRA) Business Number (BN) for this business entity, used to identify the business for payroll tax remittances. nullable: true maxLength: 255 name: type: string description: The business entity's operating or trade name. maxLength: 255 legal_name: type: string description: The business entity's registered legal name. nullable: true maxLength: 255 legal_registration_number: type: string description: The provincial business registration number. nullable: true maxLength: 255 address_line_1: type: string description: >- 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. nullable: true maxLength: 255 address_line_2: type: string description: >- 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. nullable: true maxLength: 255 city: type: string description: The city of the business entity's mailing address. nullable: true maxLength: 255 in_preview: type: boolean description: >- 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: type: string description: >- 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. nullable: true maxLength: 255 province_code: type: string description: >- This attribute is deprecated and will be removed. A deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead. nullable: true deprecated: true country_code: type: string description: The country code for the business entity's mailing address. nullable: true maxLength: 2 postal_code: type: string description: The postal code for the business entity's mailing address. nullable: true maxLength: 255 contact_name: type: string description: The name of the primary contact at the business entity. nullable: true maxLength: 255 contact_email: type: string description: The email address of the primary contact at the business entity. nullable: true maxLength: 255 contact_area_code: type: string description: The area code for the primary contact's phone number. nullable: true maxLength: 255 contact_phone_number: type: string description: The primary contact's phone number, excluding area code. nullable: true maxLength: 255 contact_extension: type: string description: The extension for the primary contact's phone number. nullable: true maxLength: 255 pay_day_movement_setting: type: string description: >- 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. enum: - inherit - next_business_day - previous_business_day vacation_pay_formula_setting: type: string description: >- The formula used to calculate vacation pay for Employees in this business entity. enum: - pay_date - period_end - period_start remitter_type: type: string description: >- The Canada Revenue Agency (CRA) remitter type, which determines the frequency of payroll tax remittances to the CRA. nullable: true enum: - accelerated_threshold_1 - accelerated_threshold_2 - quarterly - regular status: type: string description: >- The business entity's current status. A business entity must reach `approved` status before live Payrolls can be processed. enum: - approved - onboarding - suspended company: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"company"`). readOnly: true warnings: type: object description: >- A collection of data validation warnings for this business entity. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing. nullable: true properties: object: type: string nullable: true data: type: array nullable: true items: type: object properties: object: type: string nullable: true data: type: object nullable: true properties: namespace: type: string nullable: true type: type: string nullable: true external_ref: type: string description: >- 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. nullable: true maxLength: 255 available_tax_properties: type: array description: >- A list of Tax Property template identifiers supported for this business entity, based on its jurisdiction. nullable: true items: type: string effective_processing_speed: type: string description: >- The resolved processing speed after applying inheritance from the Partner if `processing_speed` is `inherit`. nullable: true processing_speed: type: string description: >- The business entity-level processing speed setting. If set to `inherit`, the Partner's processing speed is used. enum: - five_day - four_day - inherit - one_day - three_day - two_day has_bank_accounts: type: boolean description: Whether this business entity has any Bank Accounts configured. has_pay_schedules: type: boolean description: Whether this business entity has any Pay Schedules configured. has_payrolls: type: boolean description: Whether this business entity has any Payrolls. current_tax_jurisdiction: type: string description: >- The current tax jurisdiction for the business entity, derived from its `ca::province_of_employment` Tax Property. nullable: true ca_settings: type: object description: >- Canada-specific settings for this business entity. Only present for business entities with a Canadian address. nullable: true properties: roe_submission_setting: type: string description: >- Indicates whether Record of Employment (ROE) submissions are managed by Nmbr (`managed`) or by the employer directly (`manual`). nullable: true accounting_settings: type: object description: >- 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. nullable: true properties: default_bank_accounting_code: description: >- The Accounting Code used as the default bank account row when generating journal entries. default_payroll_payable_accounting_code: description: >- The Accounting Code used as the default payroll payable row when generating journal entries. resolve_journal_entry_stat_withholdings: type: boolean description: >- 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: description: >- The Tag Group that drives default accounting-code resolution for line items. Setting this also flags the group as a journal entry dimension. block_approval_on_incomplete_journal_entries: type: boolean description: >- When `true`, payroll approval is blocked if any exportable journal entry row has no Accounting Code. block_approval_on_missing_export_identifiers: type: boolean description: >- 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: description: |- This attribute is deprecated and will be removed. Use `accounting_settings.default_bank_accounting_code`. deprecated: true default_payroll_payable_accounting_code: description: |- This attribute is deprecated and will be removed. Use `accounting_settings.default_payroll_payable_accounting_code`. deprecated: true preferred_locale: type: string description: >- The locale used for payroll communications sent to Employees and Contractors within this business entity. If not set, the Company's locale is used. nullable: true enum: - en - fr hold_funding_for_verification: type: boolean description: >- 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: type: boolean description: |- This attribute is deprecated and will be removed. Use `accounting_settings.resolve_journal_entry_stat_withholdings`. deprecated: true primary_tag_group: description: |- This attribute is deprecated and will be removed. Use `accounting_settings.primary_tag_group`. deprecated: true created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Company: type: object title: Company properties: name: type: string description: The company's name. pay_day_movement_setting: type: string description: >- The company-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. Inherited by Business Entities and Pay Schedules whose own setting is `inherit`. enum: - inherit - next_business_day - previous_business_day external_ref: type: string description: >- 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. nullable: true maxLength: 255 preferred_locale: type: string description: >- The locale used for payroll communications sent to Employees and Contractors within this company. If not set, the Partner's locale is used. nullable: true enum: - en - fr created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime PaySchedule: type: object title: Pay Schedule properties: business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true title: type: string maxLength: 255 title_translations: type: object description: Optional translations for the `title` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true title_translated: type: string description: >- The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header. readOnly: true pay_frequency: type: string description: >- The frequency at which Payrolls are processed. Use `custom` for non-standard schedules where the number of pay periods per year is specified manually. enum: - bi-weekly - custom - monthly - semi-monthly - weekly anchor_pay_date: type: string description: >- The pay date of the anchor pay period. Together with `anchor_end_of_pay_period`, this establishes the pattern from which all future pay dates are calculated. nullable: true format: date anchor_start_of_pay_period: type: string description: >- The start date of the anchor pay period. Only required for semi-monthly pay schedules when `anchor_end_of_pay_period` is not the 15th or the last day of the month. For standard configurations it is derived automatically and does not need to be supplied. nullable: true format: date anchor_end_of_pay_period: type: string description: >- The end date of the anchor pay period. Together with `anchor_pay_date`, this defines the length and pattern of all future pay periods. nullable: true format: date generate_payrolls_from: type: string description: >- Only available in preview mode. When set, Payrolls are generated starting from this date rather than the default, allowing historical Payrolls to be created before the current date. nullable: true format: date day_1: type: integer description: >- For monthly pay schedules, the day of the month on which pay is issued. For semi-monthly pay schedules, the first of two pay days per month. nullable: true day_2: type: integer description: >- For semi-monthly pay schedules, the second of two pay days per month. nullable: true pay_day_movement_setting: type: string description: >- The pay schedule-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Business Entity's setting is used. enum: - inherit - next_business_day - previous_business_day send_empty_pay_stubs: type: boolean description: >- Whether Pay Stubs are generated for employees with no earnings in a given pay period. pay_stub_settings: type: object description: >- Settings that control Pay Stub display. The `show_vacation_pay_balance` field, when `true`, causes the employee's current Vacation Pay balance to appear on Pay Stubs. nullable: true properties: show_vacation_pay_balance: type: boolean custom_pay_periods_per_year: type: integer description: >- When `pay_frequency` is `custom`, the number of pay periods per year. nullable: true is_editable: type: boolean description: >- Whether the pay schedule's configuration can be edited. A pay schedule becomes non-editable once any of its Payrolls have been approved or paid. When `false`, only the `title` field may be updated. is_deletable: type: boolean description: >- Whether the pay schedule can be deleted. A pay schedule may not be deleted once any of its Payrolls have been approved or paid. In preview mode, any pay schedule may be deleted. external_ref: type: string description: >- 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. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Payroll: type: object title: Payroll properties: business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true pay_schedule: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"pay_schedule"`). readOnly: true type: type: string description: >- The type of payroll. `regular` payrolls are generated automatically on the Pay Schedule. `off_cycle` Payrolls are created manually against a source regular payroll. `historical` and `correction` payrolls are used to record or correct prior periods. enum: - correction - historical - off_cycle - regular period_number: type: integer description: >- The sequential number of this pay period within the calendar year of its `pay_date`, counting only regular payrolls. `null` for off-cycle, historical, and correction payrolls. nullable: true period_label: type: string description: A human-readable label for this pay period. nullable: true period_start: type: string description: The start date of the pay period. format: date period_end: type: string description: The end date of the pay period. format: date pay_date: type: string description: The date on which Employees and Contractors are paid. format: date original_pay_date: type: string description: >- For payrolls on a custom-frequency Pay Schedule, the originally scheduled pay date before any movement for weekends or bank holidays. Used for year-to-date calculations and tax year assignment. nullable: true format: date debit_date: type: string description: >- The expected date the company's account will be debited the `cash_requirement` amount. nullable: true approval_due_at: type: string description: >- The date and time, in UTC, by which the payroll must be approved to be processed on time. readOnly: true nullable: true format: dateTime regular_periods_count: type: integer description: >- The total number of regular pay periods in this Pay Schedule whose `pay_date` falls in the same calendar year as this payroll's `pay_date`. Used for year-to-date calculations. nullable: true is_impacted_by_weekend_or_holiday: type: boolean description: >- Whether `pay_date` or `approval_due_at` has been moved to avoid falling on a weekend or bank holiday. is_blocked_by_draft: type: boolean description: >- Whether this payroll is blocked from being approved because an earlier payroll on the same Pay Schedule is still in draft status. note: type: string description: An optional note on the payroll, visible to the partner. nullable: true employee_summary: type: object description: A summary of pay across all Employees in this payroll. nullable: true properties: gross: description: The sum of all earnings and allowances. subtractions: description: The total of all deductions, taxes, and benefit contributions. reimbursements: description: The total of non-taxable reimbursements. net: description: The Employee net pay; when negative, a warning is included. contractor_summary: type: object description: A summary of pay across all Contractors in this payroll. nullable: true properties: gross: description: The sum of all earnings. reimbursements: description: The total of non-taxable reimbursements. net: description: The Contractor net pay. company_summary: type: object description: A summary of the company's obligations in this payroll. nullable: true properties: taxes_and_contributions: description: The employer share of statutory remittances (CPP and EI). benefits: description: The total of employer benefit contributions. total: description: The company's total obligations. liability: type: number description: >- The total amount owed by the company for this payroll, including Employee and Contractor net pay, employer tax contributions, and employer benefit contributions. nullable: true format: decimal cash_requirement: type: number description: >- The total amount that will be debited from the company's account when this payroll is approved. nullable: true format: decimal status: type: string description: The current status of the payroll. enum: - approved - draft - failed - paid - partially_paid - processing approved_at: type: string description: The date on which the payroll was approved. nullable: true format: date is_stale: type: boolean description: >- Whether the payroll's tax calculations are out of date. When `true`, `stale_since` indicates when the payroll became stale. stale_since: type: string description: >- The timestamp at which the payroll's tax calculations became stale and need to be recalculated. `null` if the payroll is up to date. readOnly: true nullable: true format: dateTime source_payroll: {} warnings: type: object description: >- A collection of data validation warnings for this payroll. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing. nullable: true properties: object: type: string nullable: true data: type: object nullable: true external_ref: type: string description: >- 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. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime BankAccount: type: object title: Bank Account properties: business_entity: type: object description: >- The Business Entity that owns this bank account. Present only for Business Entity bank accounts. properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true institution_number: type: string description: The 3-digit bank institution number. institution_name: type: string description: >- The name of the banking institution matching the institution number, or `null` if the number is not recognized. Always the English name; see `institution_name_translated` for the value in the request's locale. nullable: true institution_name_translations: type: object nullable: true properties: en: type: string nullable: true fr: type: string nullable: true institution_name_translated: type: string description: >- The translation of the `institution_name` property for the request locale. Computed using the values in `institution_name` and `institution_name_translations` and the value of the request's `Accept-Language` header. readOnly: true transit_number: type: string description: The 5-digit bank transit number. transit_address: type: string description: >- The address of the branch matching the institution and transit numbers, or `null` if the pair is not recognized. nullable: true account_number_last_3: type: string description: The last 3 digits of the bank account number. nullable: true is_primary: type: boolean description: Whether this is the primary bank account for its owner. is_deletable: type: boolean description: Whether this bank account can be deleted. warnings: type: object description: >- A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number. nullable: true properties: object: type: string nullable: true data: type: object nullable: true is_pad_signed: type: boolean description: >- Whether a PAD agreement has been signed. Only present for Business Entity bank accounts. pad_signer_name: type: string description: >- The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts. nullable: true maxLength: 255 pad_signer_email: type: string description: >- The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts. nullable: true maxLength: 255 pad_signer_title: type: string description: >- The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts. nullable: true maxLength: 255 pad_signed_at: type: string description: >- The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts. readOnly: true nullable: true format: dateTime pad_file: description: >- The signed PAD agreement file. Only present for Business Entity bank accounts. created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime BusinessPreset: type: object title: Business Preset properties: business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true name: type: string maxLength: 255 name_translations: type: object description: Optional translations for the `name` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true name_translated: type: string description: >- The translation of the `name` property for the request locale. Computed using the values in `name` and `name_translations` and the value of the request's `Accept-Language` header. readOnly: true title: type: string nullable: true title_translations: type: object description: Optional translations for the `title` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true title_translated: type: string description: >- The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header. readOnly: true type: type: string maxLength: 255 subtype: type: string nullable: true maxLength: 255 remittance_account: {} is_managed: type: boolean description: >- If true, this is a default Business Preset and can not be deleted, `title` and `remittance_account` may be set. expense_accounting_code: {} liability_accounting_code: {} income_basis: type: string nullable: true enum: - all_earnings - none - regular_earnings - total_income income_includes: type: object nullable: true external_ref: type: string description: >- 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. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime TaxProperty: type: object title: Tax Property properties: type: type: string description: >- The type of this tax property, determining its format, label, and validation rules. maxLength: 255 enum: - ca::ab::claim_amount - ca::ab::total_income_less_than_total_claim_amount - ca::ab::workers_compensation_class - ca::bc::claim_amount - ca::bc::eht - ca::bc::total_income_less_than_total_claim_amount - ca::bc::workers_compensation_class - ca::cpp_exempt - ca::ei_exempt - ca::ei_premium_reduction - ca::federal::additional_tax - ca::federal::annual_deduction_at_source - ca::federal::claim_amount - ca::federal::commission_expenses - ca::federal::commission_total_income - ca::federal::income_tax_rate - ca::federal::total_income_less_than_total_claim_amount - ca::federal_oc_surtax_exempt - ca::first_nation_exemptions - ca::mb::claim_amount - ca::mb::eht - ca::mb::total_income_less_than_total_claim_amount - ca::mb::workers_compensation_class - ca::nb::claim_amount - ca::nb::total_income_less_than_total_claim_amount - ca::nb::workers_compensation_class - ca::nl::claim_amount - ca::nl::eht - ca::nl::total_income_less_than_total_claim_amount - ca::nl::workers_compensation_class - ca::ns::claim_amount - ca::ns::total_income_less_than_total_claim_amount - ca::ns::workers_compensation_class - ca::nt::claim_amount - ca::nt::territorial_payroll_tax - ca::nt::total_income_less_than_total_claim_amount - ca::nt::workers_compensation_class - ca::nu::claim_amount - ca::nu::territorial_payroll_tax - ca::nu::total_income_less_than_total_claim_amount - ca::nu::workers_compensation_class - ca::on::claim_amount - ca::on::dependent_children_credit - ca::on::eht - ca::on::impaired_dependants_credit - ca::on::total_income_less_than_total_claim_amount - ca::on::workers_compensation_class - ca::pe::claim_amount - ca::pe::total_income_less_than_total_claim_amount - ca::pe::workers_compensation_class - ca::province_of_employment - ca::province_of_work - ca::provincial::income_tax_rate - ca::qc::additional_tax - ca::qc::claim_amount - ca::qc::commission_percentage_taxed - ca::qc::eht - ca::qc::income_tax_rate - ca::qc::qpip_exempt - ca::qc::qpp_exempt - ca::qc::tax_id - ca::qc::total_income_less_than_total_claim_amount - ca::qc::workers_compensation_class - ca::sk::claim_amount - ca::sk::total_income_less_than_total_claim_amount - ca::sk::workers_compensation_class - ca::statutory_holiday_pay - ca::tax_id - ca::yt::claim_amount - ca::yt::total_income_less_than_total_claim_amount - ca::yt::workers_compensation_class value: type: string description: >- The value of this tax property. Format depends on `format`: numeric types store a decimal string, boolean types store a boolean, select types store a string key, and object types store a structured value object. nullable: true effective_from: type: string description: The date from which this tax property takes effect. format: date effective_to: type: string description: >- The date on which this tax property expires. `null` means no end date and the property remains in effect indefinitely. nullable: true format: date earliest_valid_effective_to: type: string description: >- The earliest date that `effective_to` can be set to without triggering a validation error. Corresponds to the pay date of the most recent non-draft payroll that used this property. nullable: true format: date is_editable: type: boolean description: >- Whether this tax property can be fully edited. When `false`, only `effective_to` and `note` may be updated. When false, only the `effective_to` and `note` attributes may be updated. is_deletable: type: boolean description: Whether this tax property can be deleted. label: type: string description: The human-readable display name for this tax property's type. nullable: true format: type: string description: >- The value format for this tax property's type. Determines how `value` is interpreted. nullable: true options: type: object description: >- The available options for this tax property's type if it is a select type. `null` if not applicable. nullable: true properties: ca_ab: type: string nullable: true ca_bc: type: string nullable: true ca_mb: type: string nullable: true ca_nb: type: string nullable: true ca_nl: type: string nullable: true ca_ns: type: string nullable: true ca_nt: type: string nullable: true ca_nu: type: string nullable: true ca_on: type: string nullable: true ca_pe: type: string nullable: true ca_qc: type: string nullable: true ca_sk: type: string nullable: true ca_yt: type: string nullable: true ca_oc: type: string nullable: true allow_concurrent: type: boolean description: >- Whether multiple tax properties of this tax property's type are allowed on the same owner with overlapping effective date ranges. feature: type: string description: >- The feature this tax property's type is associated with. `null` if not feature-gated. nullable: true owner: type: object description: >- The owner of this tax property. Can be a Business Entity, Work Assignment, or Remittance Account. properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true note: type: string description: An optional note for this tax property. nullable: true created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime EffectiveTaxProperty: type: object title: Effective Tax Property properties: type: type: string description: >- The type of tax property being resolved (e.g. `ca::province_of_work`). Always reflects the requested type, even when the value was inherited from a different type on a parent owner (e.g. POW resolved via a POE Tax Property). nullable: true value: type: string description: >- The resolved value for this type as of the requested date, after applying the inheritance chain. `null` if no value exists anywhere in the chain (only present when filtering to a specific type that has no value). nullable: true source_tax_property: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"tax_property"`). readOnly: true DefaultBankAccountingCode: $ref: '#/components/schemas/AccountingCode' DefaultPayrollPayableAccountingCode: $ref: '#/components/schemas/AccountingCode' PrimaryTagGroup: $ref: '#/components/schemas/TagGroup' Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 AccountingCode: type: object title: Accounting Code properties: business_entity: type: object description: The Business Entity this accounting code belongs to. properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true type: type: string description: The type of accounting code. enum: - bank - expense - liability code: type: string description: >- The accounting code identifier as it appears in the chart of accounts. nullable: true maxLength: 255 title: type: string maxLength: 255 title_translations: type: object description: Optional translations for the `title` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true title_translated: type: string description: >- The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header. readOnly: true description: type: string nullable: true description_translations: type: object description: Optional translations for the `description` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true description_translated: type: string description: >- The translation of the `description` property for the request locale. Computed using the values in `description` and `description_translations` and the value of the request's `Accept-Language` header. readOnly: true mapping: type: object nullable: true properties: xero: type: boolean quickbooks: type: boolean fallback_mappings: type: object description: >- Line Item type/subtype pairs that default to this accounting code when no specific mapping is configured. Each entry contains `type` and `subtype`. nullable: true created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime TagGroup: type: object title: Tag Group properties: label: type: string maxLength: 255 label_translations: type: object description: Optional translations for the `label` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true label_translated: type: string description: >- The translation of the `label` property for the request locale. Computed using the values in `label` and `label_translations` and the value of the request's `Accept-Language` header. readOnly: true description: type: string nullable: true description_translations: type: object description: Optional translations for the `description` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true description_translated: type: string description: >- The translation of the `description` property for the request locale. Computed using the values in `description` and `description_translations` and the value of the request's `Accept-Language` header. readOnly: true color: type: string description: >- A hex colour code for the tag group (e.g. `#AABBCC` or `#ABC`). Used for display. nullable: true maxLength: 7 archived_at: type: string description: >- When set, the tag group is archived and excluded from index listings by default. readOnly: true nullable: true format: dateTime is_deletable: type: boolean description: >- A tag group may not be deleted while it is the primary tag group or any of its tags are assigned to active allocations. is_component_locked: type: boolean description: >- When `true`, the tags within this group cannot be modified through the embedded portal. Tags can still be managed through the API. is_journal_entry_dimension: type: boolean description: >- When `true`, this tag group is used as a dimension in journal entry reports. A business entity can have up to three journal entry dimensions. integrations: type: object description: >- Identifiers and object types for this tag group in external accounting integrations, used to sync tag groups imported from those systems. QuickBooks does not expose a group-level identifier, so only the type is stored for QuickBooks. nullable: true properties: xero: type: object nullable: true properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true maxLength: 32 type: {} quickbooks: type: object nullable: true properties: type: {} business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime securitySchemes: CompanyToken: type: http scheme: bearer ````