CHAPTER 2

Use Case: Adding Entries in a Pay Data Batch

Use Case Description

This use case sends entries to a Pay Data batch. It is commonly used to send 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

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

Adds a new pay data batch.

Add-Paydata-batch-http-200-request.json

 

Add-Paydata-batch-http-200-response.json

In the given payload (Single Associate RequestMultiple Associate Request), the following is the purpose of the EventContext and Transform sections:

  • eventContext: A set of keys, identifying the subject. In the payload, the associateID field is present under eventContext. The associateID identifies the subject.
  • transform: Provides the values added or changed with respect to the subject keys defined in the eventContext section.

Application Scope

The canonical URI corresponding to the Payroll Data Input API needs to be added in the Consumer Application Registry (CAR) for the subscription following which a user can access this API and make successful API calls.

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 System user that sends pay data for a pay data batch.

Sequence of Interactions

  1. Your consumer application makes a request for /events/payroll/v1/pay-data-input.modify/meta to the ADP API endpoint.
  2. The ADP API endpoint responds to your consumer application with the meta payload. See the table in the following section.
  3. Your consumer application processes the meta payload to validate data included in the payload in step 4 and prompts the user to fix any validation issues. Otherwise, compose the payload for the /events/payroll/v1/pay-data-input.modify request.
  4. Your consumer application makes a /events/payroll/v1/pay-data-input.modify request to the ADP API endpoint.
  5. The ADP API endpoint responds to the consumer application concerning the details of /events/payroll/v1/pay-data-input.modify.

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

Tips to Handle

200 OK

Request processes successfully.

 

SA-Temporary-CostNUmber-and-codeValue-http-200-request.json

SA-http-200-response.json

 

400 Bad Request

If the payroll cycle status is not one of the following:

  • Entering Payroll Information
  • Correcting Input

"messageText": "eventContext/ payrollGroupCode is invalid. eventContext/ payrollGroupCode

payroll-cycle-status -cycle complete-http -400-request.json

payroll-cycle-status -cycle complete- http-400- response.json

Check the Payroll Cycle value for the company code, which is currently used in the request.

400 Bad Request

An invalid company code is passed in the request.

"messageText": "eventContext/payrollGroupCode is invalid. eventContext/ payrollGroupCode"

Invalid-payrollGroupCode-http-400-request.json

Invalid-payrollGroupCode- http-400- response.json

Check if the input data is the value.

400 Bad Request

An invalid Associate Organization ID (AOID) exists. This is the AOID associated with the file number passed in the request.

"messageText": "Label not found, missing following key: access.invalid associateOid: G3E82PE9GT1Q8VENN"

Invalid-AOID-http-400 -request.json

Invalid-AOID- http-400- response.json

Check if the employee is still active and eligible for payroll processing.

400 Bad Request

An Invalid payrollFileNumber is passed in the request.

"messageText": "payrollFileNumber:8118799 is invalid. payrollFileNumber:8118799"

Invalid- payrollFileNumber -http-400-request.json

Invalid- payrollFileNumber- http-400- response.json

Check if the employee is still active and eligible for payroll processing.

400 Bad Request

When an invalid payNumber is passed in the request.

"messageText": "payNumber:100 is invalid. payNumber:100"

Invalid-PayNumber-http -400-request.json

Invalid-PayNumber- http-400- response.json

Check and correct pay number value.

400 Bad Request

The hoursEarningCode is not present in the Validation table.

"messageText": "codedHoursEarning: VV is invalid. codedHoursEarning: VV"

invalid-hoursEarningCode-codedHours-http-400-request.json

Invalid-hoursEarningCode-codedhours-http-400- response.json

Your data connector application should validate that the hoursEarningCode is set up for the Codedhours in the Validation table.

400 Bad Request

The deduction code is not present in the Validation table.

"messageText": "payrollProfilePay Inputs/payInputs /deductionInputs /deductionCode /codeValue is invalid. PayrollProfilePay Inputs/payInputs /deductionInputs /deductionCode /codeValue DD"

Invalid- Deduction Code- http-400-request.json

Invalid-DeductionCode-http-400-response.json

