> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # Search tax properties ## OpenAPI ````yaml /spec/openapi.json post /tax_properties/search openapi: 3.0.0 info: title: Nmbr API description: API to interact with Nmbr Payroll version: 1.0.0 servers: - url: https://sandbox.nmbr.co/services/payroll security: - CompanyToken: [] tags: - name: Accounting Codes - name: Accounting Code Rules - name: Adjustments - name: Allowances - name: Allowance Line Items - name: Allowance Types - name: Async Tasks - name: Bank Accounts - name: Business Entities - name: Business Entity Verifications - name: Business Entity ROE Authorizations - name: Business Presets - name: Calculations - name: Companies - name: Contractors - name: Deductions - name: Deduction Line Items - name: Deduction Types - name: Earnings - name: Earning Line Items - name: Earning Types - name: Effective Tax Properties - name: Employees - name: Employee Benefits - name: Employee Benefit Line Items - name: Employee Benefit Types - name: Employer Benefits - name: Employer Benefit Line Items - name: Employer Benefit Types - name: Employer Statutory Withholding Line Items - name: Employer Statutory Withholding Types - name: Forms - name: Form Batches - name: Form Types - name: Holidays - name: Integrations - name: Journal Entries - name: Overtime Rates - name: Partners - name: Pay Rates - name: Pay Schedules - name: Pay Splits - name: Pay Stubs - name: Payments - name: Payrolls - name: Reimbursements - name: Reimbursement Line Items - name: Reimbursement Types - name: Remittance Accounts - name: Remittance Account Enrollments - name: Remittance Totals - name: Reports - name: ROE SAT Agreements - name: Statutory Withholding Line Items - name: Statutory Withholding Types - name: Tags - name: Tag Groups - name: Tax Properties - name: Tax Property Templates - name: Tokens - name: Usage Records - name: Usage Summaries - name: Vacation Pay - name: Vacation Pay Settings - name: Webhooks - name: Work Assignments paths: /tax_properties/search: post: tags: - Tax Properties summary: Search tax properties operationId: tax-properties-search requestBody: content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: object properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"tax_property"`). readOnly: true data: $ref: '#/components/schemas/TaxProperty' example: object: list data: - 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: object: work_assignment links: self: /work_assignments/ note: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /tax_properties/ links: first: http://localhost/tax_properties/search?page=1 last: http://localhost/tax_properties/search?page=1 prev: null next: null meta: current_page: 1 last_page: 1 per_page: 15 total: 1 has_more: false components: schemas: TaxProperty: type: object title: Tax Property properties: type: type: string description: >- The type of this tax property, determining its format, label, and validation rules. maxLength: 255 enum: - ca::ab::claim_amount - ca::ab::total_income_less_than_total_claim_amount - ca::ab::workers_compensation_class - ca::authorized_province - 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 value: type: string description: >- 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. nullable: true effective_from: type: string description: The date from which this tax property takes effect. format: date effective_to: type: string description: >- The date on which this tax property expires. `null` means no end date and the property remains in effect indefinitely. nullable: true format: date earliest_valid_effective_to: type: string description: >- 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. nullable: true format: date is_editable: type: boolean description: >- 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: type: boolean description: Whether this tax property can be deleted. label: type: string description: The human-readable display name for this tax property's type. nullable: true format: type: string description: >- The value format for this tax property's type. Determines how `value` is interpreted. nullable: true options: type: object description: >- The available options for this tax property's type if it is a select type. `null` if not applicable. nullable: true properties: ca_ab: type: string nullable: true ca_bc: type: string nullable: true ca_mb: type: string nullable: true ca_nb: type: string nullable: true ca_nl: type: string nullable: true ca_ns: type: string nullable: true ca_nt: type: string nullable: true ca_nu: type: string nullable: true ca_on: type: string nullable: true ca_pe: type: string nullable: true ca_qc: type: string nullable: true ca_sk: type: string nullable: true ca_yt: type: string nullable: true ca_oc: type: string nullable: true allow_concurrent: type: boolean description: >- Whether multiple tax properties of this tax property's type are allowed on the same owner with overlapping effective date ranges. feature: type: string description: >- The feature this tax property's type is associated with. `null` if not feature-gated. nullable: true owner: type: object description: >- The owner of this tax property. Can be a Business Entity, Work Assignment, or Remittance Account. properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true note: type: string description: An optional note for this tax property. nullable: true created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime securitySchemes: CompanyToken: type: http scheme: bearer ````