NMnmbr
Forms

Create a form

Changed on

Endpoint to create a Form.

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

post/forms

Request

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

Request body

owner_idstring required
form_batch_idstring
type'rl1' | 'roe' | 't4' | 't4a' | 'td1' | 'td1ab' | 'td1bc' | 'td1mb' | 'td1nb' | 'td1nl' | 'td1ns' | 'td1nt' | 'td1nu' | 'td1on' | 'td1pe' | 'td1sk' | 'td1x' | 'td1yt' | 'tp_1015_3_v' | 'tp_1015_r_13_v' required

The type of form (e.g. T4, ROE, RL-1).

effective_datestring date

The effective date used to determine the form variant (e.g. the T4 tax year).

Determines the form variant. Defaults to the current date if not provided.

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

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes