Sign in

v4

latestOpenAPI 3.0.02026-07-314441026.8 MB
Form Batches

Create a form batch

post/form_batches

Request body

owner_idstring required
form_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 Forms in this batch (e.g. T4, RL-1).

Must be a form type that supports form batches. Not all form types support batches.

effective_datestring date

The effective date used to determine the form variant for all Forms in this batch.

Determines the form variant. Defaults to January 1 of the current year if not provided.

form_stage'amendment' | 'cancellation' | 'original'

The lifecycle stage of the Forms in this batch: original, amendment, or cancellation.

Defaults to original if not provided.

contact_namestring required

The name of the contact person responsible for this submission.

contact_emailstring required

The email address of the contact person.

contact_area_codestring required

The 3-digit area code of the contact's phone number.

contact_phone_numberstring required

The 7-digit phone number of the contact.

contact_extensionstring nullable

The optional extension for the contact's phone number.

notestring nullable

An optional note for this form batch.

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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