Your data connector application should validate that the deduction code is set up for the specific deduction in the Validation table.

400 Bad Request

Request for single Associate with Amount and Inactive Memo code value.

"messageText": "Label not found, missing following key: Memo codeValue does not exist in Validation Table, or MemoCode is not an active memo code in the Company G"

SA-same-amount-inactive-memocode-http-400-request.json

SA-same-amount-inactive-memocode-http-400-response.json

 

400 Bad Request

Request for single Associate with Amount and Memo code value as empty.

"messageText": "Label not found, missing following key: Memo codeValue does not exist in Validation Table, or MemoCode is not an active memo code in the Company "

SA-same-amount-empty-memocode-http-400-request.json

SA-same-amount-empty-memocode-http-400-response.json

 

400 Bad Request

Request for single Associate with Amount and Invalid Memo code value.

"messageText": "Label not found, missing following key: Memo codeValue does not exist in Validation Table, or MemoCode is not an active memo code in the Company aaa"

SA-amount-invalid-memocode-http-400-request.json

SA-amount-invalid-memocode-http-400-response.json

 

400 Bad Request

Request for single Associate Memo code and invalid amount.

"messageText": "Label not found, missing following key: Memo amountValue - The value must be between -99,999,999.99 and 99,999,999.99. 6000000000000"

SA-invalid-amount-memocode-http-400-request.json

SA-invalid-amount-memocode-http-400-response.json

 

400 Bad Request

Request for a Single Associate with Single Pay Number and Temporary Cost Number when costNumber is not present in the Validation table.

 

SA-Temporary-CostNUmber-not-in-validationtable-http-400-request.json

SA-Temporary-CostNUmber-not-in-validationtable-http-400-response.json

Your data connector application should validate that the Cost Number is set up for the specific Cost Number in the Validation table.

400 Bad Request

Request for a Single Associate with costNumber when the Company set up options includes a department number.

"messageText": "Provide correct message for the key - Error creating paydataGrid column Temporary Cost Number"

SA-Temp-CostNumber-but-companyOptions-have-Dept-setup-http-400-request.json

SA-Temp-CostNumber-but-companyOptions-have-Dept-setup-http-400-response.json

Your data connector application should validate that the Cost Number is set up for both Labor Distribution and Allocations in ADP Workforce Now by selecting Setup > Payroll > Company Options.

400 Bad Request

Request for a Single Associate with Temporary Cost Number and codeValue="".

"messageText": "Label not found, missing following key: payAllocation/allocationTypeCode/codeValue cannot be empty or null"

SA-Temp-Cost-Number-codevalue-empty-http-400-request.json

SA-Temp-Cost-Number-codevalue-empty-http-400-response.json

Check and pass the valid Value for Temporary Cost Number.

400 Bad Request

Request for a Single Associate with Temporary Cost Number when codeValue for costNumber is more than 50.

"messageText": "Label not found, missing following key: cost number cannot be more than 50 "

SA-Temp-Cost-Number-greater-than-50-http-400-request.json

SA-Temp-Cost-Number-greater-than-50-http-400-response.json

Temporary Cost Number must be 50 characters.

400 Bad Request

Request for a Single Associate with Temporary Department and codeValue="".

"messageText": "Label not found, missing following key: payAllocation/allocationTypeCode/codeValue cannot be empty or null "

SA-with-Temp-Dept-codevalue-empty-http-400-request.json

SA-with-Temp-Dept-codevalue-empty-http-400-response.json

Check and pass the valid value.

400 Bad Request

Request for a Single Associate with Temporary Department Number when Department Number is not present in the Validation table.

"messageText": "Label not found, missing following key: Allocation code is invalid "

SA-Temp_dept-codeValue-not-in-Validation-table-http-400-request.json

SA-Temp_dept-codeValue-not-in-Validation-table-http-400-response.json

Check and pass the valid value for Temporary Department Number.

400 Bad Request

Request for a Single Associate with Department Number when Company set up options includes a Cost Number.

"messageText": "Label not found, missing following key: Error creating paydataGrid column Temporary Department 3"

