v1
latestOpenAPI 3.0.42026-07-2481154567.6 KBGet New Payroll Batch Status
Summary Description
The Get New Payroll Batch Status endpoint is used to retrieve the current status and details of a previously submitted payroll batch.
Key Features:
- Returns the processing status of the payroll batch (e.g., Pending, Completed, Error).
- Provides timestamp information for when the batch was created.
- Includes a summary of the data inserted into the batch.
- Highlights any validation issues or errors that need resolution.
Important: When a payroll batch is successfully submitted using the Create New Payroll Batch endpoint, a 202 Accepted response is returned. This response includes a timeImportFileTrackingId, which is required to query the status of that specific batch. Use this timeImportFileTrackingId as the {timeImportFileTrackingId} path parameter in the GET New Payroll Batch Status endpoint.
Recommendation: API users should call this endpoint after submitting a batch to ensure the data was successfully processed. If errors are present, they should be addressed before payroll is finalized.
Path parameters
The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity
When a payroll batch is successfully submitted using the Create New Payroll Batch endpoint, a 202 Accepted response is returned. This response includes a timeImportFileTrackingId, which is required to query the status of that specific batch. Use this timeImportFileTrackingId as the {timeImportFileTrackingId} path parameter in the Get New Payroll Batch Status endpoint
Headers
Bearer token
Response
successful operation