PayrollRuns

The table that records details for each payroll run that is processed in ADP. This table includes key identifiers (Ids), pay-period information, and references to associated inputs such as earnings and deductions. This table enables audit tracking, reconciliation, and historical reporting of payroll operations.

Table Specific Information

Select

The cmdlet uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the cmdlet.

ItemID supports the '=' comparison.
PayrollRegionCodeValue supports the '=' comparison.
PayrollGroupCodeValue supports the '=' comparison.
PayrollScheduleReferenceScheduleEntryID supports the '=' comparison.
PayrollScheduleReferencePayrollWeekNumber supports the '=' comparison.
PayrollScheduleReferencePayrollYear supports the '=' comparison.
PayrollScheduleReferencePayrollRunNumber supports the '=' comparison.
Level supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PayrollRuns WHERE ItemID = 'TXSMIb+yh9UbJ9-im9au7g=='

SELECT * FROM PayrollRuns WHERE PayrollRegionCodeValue = 'BOST'

SELECT * FROM PayrollRuns WHERE PayrollGroupCodeValue = '3TN'

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferenceScheduleEntryID = '20201117141612-l6OF8VuGHJD1ydLFoe5+nGBEm7rZkaRSorra0woRs04='

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollWeekNumber = '40'

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollYear = '2020'

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollRunNumber = '1'

SELECT * FROM PayrollRuns WHERE Level = 'payroll'

Insert

Following is an example of how to inserting pay data inputs into PayrollRuns table. For example:

INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', 'G3BGDF8JG32ERTGK', '1', '020024', '[{"earningCode":{"codeValue":"R"},"modifierCode":{"codeValue":"1"},"rate":{"rateValue":"44.50"},"configurationTags":[{"tagCode":"ShiftCode","tagValues":["1"]}],"numberOfHours":40},{"earningCode":{"codeValue":"O"},"modifierCode":{"codeValue":"2"},"numberOfHours":4}]', '[{"deductionCode":{"codeValue":"A"},"deductionRate":{"rateValue":9.5,"currencyCode":"USD"}}]', '[{"reimbursementCode":{"codeValue":"B"},"reimbursementAmount":{"amountValue":25,"currencyCode":"USD"}}]')

Inserting pay data inputs using Temp Table.

INSERT INTO PayrollRunsEarningInputs#TEMP (EarningCodeValue, RateValue, NumberOfHours) VALUES ('R', '50.50', '40');
INSERT INTO PayrollRunsDeductionInputs#TEMP (DeductionCodeValue, DeductionRateValue, DeductionAmountcurrencyCode) VALUES ('A', '10', 'USD');
INSERT INTO PayrollRunsReimbursementInputs#TEMP (ReimbursementCodeValue, ReimbursementAmountValue, ReimbursementAmountCurrencyCode) VALUES ('B', '25.00', 'USD');

INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, PayrollWeekNumber, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs,  ReimbursementInputs) VALUES ('3U7', 'TestProcessing', '53', 'G3BGDF8JG32ERTGK', '1', '020024', 'PayrollRunsEarningInputs#TEMP', 'PayrollRunsDeductionInputs#TEMP', 'PayrollRunsReimbursementInputs#TEMP');

Columns


Name	Type	ReadOnly	References	Description
ItemID [KEY]	String	True		The unique identifier (Id) that represents the payroll run record. This Id distinguishes each payroll run within ADP's payroll processing system.
PayrollProcessingJobID	String	False		The Id that identifies the payroll processing job that is associated with the current run. This Id is generated when the payrollProcessingJob.initiate event is triggered.
AlternateJobIDs	String	True		The alternate Ids that are associated with the payroll processing job. These Ids can be used to reference parallel or linked payroll runs within the system.
PayrollRegionCodeValue	String	True		The code that identifies the region in which the payroll is processed. This code ensures correct application of regional tax and labor rules.
PayrollGroupCodeValue	String	False	PayrollGroup.Code	The code that identifies the payroll group that is relevant to this payroll run. This code aligns the run with the appropriate pay cycle and processing configuration.
PayrollGroupCodeShortName	String	True		The short descriptive name that corresponds to the payroll group code. This field provides a concise label for use in reports and dashboards.
PayrollGroupCodeLongName	String	True		The long descriptive name that corresponds to the payroll group code. This field provides a full, readable name used in reports and payroll configuration references.
PayrollScheduleReferencePayrollScheduleID	String	True		The Id that identifies the payroll schedule that is associated with the payroll output. This Id links the payroll run to the applicable pay period schedule.
PayrollScheduleReferenceScheduleEntryID	String	True		The Id that identifies the specific entry within the payroll schedule that is associated with this run. This Id supports traceability between schedule entries and payroll runs.
PayrollScheduleReferencePayrollWeekNumber	String	True		The week number that represents the payroll period within the payroll schedule. This value does not necessarily align with the calendar week number.
PayrollScheduleReferencePayrollYear	String	True		The year that is associated with the payroll period. This value helps identify pay runs that occur within the same fiscal or calendar year.
PayrollScheduleReferencePayrollRunNumber	String	True		The run number that represents the sequence of payroll runs within a given week. This value distinguishes reruns or supplemental payrolls.
PayrollProcessingJobStatusCodeValue	String	True		The code that identifies the processing status of the payroll job (for example, Pending, In Progress, or Completed). This code supports workflow tracking and system monitoring.
PayrollProcessingJobStatusCodeShortName	String	True		The short descriptive name that corresponds to the payroll job status code. This field provides a readable label for display in dashboards and audit reports.
PayrollProcessingJobStatusCodelongName	String	True		The long descriptive name that corresponds to the payroll job status code. This name provides detailed context for reporting and troubleshooting.
AssociatePayments	String	True		The data that is returned for associate payments when the processing level is set to Detail. This field provides access to payment-level breakdowns within the payroll run.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.