CreatePayEntryImportBatch
Create a new Pay Entry payroll batch by importing summarized payroll data for a specified pay period and check date. The CreatePayEntryImportBatch stored procedure requires the Pay Entry API. To query this stored procedure, the UsePayEntryAPI connection property must be set to true.
Stored Procedures Specific Information
In order to insert into CreatePayEntryImportBatch, you must submit the TimeEntry details and a Pay Period. The TimeEntry details may be submitted via
a Temp table by first inserting to the Input_TimeEntry input only table. The Pay Period may be specified by setting the PayPeriodBeginDate, PayPeriodEndDate,
and CheckDate. For example:
INSERT INTO Input_TimeEntry#TEMP (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623635, 'E', 'REG', 40.00, 30, '2021-08-08', '2021-08-14') INSERT INTO Input_TimeEntry#TEMP (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623636, 'E', 'REG', 40.00, 25, '2021-08-08', '2021-08-14') EXECUTE CreatePayEntryImportBatch TimeEntry = 'Input_TimeEntry#TEMP', AutoAcknowledge = 'true', BatchName = 'Test', PayPeriodBeginDate = '2021-08-15', PayPeriodEndDate = '2021-08-21', CheckDate = '2021-08-27'
Alternatively, you can manually provide a list of values for the TimeEntry aggregate column using JSON structures.
EXECUTE CreatePayEntryImportBatch TimeEntry = '[{"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","sequence":"string","checkType":"string","checkNumber":"string"}]', AutoAcknowledge = 'true', BatchName = 'Test', PayPeriodBeginDate = '2021-08-15', PayPeriodEndDate = '2021-08-21', CheckDate = '2021-08-27'
Input
| Name | Type | Required | Description |
| TimeEntry | String | True | An array of payroll entry objects representing employee-level payroll data (such as earnings, hours, and deductions) to be included in the batch. This can be submitted by inserting to the Input_TimeEntry input only table. |
| AutoAcknowledge | Boolean | False | Use true to auto acknowledge any errors or warnings for the import, false to not auto acknowledge. |
| BatchName | String | False | The name of the Payroll batch. |
| MergeBatchId | String | False | The Id of the batch to be merged. |
| CalendarId | String | False | DEPRECATED. The Calendar Id for the check date. |
| PayPeriodBeginDate | String | False | The Pay Period Begin Date in YYYY-MM-DD format. |
| PayPeriodEndDate | String | False | The Pay Period End Date in YYYY-MM-DD format. |
| CheckDate | String | False | The Pay Period Check Date in YYYY-MM-DD format. |
| CheckType | String | False | The Check Type. |
Result Set Columns
| Name | Type | Description |
| FileName | String | The name of the import file generated by Paylocity for the submitted payroll batch. |
| TimeImportFileTrackingId | String | The Id of the time import file tracking. |
| Status | String | Status of the Time Import Batch. |