List tax properties

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/tax_properties \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "tax_property",
      "data": {
        "type": "ca::province_of_employment",
        "value": "ca_on",
        "effective_from": "2026-01-01",
        "effective_to": null,
        "earliest_valid_effective_to": "2026-01-01",
        "is_editable": true,
        "is_deletable": true,
        "label": "Province of Employment",
        "format": "string",
        "options": {
          "ca_ab": "Alberta",
          "ca_bc": "British Columbia",
          "ca_mb": "Manitoba",
          "ca_nb": "New Brunswick",
          "ca_nl": "Newfoundland and Labrador",
          "ca_ns": "Nova Scotia",
          "ca_nt": "Northwest Territories",
          "ca_nu": "Nunavut",
          "ca_on": "Ontario",
          "ca_pe": "Prince Edward Island",
          "ca_qc": "Quebec",
          "ca_sk": "Saskatchewan",
          "ca_yt": "Yukon",
          "ca_oc": "Outside Canada"
        },
        "allow_concurrent": false,
        "feature": "onboarding",
        "owner": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "note": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tax_properties/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "tax_property",
      "data": {
        "type": "ca::tax_id",
        "value": "136549169RP9916",
        "effective_from": "2026-01-01",
        "effective_to": null,
        "earliest_valid_effective_to": "2026-01-01",
        "is_editable": true,
        "is_deletable": true,
        "label": "Tax ID",
        "format": "string",
        "options": null,
        "allow_concurrent": true,
        "feature": "onboarding",
        "owner": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "note": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tax_properties/<id>"
      }
    }
  ],
  "links": {
    "first": "/tax_properties?owner_id=<id>&page=1",
    "last": "/tax_properties?owner_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 2,
    "has_more": false
  }
}

GET

tax_properties

