---
title: "Create New Payroll Batch"
method: POST
path: "/apihub/payroll/v2/companies/{companyId}/payEntryImport"
tags: ["Pay Entry"]
---

# Create New Payroll Batch

`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`

**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.

## Path parameters

- `companyId` unknown, required

## Headers

- `Authorization` unknown, required

## Request body

- PayEntry
  - `autoAcknowledge` boolean: Auto Acknowledge the batch (True/False)
  - `batchName` string: Name for the Payroll Batch you are creating
  - `mergeBatchId` integer: Merge Batch
  - `payPeriodBeginDate` string, date-time: Pay Period Begin Date
  - `payPeriodEndDate` string, date-time: Pay Period End Date
  - `checkDate` string, date-time: Check Date for Payroll
  - `checkType` string: Check Type
  - `payEntries` PayEntries[]
    - `employeeId` string: The employee's employee ID.
    - `det` string: Identifies the type of record being imported. May be 'E' for earning, 'D' for deduction and 'A' for accrual balances.
    - `detCode` string: The earning or deduction code. This must be a code currently defined on the company-level in Paylocity.
    - `hours` string: The number of hours worked by the employee, or the used accrual hours.
    - `amount` string: The dollar amount to pay the employee or the available accrual hours. If an amount is entered, any information entered in the hours, rate, and rateCode fields are ignored.
    - `tempRate` string: Rate
    - `rateCode` string: The employee�s pay rate. If no rate is entered, the employees base rate will be used.
    - `costCenter1` string: This field is used to enter an override value for the first-level cost center charged by the employee.
    - `costCenter2` string: This field is used to enter an override value for the second-level cost center charged by the employee.
    - `costCenter3` string: This field is used to enter an override value for the third-level cost center charged by the employee.
    - `jobCode` string: This field is used to enter an override company-defined job code to be charged by the employee.
    - `shift` string: This field is used to enter an override company-defined shift code to be charged by the employee.
    - `beginDate` string: Begin Date associated with this line item
    - `endDate` string: End Date associated with this line item
    - `workersCompCode` string: The company defined workers comp code for work performed by the employee.
    - `sequence` string: This field is used to indicate multiple checks. For example, if an employee should have two checks, then the entries which should create the first check will have a sequence of 1. The second check will have a sequence of 2. Sequence may be any number between 1-9.
    - `checkType` string: This field is used to indicate an override check Type.
    - `checkNumber` string: This field is used to indicate an override check Number. It is only valid when check Type is Manual. Check number for regular checks is assigned during processing.

## Response `202`

successful operation

- SuccessResponse
  - `fileName` string
  - `timeImportFileTrackingId` string
  - `status` string

## Other responses

- `400`: invalid body
- `401`: unauthorized
- `403`: forbidden

---

[API](https://skmtc.dev/paylocity/apis/pay-entry.md) - [All operations](https://skmtc.dev/paylocity/apis/pay-entry/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/pay-entry/revisions/c97a1bb2f2cf?raw)