ADP Developer Resources

Use Case Description

This use case appends entries to an existing Pay Data batch. It is commonly used to append the following data from a different system or application to the ADP Workforce Now Paydata page:

Earnings
Deductions
Reimbursement
Reportable Earnings and Benefits
Temporary Cost Number
Temporary Department Number
Allocations
Memo's

API Usage

Method	Uniform Resource Identifier (URI)	Description	Github Sample Request Payload	Github Sample Response Payload
GET	/events/payroll/v1/pay-data-input.modify/meta	Returns an event metadata. Note: Sample payload can be built from the meta call.	NA	Paydatainput-meta-call-http-200-response.json
POST	/events/payroll/v1/pay-data-input.modify	Appends entries to an existing pay data batch.	APPEND-Paydata-batch-http-200-request	APPEND-Paydata-batch-http-200-response

Functionality of APPEND:

When performing an APPEND to an existing pay data batch, we need to include "_modificationTypeCode": "Append" in the request payload. Refer to the Github Sample Request Payload: payrollProcessingJobID[BatchID].

Functionality of the APPEND:

Note, that the batch is created with the batch name[provided in request] appending random numeric values [Example: Batch_654321] in the UI.
IF payrollProcessingJobID = ‘Batch_654321’ Then it will append to Batch_654321
When there are multiple payrollProcessingJobID(i.e Batch ID) with the same name.The Append functionality is performed to the latest batch that is added.
Example:
- Batch_123456
- Batch_654321
- Batch_987654

If payrollProcessingJobID = ‘Batch’ Then it will append to Batch_987654

Application Scope

The following canonical needs to be added to your application scope to enable this use case:

/payroll/payrollManagement/payrollProcessing/payDataInputManagement/
pay-data-input.modify

Supported Actors

Request Parameter roleCode Value	Usage
practitioner	Appends the entries to an existing pay data batch as a practitioner.

Data Dictionary

Refer to Chapter 1 - About this API, under the Temporary Cost Number, Temporary Department Number, and Allocation Data Dictionary section. Need to include the following request payload for the APPEND functionality.

Schema Location	Field Name in WFN UI	Notes
/payDataInput/payeePayInputs/payrollProfilePayInputs/payInputs/_modificationTypeCode	Not Displayed	"_modificationTypeCode": "Append" indicates the APPEND functionality of the API, which appends entries to the existing batch.

Responses

You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development.

For more information, see API Common Exceptions and Tips for Handling.

Response Code	Condition	messageText	GitHub Sample Request Payload	GitHub Sample Response Payload
200 OK	Append the paydata entries for an existing paydata batch.	NA	APPEND-Paydata-batch-http-200-request.json	APPEND-Paydata-batch-http-200-response.json
200 OK	Append the paydata batch with coded hrs and earning.	NA	APPEND-Paydata-batch-with-codehoursAndEarnings-http-200-request	APPEND-Paydata-batch-with-codehoursAndEarnings-http-200-response
200 OK	Append the paydata batch with rate codes for multiple associates.	NA	APPEND-Paydata-batch-MA-with-rateCode-http-200-request.json	APPEND-Paydata-batch-MA-with-rateCode-http-200-response.json
200 OK	Append the paydata batch with cost number.	NA	APPEND-Paydata-batch-with-CostNumber-http-200-request.json	APPEND-Paydata-batch-with-CostNumber-http-200-response.json
200 OK	Append the paydata batch with Department number.	NA	APPEND-Paydata-batch-with-DeptNumber-http-200-request.json	APPEND-Paydata-batch-with-DeptNumber-http-200-response.json
400 Bad Request	Append the paydata batch with invalid payrollProcessingJobID.	messageText": "eventContext/payrollProcessingJobID is invalid. eventContext/payrollProcessingJobID"	APPEND-Paydata-batch-invalid-payrollProcessingJobID-http-400-request.json	APPEND-Paydata-batch-invalid-payrollProcessingJobID-http-400-response.json