Path parameters

• employerId string(uuid) Required

  Penfold employer UUID

Query parameters

• pageNumber integer

  The page number to return.

  Minimum value is 1. Default value is 1.

Responses

• 200 application/json

  Retrieved the uploads successfully.

  Hide response attributes Show response attributes object

  • pageNumber integer

    The current page number.

  • pageSize integer

    The number of items per page.

  • totalItems integer

    The total number of items available.

  • items array[object]

    An array of Upload objects on the current page.

    Hide items attributes Show items attributes object

    • id string Required

      ID of the upload.

    • employerId string | null

      ID of the employer the upload was made for.

    • putDestinationUrl string | null Required

      Destination URL where the actual file should be sent, using a PUT request. Only present when status is AwaitingFile. We recommend using the AWS S3 client SDK to perform the upload.

    • createdAt string(date-time) Required

      Datetime the upload was created.

    • updatedAt string(date-time) Required

      Datetime the upload was last updated.

    • processingStarted string(date-time) | null Required

      Datetime of when processing of the file began.

    • processingEnded string(date-time) | null Required

      Datetime of when processing of the file ended, or null if it has not ended.

    • processingTime number | null Required

      The number of seconds it took to process the file end-to-end (if applicable).

    • totalErrors number Required

      The number of errors produced in processing the file. Zero if there are none or processing is not finished. Use the {uploadId}/errors endpoint to retrieve detailed information.

    • contributionsCreated number Required

      The number of contributions created during processing. Zero if processing is not finished.

    • contributionsUnprocessed number

      The number of contributions that failed to be created during processing. Zero if processing is not finished.

    • contributionsAlreadyExisted number Required

      The number of contributions that already existed prior to processing and were skipped. Zero if processing is not finished.

    • employerContributions number Required

      The total of employer contributions created for the upload, excluding those that already existed. Zero if processing is not finished.

    • employeeContributions number Required

      The total of employee contributions created for the upload, excluding those that already existed. Zero if processing is not finished.

    • totalContributions number Required

      The total of all contributions created for the upload, excluding those that already existed. Zero if processing is not finished.

    • filename string | null Required

      The filename of the uploaded file (if applicable).

    • status string Required

      The status of the upload. Error indicates the file was not able to be processed. PartiallyProcessed indicates that some but not all contributions or enrolments were created.

      Values are AwaitingFile, ReceivedFile, Processing, Processed, Error, Timeout, or PartiallyProcessed.

• 401 application/json

  Missing or invalid authentication token

  Hide response attribute Show response attribute object

  • error string Required
• 404 application/json

  Resource not found

  Hide response attribute Show response attribute object

  • error string Required
• 500 application/json

  Internal server error

  Hide response attribute Show response attribute object

  • error string Required