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"
executionStartTime
The Job excution start time.
 string date "2024-05-19"
timeInQueue
The time the Job spent in the queue before execution in seconds.
 integer int32 0
executionTime
The time it took the Job to execute in seconds.
 integer int32 0
result Contract.JobResultResponse {Contract.JobResultResponse}
createdDate
Job Created date.
 string date "2024-05-19"
updatedDate
Job Updated date where applicable.
 string date "2024-05-19"

JSON Example 

{
  "id": "string",
  "employerId": "string",
  "employerName": "string",
  "type": "Report",
  "subType": "string",
  "name": "string",
  "outputFormat": "string",
  "status": "Queued",
  "executionStartTime": "2024-05-19",
  "timeInQueue": 0,
  "executionTime": 0,
  "result": {
    "file": {
      "fileName": "string",
      "uri": "string"
    },
    "metadata": {},
    "errors": [
      "string"
    ]
  },
  "createdDate": "2024-05-19",
  "updatedDate": "2024-05-19"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Import Employees Asynchronously (Beta)
Import Row-Based Payments Asynchronously (Beta)
Import the CSV for Column-Based Payments Asynchronously (Beta)
Get Job
Gross To Net async (beta)
Introduction Async Jobs