Contract.JobResponse

Schema

Name / Description Type / Format Example
id
Job public Id.
 string uuid "string"
employerId
Employer public Id.
 string uuid "string"
employerName
Employer name.
 string "string"
type string "Report" "Import" "PayRun"
subType
The Job request payload.
 string "string"
name
The Job name, e.g. uploaded file for Import, or report display name for Report
 string "string"
outputFormat
The Job output format, e.g. json/csv/pdf for Report, or something else for other Job types.
 string "string"
status string "Queued" "Executing" "Completed" "Failed" "CompletedWithErrors"
result Contract.JobResultResponse {Contract.JobResultResponse}
createdDate
Job Created date.
 string date "2024-04-27"
updatedDate
Job Updated date where applicable.
 string date "2024-04-27"

JSON Example 

{
  "id": "string",
  "employerId": "string",
  "employerName": "string",
  "type": "Report",
  "subType": "string",
  "name": "string",
  "outputFormat": "string",
  "status": "Queued",
  "result": {
    "file": {
      "fileName": "string",
      "uri": "string"
    },
    "metadata": {},
    "errors": [
      "string"
    ]
  },
  "createdDate": "2024-04-27",
  "updatedDate": "2024-04-27"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Import Employees Asynchronously (Beta)
Get Job
Gross To Net async (beta)
Introduction Async Jobs