Skip to main content
GET
List remittance totals

Authorizations

Authorization
string
header
required

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

Path Parameters

payroll
string
required

Query Parameters

account_provider
enum<string>[]

Only return totals for these authorities. Supports multiple comma-separated values.

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,
uk_hmrc
remittance_account_id
string[]

Only return totals for these remittance accounts. Supports multiple comma-separated values.

expand
enum<string>[]

The relationships to expand in the response.

Available options:
remittance_account
shape
enum<string>

The shape of the response. full, the default, returns each object in full. minimal returns only each object's id and object, without its data.

Available options:
full,
minimal

Response

200 - application/json

OK

object
string
read-only

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

data
(Full · object | Minimal · object)[]

Returned by default or when you send shape=full. The object in full.