Remittance Accounts
Create a remittance account
post/remittance_accounts
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'
category'ca_benefit_provider' | 'ca_provincial_government' | 'ca_tax_agency' | 'ca_union' | 'ca_workers_compensation'
labelstring required
account_identifierstring nullable
is_defaultboolean
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
Created
idstring
The unique identifier of the object in Nmbr.
objectstring
The type of the object in Nmbr ("remittance_account").