Create New Payroll Batch | Paylocity

curl -X POST https://api.paylocity.com/apihub/payroll/v2/companies/companyId/payEntryImport \
     -H "Accept: application/json" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "autoAcknowledge": "<boolean>",
  "batchName": "<string>",
  "mergeBatchId": "<integer>",
  "calendarId": "<integer>",
  "payPeriodBeginDate": "<dateTime>",
  "payPeriodEndDate": "<dateTime>",
  "checkDate": "<dateTime>",
  "payEntries": [
    {
      "employeeId": "<string>",
      "det": "<string>",
      "detCode": "<string>",
      "hours": "<string>",
      "amount": "<string>",
      "tempRate": "<string>",
      "rateCode": "<string>",
      "costCenter1": "<string>",
      "costCenter2": "<string>",
      "costCenter3": "<string>",
      "jobCode": "<string>",
      "shift": "<string>",
      "beginDate": "<string>",
      "endDate": "<string>",
      "workersCompCode": "<string>",
      "tCode1": "<string>",
      "tCode2": "<string>",
      "tCode3": "<string>",
      "tCode4": "<string>",
      "sequence": "<string>",
      "checkType": "<string>",
      "checkNumber": "<string>"
    },
    {
      "employeeId": "<string>",
      "det": "<string>",
      "detCode": "<string>",
      "hours": "<string>",
      "amount": "<string>",
      "tempRate": "<string>",
      "rateCode": "<string>",
      "costCenter1": "<string>",
      "costCenter2": "<string>",
      "costCenter3": "<string>",
      "jobCode": "<string>",
      "shift": "<string>",
      "beginDate": "<string>",
      "endDate": "<string>",
      "workersCompCode": "<string>",
      "tCode1": "<string>",
      "tCode2": "<string>",
      "tCode3": "<string>",
      "tCode4": "<string>",
      "sequence": "<string>",
      "checkType": "<string>",
      "checkNumber": "<string>"
    }
  ]
}'

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.

Request

Request payload for this operation. See the official endpoint documentation for required fields and allowable values.

Response

Successful response

Errors

401

Unauthorized Error

Authentication

Path parameters

Headers

Request

Response

Errors