Punch Data Imports

Overview

Paylocity provides integrators a direct way to import finalized punch data from external time-tracking systems into Paylocity’s Time & Labor module. These imports are limited to a 62-day window (31 days prior and 31 days forward, if pay periods are open) and is intended for importing finalized data only; edits to submitted punches are not currently supported. Once imported, punches flow through the Time & Labor rules engine for finalization and payroll readiness.

📘

Implementing Punch Import Integrations

The primary method of performing these imports will use the Punch Import API and requires:

  • Valid credentials with Punch Import permissions
  • An active Time & Labor module for the integrating company ID
  • Alignment with the File Map for Punch Imports and cost center configurations.

Common use-cases & industries that the Punch Import API can accommodate are:

  • Hardware Clocks – Badge swipes, fingerprint, or facial recognition devices feeding punches directly into T&L.
  • Shift-Based Operations – Manufacturing plants, warehouses, or union shops with multiple shifts and overtime rules.
  • Retail & Restaurants – POS systems where staff clock in/out at terminals across many locations. They may also have Tips to allocate.
  • Scheduling Tools – Third-party scheduling systems that generate punches at shift start/end (e.g., call centers, staffing).
  • Mobile Workforce – Drivers, sales reps, healthcare workers, or field staff clocking in/out via mobile apps.
  • Franchise & Distributed Operations – Chains or franchisees consolidating punches from varied local systems into a standard T&L process

File Map for Punch Imports

The File Map for Punch Imports configuration within the Time & Labor module is responsible for digesting API Requests and ensuring they are formatted as expected. These mappings are company-specific; so while they may appear similar, each company ID may have unique configurations, especially concerning record types such as Punch In, Punch Out, Lunch, etc. Additionally, only Punch Types that are added to the File Map configuration will be accepted via the Punch Import API. Client administrators must be sure to select the “No Headers” option during creation of the File Map for Punch Imports.

  • File Maps are not available via API calls; they must be configured within the Paylocity front-end user experience
  • To better understand the data-elements and their definitions refer to the Punch Import Data Fields documentation
  • To better understand the process around the creation or updating of a File Map for Punch Imports configuration, client administrators should refer to the Paylocity Knowledge Base Article: PCTY-69546 -- Configure a File Map for Punch Imports

Concepts to Consider

To pass the app review process, demonstrating an understanding and planned support for the below concepts, we recommend the following submission formats:

  • Provide a Written Overview (pdf): Submit a brief written explanation (one to two paragraphs) describing how your application and support process will handle the listed activities.
  • Document Known Limitations: If your application cannot support a particular scenario, clearly document the limitation. This transparency ensures clients are informed during the sales and discovery phases and should they contact our support team, we can refer them to the appropriate documentation on your site.
ActivityRecommendation
Error Handling VisibilityBe aware that Punch Import errors are surfaced only in the Time & Labor module UI. Programmatic error handling (via API response codes or endpoints) is not currently available.
Import error details and corrections must be addressed manually within the Time and Labor module.
Adjustments & Edits to Imported PunchesThe Punch Import API does not support adjustments to the same segment of time. Any edits must be made manually by a Client Administrator on the employee’s timecard within the Time & Labor module.
Punch Import Map SetupBe aware that the Punch Import API follows the configured File Map for Punch Imports within Time & Labor. Payloads must align to the defined map; header rows are not supported. File Map configuration must be completed manually prior to using the Punch Import API.
Importing Punches Without Assigned Labor LevelsBe aware that punches cannot be processed for employees who do not have valid Labor Levels assigned. Ensure Labor Levels are assigned within the Time & Labor module prior to using the Punch Import API.
Handling Time ZonesPunch data uses the employee’s default time zone as configured in the Time & Labor module. Since no API endpoint exposes this setting, ensure your system aligns using alternative methods prior to using the Punch Import API.
Approved/Finalized Punch Data OnlyEnsure only finalized punch data is transmitted via the API. Draft or unapproved punches should not be sent to Paylocity.
HoursDollarsWhen submitting recordTypes for Pay Types or Pay Adjustments, the hoursDollars field must be included.
Labor Levels & Cost CentersEmployees can only punch into the labor levels they are assigned to. Ensure labor-level permissions are correctly configured in the Time & Labor database before sending punches or transfers.

Test Scenarios

To satisfy the below test requirements (when applicable), provide:

  • Technical DEMO: A video of a technical demonstration that shows the functionality working as intended (Preferred)
  • API Logging: Provide API logging details (request & response payloads without PII) with date and time stamps via email.
ScenarioTest Requirement
Sending Regular Time PunchesDemonstrate transmission of a standard 40-hour work week using Punch In, Punch Out, Lunch, and Break punch types. Provide Punch Import logs and confirm accurate totals using Punch Detail Reporting from the Time & Labor module.
Sending Overtime / DoubletimeDemonstrate how overtime or doubletime punches are transmitted.
Sending Approved Time-Off Requests (PTO, Sick, Jury, etc.)Demonstrate how approved non-work hours are transmitted.
Sending Pay Adjustments (Tips, Commission, Bonus, etc.)Demonstrate how Pay Adjustments are transmitted.
Employee Transfers Between Departments / LocationsDemonstrate how transfer punches are used to move an employee from one department or location to another.