Skip to main content
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
}
'
import requests

url = "https://sandbox.nmbr.co/services/payroll/forms/{form}"

payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};

fetch('https://sandbox.nmbr.co/services/payroll/forms/{form}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/forms/{form}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.nmbr.co/services/payroll/forms/{form}"

payload := strings.NewReader("{\n \"form_batch_id\": \"<string>\",\n \"note\": \"<string>\",\n \"line_1_basic_personal_amount\": 1,\n \"line_2_infirm_children_caregiver_amount\": 1,\n \"line_3_age_amount\": 1,\n \"line_4_pension_income_amount\": 1,\n \"line_5_tuition\": 1,\n \"line_6_disability_amount\": 1,\n \"line_7_spouse_or_common_law_partner_amount\": 1,\n \"line_8_eligible_dependent_amount\": 1,\n \"line_9_infirm_dependent_caregiver_amount\": 1,\n \"line_10_dependent_caregiver_amount\": 1,\n \"line_11_spouse_or_common_law_transfer_amount\": 1,\n \"line_12_dependent_transfer_amount\": 1,\n \"line_13_total_claim_amount\": 1,\n \"more_than_one_employer_or_payer\": true,\n \"total_income_less_than_total_claim_amount\": true,\n \"ninety_percent_world_income_taxable_income\": true,\n \"prescribed_zone_deduction\": 1,\n \"additional_tax_deduction\": 1\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://sandbox.nmbr.co/services/payroll/forms/{form}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"form_batch_id\": \"<string>\",\n \"note\": \"<string>\",\n \"line_1_basic_personal_amount\": 1,\n \"line_2_infirm_children_caregiver_amount\": 1,\n \"line_3_age_amount\": 1,\n \"line_4_pension_income_amount\": 1,\n \"line_5_tuition\": 1,\n \"line_6_disability_amount\": 1,\n \"line_7_spouse_or_common_law_partner_amount\": 1,\n \"line_8_eligible_dependent_amount\": 1,\n \"line_9_infirm_dependent_caregiver_amount\": 1,\n \"line_10_dependent_caregiver_amount\": 1,\n \"line_11_spouse_or_common_law_transfer_amount\": 1,\n \"line_12_dependent_transfer_amount\": 1,\n \"line_13_total_claim_amount\": 1,\n \"more_than_one_employer_or_payer\": true,\n \"total_income_less_than_total_claim_amount\": true,\n \"ninety_percent_world_income_taxable_income\": true,\n \"prescribed_zone_deduction\": 1,\n \"additional_tax_deduction\": 1\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/forms/{form}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"form_batch_id\": \"<string>\",\n \"note\": \"<string>\",\n \"line_1_basic_personal_amount\": 1,\n \"line_2_infirm_children_caregiver_amount\": 1,\n \"line_3_age_amount\": 1,\n \"line_4_pension_income_amount\": 1,\n \"line_5_tuition\": 1,\n \"line_6_disability_amount\": 1,\n \"line_7_spouse_or_common_law_partner_amount\": 1,\n \"line_8_eligible_dependent_amount\": 1,\n \"line_9_infirm_dependent_caregiver_amount\": 1,\n \"line_10_dependent_caregiver_amount\": 1,\n \"line_11_spouse_or_common_law_transfer_amount\": 1,\n \"line_12_dependent_transfer_amount\": 1,\n \"line_13_total_claim_amount\": 1,\n \"more_than_one_employer_or_payer\": true,\n \"total_income_less_than_total_claim_amount\": true,\n \"ninety_percent_world_income_taxable_income\": true,\n \"prescribed_zone_deduction\": 1,\n \"additional_tax_deduction\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "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

OK

id
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