Forms

Endpoint to update a Form.

The following example is for a 2026 TD1, but the response fields will differ depending on the specific Form instance requested.

put/forms/{form}

Request

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

Path parameters

formstring required

Request body

form_batch_idstring
notestring nullable

An optional note for this form.

line_1_basic_personal_amountnumber

Up to 2 decimal places.

line_2_infirm_children_caregiver_amountnumber

Up to 2 decimal places.

line_3_age_amountnumber

Up to 2 decimal places.

line_4_pension_income_amountnumber

Up to 2 decimal places.

line_5_tuitionnumber

Up to 2 decimal places.

line_6_disability_amountnumber

Up to 2 decimal places.

line_7_spouse_or_common_law_partner_amountnumber

Up to 2 decimal places.

line_8_eligible_dependent_amountnumber

Up to 2 decimal places.

line_9_infirm_dependent_caregiver_amountnumber

Up to 2 decimal places.

line_10_dependent_caregiver_amountnumber

Up to 2 decimal places.

line_11_spouse_or_common_law_transfer_amountnumber

Up to 2 decimal places.

line_12_dependent_transfer_amountnumber

Up to 2 decimal places.

line_13_total_claim_amountnumber

Up to 2 decimal places.

more_than_one_employer_or_payerboolean
total_income_less_than_total_claim_amountboolean
ninety_percent_world_income_taxable_incomeboolean
prescribed_zone_deductionnumber

Up to 2 decimal places.

additional_tax_deductionnumber

Up to 2 decimal places.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes