Submit a form

curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/forms/{form}/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "id": "<id>",
  "object": "form",
  "data": {
    "owner": {
      "id": "<id>",
      "object": "employee",
      "links": {
        "self": "/employees/<id>"
      }
    },
    "form_batch": null,
    "stage": "original",
    "note": null,
    "type": "roe",
    "effective_date": "2026-01-01",
    "version_year": "2026",
    "version_month": "january",
    "validation_error_count": 19,
    "status": "done",
    "is_editable": false,
    "metadata": {
      "submission_setting": "manual",
      "business_entity_name": null
    },
    "block_1_serial_number": null,
    "block_2_serial_number_of_amended_or_replaced": null,
    "block_3_employer_payroll_reference_number": null,
    "block_5_cra_payroll_account_number": null,
    "block_6_pay_period_type": null,
    "block_8_social_insurance_number": null,
    "employee_first_name": null,
    "employee_initial": null,
    "employee_last_name": null,
    "employee_address_line_1": null,
    "employee_address_line_2": null,
    "employee_address_line_3": null,
    "employee_postal_code": null,
    "contact_first_name": null,
    "contact_last_name": null,
    "contact_area_code": null,
    "contact_phone_number": null,
    "contact_phone_number_extension": null,
    "block_10_first_day_worked": null,
    "block_11_last_day_for_which_paid": null,
    "block_12_final_pay_period_ending_date": null,
    "block_16_separation_code": null,
    "block_14_expected_recall_code": null,
    "block_14_expected_recall_date": null,
    "block_18_comments": null,
    "block_15_total_insurable_hours": null,
    "pp1_insurable_earnings": null,
    "pp2_insurable_earnings": null,
    "pp3_insurable_earnings": null,
    "pp4_insurable_earnings": null,
    "pp5_insurable_earnings": null,
    "pp6_insurable_earnings": null,
    "pp7_insurable_earnings": null,
    "pp8_insurable_earnings": null,
    "pp9_insurable_earnings": null,
    "pp10_insurable_earnings": null,
    "pp11_insurable_earnings": null,
    "pp12_insurable_earnings": null,
    "pp13_insurable_earnings": null,
    "pp14_insurable_earnings": null,
    "pp15_insurable_earnings": null,
    "pp16_insurable_earnings": null,
    "pp17_insurable_earnings": null,
    "pp18_insurable_earnings": null,
    "pp19_insurable_earnings": null,
    "pp20_insurable_earnings": null,
    "pp21_insurable_earnings": null,
    "pp22_insurable_earnings": null,
    "pp23_insurable_earnings": null,
    "pp24_insurable_earnings": null,
    "pp25_insurable_earnings": null,
    "pp26_insurable_earnings": null,
    "pp27_insurable_earnings": null,
    "pp28_insurable_earnings": null,
    "pp29_insurable_earnings": null,
    "pp30_insurable_earnings": null,
    "pp31_insurable_earnings": null,
    "pp32_insurable_earnings": null,
    "pp33_insurable_earnings": null,
    "pp34_insurable_earnings": null,
    "pp35_insurable_earnings": null,
    "pp36_insurable_earnings": null,
    "pp37_insurable_earnings": null,
    "pp38_insurable_earnings": null,
    "pp39_insurable_earnings": null,
    "pp40_insurable_earnings": null,
    "pp41_insurable_earnings": null,
    "pp42_insurable_earnings": null,
    "pp43_insurable_earnings": null,
    "pp44_insurable_earnings": null,
    "pp45_insurable_earnings": null,
    "pp46_insurable_earnings": null,
    "pp47_insurable_earnings": null,
    "pp48_insurable_earnings": null,
    "pp49_insurable_earnings": null,
    "pp50_insurable_earnings": null,
    "pp51_insurable_earnings": null,
    "pp52_insurable_earnings": null,
    "pp53_insurable_earnings": null,
    "vacation_pay_code": null,
    "vacation_pay_start_date": null,
    "vacation_pay_end_date": null,
    "vacation_pay_amount": null,
    "statutory_holiday_pay_for_date_1": null,
    "statutory_holiday_pay_for_amount_1": null,
    "statutory_holiday_pay_for_date_2": null,
    "statutory_holiday_pay_for_amount_2": null,
    "statutory_holiday_pay_for_date_3": null,
    "statutory_holiday_pay_for_amount_3": null,
    "statutory_holiday_pay_for_date_4": null,
    "statutory_holiday_pay_for_amount_4": null,
    "statutory_holiday_pay_for_date_5": null,
    "statutory_holiday_pay_for_amount_5": null,
    "statutory_holiday_pay_for_date_6": null,
    "statutory_holiday_pay_for_amount_6": null,
    "statutory_holiday_pay_for_date_7": null,
    "statutory_holiday_pay_for_amount_7": null,
    "statutory_holiday_pay_for_date_8": null,
    "statutory_holiday_pay_for_amount_8": null,
    "statutory_holiday_pay_for_date_9": null,
    "statutory_holiday_pay_for_amount_9": null,
    "statutory_holiday_pay_for_date_10": null,
    "statutory_holiday_pay_for_amount_10": null,
    "other_monies_code_1": null,
    "other_monies_start_date_1": null,
    "other_monies_end_date_1": null,
    "other_monies_amount_1": null,
    "other_monies_code_2": null,
    "other_monies_start_date_2": null,
    "other_monies_end_date_2": null,
    "other_monies_amount_2": null,
    "other_monies_code_3": null,
    "other_monies_start_date_3": null,
    "other_monies_end_date_3": null,
    "other_monies_amount_3": null,
    "special_payments_code_1": null,
    "special_payments_start_date_1": null,
    "special_payments_end_date_1": null,
    "special_payments_amount_1": null,
    "special_payments_period_1": null,
    "special_payments_code_2": null,
    "special_payments_start_date_2": null,
    "special_payments_end_date_2": null,
    "special_payments_amount_2": null,
    "special_payments_period_2": null,
    "special_payments_code_3": null,
    "special_payments_start_date_3": null,
    "special_payments_end_date_3": null,
    "special_payments_amount_3": null,
    "special_payments_period_3": null,
    "special_payments_code_4": null,
    "special_payments_start_date_4": null,
    "special_payments_end_date_4": null,
    "special_payments_amount_4": null,
    "special_payments_period_4": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/forms/<id>"
  }
}

POST

forms

{form}

submit

Submit a form

curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/forms/{form}/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "id": "<id>",
  "object": "form",
  "data": {
    "owner": {
      "id": "<id>",
      "object": "employee",
      "links": {
        "self": "/employees/<id>"
      }
    },
    "form_batch": null,
    "stage": "original",
    "note": null,
    "type": "roe",
    "effective_date": "2026-01-01",
    "version_year": "2026",
    "version_month": "january",
    "validation_error_count": 19,
    "status": "done",
    "is_editable": false,
    "metadata": {
      "submission_setting": "manual",
      "business_entity_name": null
    },
    "block_1_serial_number": null,
    "block_2_serial_number_of_amended_or_replaced": null,
    "block_3_employer_payroll_reference_number": null,
    "block_5_cra_payroll_account_number": null,
    "block_6_pay_period_type": null,
    "block_8_social_insurance_number": null,
    "employee_first_name": null,
    "employee_initial": null,
    "employee_last_name": null,
    "employee_address_line_1": null,
    "employee_address_line_2": null,
    "employee_address_line_3": null,
    "employee_postal_code": null,
    "contact_first_name": null,
    "contact_last_name": null,
    "contact_area_code": null,
    "contact_phone_number": null,
    "contact_phone_number_extension": null,
    "block_10_first_day_worked": null,
    "block_11_last_day_for_which_paid": null,
    "block_12_final_pay_period_ending_date": null,
    "block_16_separation_code": null,
    "block_14_expected_recall_code": null,
    "block_14_expected_recall_date": null,
    "block_18_comments": null,
    "block_15_total_insurable_hours": null,
    "pp1_insurable_earnings": null,
    "pp2_insurable_earnings": null,
    "pp3_insurable_earnings": null,
    "pp4_insurable_earnings": null,
    "pp5_insurable_earnings": null,
    "pp6_insurable_earnings": null,
    "pp7_insurable_earnings": null,
    "pp8_insurable_earnings": null,
    "pp9_insurable_earnings": null,
    "pp10_insurable_earnings": null,
    "pp11_insurable_earnings": null,
    "pp12_insurable_earnings": null,
    "pp13_insurable_earnings": null,
    "pp14_insurable_earnings": null,
    "pp15_insurable_earnings": null,
    "pp16_insurable_earnings": null,
    "pp17_insurable_earnings": null,
    "pp18_insurable_earnings": null,
    "pp19_insurable_earnings": null,
    "pp20_insurable_earnings": null,
    "pp21_insurable_earnings": null,
    "pp22_insurable_earnings": null,
    "pp23_insurable_earnings": null,
    "pp24_insurable_earnings": null,
    "pp25_insurable_earnings": null,
    "pp26_insurable_earnings": null,
    "pp27_insurable_earnings": null,
    "pp28_insurable_earnings": null,
    "pp29_insurable_earnings": null,
    "pp30_insurable_earnings": null,
    "pp31_insurable_earnings": null,
    "pp32_insurable_earnings": null,
    "pp33_insurable_earnings": null,
    "pp34_insurable_earnings": null,
    "pp35_insurable_earnings": null,
    "pp36_insurable_earnings": null,
    "pp37_insurable_earnings": null,
    "pp38_insurable_earnings": null,
    "pp39_insurable_earnings": null,
    "pp40_insurable_earnings": null,
    "pp41_insurable_earnings": null,
    "pp42_insurable_earnings": null,
    "pp43_insurable_earnings": null,
    "pp44_insurable_earnings": null,
    "pp45_insurable_earnings": null,
    "pp46_insurable_earnings": null,
    "pp47_insurable_earnings": null,
    "pp48_insurable_earnings": null,
    "pp49_insurable_earnings": null,
    "pp50_insurable_earnings": null,
    "pp51_insurable_earnings": null,
    "pp52_insurable_earnings": null,
    "pp53_insurable_earnings": null,
    "vacation_pay_code": null,
    "vacation_pay_start_date": null,
    "vacation_pay_end_date": null,
    "vacation_pay_amount": null,
    "statutory_holiday_pay_for_date_1": null,
    "statutory_holiday_pay_for_amount_1": null,
    "statutory_holiday_pay_for_date_2": null,
    "statutory_holiday_pay_for_amount_2": null,
    "statutory_holiday_pay_for_date_3": null,
    "statutory_holiday_pay_for_amount_3": null,
    "statutory_holiday_pay_for_date_4": null,
    "statutory_holiday_pay_for_amount_4": null,
    "statutory_holiday_pay_for_date_5": null,
    "statutory_holiday_pay_for_amount_5": null,
    "statutory_holiday_pay_for_date_6": null,
    "statutory_holiday_pay_for_amount_6": null,
    "statutory_holiday_pay_for_date_7": null,
    "statutory_holiday_pay_for_amount_7": null,
    "statutory_holiday_pay_for_date_8": null,
    "statutory_holiday_pay_for_amount_8": null,
    "statutory_holiday_pay_for_date_9": null,
    "statutory_holiday_pay_for_amount_9": null,
    "statutory_holiday_pay_for_date_10": null,
    "statutory_holiday_pay_for_amount_10": null,
    "other_monies_code_1": null,
    "other_monies_start_date_1": null,
    "other_monies_end_date_1": null,
    "other_monies_amount_1": null,
    "other_monies_code_2": null,
    "other_monies_start_date_2": null,
    "other_monies_end_date_2": null,
    "other_monies_amount_2": null,
    "other_monies_code_3": null,
    "other_monies_start_date_3": null,
    "other_monies_end_date_3": null,
    "other_monies_amount_3": null,
    "special_payments_code_1": null,
    "special_payments_start_date_1": null,
    "special_payments_end_date_1": null,
    "special_payments_amount_1": null,
    "special_payments_period_1": null,
    "special_payments_code_2": null,
    "special_payments_start_date_2": null,
    "special_payments_end_date_2": null,
    "special_payments_amount_2": null,
    "special_payments_period_2": null,
    "special_payments_code_3": null,
    "special_payments_start_date_3": null,
    "special_payments_end_date_3": null,
    "special_payments_amount_3": null,
    "special_payments_period_3": null,
    "special_payments_code_4": null,
    "special_payments_start_date_4": null,
    "special_payments_end_date_4": null,
    "special_payments_amount_4": null,
    "special_payments_period_4": 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

The body is of type object.

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.

Approve a form Amend a form

⌘I