> ## 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. # List remittance accounts ## OpenAPI ````yaml /spec/openapi.json get /remittance_accounts 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: /remittance_accounts: get: tags: - Remittance Accounts summary: List remittance accounts operationId: remittance-accounts-index parameters: - name: business_entity_id in: query schema: type: string required: true - name: category in: query schema: anyOf: - type: string enum: - ca_benefit_provider - ca_provincial_government - ca_tax_agency - ca_union - ca_workers_compensation - type: array items: type: string enum: - ca_benefit_provider - ca_provincial_government - ca_tax_agency - ca_union - ca_workers_compensation required: false - name: has_payments in: query schema: type: boolean required: false - name: account_provider in: query schema: anyOf: - type: string enum: - ca_ab_workers_compensation - ca_bc_eht - ca_bc_workers_compensation - ca_cra - ca_mb_eht - ca_mb_workers_compensation - ca_nb_workers_compensation - ca_nl_eht - ca_nl_workers_compensation - ca_ns_workers_compensation - ca_nt_government - ca_nt_workers_compensation - ca_nu_government - ca_nu_workers_compensation - ca_on_eht - ca_on_workers_compensation - ca_pe_workers_compensation - ca_rq - ca_sk_workers_compensation - ca_yt_workers_compensation - type: array items: type: string enum: - ca_ab_workers_compensation - ca_bc_eht - ca_bc_workers_compensation - ca_cra - ca_mb_eht - ca_mb_workers_compensation - ca_nb_workers_compensation - ca_nl_eht - ca_nl_workers_compensation - ca_ns_workers_compensation - ca_nt_government - ca_nt_workers_compensation - ca_nu_government - ca_nu_workers_compensation - ca_on_eht - ca_on_workers_compensation - ca_pe_workers_compensation - ca_rq - ca_sk_workers_compensation - ca_yt_workers_compensation required: false - name: system_type in: query schema: type: string enum: - ca_ab_workers_compensation - ca_bc_eht - ca_bc_workers_compensation - ca_cra - ca_mb_eht - ca_mb_workers_compensation - ca_nb_workers_compensation - ca_nl_eht - ca_nl_workers_compensation - ca_ns_workers_compensation - ca_nt_government - ca_nt_workers_compensation - ca_nu_government - ca_nu_workers_compensation - ca_on_eht - ca_on_workers_compensation - ca_pe_workers_compensation - ca_rq - ca_sk_workers_compensation - ca_yt_workers_compensation required: false - name: expand in: query schema: type: array items: type: string enum: - business_entity - remittance_account_enrollments - source_tax_property required: false responses: '200': description: OK content: application/json: schema: type: object 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 (`"remittance_account"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/RemittanceAccount' anyOf: - type: object title: Default - type: object title: With business_entity expanded properties: business_entity: type: object properties: data: $ref: '#/components/schemas/BusinessEntity' - type: object title: With source_tax_property expanded properties: source_tax_property: type: object properties: data: $ref: '#/components/schemas/SourceTaxProperty' - type: object title: With remittance_account_enrollments expanded properties: remittance_account_enrollments: 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/RemittanceAccountEnrollment example: object: list data: - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_on_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: Workplace Safety and Insurance Board (WSIB Ontario) label_translations: en: Workplace Safety and Insurance Board (WSIB Ontario) fr: >- Commission de la sécurité professionnelle et de l'assurance contre les accidents du travail (WSIB Ontario) label_translated: Workplace Safety and Insurance Board (WSIB Ontario) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_bc_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: WorkSafeBC (WSBC British Columbia) label_translations: en: WorkSafeBC (WSBC British Columbia) fr: WorkSafeBC (WSBC British Columbia) label_translated: WorkSafeBC (WSBC British Columbia) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_ab_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: Workers Compensation Board (WCB Alberta) label_translations: en: Workers Compensation Board (WCB Alberta) fr: >- Commission des accidents du travail de l'Alberta (CAT-Alberta) label_translated: Workers Compensation Board (WCB Alberta) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_sk_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: Workers Compensation Board (WCB Saskatchewan) label_translations: en: Workers Compensation Board (WCB Saskatchewan) fr: Workers Compensation Board (WCB Saskatchewan) label_translated: Workers Compensation Board (WCB Saskatchewan) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_mb_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: Workers Compensation Board (WCB Manitoba) label_translations: en: Workers Compensation Board (WCB Manitoba) fr: >- Commission des accidents du travail du Manitoba (WCB Manitoba) label_translated: Workers Compensation Board (WCB Manitoba) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_nb_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: WorkSafeNB (WSNB New Brunswick) label_translations: en: WorkSafeNB (WSNB New Brunswick) fr: Travail sécuritaire NB (WSNB Nouveau-Brunswick) label_translated: WorkSafeNB (WSNB New Brunswick) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_ns_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: Workers Compensation Board (WCB Nova Scotia) label_translations: en: Workers Compensation Board (WCB Nova Scotia) fr: Workers Compensation Board (WCB Nova Scotia) label_translated: Workers Compensation Board (WCB Nova Scotia) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_pe_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: Workers Compensation Board (WCB Prince Edward Island) label_translations: en: Workers Compensation Board (WCB Prince Edward Island) fr: Workers Compensation Board (WCB Prince Edward Island) label_translated: Workers Compensation Board (WCB Prince Edward Island) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_nl_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: WorkplaceNL (WNL Newfoundland and Labrador) label_translations: en: WorkplaceNL (WNL Newfoundland and Labrador) fr: WorkplaceNL (WNL Newfoundland and Labrador) label_translated: WorkplaceNL (WNL Newfoundland and Labrador) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_yt_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: Workers' Safety and Compensation Board (WSCB Yukon) label_translations: en: Workers' Safety and Compensation Board (WSCB Yukon) fr: >- Commission de la sécurité et de l'indemnisation des travailleurs (WSCB Yukon) label_translated: Workers' Safety and Compensation Board (WSCB Yukon) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_nt_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: >- Workers Safety and Compensation Commission (WSCC Northwest Territories) label_translations: en: >- Workers Safety and Compensation Commission (WSCC Northwest Territories) fr: >- Commission de la sécurité au travail et de l'indemnisation des travailleurs (CSTIT Territoires du Nord-Ouest) label_translated: >- Workers Safety and Compensation Commission (WSCC Northwest Territories) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_nu_workers_compensation is_default: false is_editable: true is_deletable: true category: ca_workers_compensation label: >- Workers Safety and Compensation Commission (WSCC Nunavut) label_translations: en: >- Workers Safety and Compensation Commission (WSCC Nunavut) fr: >- Commission de la sécurité au travail et de l'indemnisation des travailleurs (CSTIT Nunavut) label_translated: >- Workers Safety and Compensation Commission (WSCC Nunavut) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_nt_government is_default: false is_editable: true is_deletable: true category: ca_provincial_government label: Government of Northwest Territories label_translations: en: Government of Northwest Territories fr: Gouvernement des Territoires du Nord-Ouest label_translated: Government of Northwest Territories account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_nu_government is_default: false is_editable: true is_deletable: true category: ca_provincial_government label: Government of Nunavut label_translations: en: Government of Nunavut fr: Gouvernement du Nunavut label_translated: Government of Nunavut account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ - id: object: remittance_account data: business_entity: id: object: business_entity links: self: /business_entities/ source_tax_property: null account_provider: ca_on_eht is_default: false is_editable: true is_deletable: true category: ca_provincial_government label: Ontario Ministry of Finance (EHT) label_translations: en: Ontario Ministry of Finance (EHT) fr: Ministère des Finances de l'Ontario (ISE) label_translated: Ontario Ministry of Finance (EHT) account_identifier: null remitter_type: null remittance_management: manual note: null address_line_1: null address_line_2: null city: null administrative_area: null province_code: null country_code: null postal_code: null has_payments: false current_enrollments_count: 0 pending_enrollments_count: 0 metadata: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /remittance_accounts/ links: first: /remittance_accounts?business_entity_id=&page=1 last: /remittance_accounts?business_entity_id=&page=2 prev: null next: /remittance_accounts?business_entity_id=&page=2 meta: current_page: 1 last_page: 2 per_page: 15 total: 20 has_more: true components: schemas: RemittanceAccount: type: object title: Remittance Account 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 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 account_provider: type: string description: >- The authority to which remittances are made for this account. This is used to determine how to remit payments for this account. Employer Health Tax (EHT) and Workers' Compensation (WCB) authorities are limited to one account, per province, per business entity; creating a second for an authority that already has one is rejected. nullable: true enum: - ca_ab_workers_compensation - ca_bc_eht - ca_bc_workers_compensation - ca_cra - ca_mb_eht - ca_mb_workers_compensation - ca_nb_workers_compensation - ca_nl_eht - ca_nl_workers_compensation - ca_ns_workers_compensation - ca_nt_government - ca_nt_workers_compensation - ca_nu_government - ca_nu_workers_compensation - ca_on_eht - ca_on_workers_compensation - ca_pe_workers_compensation - ca_rq - ca_sk_workers_compensation - ca_yt_workers_compensation is_default: type: boolean description: >- When true, this account is used for auto-enrollment of new work-assignments, and work-assignments without an existing enrollment for this authority. Only one account per authority per business may be the default at a time. is_editable: type: boolean description: >- When false, the account's `account_identifier` cannot be updated. Becomes false once the account is used on a non-draft payroll and an `account_identifier` is set; returns to true when every referencing payroll is reverted to draft or deleted. is_deletable: type: boolean description: >- When false, the account cannot be deleted. Becomes false once the account is referenced by any non-draft payroll; returns to true when every referencing payroll is reverted to draft or deleted. category: type: string nullable: true enum: - ca_benefit_provider - ca_provincial_government - ca_tax_agency - ca_union - ca_workers_compensation 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 account_identifier: type: string nullable: true maxLength: 255 remitter_type: type: string description: >- The CRA remitter type for this account, which determines remittance due dates and reporting frequency. When null, falls back to the business entity's remitter type. nullable: true enum: - accelerated_threshold_1 - accelerated_threshold_2 - quarterly - regular remittance_management: type: string description: >- Whether remittances for this account are filed manually by the employer (`manual`) or handled automatically by Nmbr (`automatic`). Only accounts Nmbr can remit on your behalf (CRA, RQ, and Employer Health Tax authorities) may be set to `automatic`; all others are always `manual`. enum: - automatic - manual note: type: string nullable: true address_line_1: type: string nullable: true maxLength: 255 address_line_2: type: string nullable: true maxLength: 255 city: type: string nullable: true maxLength: 255 administrative_area: type: string nullable: true maxLength: 255 province_code: type: string nullable: true country_code: type: string nullable: true maxLength: 2 postal_code: type: string nullable: true maxLength: 10 has_payments: type: boolean current_enrollments_count: type: number nullable: true format: decimal pending_enrollments_count: type: number nullable: true format: decimal metadata: $ref: '#/components/schemas/RemittanceAccountMetadata' 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 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 SourceTaxProperty: $ref: '#/components/schemas/TaxProperty' RemittanceAccountEnrollment: type: object title: Remittance Account Enrollment properties: remittance_account: 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 (`"remittance_account"`). readOnly: true work_assignment: 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 (`"work_assignment"`). readOnly: true effective_from: type: string format: date effective_to: type: string nullable: true format: date 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 Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 RemittanceAccountMetadata: type: object description: >- Additional data points for this account. The available fields depend on the account's `category`; `null` for categories that capture no metadata. anyOf: - type: object title: Workers’ compensation properties: last_payment_amount: type: string description: >- The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. `"1250.00"`). nullable: true format: decimal - type: object description: >- Categories with no category-specific metadata. Omit the field or send `null`. title: Other categories nullable: true nullable: true 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 securitySchemes: CompanyToken: type: http scheme: bearer ````