SA-Temp-DeptNumber-but-companyOptions-have-CostNumber-setup-http-400-request.json

SA-Temp-DeptNumber-but-companyOptions-have-CostNumber-setup-http-400-response.json

Your data connector application should validate that Department Number is set up for both Labor Distribution and Allocations in ADP Workforce Now by selecting Setup > Payroll > Company Options.

400 Bad Request

 

Request for a Single Associate and Single Pay Number with Allocation Number when Company set up options are set to enable[Automatic and Manual] for costNumber, and:
 

  • Allocations are in employment profile > allocations
  • codeValue=""

"messageText": "Label not found, missing following key: payAllocation/allocationTypeCode/codeValue cannot be empty or null "

SA-Allocation-CostNum-Automatic&Manual-CodeValue-empty-http-400-request.json

SA-Allocation-CostNum-Automatic&Manual-CodeValue-empty-http-400-response.json

 

400 Bad Request

Request for a Single Associate and Single Pay Number with Allocation Number when Company set up options are set to enable[Manual] for costNumber, and:
 

  • Allocations are in employment profile > allocations
  • codeValue=1

"messageText": "Label not found, missing following key: Allocation code is cannot be 1 if Automatic Allocation by Percentage not checked code: 1"

SA-Allocation-CostNum-Manual-CodeValue-1-http-400-request.json

SA-Allocation-CostNum-Manual-CodeValue-1-http-400-response.json

 

400 Bad Request

 

Request for a Single Associate and Single Pay Number with Allocation Number when Company set up options are set to enable[Manual] for costNumber, and:
]]></ac:plain-text-body></ac:structured-macro>

  • Allocations are in employment profile > allocations
  • codeValue=""

"messageText": "Label not found, missing following key: payAllocation/allocationTypeCode/codeValue cannot be empty or null"

SA-Allocation-CostNum-Manual-CodeValue-empty-http-400-request.json

SA-Allocation-CostNum-Manual-CodeValue-empty-http-400-response.json

 

400 Bad Request

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Manual] for costNumber, and:
 

  • Allocations are in employment profile > allocations- add > allocation position
  • codeValue=1 and 1

"messageText": "Label not found, missing following key: Allocation code is cannot be 1 if Automatic Allocation by Percentage not checked code: 1"

SA-Multi-payNumber-Allocation-CostNum-Manual-CodeValue-1&1-http-400-request.json

SA-Multi-payNumber-Allocation-CostNum-Manual-CodeValue-1&1-http-400-response.json

 

400 Bad Request

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set up to enable[Automatic] for costNumber, and:
 

  • Allocations are in employment profile > allocations- add > allocation position
  • codeValue="" and ""

"messageText": "Label not found, missing following key: payAllocation/allocationTypeCode/codeValue cannot be empty or null"

SA-Multi-payNumber-Allocation-CostNum-Automatic-CodeValue-empty&empty-http-400-request.json

SA-Multi-payNumber-Allocation-CostNum-Automatic-CodeValue-empty&empty-http-400-response.json

 

400 Bad Request

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set.

"messageText": "Label not found, missing following key: payAllocation/ allocationType Code/codeValue cannot be empty or null"

SA-Multi-payNumber-Allocation-CostNum-Automatic-CodeValue-1&empty-http-200-request.json

SA-Multi-payNumber-Allocation-CostNum-Automatic-CodeValue-1&empty-http-200-response.json

 

400 Bad Request

Request for a Single Associate and Single Pay Number with Allocation Number When: Company set up options are set to enable[Automatic] for costNumber, and:
 

  • Allocations are in employment profile > allocations- add > allocation position
  • codeValue=""

"messageText": "Label not found, missing following key: payAllocation /allocationType Code/codeValue cannot be empty or null"

SA-Allocation-CostNum-Automatic-CodeValue-empty-http-400-request.json

SA-Allocation-CostNum-Automatic-CodeValue-empty-http-400-response.json

 

400 Bad Request

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic] for DepartmentNumber.
Allocations are in employment profile > allocations- add > allocation position is 3 and 10[allocation position not there in employment profile].

