v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create a paperwork submission

put/paperwork/submissions

Request body

templateIDstring required

Unique identifier for the paperwork template.

worker_type'Employee' | 'Contractor' required

Type of worker (Employee or Contractor).

companyIDstring required

Unique identifier for the company.

employeeIDstring nullable

Unique identifier for the employee. Nullable if the worker type is contractor.

contractorIDstring nullable

Unique identifier for the contractor. Nullable if the worker type is employee.

fieldsobject required

Additional fields for the paperwork submission.

Example request

{
  "templateID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "worker_type": "Employee",
  "companyID": "603d0f8f1c4b2a4e28c8f0b4",
  "employeeID": "603d0f8f1c4b2a4e28c8f0b4",
  "contractorID": "603d0f8f1c4b2a4e28c8f0b5",
  "fields": {
    "field1": "value1",
    "field2": "value2"
  }
}

Response

Paperwork submission created

successboolean

Indicates if the operation was successful.

Example response

{
  "data": {
    "templateID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "submissionID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "submission_date": "2023-06-01T12:00:00Z",
    "worker_type": "Employee",
    "companyID": "603d0f8f1c4b2a4e28c8f0b4",
    "employeeID": "603d0f8f1c4b2a4e28c8f0b4",
    "fields": {
      "field1": "value1",
      "field2": "value2"
    },
    "paperwork_type": "W4",
    "url": "https://zeal.com/submission/12345"
  }
}