---
title: "Update a remittance account"
method: PUT
path: "/remittance_accounts/{remittance_account}"
tags: ["Remittance Accounts"]
---

# Update a remittance account

`PUT /remittance_accounts/{remittance_account}`

## Path parameters

- `remittance_account` string, required

## Request body

- object
  - `is_default` boolean
  - `linked_remittance_account_id` string — 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_provider` string
  - `category` 'ca_benefit_provider' | 'ca_provincial_government' | 'ca_tax_agency' | 'ca_union' | 'ca_workers_compensation'
  - `label` string
  - `label_translations` Translations, nullable
    - `en` string
    - `fr` string
  - `account_identifier` string, nullable — Editing is prevented when `is_editable` is false
  - `remitter_type` 'accelerated_threshold_1' | 'accelerated_threshold_2' | 'quarterly' | 'regular'
  - `remittance_management` 'automatic' | 'manual'
  - `note` string, nullable
  - `address_line_1` string, nullable
  - `address_line_2` string, nullable
  - `city` string, nullable
  - `administrative_area` string, nullable
  - `province_code` string, 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_code` string, nullable — Must be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., `CA`).
  - `postal_code` string, nullable
  - `metadata` union — Additional data points for this account. The available fields depend on the account's `category`; `null` for categories that capture no metadata.
    - object
      - `last_payment_amount` string, decimal, nullable — The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. `"1250.00"`).
    - object, nullable — Categories with no category-specific metadata. Omit the field or send `null`.

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"remittance_account"`).
  - `data` RemittanceAccount
    - `business_entity` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"business_entity"`).
    - `source_tax_property` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"tax_property"`).
    - `account_provider` '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', nullable — 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.
    - `is_default` boolean — 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` boolean — 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` boolean — 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.
    - `linked_remittance_account` unknown
    - `category` 'ca_benefit_provider' | 'ca_provincial_government' | 'ca_tax_agency' | 'ca_union' | 'ca_workers_compensation', nullable
    - `label` string
    - `label_translations` Translations, nullable
      - `en` string
      - `fr` string
    - `label_translated` string — 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.
    - `account_identifier` string, nullable
    - `remitter_type` 'accelerated_threshold_1' | 'accelerated_threshold_2' | 'quarterly' | 'regular', nullable — 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.
    - `remittance_management` 'automatic' | 'manual' — 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`.
    - `note` string, nullable
    - `address_line_1` string, nullable
    - `address_line_2` string, nullable
    - `city` string, nullable
    - `administrative_area` string, nullable
    - `province_code` string, nullable
    - `country_code` string, nullable
    - `postal_code` string, nullable
    - `has_payments` boolean
    - `current_enrollments_count` number, nullable
    - `pending_enrollments_count` number, nullable
    - `metadata` union — Additional data points for this account. The available fields depend on the account's `category`; `null` for categories that capture no metadata.
      - object
        - `last_payment_amount` string, decimal, nullable — The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. `"1250.00"`).
      - object, nullable — Categories with no category-specific metadata. Omit the field or send `null`.
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)