PApaylocity
Time Snapshot

Get Snapshot Summary

🚧 Partner Restricted

This endpoint is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, please reach out to our team to discuss partnership opportunities.

Summary Description

Retrieve time snapshot summary data for the specified id.

get/apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots/{snapshotId}

Request

  • Base URL
    https://dc1demogwext.paylocity.com
  • URL
    https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots/{snapshotId}
  • Auth
    HTTP bearer

Path parameters

companyIdstring required

The Paylocity Company Identifier

snapshotIdinteger required

The snapshot unique identifier

Headers

testModeboolean

If true, responses are mocked.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK

snapshotIdinteger nullable

The unique identifier of the snapshot.

status'queued' | 'inProcess' | 'complete' | 'failed' | 'retry'

Generation status enumeration.

statusReason'none' | 'invalidEmployeeNumber' | 'emptyGroup'

Generation status reason enumeration.

payrollDataConfigurationIdinteger nullable

The payroll data configuration identifier.

startDatestring date-time

Start date of the pay period range.

endDatestring date-time

End date of the pay period range.

lastModifiedstring date-time

Date and time when the snapshot was last modified.

payPeriodStatus'open' | 'closed'

Pay period status enumeration.

payrollPolicyNamesstring[] nullable

Array of payroll policy names associated with the snapshot.

submissionIdstring uuid nullable

The payroll submission identifier.

isPayrollLockedboolean nullable

Indicates if the payroll is locked.

isEmptyboolean nullable

Indicates if the snapshot is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.