"messageText": "Label not found, missing following key: Allocation code is cannot be 2-99 if Manual Posting of Allocation in Paydata not checked code: 10"

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-3-and-5-not-in-empProfile-http-400-request.json

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-3-and-5-not-in-empProfile-http-400-response.json

 

400 Bad Request

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic] for DepartmentNumber, and:
 

  • Allocations in employment profile > allocations- add > allocation position
  • codeValue="" and ""

"messageText": "Label not found, missing following key: payAllocation/allocationTypeCode/codeValue cannot be empty or null"

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-empty&empty-http-400-request.js

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-empty&empty-http-400-response.json

 

400 Bad Request

 Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic] for Department Number, and codeValue="" and "1".

"messageText": "Label not found, missing following key: payAllocation/ allocationType Code/codeValue cannot be empty or null"

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-empty%261-http-200-request.json

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-empty%261-http-200-response.json

 

400 Bad Request

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic] for DepartmentNumber, and:
 

  • Allocations are in employment profile > allocations- add > allocation position
  • codeValue="4" and "3"

"messageText": "Label not found, missing following key: Allocation code is cannot be 2-99 if Manual Posting of Allocation in Paydata not checked code: 4"

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-10&3-http-400-request.json

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-10&3-http-400-response.json

 

400 Bad Request

Request for a Single Associate with Allocation Number when Company set up options are set to enable[Automatic and Manual] for DepartmentNumber, and:
]]></ac:plain-text-body></ac:structured-macro>

  • Allocations are set to employment profile > allocations
  • codeValue=""

"messageText": "Label not found, missing following key: payAllocation/allocationTypeCode/codeValue cannot be empty or null"

SA-Allocation-DeptNum-Automatic&Manual-CodeValue-empty-http-400-request.json

SA-Allocation-DeptNum-Automatic&Manual-CodeValue-empty-http-400-response.json

 

400 Bad Request

Request for a Single Associate with Allocation Number when Company set up options are set to enable[Manual] for DepartmentNumber, and:
 

  • Allocations are in employment profile > allocations- add > allocation position
  • codeValue=1

"messageText": "Label not found, missing following key: Allocation code is cannot be 1 if Automatic Allocation by Percentage not checked code: 1"

SA-Allocation-DeptNum-Manual-CodeValue-1-http-400-request.json

SA-Allocation-DeptNum-Manual-CodeValue-1-http-400-response.json

 

400 Bad Request

Request for a Single Associate with Allocation Number when Company set up options are set to enable[ Manual] for DepartmentNumber, and:
 

  • Allocations are in employment profile > allocations- add > allocation position
  • codeValue=""

"messageText": "Label not found, missing following key: payAllocation/ allocationType Code/codeValue cannot be empty or null"

SA-Allocation-DeptNum-Manual-CodeValue-empty-http-400-request.json

SA-Allocation-DeptNum-Manual-CodeValue-empty-http-400-response.json

 

400 Bad Request

Request for a Single Associate with Allocation Number when Company set up options are set to enable[ Manual] for DepartmentNumber.
Allocations are in employment profile > allocations- add > allocation position is "5"[which is not there in allocation]

"messageText": "Label not found, missing following key: Allocation code is invalid code: 5"

SA-Allocation-DeptNum-Manual-CodeValue-5-not-emp-profile-http-400-request.json]

SA-Allocation-DeptNum-Manual-CodeValue-5-not-emp-profile-http-400-response.json]

 

400 Bad Request

Request for a Single Position-Multiple PayNumber with Allocation Number when Company set up options has enable[ Manual] for DepartmentNumber, and:
]]></ac:plain-text-body></ac:structured-macro>

  • Allocations are in employment profile-> allocations
  • codeValue="1" and 1

"messageText": "Label not found, missing following key: Allocation code is cannot be 1 if Automatic Allocation by Percentage not checked code: 1"

SA-Multi-payNumber-Allocation-DeptNum-Manual-CodeValue-1&1-http-400-request.json

SA-Multi-payNumber-Allocation-DeptNum-Manual-CodeValue-1&1-http-400-response.json

 

