Managing Remittance Accounts
Each Business Entity can have multiple accounts for each tax agency — for example, a business with multiple divisions might have separate CRA accounts for each division’s payroll. However, each account must have a uniqueaccount_identifier within the same Business Entity and provider.
When creating a CRA or RQ Remittance Account, the account_provider field must be set to either ca_cra or ca_rq. The category is automatically derived from the provider — both CRA and RQ accounts are assigned the ca_tax_agency category. The account_identifier is optional at creation time but must be set before Payrolls can be approved.
Tax-agency configuration
The Remittance Account is where tax-agency configuration lives: enrollments,
remittance reporting, remitter type, the tax ID (via
account_identifier),
and Tax Properties like EI Premium Reduction configured for the account.Account Identifier Formats
Each agency has a specific identifier format:- CRA: 9 digits +
RP+ 4 digits (e.g.123456789RP0001) - RQ: 10 digits +
RS+ 4 digits (e.g.1234567890RS0001)
Tax Property sync
The
account_identifier and the corresponding ca::tax_id (for CRA) or
ca::qc::tax_id (for RQ) Tax Property on the Business Entity stay in sync.
Writing either one creates or updates the other.Updating a Remittance Account
Theaccount_provider field cannot be changed after creation. The account_identifier and category fields become locked once the Remittance Account is no longer editable (i.e. it has been used on a non-draft payroll). You can check the is_editable field on the Remittance Account to determine whether these fields can be modified. The label field can always be updated.
Account Metadata
Some Remittance Accounts capture extra data points specific to their category, returned in the account’smetadata field. The available fields depend on the category:
- Workers’ compensation accounts can capture
last_payment_amount, which Nmbr uses to enable automated remittance for select providers. See the Workers Compensation Board (WCB) guide.
metadata is null.
Remitter Type
Every CRA and RQ Remittance Account needs a remitter type to determine when remittance payments are due and how they are reported. The CRA assigns a remitter type to each business based on its average monthly withholding amount (AMWA). The possible values are:| Value | Description | AMWA Range |
|---|---|---|
quarterly | Quarterly remitter — new small employers or accounts with a perfect compliance record | 2,999.99 |
regular | Regular remitter — remittances due by the 15th of the following month | 24,999.99 |
accelerated_threshold_1 | Accelerated remitter (Threshold 1) — remittances due twice monthly | 99,999.99 |
accelerated_threshold_2 | Accelerated remitter (Threshold 2) — remittances due within 3 business days | $100,000+ |
Setting the Remitter Type
The remitter type can be set in two places:- On the Business Entity — applies as a default to all CRA and RQ Remittance Accounts under that Business Entity.
- On the Remittance Account — overrides the Business Entity default for that specific account.
remitter_type if set, otherwise falls back to the Business Entity’s remitter_type. If neither is set, payroll approval will be blocked with a remitter_type_not_provided warning.
For most businesses, setting the remitter type on the Business Entity is sufficient — all CRA and RQ accounts will inherit the same value. Per-account overrides are available for cases where an account needs a different remitter type.
To set the remitter type on a Remittance Account, include the remitter_type field when creating or updating the account.
Auto-Enrollment
When a Remittance Account is the only account of its provider type for a Business Entity, Nmbr automatically enrolls Work Assignments into it. This covers the common case where a business has a single CRA account and/or a single RQ account.CRA Auto-Enrollment
When a CRA Remittance Account is created and it is the only CRA account for the Business Entity, all existing Work Assignments belonging to that Business Entity are automatically enrolled. Similarly, when a new Work Assignment is created and the Business Entity has exactly one CRA account, the Work Assignment is automatically enrolled into it.RQ Auto-Enrollment
RQ auto-enrollment follows the same logic but only applies to Work Assignments with a Quebec province of employment — either set explicitly on the Work Assignment or inherited from the Business Entity. When an RQ Remittance Account is created and it is the only RQ account for the Business Entity, all eligible Quebec Work Assignments are automatically enrolled. New Quebec Work Assignments are also auto-enrolled if exactly one RQ account exists.When Auto-Enrollment Does Not Apply
Auto-enrollment is skipped when a Business Entity has more than one account for the same provider. In this case, you must manually enroll Work Assignments using the enrollment endpoints described below.Managing Enrollments
Manual enrollment is required when a Business Entity has multiple accounts for the same provider — for example, two CRA Remittance Accounts for different divisions.Creating an Enrollment
Use Remittance Account Enrollments to enroll a Work Assignment into a Remittance Account. Each enrollment has aneffective_from date and an optional effective_to. The Remittance Account and Work Assignment must belong to the same Business Entity, and only ca_cra and ca_rq accounts support enrollments.
Enrollments for the same Work Assignment and provider cannot overlap. If a conflict exists, pass overlap_strategy: "replace_existing" to automatically resolve overlaps instead of returning a validation error. Existing enrollments that started before the new effective_from are ended (their effective_to is set to the day before), and overlapping enrollments that start on or after the new effective_from are deleted.
Bulk Creating Enrollments
Use Bulk Operations to enroll multiple Work Assignments at once. Rather than specifying individual Work Assignments, you provide abusiness_entity_id and use the work_assignments field to query which ones to enroll — for example, all Work Assignments, or only those on a specific Pay Schedule. All selected Work Assignments receive the same Remittance Account and effective dates.
Payroll Warnings
Nmbr surfaces warnings on payrolls when Remittance Account configuration is incomplete. These warnings block payroll approval until resolved.Missing Enrollment
The warningsmissing_cra_remittance_account_enrollment and missing_rq_remittance_account_enrollment appear when a Pay Stub has no active enrollment for the pay period. This typically means the Work Assignment was never enrolled, or the enrollment’s effective dates don’t cover the payroll period.
To resolve, create an enrollment for the affected Work Assignment. If the Business Entity has only one account of that provider type, the enrollment may have been inadvertently removed.
Missing Identifier
The warningsmissing_cra_remittance_account_identifier and missing_rq_remittance_account_identifier appear when a Remittance Account used on the payroll has no account_identifier set.
To resolve, update the Remittance Account with the correct identifier.
