---
title: "List tax properties"
method: GET
path: "/tax_properties"
tags: ["Tax Properties"]
---

# List tax properties

`GET /tax_properties`

## Query parameters

- `owner_id` string
- `business_entity_id` string
- `type` union
  - '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::income_tax_rate' | '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::provincial::income_tax_rate' | 'ca::qc::additional_tax' | 'ca::qc::claim_amount' | 'ca::qc::commission_percentage_taxed' | 'ca::qc::eht' | 'ca::qc::income_tax_rate' | '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'
  - string[]
- `feature` union
  - 'eht' | 'first_nation_status' | 'general' | 'onboarding' | 'outside_canada' | 'statutory_holiday_pay' | 'tax_forms' | 'territorial_payroll_tax' | 'workers_compensation'
  - string[]
- `effective_on` object
- `not_effective_on` string, date
- `effective_from` object
- `effective_to` object
- `sort` 'effective_from' | 'effective_to'
- `expand` string[]

## Response `200`

OK

- object
  - `object` string — The type of the object in Nmbr (`"list"`).
  - `data` object[]
    - `id` string — The unique identifier of the object in Nmbr.
    - `object` string — The type of the object in Nmbr (`"tax_property"`).
    - `data` TaxProperty
      - `type` '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::income_tax_rate' | '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::provincial::income_tax_rate' | 'ca::qc::additional_tax' | 'ca::qc::claim_amount' | 'ca::qc::commission_percentage_taxed' | 'ca::qc::eht' | 'ca::qc::income_tax_rate' | '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' — The type of this tax property, determining its format, label, and validation rules.
      - `value` string, nullable — 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.
      - `effective_from` string, date — The date from which this tax property takes effect.
      - `effective_to` string, date, nullable — The date on which this tax property expires. `null` means no end date and the property remains in effect indefinitely.
      - `earliest_valid_effective_to` string, date, nullable — 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.
      - `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.
      - `is_deletable` boolean — Whether this tax property can be deleted.
      - `label` string, nullable — The human-readable display name for this tax property's type.
      - `format` string, nullable — The value format for this tax property's type. Determines how `value` is interpreted.
      - `options` object, nullable — The available options for this tax property's type if it is a select type. `null` if not applicable.
        - `ca_ab` string, nullable
        - `ca_bc` string, nullable
        - `ca_mb` string, nullable
        - `ca_nb` string, nullable
        - `ca_nl` string, nullable
        - `ca_ns` string, nullable
        - `ca_nt` string, nullable
        - `ca_nu` string, nullable
        - `ca_on` string, nullable
        - `ca_pe` string, nullable
        - `ca_qc` string, nullable
        - `ca_sk` string, nullable
        - `ca_yt` string, nullable
        - `ca_oc` string, nullable
      - `allow_concurrent` boolean — Whether multiple tax properties of this tax property's type are allowed on the same owner with overlapping effective date ranges.
      - `feature` string, nullable — The feature this tax property's type is associated with. `null` if not feature-gated.
      - `owner` object — The owner of this tax property. Can be a Business Entity, Work Assignment, or Remittance Account.
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"business_entity"`).
      - `note` string, nullable — An optional note for this tax property.
      - `created_at` string, dateTime — The date and time the object was created in Nmbr.
      - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/revisions/01cd9c45a923/schema)