400 Bad Request When adding a batch with multiple employees and if any error exists in the payload

"resourceMessageInfoList": [ { "resourceMessageID": null, "processMessageInfoList": [ { "processMessageID": null, "messageTypeCode": "error", "messageText": "payrollFileNumber:81187 is invalid. payrollFileNumber:81187" } ] }, { "resourceMessageID": null, "processMessageInfoList": [ { "processMessageID": null, "messageTypeCode": "error", "messageText": "Label not found, missing following key: access.invalid associateOid: G3E82PE9GT1Q8VE" } ] } ],

Add-batch-for-multiple-associates-Invalid-http-400-request.json Add-batch-for-multiple-associates-Invalid-http-400-response.json In this case, if there are any errors in the payload, the API fails and batch will not create.
400 Bad Request Add a pay data with incorrect Rate code

"messageText": "earningInputs/rateCode/codeValue is invalid. earningInputs/rateCode/codeValue"

Add-Paydata-batch-with-invalid-ratecode-http-400-request.json Add-Paydata-batch-with-invalid-ratecode-http-400-response.json  
400 Bad Request Add a pay data with both rate code and rate value "messageText": "Label not found, missing following key: A paydata transaction may contain either temporary rate or temporary rate code. " Add-Paydata-batch-with-both-ratecode-rateValue-http-400-request.json Add-Paydata-batch-with-both-ratecode-rateValue-http-400-response.json  

Other Scenarios

The following is a list of common scenarios that you may want to consider for your application.

The sample responses listed all have the response code of 200.

Scenario Description

GitHub Sample Request Payload

GitHub Sample Response Payload

Notes

A batch already exists.

NA

NA

When a batch with the same Batch ID is requested, a new batch will be created with a system generated Batch ID (characters append to the same Batch ID).

Send in Hours for client configured Hours and Earnings
Earning Code Type: Other Hours

SA-hours-type-otherhours-codedhours-http-200-request.json

SA-hours-type-otherhours-codedhours-http-200-response.json

 

Send in HoursRate, and Amount for client configured Hours and Earnings
Earning Code Type: Hours/Earnings
Field Value: 3

SA-hours-type-hoursearnings-codedhours-http-200-request.json

SA-hours-type-hoursearnings-codedhours-http-200-response.json

 

Send in HoursRate, and Amount for client configured Hours and Earnings
Earning Code Type: Hours/Earnings
Field Value: 4

SA-amount-hours&earnings-codedhours-http-200-request.json

SA-amount-hours&earnings-codedhours-http-200-response.json

 

Send in Hours for Regular Earning

SA-hours-regularearning-http-200-request.json

SA-hours-regularearning-http-200-response.json

 

Send in Hours for Overtime Earning

SA-hours-overtime-earning-http-200-request.json

SA-hours-overtime-earning-http-200-response.json

 

Send in Temp Rate and Hours for Regular Earning

SA-hours&temprate-regular-earning-http-200-request.json

SA-hours&temprate-regular-earning-http-200-response.json

 

Send in Temp Rate and Hours for Overtime Earning

SA-hours&temprate-overtime-earning-http-200-request.json

SA-hours&temprate-overtime-earning-http-200-response.json

 

Send in Amount for Regular Earning

SA-amount-regular-earning-http-200-request.json

SA-amount-regular-earning-http-200-response.json

 

Send in Amount for Overtime Earning

SA-amount-overtime-earning-http-200-request.json

SA-amount-overtime-earning-http-200-response.json

 

Send in both Hours and Amounts for Regular Earning

SA-hours&amount-regular-earning-http-200-request.json

SA-hours&amount-regular-earning-http-200-response.json

 

Send in both Hours and Amounts for Overtime Earning.

SA-hours&amount-overtime-http-200-request.json

SA-hours&amount-overtime-http-200-response.json

 

Request with the same code for multiple associates for codedhoursEarnings Inputs.
Note: DT is an Hours/Earnings type.

MA-samecode-hours&earnings-codedhours-http-200-request.json

MA-samecode-hours&earnings-codedhours-http-200-response.json

 

