v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Employee Punch Details

[DEPRECATED] Get Employee Punch Details

Summary Description

The GET Punch Details API 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. The Punch Details API can be filtered by date range

The Paylocity Punch Detail use cases:

  • The Punch Detail API provides HR and payroll organizations with precise and comprehensive punch data for every employee. The provided data can be utilized to accurately compute employee salaries, incorporating overtime and rounding modifications
  • Organizations can employ the API to collect punch data for particular cost centers or departments. This enables comprehensive examination of labor efficiency, attendance, and time allocation. By having access to both rounded and precise punch times, firms can analyze patterns, evaluate employee punctuality, and utilize data-driven strategies to enhance operational efficiency
  • The Punch Detail API is indispensable for ensuring adherence to labor standards. It offers a thorough record of employee punches, facilitating the demonstration of compliance during audits or inquiries. Users have the ability to apply filters based on date range, facilitating the retrieval of specific data needed for compliance reporting
get/apiHub/time/v1/companies/{companyId}/employees/{employeeId}/punchDetails

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