List tax properties

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/tax_properties \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "tax_property",
      "data": {
        "type": "ca::province_of_employment",
        "value": "ca_on",
        "effective_from": "2026-01-01",
        "effective_to": null,
        "earliest_valid_effective_to": "2026-01-01",
        "is_editable": true,
        "is_deletable": true,
        "label": "Province of Employment",
        "format": "string",
        "options": {
          "ca_ab": "Alberta",
          "ca_bc": "British Columbia",
          "ca_mb": "Manitoba",
          "ca_nb": "New Brunswick",
          "ca_nl": "Newfoundland and Labrador",
          "ca_ns": "Nova Scotia",
          "ca_nt": "Northwest Territories",
          "ca_nu": "Nunavut",
          "ca_on": "Ontario",
          "ca_pe": "Prince Edward Island",
          "ca_qc": "Quebec",
          "ca_sk": "Saskatchewan",
          "ca_yt": "Yukon",
          "ca_oc": "Outside Canada"
        },
        "allow_concurrent": false,
        "feature": "onboarding",
        "owner": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "note": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tax_properties/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "tax_property",
      "data": {
        "type": "ca::tax_id",
        "value": "136549169RP9916",
        "effective_from": "2026-01-01",
        "effective_to": null,
        "earliest_valid_effective_to": "2026-01-01",
        "is_editable": true,
        "is_deletable": true,
        "label": "Tax ID",
        "format": "string",
        "options": null,
        "allow_concurrent": true,
        "feature": "onboarding",
        "owner": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "note": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tax_properties/<id>"
      }
    }
  ],
  "links": {
    "first": "/tax_properties?owner_id=<id>&page=1",
    "last": "/tax_properties?owner_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 2,
    "has_more": false
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

owner_id

string

Filter by owner. Accepts a comma-separated list of IDs.

business_entity_id

string

type

enum<string>

Available options:

ca::ab::claim_amount,

ca::ab::total_income_less_than_total_claim_amount,

ca::ab::workers_compensation_class,

ca::bc::claim_amount,

ca::bc::eht,

ca::bc::total_income_less_than_total_claim_amount,

ca::bc::workers_compensation_class,

ca::cpp_exempt,

ca::ei_exempt,

ca::ei_premium_reduction,

ca::federal::additional_tax,

ca::federal::annual_deduction_at_source,

ca::federal::claim_amount,

ca::federal::commission_expenses,

ca::federal::commission_total_income,

ca::federal::total_income_less_than_total_claim_amount,

ca::federal_oc_surtax_exempt,

ca::first_nation_exemptions,

ca::mb::claim_amount,

ca::mb::eht,

ca::mb::total_income_less_than_total_claim_amount,

ca::mb::workers_compensation_class,

ca::nb::claim_amount,

ca::nb::total_income_less_than_total_claim_amount,

ca::nb::workers_compensation_class,

ca::nl::claim_amount,

ca::nl::eht,

ca::nl::total_income_less_than_total_claim_amount,

ca::nl::workers_compensation_class,

ca::ns::claim_amount,

ca::ns::total_income_less_than_total_claim_amount,

ca::ns::workers_compensation_class,

ca::nt::claim_amount,

ca::nt::territorial_payroll_tax,

ca::nt::total_income_less_than_total_claim_amount,

ca::nt::workers_compensation_class,

ca::nu::claim_amount,

ca::nu::territorial_payroll_tax,

ca::nu::total_income_less_than_total_claim_amount,

ca::nu::workers_compensation_class,

ca::on::claim_amount,

ca::on::dependent_children_credit,

ca::on::eht,

ca::on::impaired_dependants_credit,

ca::on::total_income_less_than_total_claim_amount,

ca::on::workers_compensation_class,

ca::pe::claim_amount,

ca::pe::total_income_less_than_total_claim_amount,

ca::pe::workers_compensation_class,

ca::province_of_employment,

ca::province_of_work,

ca::qc::additional_tax,

ca::qc::claim_amount,

ca::qc::commission_percentage_taxed,

ca::qc::eht,

ca::qc::qpip_exempt,

ca::qc::qpp_exempt,

ca::qc::tax_id,

ca::qc::total_income_less_than_total_claim_amount,

ca::qc::workers_compensation_class,

ca::sk::claim_amount,

ca::sk::total_income_less_than_total_claim_amount,

ca::sk::workers_compensation_class,

ca::statutory_holiday_pay,

ca::tax_id,

ca::yt::claim_amount,

ca::yt::total_income_less_than_total_claim_amount,

ca::yt::workers_compensation_class

feature

enum<string>

Filter by feature. Accepts a comma-separated list of feature values.

Available options:

eht,

first_nation_status,

general,

onboarding,

outside_canada,

statutory_holiday_pay,

tax_forms,

territorial_payroll_tax,

workers_compensation

effective_on

object

Filter by effective date. Accepts a full date (YYYY-MM-DD), a year-month (YYYY-MM), or a year (YYYY). Returns Tax Properties that are in effect at any point during the specified period.

Partial date filters support three formats:

YYYY — Returns all records matching the given year. Example: effective_on=2024
YYYY-MM — Returns all records matching the given month. Example: effective_on=2024-06
YYYY-MM-DD — Returns all records matching the specific date. Example: effective_on=2024-06-15

not_effective_on

string<date>

Filter to Tax Properties that are NOT in effect on the given date (YYYY-MM-DD).

effective_from

object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_from=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

gt (greater than)
gte (greater than or equal to)
lte (less than or equal to)
lt (less than) Example: effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31

effective_to

object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_to=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

gt (greater than)
gte (greater than or equal to)
lte (less than or equal to)
lt (less than) Example: effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31

sort

enum<string>

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

Available options:

effective_from,

effective_to

expand

enum<string>[]

Available options:

owner

Response

200 - application/json

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.data

Default · object

Default
With owner expanded

Hide child attributes

data.data.type

enum<string>

The type of this tax property, determining its format, label, and validation rules.

Available options:

ca::ab::claim_amount,

ca::ab::total_income_less_than_total_claim_amount,

ca::ab::workers_compensation_class,

ca::bc::claim_amount,

ca::bc::eht,

ca::bc::total_income_less_than_total_claim_amount,

ca::bc::workers_compensation_class,

ca::cpp_exempt,

ca::ei_exempt,

ca::ei_premium_reduction,

ca::federal::additional_tax,

ca::federal::annual_deduction_at_source,

ca::federal::claim_amount,

ca::federal::commission_expenses,

ca::federal::commission_total_income,

ca::federal::total_income_less_than_total_claim_amount,

ca::federal_oc_surtax_exempt,

ca::first_nation_exemptions,

ca::mb::claim_amount,

ca::mb::eht,

ca::mb::total_income_less_than_total_claim_amount,

ca::mb::workers_compensation_class,

ca::nb::claim_amount,

ca::nb::total_income_less_than_total_claim_amount,

ca::nb::workers_compensation_class,

ca::nl::claim_amount,

ca::nl::eht,

ca::nl::total_income_less_than_total_claim_amount,

ca::nl::workers_compensation_class,

ca::ns::claim_amount,

ca::ns::total_income_less_than_total_claim_amount,

ca::ns::workers_compensation_class,

ca::nt::claim_amount,

ca::nt::territorial_payroll_tax,

ca::nt::total_income_less_than_total_claim_amount,

ca::nt::workers_compensation_class,

ca::nu::claim_amount,

ca::nu::territorial_payroll_tax,

ca::nu::total_income_less_than_total_claim_amount,

ca::nu::workers_compensation_class,

ca::on::claim_amount,

ca::on::dependent_children_credit,

ca::on::eht,

ca::on::impaired_dependants_credit,

ca::on::total_income_less_than_total_claim_amount,

ca::on::workers_compensation_class,

ca::pe::claim_amount,

ca::pe::total_income_less_than_total_claim_amount,

ca::pe::workers_compensation_class,

ca::province_of_employment,

ca::province_of_work,

ca::qc::additional_tax,

ca::qc::claim_amount,

ca::qc::commission_percentage_taxed,

ca::qc::eht,

ca::qc::qpip_exempt,

ca::qc::qpp_exempt,

ca::qc::tax_id,

ca::qc::total_income_less_than_total_claim_amount,

ca::qc::workers_compensation_class,

ca::sk::claim_amount,

ca::sk::total_income_less_than_total_claim_amount,

ca::sk::workers_compensation_class,

ca::statutory_holiday_pay,

ca::tax_id,

ca::yt::claim_amount,

ca::yt::total_income_less_than_total_claim_amount,

ca::yt::workers_compensation_class

Maximum string length: 255

data.data.value

string | null

The value of this tax property. Format depends on format: numeric types store a decimal string, boolean types store a boolean, select types store a string key, and object types store a structured value object.

data.data.effective_from

string<date>

The date from which this tax property takes effect.

data.data.effective_to

string<date> | null

The date on which this tax property expires. null means no end date and the property remains in effect indefinitely.

data.data.earliest_valid_effective_to

string<date> | null

The earliest date that effective_to can be set to without triggering a validation error. Corresponds to the pay date of the most recent non-draft payroll that used this property.

data.data.is_editable

boolean

Whether this tax property can be fully edited. When false, only effective_to and note may be updated.

When false, only the effective_to and note attributes may be updated.

data.data.is_deletable

boolean

Whether this tax property can be deleted.

data.data.label

string | null

The human-readable display name for this tax property's type.

data.data.format

string | null

The value format for this tax property's type. Determines how value is interpreted.

data.data.options

object

The available options for this tax property's type if it is a select type. null if not applicable.

Hide child attributes

data.data.options.ca_ab

string | null

data.data.options.ca_bc

string | null

data.data.options.ca_mb

string | null

data.data.options.ca_nb

string | null

data.data.options.ca_nl

string | null

data.data.options.ca_ns

string | null

data.data.options.ca_nt

string | null

data.data.options.ca_nu

string | null

data.data.options.ca_on

string | null

data.data.options.ca_pe

string | null

data.data.options.ca_qc

string | null

data.data.options.ca_sk

string | null

data.data.options.ca_yt

string | null

data.data.options.ca_oc

string | null

data.data.allow_concurrent

boolean

Whether multiple tax properties of this tax property's type are allowed on the same owner with overlapping effective date ranges.

data.data.feature

string | null

The feature this tax property's type is associated with. null if not feature-gated.

data.data.owner

object

The owner of this tax property. Can be a Business Entity, Work Assignment, or Remittance Account.

Hide child attributes

data.data.owner.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.owner.object

string

read-only

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

data.data.note

string | null

An optional note for this tax property.

data.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

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

Show bulk delete scope for remittance account enrollments Create a tax property

⌘I