PApaylocity
Time Snapshot

Get Snapshot by Employee and Pay Period Range

🚧 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

Request time snapshot data for the specified employees within the given pay period date range.

post/apiHub/payroll/v1/companies/{companyId}/payrollReadiness/snapshots

Request

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

Path parameters

companyIdstring required

The Paylocity Company Identifier.

Headers

testModeboolean

If true, responses are mocked.

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

payrollDataConfigurationIdinteger nullable

Identifier for payroll data configuration.

Optional, but either this property or PayrollSettingsOverride must be provided.
If both are populated, PayrollSettingsOverride takes precedence over this ID.

startDatestring date-time required

Start date of the snapshot.

Format: yyyy-MM-dd. Required.

endDatestring date-time required

End date of the snapshot.

Format: yyyy-MM-dd. Required.

Response

Accepted

snapshotIdinteger nullable

The unique identifier of the created snapshot.

Changes

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