Request with different codes for multiple associates for codedhoursEarningsInputs.

MA-with-differentcodes-for-codedhours-http-200-request.json

MA-with-differentcodes-for-codedhours-http-200-response.json

 

Request with multiple associates with different earning code, deduction, and codedhoursEarnings.

MA-diff-Earning-deductions-codedhours-http-200-request.json

MA-diff-Earning-deductions-codedhours-http-200-response.json

 

Request with multiple associates with the same deduction codes, earning code, and different codedhoursEarnings.

MA-same-deduction-earningcode-diff-codedhours-http-200-request.json

MA-same-deduction-earningcode-diff-codedhours-http-200-response.json

 

Request for multiple associates with different deduction codes, earning code, and different codedhoursEarnings.

MA-same-deductions-earnings-diff-codedhours-http-200-request.json

MA-same-deductions-earnings-diff-codedhours-http-200-response.json

 

Request for a single associate with earning code, deduction, and codedhoursEarnings.

SA-http-200-request.json

SA-http-200-response.json

 

Request for a single associate with hours for client configured Hours and Earnings
Earning Code Type/Field type: OH is an Hours type

SA-hours-type-otherhours-codedhoursEarnings-http-200-request.json

SA-amount-otherearnings-for-codedhours-http-200-request.json

 

Request for a single associate with Amount for client configured Hours and Earnings
Earning Code Type/Field Type: Other Earnings (N is an Other Earnings type)

SA-amount-otherearnings-codedhours-http-200-response.json

SA-amount-otherearnings-for-codedhours-http-200-request.json

 

Request for a single associate with hours for client configured Hours and Earning
Earning Code Type/Field Type: Hours/Earnings

SA-hours-type-hoursearnings-codedhours-http-200-request.json

SA-hours-hours&earnings-codedhours-http-200-response.json

 

Request for a single associate with Amount for client configured Hours and Earnings
Earning Code Type/Field Type: Hours/Earnings

SA-amount-hours&earnings-codedhours-http-200-request.json

SA-amount-hours&earnings-codedhours-http-200-response.json

 

Request with the same code for multiple associates for codedHoursEarningInputs for the Hours/Earnings type with the same deduction codes.
Note: DT is an Hours/Earnings type.

MA-same-deductions-hours&earnings-codedhours-http-200-request.json

MA-same-deductions-hours&earnings-codedhours-http-200-response.json

 

Request with the same code for multiple associates for codedHoursEarningInputs for the Other Earnings type with the same deduction codes.
Note: N is an Earnings type.

MA-same-deduction-type-Otherearnings-codedhours-http-200-request.json

MA-same-deduction-type-Otherearnings-codedhours-http-200-response.json

 

Request with the same code for multiple associates for codedHoursEarningInputs for the Other Hours type with the same deduction codes.
Note: OH is an Other Hours type.

MA-same-deduction-type-Otherhours-codedhours-http-200-request.json

MA-same-deduction-type-Otherhours-codedhours-http-200-response.json

 

Request with the same code for multiple associates for codedHoursEarningInputs for the Hours/Earnings type with different deduction codes.
Note: DT is an Hours/Earnings type.

MA-diff-deduction-type-Hours&earnings-codedhours-http-200-request.json

MA-diff-deduction-type-Hours&earnings-codedhours-http-200-response.json

 

Request with the same code for multiple associates for codedHoursEarningInputs for the Other Earnings type with different deduction codes.
Note: N is an Earnings type.

MA-diff-deduction-type-Otherearnings-codedhours-http-200-request.json

MA-diff-deduction-type-Otherearnings-codedhours-http-200-response.json

 

Request with the same code for multiple associates for codedHoursEarningInputs for the Other Hours type with different deduction codes.
Note: OH is an Other Hours type.

MA-diff-deduction-type-Otherhours-codedhours-http-200-request.json

MA-diff-deduction-type-Otherhours-codedhours-http-200-response.json

 

Request with different codes for multiple associates for codedHoursEarningInputs.

  • DT – Hours /Earnings type
  • OH – Other Hours type
  • N – Earnings type

MA-with-differentcodes-for-codedhours-http-200-request.json

