Gets Employee Punch Details

get https://dc1demogwext.paylocity.com/apiHub/time/v2/companies/{companyId}/employees/{employeeId}/punchDetails

Summary Description

The GET Punch Detail V2 endpoint provides access to employee punch details effortlessly. The punch detail API will include all punch data for a single employee. It serves as a valuable tool for accessing, analyzing, and managing time-related records, providing intricate details related to employee punches. Punch Detail V2 offers four decimals of precision for timesheets using hours instead of seconds, allowing timesheets to display four decimal places and capturing hours with better precision. Punch times as well as non-work pay types will display up to four decimals. The Punch Details API can be filtered by the relative date and time based on your time zone.

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:00, just a second before the next day begins.

A 24 hour day is represented by using:

startDate={{relativeStartTime}}&endDate={{relativeEndTime}}

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

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

/Time/v2/companies/{{companyId}}/employees/{{employeeId}}/punchdetails?startDate={{relativeStartTime}}&endDate={{relativeEndTime}}

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

Responses

Response body

array of objects

object

employeeId

string | null

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

companyId

string | null

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

badgeNumber

int32

The Time and Labor badge number

relativeStart

date-time | null

The relative DateTime for the beginning of the WorkedShift

relativeEnd

date-time | null

The relative DateTime for the end of the WorkedShift

segments

array of objects | null

Breakdown of the worked shift's durations by time card entry. The entire span of time from beginning of worked shift to end of worked shift is represented in this breakdown.

segments

object

punchID

string | null

A unique identifier assigned to each punch or time entry, ensuring that each entry is distinct, traceable, and easily referenced for tracking purposes.

origin

string | null

The associated origin of the time entry.

date

Date the worked shift segment took place. In the case of over night shifts, this is the date these worked hours apply to in payroll and can play a role in some overtime calculations.

punchType

string | null

The type of punch recorded indicating whether it was recorded for categories such as work, lunch break etc

relativeStart

date-time | null

Relative DateTime of the beginning of this segment after payroll policy rules are applied. Null if the segment began with a missed punch.

relativeEnd

date-time | null

Relative DateTime of the end of this segment after payroll policy rules are applied. Null if the segment ended with a missed punch.

relativeOriginalStart

date-time | null

Relative DateTimeOffset of the beginning of this segment before payroll policy rules are applied. Null if the segment began with a missed punch.

relativeOriginalEnd

date-time | null

Relative DateTime of the end of this segment before payroll policy rules are applied. Null if the segment ended with a missed punch.

durationHours

double | null

The total hours worked by the employee for a particular punch or time entry, reflecting the duration of their work.

earnings

double

The total earnings accrued by the employee for the specific punch or time entry, including wages, bonuses, or additional compensation.

costCenters

array of objects | null

List of cost centers, at most one per cost center level, that this segment of the worked shift is allocated to.

costCenters

object

string

unique Guid

costCenterId

int32

Cost center id

level

int32

Cost center level

code

string | null

Cost center code

name

string | null

Cost center name

isActive

boolean

The boolean value indicates whether the cost center is active or not.

401

Unauthorized

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://dc1demogwext.paylocity.com/apiHub/time/v2/companies/companyId/employees/employeeId/punchDetails?testFlag=false' \
3
     --header 'Authorization: Bearer JWT_GOES_HERE' \
4
     --header 'accept: application/json'


xxxxxxxxxx
33
]
1
[
2
  {
3
    "employeeId": "string",
4
    "companyId": "string",
5
    "badgeNumber": 0,
6
    "relativeStart": "2025-03-30T15:42:27.788Z",
7
    "relativeEnd": "2025-03-30T15:42:27.788Z",
8
    "segments": [
9
      {
10
        "punchID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11
        "origin": "string",
12
        "date": "2025-03-30",
13
        "punchType": "string",
14
        "relativeStart": "2025-03-30T15:42:27.788Z",
15
        "relativeEnd": "2025-03-30T15:42:27.788Z",
16
        "relativeOriginalStart": "2025-03-30T15:42:27.788Z",
17
        "relativeOriginalEnd": "2025-03-30T15:42:27.788Z",
18
        "durationHours": 0,
19
        "earnings": 0,
20
        "costCenters": [
21
          {
22
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
23
            "costCenterId": 0,
24
            "level": 0,
25
            "code": "string",

200Success

400Bad Request

403Forbidden

500Server Error