Update a form

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/forms/{form} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "form_batch_id": "<string>",
  "note": "<string>",
  "line_1_basic_personal_amount": 1,
  "line_2_infirm_children_caregiver_amount": 1,
  "line_3_age_amount": 1,
  "line_4_pension_income_amount": 1,
  "line_5_tuition": 1,
  "line_6_disability_amount": 1,
  "line_7_spouse_or_common_law_partner_amount": 1,
  "line_8_eligible_dependent_amount": 1,
  "line_9_infirm_dependent_caregiver_amount": 1,
  "line_10_dependent_caregiver_amount": 1,
  "line_11_spouse_or_common_law_transfer_amount": 1,
  "line_12_dependent_transfer_amount": 1,
  "line_13_total_claim_amount": 1,
  "more_than_one_employer_or_payer": true,
  "total_income_less_than_total_claim_amount": true,
  "ninety_percent_world_income_taxable_income": true,
  "prescribed_zone_deduction": 1,
  "additional_tax_deduction": 1
}
'

{
  "id": "<id>",
  "object": "form",
  "data": {
    "owner": {
      "id": "<id>",
      "object": "work_assignment",
      "links": {
        "self": "/work_assignments/<id>"
      }
    },
    "form_batch": null,
    "stage": "original",
    "note": null,
    "type": "td1",
    "effective_date": "2026-01-01",
    "version_year": "2026",
    "version_month": "january",
    "validation_error_count": 0,
    "is_editable": true,
    "line_1_basic_personal_amount": null,
    "line_2_infirm_children_caregiver_amount": null,
    "line_3_age_amount": null,
    "line_4_pension_income_amount": null,
    "line_5_tuition": null,
    "line_6_disability_amount": null,
    "line_7_spouse_or_common_law_partner_amount": null,
    "line_8_eligible_dependent_amount": null,
    "line_9_infirm_dependent_caregiver_amount": null,
    "line_10_dependent_caregiver_amount": null,
    "line_11_spouse_or_common_law_transfer_amount": null,
    "line_12_dependent_transfer_amount": null,
    "line_13_total_claim_amount": null,
    "more_than_one_employer_or_payer": null,
    "total_income_less_than_total_claim_amount": null,
    "ninety_percent_world_income_taxable_income": null,
    "prescribed_zone_deduction": null,
    "additional_tax_deduction": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/forms/<id>"
  }
}

PUT

forms

{form}

Update a form

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/forms/{form} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "form_batch_id": "<string>",
  "note": "<string>",
  "line_1_basic_personal_amount": 1,
  "line_2_infirm_children_caregiver_amount": 1,
  "line_3_age_amount": 1,
  "line_4_pension_income_amount": 1,
  "line_5_tuition": 1,
  "line_6_disability_amount": 1,
  "line_7_spouse_or_common_law_partner_amount": 1,
  "line_8_eligible_dependent_amount": 1,
  "line_9_infirm_dependent_caregiver_amount": 1,
  "line_10_dependent_caregiver_amount": 1,
  "line_11_spouse_or_common_law_transfer_amount": 1,
  "line_12_dependent_transfer_amount": 1,
  "line_13_total_claim_amount": 1,
  "more_than_one_employer_or_payer": true,
  "total_income_less_than_total_claim_amount": true,
  "ninety_percent_world_income_taxable_income": true,
  "prescribed_zone_deduction": 1,
  "additional_tax_deduction": 1
}
'

