Employee Punch Details

Get Employee Punch Details

Summary Description

The GET Punch Detail V2 endpoint provides access to detailed punch information for a single employee. It returns all associated punch data, including work and non-work time entries, to support analysis and time-record management. Punch Detail V2 uses four-decimal precision for timesheets that track time in hours rather than seconds. For example, 7.2567 hours. Users can filter Punch Detail V2 results by relative date and time, using the time zone associated with your request.

Filtering by Date Range
The Punch Detail API can be filtered by the relative date and time based on your time zone. For example:
Start of the day: At 00:00:00 (midnight), marking the beginning of the day.
Midday: At 12:00:00 (noon), halfway through the day.
End of the day: At 23:59:59, just a second before the next day begins.

A 24 hour day is represented by using:

relativeStart={{relativeStartTime}}&relativeEnd={{relativeEndTime}}

"relativeStart": "2024-03-05T00:00:00"

"relativeEnd": "2024-03-05T23:59:00"

/Time/v2/companies/{{companyId}}/employees/{{employeeId}}/punchdetails?relativeStart={{relativeStartTime}}&relativeEnd={{relativeEndTime}}

For more information on implementing this API, see our Punch Details Overview

Use Cases

  • Retrieve a single employee's punch records for a selected timeframe.
  • Use four-decimal-place hour values from work and non-work punches.
  • Retrieve punch activity so managers can identify missing or irregular punches before approving timecards.
get/apiHub/time/v2/companies/{companyId}/employees/{employeeId}/punchDetails

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/time/v2/companies/{companyId}/employees/{employeeId}/punchDetails
  • Auth
    HTTP bearer

Path parameters

companyIdstring required

The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity.

employeeIdstring required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID.

Query parameters

relativeStartstring date-time required

The relative DateTime for the beginning of the WorkedShift. Value must not have timezone information. Allowable Values: Format: yyyy-MM-ddT00:00:00

relativeEndstring date-time required

The relative DateTime for the end of the WorkedShift. Value must not have timezone information. Allowable Values: Format: yyyy-MM-ddT00:00:00

testFlagboolean

A Boolean value that, when set to "true", returns mock data.

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Success

employeeIdstring nullable

The Paylocity Employee ID. This is a unique value per Paylocity Company ID.

companyIdstring nullable

The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity.

badgeNumberinteger

The Time and Labor badge number

relativeStartstring date-time nullable

The relative DateTime for the beginning of the WorkedShift

relativeEndstring date-time nullable

The relative DateTime for the end of the WorkedShift

Changes

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