MA-with-differentcodes-for-codedhours-http-200-response.json

 

Request for a single associate with same Amount and different Memo code value.

SA-same-amount-diff-memocode-http-200-request.json

SA-same-amount-diff-memocode-http-200-response.json

 

Request for a single Associate with different Amount and same Memo code value.

SA-diff-amount-same-memocode-http-200-request.json

SA-diff-amount-same-memocode-http-200-response.json

 

Request for a single associate with Temporary Cost Number and code value.

SA-Temporary-CostNUmber-and-codeValue-http-200-request.json

SA-Temporary-CostNUmber-and-codeValue-http-200-response.json

 

Request for a single associate with Temporary Cost Number and code value, which is in the Inactive status.

SA-Temp-Dept-Codevalue-Inactive-status-http-200-request.json

SA-Temp-Dept-Codevalue-Inactive-status-http-200-response.json

 

Request for a single associate with the following:

  • Multiple Pay Number
  • Temporary Cost Number
  • codeValue is 001000
  • AllocationID:2

SA-Multiple-payNumber-with-Tempcost-http-200-request.json

SA-Multiple-payNumber-with-Tempcost-http-200-response.json

 

Request for multiple associates with the following:

  • Multiple Pay Number
  • Temporary Cost Number
  • codeValue
  • allocationID

MA-Multiple-payNumber-with-Temp-costNumber-http-200-request.json

MA-Multiple-payNumber-with-Temp-costNumber-http-200-response.json

 

Request for single associate with the following:

  • Temporary Department
  • codeValue

SA-Temporary-DreptNumber-and-codeValue-http-200-request.json

SA-Temporary-DreptNumber-and-codeValue-http-200-response.json

 

Request for a single associate with the following:

  • Temporary Department Number
  • codeValue, which is in the Inactive status

SA-Temp-Dept-Codevalue-Inactive-status-http-200-request.json

SA-Temp-Dept-Codevalue-Inactive-status-http-200-response.json

 

Request for a single associate with the following:

  • Multiple Pay Number
  • Department Number
  • codeValue is 001000
  • allocationID:3

SA-Temporary-DreptNumber-and-codeValue-http-200-request.json

SA-Temporary-DreptNumber-and-codeValue-http-200-response.json

 

Request for multiple associates with the following:

  • Multiple Pay Number
  • Temporary Department Number
  • codeValue
  • allocationID is 3

MA-Multiple-payNumber-with-Temp-DeptNumber-http-200-request.js

MA-Multiple-payNumber-with-Temp-DeptNumber-http-200-response.json

 

Request for a single associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic and Manual] for costNumber, and:

  • Allocations are in employment profile > allocations with department and percentage
  • codeValue=3 and 4

SA-Multiple-payNum-Allocation-CostNum-Automatic&Manual-CodeValue-3&4-http-200-request.json

SA-Multiple-payNum-Allocation-CostNum-Automatic&Manual-CodeValue-3&4-http-200-response.json

 

Request for a single associate with Single Pay Number and Allocation Number when Company set up options are enable[Automatic and Manual] for costNumber, and:
 

  • Allocations are in employment profile-> allocations
  • codeValue=3

SA-Allocation-CostNum-Automatic&Manual-CodeValue-3-http-200-request.json

SA-Allocation-CostNum-Automatic&Manual-CodeValue-3-http-200-response.json

 

Request for a single associate and Single Pay Number with Allocation Number when Company set up options are set to enable[Automatic and Manual] for costNumber, and:
 

  • Allocations are in employment profile > allocations
  • codeValue=1

SA-Allocation-CostNum-Automatic&Manual-CodeValue-1-http-400-request.json

SA-Allocation-CostNum-Automatic&Manual-CodeValue-1-http-400-response.json

 

Request for a Single AssociateSingle Pay Number, and Allocation Number when Company set up options are set to enable[Manual] for costNumber, and:
 

  • Allocations are in employment profile > allocations
  • codeValue=4

SA-Allocation-CostNum-Manual-CodeValue-5-http-200-request.json

