GetEmployeePunchDetails
Get employee punch details. The GetEmployeePunchDetails stored procedure requires the Pay Entry API. To use this stored procedure, the UsePayEntryAPI connection property must be set to true.
Stored Procedures Specific Information
Paylocity allows only a small subset of columns to be used in the Exec query. The required parameters for GetEmployeePunchDetails are CompanyId and EmployeeId. The CompanyId can also be specified in the connection string. If CompanyId is specified in both the connection string and the query, the value provided in the query takes precedence.
For example:
EXECUTE GetEmployeePunchDetails EmployeeId = 'D3402040' EXECUTE GetEmployeePunchDetails EmployeeId = 'D3402040', RelativeStart = '2026-01-05T06:00:00', RelativeEnd = '2026-01-05T14:30:00'
Input
| Name | Type | Required | Description |
| EmployeeId | String | True | Id of the Employee. |
| CompanyId | String | False | The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity. |
| RelativeStart | Datetime | False | The relative DateTime for the beginning of the WorkedShift in format yyyy-MM-ddThh:mm:ss. |
| RelativeEnd | Datetime | False | The relative DateTime for the end of the WorkedShift in format yyyy-MM-ddThh:mm:ss. |
| TestFlag | Boolean | False | A Boolean value that, when set to true, returns mock data. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Execution status of the stored procedure |
| EmployeeId | String | Id of the Employee. |
| SegmentsPunchId | String | A unique identifier assigned to each punch or time entry, ensuring that each entry is distinct, traceable, and easily referenced for tracking purposes. |
| CompanyId | String | The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity. |
| BadgeNumber | Integer | The Time and Labor badge number. |
| RelativeStart | Datetime | The relative DateTime for the beginning of the WorkedShift in format yyyy-MM-ddThh:mm:ss. |
| RelativeEnd | Datetime | The relative DateTime for the end of the WorkedShift in format yyyy-MM-ddThh:mm:ss. |
| SegmentsOrigin | String | The associated origin of the time entry. |
| SegmentsDate | 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. |
| SegmentsPunchType | String | The type of punch recorded indicating whether it was recorded for categories such as work, lunch break etc. |
| SegmentsRelativeStart | Datetime | Relative DateTime of the beginning of this segment after payroll policy rules are applied. Null if the segment began with a missed punch. |
| SegmentsRelativeEnd | Datetime | Relative DateTime of the end of this segment after payroll policy rules are applied. Null if the segment ended with a missed punch. |
| SegmentsRelativeOriginalStart | Datetime | Relative DateTimeOffset of the beginning of this segment before payroll policy rules are applied. Null if the segment began with a missed punch. |
| SegmentsRelativeOriginalEnd | Datetime | Relative DateTime of the end of this segment before payroll policy rules are applied. Null if the segment ended with a missed punch. |
| SegmentsDurationHours | Double | The total hours worked by the employee for a particular punch or time entry, reflecting the duration of their work. |
| SegmentsEarnings | Double | The total earnings accrued by the employee for the specific punch or time entry, including wages, bonuses, or additional compensation. |
| SegmentsCostCenters | String | List of cost centers, at most one per cost center level, that this segment of the worked shift is allocated to. |