Paperwork Template Object
The Paperwork Template object represents a template for custom paperwork that can be utilized during a worker’s onboarding process.| attribute | type | description |
|---|---|---|
| templateID | string | Unique identifier for the template |
| companyID | string | Unique identifier for Zeal company |
| form_name | string | Name of the paperwork form |
| description | string | Description of the paperwork form |
| paperwork_type | string | Type of paperwork form. Holds one of the following values: W4, I9, W9, CustomPaperwork |
| worker_type | string | Type of worker the form is applicable to. Can be Employee, Contractor, or All |
| jurisdictions_filter | object | Filter for jurisdictions where the form is applicable |
| jurisdiction_type | string | Type of jurisdiction for the form. Can be WorkLocation, Residency, or All |
| effective_date | string | Date from which the template is effective (format: YYYY-MM-DD) |
| archive_date | string | Date when the template will be archived (format: YYYY-MM-DD) |
| form_fields | array | Array of form fields in the template |
| urls | array | List of URLs associated with the template |
| status | string | Current status of the template. Can be Draft, Live, or Archived |
Example Paperwork Template Object
{
"templateID": "template_123456",
"companyID": "fc235fcccee46aa8a082f357715bcfa",
"form_name": "Updated W-4 Form",
"description": "Updated Employee's Withholding Certificate",
"paperwork_type": "W4",
"worker_type": "Employee",
"jurisdictions_filter": {
"type": "include",
"jurisdictions": [
"CA",
"NY",
"TX"
]
},
"jurisdiction_type": "WorkLocation",
"effective_date": "2023-08-01",
"archive_date": "2024-07-31",
"form_fields": [
{
"field_name": "employee_name",
"label": "Employee's Full Name",
"type": "string",
"required": true
},
{
"field_name": "ssn",
"label": "Social Security Number",
"type": "string",
"required": true
}
],
"urls": [
"https://example.com/updated_w4_form.pdf"
],
"status": "Live"
}