NMnmbr
Remittance Accounts

Update a remittance account

Changed on
put/remittance_accounts/{remittance_account}

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

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. With superseded_on set, 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. Without a date, the replacement is recorded and enrollments are left as they are. Clearing the value, or the date, also leaves enrollments as they are. Only one account in a line of accounts can have a replacement waiting to take effect at a time.

May be set without superseded_on, in which case no enrollments are moved.

superseded_onstring date

The date this account was replaced by its successor, from which its enrolled employees move to the superseding account. Optional: left unset, the successor is recorded and no enrollments are moved. Must be today or later, and later than the most recent pay date already paid through this account.

Requires superseding_remittance_account_id; a date without a superseding account 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' | 'uk_tax_agency'
labelstring
addresseestring nullable
account_identifierstring nullable

Editing is prevented when is_editable is false

remitter_type'accelerated_threshold_1' | 'accelerated_threshold_2' | 'annual' | 'quarterly' | 'regular'
remittance_management'automatic' | 'manual'
notestring nullable
address_line_1string nullable

Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

address_line_2string nullable

Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

citystring nullable

Up to 28 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

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

  • e2262a86fcc4Revision changes
    • warning

      added the new uk_hmrc enum value to the / response property for the response status

    • warning

      added the new uk_tax_agency enum value to the / response property for the response status

    • info

      added the new uk_tax_agency enum value to the request property

  • fd2d967d9df4Revision changes
    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 255