Sign in
Remittance Accounts

Update a remittance account

put/remittance_accounts/{remittance_account}

Path parameters

remittance_accountstring required

Request body

is_defaultboolean
superseding_remittance_account_idstring

The account that replaces this one after a business-number change or correction. Ties this account's paid history to its successor for combined year-to-date. Employees enrolled in this account are enrolled in the successor from the changeover date onward, and a work assignment created afterwards is enrolled in whichever account covers each part of its dates. Only one account in a line of accounts can have a replacement waiting to take effect at a time.

Must be set together with superseded_on; providing one without the other is rejected.

superseded_onstring date

The date this account was replaced by its successor. Must be a future date, and later than the most recent pay date already paid through this account.

Must be set together with superseding_remittance_account_id; providing one without the other is rejected.

linked_remittance_account_idstring

The id of a CRA remittance account in the same business entity whose enrollments this account should follow. When set, work assignments enrolled in that CRA account are automatically enrolled in this account with matching effective dates, and manual enrollments on this account become unavailable. Only a Revenue Québec account may be linked, and only to a CRA account. An account that is the default for its authority cannot be linked; set is_default to false in the same request to link it. Clearing the value releases the generated enrollments, which stay in place and become editable and deletable again.

account_providerstring
category'ca_benefit_provider' | 'ca_provincial_government' | 'ca_tax_agency' | 'ca_union' | 'ca_workers_compensation'
labelstring
account_identifierstring nullable

Editing is prevented when is_editable is false

remitter_type'accelerated_threshold_1' | 'accelerated_threshold_2' | 'quarterly' | 'regular'
remittance_management'automatic' | 'manual'
notestring nullable
address_line_1string nullable
address_line_2string nullable
citystring nullable
administrative_areastring nullable
province_codestring nullable

In Canada, must be an uppercase 2-letter province code: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT

country_codestring nullable

Must be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., CA).

postal_codestring nullable

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes