NMnmbr
Tax Properties

Update a tax property

Changed on
put/tax_properties/{tax_property}

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Path parameters

tax_propertystring required

Request body

effective_fromstring date

The date from which this tax property takes effect.

Only updatable when is_editable is true.

Editing is prevented when is_editable is false

effective_tostring date

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

type'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' | 'uk::has_irregular_payment' | 'uk::has_postgraduate_loan' | 'uk::ni_category' | 'uk::p45' | 'uk::payroll_id' | 'uk::starter_declaration' | 'uk::student_loan_plan' | 'uk::tax_basis' | 'uk::tax_code'

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

Only updatable when is_editable is true.

Editing is prevented when is_editable is false

valuestring

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.

Only updatable when is_editable is true.

Editing is prevented when is_editable is false

notestring nullable

An optional note for this tax property.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

  • 353210c3786cRevision changes
    • warning

      added the new uk::has_irregular_payment enum value to the / response property for the response status

    • warning

      added the new uk::has_postgraduate_loan enum value to the / response property for the response status

    • warning

      added the new uk::ni_category enum value to the / response property for the response status

    • warning

      added the new uk::p45 enum value to the / response property for the response status

    • warning

      added the new uk::payroll_id enum value to the / response property for the response status

    • warning

      added the new uk::starter_declaration enum value to the / response property for the response status

    • warning

      added the new uk::student_loan_plan enum value to the / response property for the response status

    • warning

      added the new uk::tax_basis enum value to the / response property for the response status

    • warning

      added the new uk::tax_code enum value to the / response property for the response status

    • info

      added the new uk::has_irregular_payment enum value to the request property

    • info

      added the new uk::has_postgraduate_loan enum value to the request property

    • info

      added the new uk::ni_category enum value to the request property

    • info

      added the new uk::p45 enum value to the request property

    • info

      added the new uk::payroll_id enum value to the request property

    • info

      added the new uk::starter_declaration enum value to the request property

    • info

      added the new uk::student_loan_plan enum value to the request property

    • info

      added the new uk::tax_basis enum value to the request property

    • info

      added the new uk::tax_code enum value to the request property

  • b9b79a0450dfRevision changes
    • warning

      added the new ca::authorized_province enum value to the / response property for the response status

    • info

      added the new ca::authorized_province enum value to the request property