PApaylocity
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

Request

  • Base URL
    https://dc1demogwext.paylocity.com
  • URL
    https://dc1demogwext.paylocity.com/apihub/payroll/v2/companies/{companyId}/payEntryImport
  • Auth
    none declared. Required headers: Authorization

Path parameters

companyIdunknown required

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

Headers

Authorizationunknown required

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

Changes

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