SA-Allocation-CostNum-Manual-CodeValue-5-http-200-response.json

 

Request for a Single AssociateSingle Pay Number, and Allocation Number when Company set up options are set to enable[Manual] for costNumber, and:
 

  • Allocations are in employment profile > allocations
  • codeValue=10

SA-Allocation-CostNum-Manual-CodeValue-10-http-200-request.json

SA-Allocation-CostNum-Manual-CodeValue-10-http-200-response.json

 

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Manual] for costNumber, and:
 

  • Allocations are in employment profile > allocations with department and percentage
  • codeValue=5 and 10

SA-Multi-payNumber-Allocation-CostNum-Manual-CodeValue-5&10-http-200-request.json

SA-Multi-payNumber-Allocation-CostNum-Manual-CodeValue-5&10-http-200-response.json

 

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic] for costNumber, and:

  • Allocations are in employment profile > allocations
  • codeValue=1 and 1

SA-Multi-payNumber-Allocation-CostNum-Automatic-CodeValue-1&1-http-200-request.json

SA-Multi-payNumber-Allocation-CostNum-Automatic-CodeValue-1&1-http-200-response.json

 

Request for a Single Associate and Single Pay Number with Allocation Number when Company set up options are set to enable[ Automatic ] for costNumber and codeValue="1".

https://github.com/adpllc/marketplace-sample-payloads/blob/master/wfn/payroll/pay-data-input/pay-data-input.modify/success/SA-Allocation-CostNum-Automatic-CodeValue-1-http-200-request.json]

https://github.com/adpllc/marketplace-sample-payloads/blob/master/wfn/payroll/pay-data-input/pay-data-input.modify/success/SA-Allocation-CostNum-Automatic-CodeValue-1-http-200-response.json]

 

Request for a single associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic and Manual] for costNumber, and:

  • Allocations are in employment profile > allocations with department and percentage
  • codeValue=3 and 4

SA-Multiple-payNum-Allocation-CostNum-Automatic&Manual-CodeValue-3&4-http-200-request.json

SA-Multiple-payNum-Allocation-CostNum-Automatic&Manual-CodeValue-3&4-http-200-response.json

 

Request for a single associate with Single Pay Number and Allocation Number when Company set up options are enable[Automatic and Manual] for costNumber, and:
 

  • Allocations are in employment profile-> allocations
  • codeValue=3

SA-Allocation-CostNum-Automatic&Manual-CodeValue-3-http-200-request.json

SA-Allocation-CostNum-Automatic&Manual-CodeValue-3-http-200-response.json

 

Request for a Single Associate and Multiple Pay Number with Allocation Number when Company set up options are set to enable[Automatic] for DepartmentNumber and codeValue="1" and "1".

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-1&1-http-200-request.json

SA-Multi-payNumber-Allocation-DeptNum-Automatic-CodeValue-1&1-http-200-response.json

 

Request for a Single Associate with Allocation Number when Company set up options are set to enable[Automatic and Manual] for DepartmentNumber and codeValue="1".

SA-Allocation-DeptNum-Automatic&Manual-CodeValue-1-http-200-re

SA-Allocation-DeptNum-Automatic&Manual-CodeValue-1-http-200-response.json

 

Request for a Single Associate with Allocation Number when Company set up options are set to enable[Manual] for DepartmentNumber, and:

  • Allocations are in employment profile > allocations
  • codeValue="10"

SA-Allocation-DeptNum-Manual-CodeValue-10-http-200-request.json

SA-Allocation-DeptNum-Manual-CodeValue-10-http-200-response.json

 

Request for a Single Associate with Allocation Number when Company set up options are set up to enable[Automatic and Manual] for DepartmentNumber, and:

  • Allocations are in employment profile > allocations
  • codeValue="3"

SA-Allocation-DeptNum-Automatic&Manual-CodeValue-3-http-400-request.json

SA-Allocation-DeptNum-Automatic&Manual-CodeValue-3-http-400-response.json

 

 Add paydata with Rate code

Add-Paydata-batch-with-ratecode-http-200-request.json

Add-Paydata-batch-with-ratecode-http-200-response.json