Path parameters

• employer_id string Required

Responses

• 200 application/json

  Successfully created the upload. The response contains the ID of the upload, that can be used in querying /uploads/{upload_id} endpoints.

  Hide response attributes Show response attributes object

  • id string Required

    ID of the upload.

  • employer_id string | null

    ID of the employer the upload was made for.

  • put_destination_url 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.

  • created_at string(date-time) Required

    Datetime the upload was created.

  • updated_at string(date-time) Required

    Datetime the upload was last updated.

  • processing_started string(date-time) | null Required

    Datetime of when processing of the file began.

  • processing_ended string(date-time) | null Required

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

  • processing_time number | null Required

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

  • total_errors number Required

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

  • contributions_created number Required

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

  • contributions_unprocessed number

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

  • contributions_already_existed number Required

    The number of contributions that already existed prior to processing, and which have been skipped during processing of the upload. Zero if processing is not finished.

  • employer_contributions number Required

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

  • employee_contributions number Required

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

  • total_contributions number Required

    The total of contributions created for the upload, excluding contributions 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 validation passed and processing ran eagerly, but some records succeeded while others produced errors — treat this status as incomplete and re-submit the failing records (or the entire file) to recover. Processing is idempotent per pay period, so successfully-processed records will be skipped on re-submission. To retrieve the errors for an Error or PartiallyProcessed upload, use the /uploads/{upload_id}/errors endpoint.

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

• 400 application/json

  Bad request, the request is malformed or contains invalid data.

  Hide response attributes Show response attributes object

  • error string

    A descriptive error message.

  • validation_errors array[object]
    Hide validation_errors attributes Show validation_errors attributes object

    • field string Required

      The name of the field that failed validation.

    • message string Required

      A descriptive error message.

• 401 application/json

  Unauthorized, the request requires authentication, and the provided credentials are either missing or incorrect.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.

• 404 application/json

  The employer was not found.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.