Skip to main content
GET
/
remittance_accounts
List remittance accounts
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/remittance_accounts \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_on_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workplace Safety and Insurance Board (WSIB Ontario)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_bc_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "WorkSafeBC (WSBC British Columbia)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_ab_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workers Compensation Board (WCB Alberta)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_sk_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workers Compensation Board (WCB Saskatchewan)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_mb_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workers Compensation Board (WCB Manitoba)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_nb_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "WorkSafeNB (WSNB New Brunswick)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_ns_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workers Compensation Board (WCB Nova Scotia)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_pe_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workers Compensation Board (WCB Prince Edward Island)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_nl_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "WorkplaceNL (WNL Newfoundland and Labrador)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_yt_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Yukon Workers Compensation Health and Safety Board (YWCHSB Yukon)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_nt_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workers Safety and Compensation Commission (WSCC Northwest Territories)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_nu_workers_compensation",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_workers_compensation",
        "label": "Workers Safety and Compensation Commission (WSCC Nunavut)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_nt_government",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_provincial_government",
        "label": "Government of Northwest Territories",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_nu_government",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_provincial_government",
        "label": "Government of Nunavut",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "remittance_account",
      "data": {
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "source_tax_property": null,
        "account_provider": "ca_on_eht",
        "is_default": false,
        "is_editable": true,
        "is_deletable": true,
        "category": "ca_provincial_government",
        "label": "Ontario Ministry of Finance (EHT)",
        "account_identifier": null,
        "remitter_type": null,
        "note": null,
        "address_line_1": null,
        "address_line_2": null,
        "city": null,
        "province_code": null,
        "country_code": null,
        "postal_code": null,
        "has_payments": false,
        "current_enrollments_count": 0,
        "pending_enrollments_count": 0,
        "metadata": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/remittance_accounts/<id>"
      }
    }
  ],
  "links": {
    "first": "/remittance_accounts?business_entity_id=<id>&page=1",
    "last": "/remittance_accounts?business_entity_id=<id>&page=2",
    "prev": null,
    "next": "/remittance_accounts?business_entity_id=<id>&page=2"
  },
  "meta": {
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "total": 20,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

business_entity_id
string
required
category
enum<string>
Available options:
ca_benefit_provider,
ca_provincial_government,
ca_tax_agency,
ca_union,
ca_workers_compensation
has_payments
boolean
account_provider
enum<string>
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
system_type
enum<string>
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
expand
enum<string>[]
Available options:
business_entity,
remittance_account_enrollments,
source_tax_property

Response

200 - application/json

OK

object
string
read-only

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

data
object[]