{
  "id": "<id>",
  "object": "form",
  "data": {
    "owner": {
      "id": "<id>",
      "object": "work_assignment",
      "links": {
        "self": "/work_assignments/<id>"
      }
    },
    "form_batch": null,
    "stage": "original",
    "note": null,
    "type": "td1",
    "effective_date": "2026-01-01",
    "version_year": "2026",
    "version_month": "january",
    "validation_error_count": 0,
    "is_editable": true,
    "line_1_basic_personal_amount": null,
    "line_2_infirm_children_caregiver_amount": null,
    "line_3_age_amount": null,
    "line_4_pension_income_amount": null,
    "line_5_tuition": null,
    "line_6_disability_amount": null,
    "line_7_spouse_or_common_law_partner_amount": null,
    "line_8_eligible_dependent_amount": null,
    "line_9_infirm_dependent_caregiver_amount": null,
    "line_10_dependent_caregiver_amount": null,
    "line_11_spouse_or_common_law_transfer_amount": null,
    "line_12_dependent_transfer_amount": null,
    "line_13_total_claim_amount": null,
    "more_than_one_employer_or_payer": null,
    "total_income_less_than_total_claim_amount": null,
    "ninety_percent_world_income_taxable_income": null,
    "prescribed_zone_deduction": null,
    "additional_tax_deduction": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/forms/<id>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

form

string

required

Body

application/json

form_batch_id

string

note

string | null

An optional note for this form.

Maximum string length: 65000

line_1_basic_personal_amount

number<decimal>

Required range: x >= 0

line_2_infirm_children_caregiver_amount

number<decimal>

Required range: x >= 0

line_3_age_amount

number<decimal>

Required range: x >= 0

line_4_pension_income_amount

number<decimal>

Required range: x >= 0

line_5_tuition

number<decimal>

Required range: x >= 0

line_6_disability_amount

number<decimal>

Required range: x >= 0

line_7_spouse_or_common_law_partner_amount

number<decimal>

Required range: x >= 0

line_8_eligible_dependent_amount

number<decimal>

Required range: x >= 0

line_9_infirm_dependent_caregiver_amount

number<decimal>

Required range: x >= 0

line_10_dependent_caregiver_amount

number<decimal>

Required range: x >= 0

line_11_spouse_or_common_law_transfer_amount

number<decimal>

Required range: x >= 0

line_12_dependent_transfer_amount

number<decimal>

Required range: x >= 0

line_13_total_claim_amount

number<decimal>

Required range: x >= 0

more_than_one_employer_or_payer

boolean

total_income_less_than_total_claim_amount

boolean

ninety_percent_world_income_taxable_income

boolean

prescribed_zone_deduction

number<decimal>

Required range: x >= 0

additional_tax_deduction

number<decimal>

Required range: x >= 0

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Form · object

Hide child attributes

data.owner

object

The owner of this form. Can be a Work Assignment, Employee, or Contractor.

Hide child attributes

data.owner.id

string

read-only

The unique identifier of the object in Nmbr.

data.owner.object

string

read-only

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

data.form_batch

any

The Form Batch this form belongs to, if any.

data.stage

enum<string>

The lifecycle stage of this form: original, amendment, or cancellation.

Available options:

amendment,

cancellation,

original

data.note

string | null

An optional note for this form.

data.type

enum<string>

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

Available options:

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

Maximum string length: 255

data.effective_date

string<date>

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

data.version_year

string | null

The form variant's version year. New versions are typically released in January. Note: the version year may differ from the tax year. For example, income earned in the 2025 tax year is typically reported on a 2026 version of the T4.

data.version_month

string | null

The month component of the form variant, for forms with monthly variants. null for annual forms.

data.validation_error_count

number<decimal> | null

The number of validation errors currently present in the form's fields.

data.is_editable

boolean

Whether the form can be edited.

Whether the form can currently be modified.

data.line_1_basic_personal_amount

any

data.line_2_infirm_children_caregiver_amount

any

data.line_3_age_amount

any

data.line_4_pension_income_amount

any

data.line_5_tuition

any

data.line_6_disability_amount

any

data.line_7_spouse_or_common_law_partner_amount

any

data.line_8_eligible_dependent_amount

any

data.line_9_infirm_dependent_caregiver_amount

any

data.line_10_dependent_caregiver_amount

any

data.line_11_spouse_or_common_law_transfer_amount

any

data.line_12_dependent_transfer_amount

any

data.line_13_total_claim_amount

any

data.more_than_one_employer_or_payer

any

data.total_income_less_than_total_claim_amount

any

data.ninety_percent_world_income_taxable_income

any

data.prescribed_zone_deduction

any

data.additional_tax_deduction

any

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

Retrieve a form Delete a form

⌘I