Guides

Name / Description	Type / Format	Example
`uniqueId` The unique id of the import result. Null when no import result exists yet (for example while an import job is still in progress).	`string` uuid	`"string"`
`importType` Import Type	`string`	`"string"`
`status`	`string`	`"Queued"` `"Executing"` `"Completed"` `"Failed"` `"CompletedWithErrors"`
`createdDate` Created date of the import result (ISO 8601, includes time).	`string`	`"string"`
`summary`	`PayImportPayCodeSummary`	`{PayImportPayCodeSummary}`
`payCodeTotals` PayCode Totals	`PayImportPayCodeTotals[]`	`{PayImportPayCodeTotals}`
`errors` List of row level Errors	`ImportRowError[]`	`{ImportRowError}`

JSON Example

{
  "uniqueId": "string",
  "importType": "string",
  "status": "Queued",
  "createdDate": "string",
  "summary": {
    "totalRows": 0,
    "successCount": 0,
    "errorCount": 0,
    "payPeriod": "Custom",
    "ordinal": 0
  },
  "payCodeTotals": [
    {
      "payCode": "string",
      "totalValue": 0.0
    }
  ],
  "errors": [
    {
      "rowNumber": 0,
      "payrollCode": "string",
      "payCode": "string",
      "roleReference": "string",
      "employerIdentifier": "string",
      "errorCode": "string",
      "errorType": "UnexpectedError",
      "message": "string"
    }
  ]
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Get Import Results (beta)