PApaylocity
Company Punch Details

Create Company Punch Detail Operation

Summary Description

The Company Punch Detail endpoint returns punch records for all employees within a specified company. Company Punch Detail endpoint represents the first step in a three-step process for retrieving punch details at the company level. Results can be limited by specifying a start date and end date. Date and time filtering uses the consumer's time zone and supports standard daily boundaries (00:00:00, 12:00:00, and 23:59:59).

For information about the complete sequence, see the Punch Detail Overview or the Getting Started with Company Punch Details API recipe.

Use Cases

  • Retrieve punch details for all employees associated with a specific company ID.
  • Narrow results to a defined timeframe by using the relativeStart and relativeEnd parameters.
post/apiHub/time/v2/companies/{companyId}/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}/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.

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

relativeStartstring date-time

The relative DateTime for the beginning of the WorkedShift. Value must not have timezone information.

relativeEndstring date-time

The relative DateTime for the end of the WorkedShift. Value must not have timezone information.

Response

Accepted. This response has no body. Use the Location header value to retrieve the operation status and operationId in Step 2.

Changes

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