Skip to main content
GET
List tax properties

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
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::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
feature

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

OK

object
string
read-only

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

data
object[]