Remittance Accounts

Create a remittance account

Changed on
post/remittance_accounts

Request

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

Request body

business_entity_idstring required
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' | 'uk_hmrc'
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.

category'ca_benefit_provider' | 'ca_provincial_government' | 'ca_tax_agency' | 'ca_union' | 'ca_workers_compensation' | 'uk_tax_agency'
labelstring required
addresseestring nullable
account_identifierstring nullable
is_defaultboolean
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

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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

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_hmrc enum value to the request property /

    • info

      added the new uk_tax_agency enum value to the request property /

    • 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