Retrieve a remittance account

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

remittance_account

string

required

Query Parameters

expand

enum<string>[]

Available options:

business_entity,

remittance_account_enrollments,

source_tax_property

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Default · object

Default
With business_entity expanded
With source_tax_property expanded
With remittance_account_enrollments expanded

Hide child attributes

data.business_entity

object

Hide child attributes

data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_entity.object

string

read-only

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

data.source_tax_property

object

Hide child attributes

data.source_tax_property.id

string

read-only

The unique identifier of the object in Nmbr.

data.source_tax_property.object

string

read-only

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

data.account_provider

enum<string> | null

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.

Available options:

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

data.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.

data.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.

data.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.

data.category

enum<string> | null

Available options:

ca_benefit_provider,

ca_provincial_government,

ca_tax_agency,

ca_union,

ca_workers_compensation

data.label

string

Maximum string length: 255

data.account_identifier

string | null

Maximum string length: 255

data.remitter_type

enum<string> | null

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.

Available options:

accelerated_threshold_1,

accelerated_threshold_2,

quarterly,

regular

data.note

string | null

data.address_line_1

string | null

Maximum string length: 30

data.address_line_2

string | null

Maximum string length: 30

data.city

string | null

Maximum string length: 28

data.province_code

string | null

Maximum string length: 100

data.country_code

string | null

Maximum string length: 2

data.postal_code

string | null

Maximum string length: 10

data.has_payments

boolean

data.current_enrollments_count

number<decimal> | null

data.pending_enrollments_count

number<decimal> | null

data.metadata

Workers’ compensation · object

Additional data points for this account. The available fields depend on the account's category; null for categories that capture no metadata.

Workers’ compensation
Other categories

Hide child attributes

data.metadata.last_payment_amount

string<decimal> | null

The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. "1250.00").

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.