NMnmbr
Remittance Totals

List remittance totals

Changed on

Totals every statutory withholding, deduction and benefit on the payroll that names a remittance destination, and returns one figure per destination — what the payroll owes the CRA, Revenue Québec, each benefit provider, union, workers' compensation board and employer health tax authority.

Totals are computed when you ask for them, so they are available on a draft payroll that has never been approved, and on historical, correction and off-cycle payrolls that never produce payments at all. The whole list comes back in one response — there are no pages.

Line items that name no remittance destination are left out entirely; there is no catch-all entry for them. A payroll with nothing to remit returns an empty list.

get/payrolls/{payroll}/remittances

Request

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

Path parameters

payrollstring required

Query parameters

'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'
OR
string[]

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

remittance_account_idstring

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

expandstring[]

Response

OK

objectstring

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

Changes

  • e2262a86fcc4Revision changes
    • warning

      added the new uk_hmrc enum value to the //// response property for the response status

    • 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

  • 353210c3786cRevision changes
    • warning

      added the new annual enum value to the ////// response property for the response status