v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Pay Entry

Create New Payroll Batch

Summary Description

The Pay Entry API allows API users to interface with Paylocity�s HR & Payroll module, specifically within the 'Run Payroll' feature. This API allows users to submit new payroll batches for a specified check date. The endpoint accepts summarized payroll data, allowing API users to import data from third-party systems.

post/apihub/payroll/v2/companies/{companyId}/payEntryImport

Path parameters

{"stackTrail":"paths:/apihub/payroll/v2/companies/{companyId}/payEntryImport:post:parameters:0:schema","oasType":"schema","type":"unknown"}

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

Headers

{"stackTrail":"paths:/apihub/payroll/v2/companies/{companyId}/payEntryImport:post:parameters:1:schema","oasType":"schema","type":"unknown"}

Bearer token

Request body

autoAcknowledgeboolean

Auto Acknowledge the batch (True/False)

batchNamestring

Name for the Payroll Batch you are creating

mergeBatchIdinteger

Merge Batch

payPeriodBeginDatestring date-time

Pay Period Begin Date

payPeriodEndDatestring date-time

Pay Period End Date

checkDatestring date-time

Check Date for Payroll

checkTypestring

Check Type

Response

successful operation

fileNamestring
timeImportFileTrackingIdstring
statusstring