Pay Input - ADP Data Target Requirement
DataBlend supports the standard API calls to create Pay Input leveraging the ADP NextGen SDK. In addition, custom fields can be added for data that is unique to your business practices. All column names are case-insensitive.
The Pay Input object type integrates with the policy types listed in https://developers.adp.com/apis/api-explorer/hcm-offrg-wfn.next.gen/hcm-offrg-wfn.next.gen-payroll-pay-data-input-v1-pay-data-input.
ADP uses the same field name for different policy types. DataBlend's naming convention differentiates which policy type the field is used for in the query. For example, the policy type Earnings and Deduction each have a rateValue field. DataBlend's naming convention for the Earnings rateValue is rate and DataBlend's naming convention for the Deduction rateValue is deductionrate. See the image below for other ADP fields that are used in multiple policy types and what DataBlend's naming convention for each are.
Required Fields
| DataBlend Query Object (SDK) | ADP Object (API) | Required | Notes |
| payrollgroupcode | codeValue | Yes | ADP payroll group code (e.g. AX3S). |
| payrollprocessingjobid | payrollProcessingJobID | Yes | Batch name of the ADP payroll processing job. See image below for where to find payrollprocessingjobid in the UI. |
| paydate | payDate | Optional per ADP. Leave blank if not required. | |
| associateoid | associateOID | Yes | Worker's ADP Associate OID. |
| paynumber | payNumber | Yes | Pay number within the run. |
| payrollfilenumber | payrollFileNumber | Yes | Payroll file number associated with the worker profile. |
| modificationtypecode | modificationTypeCode | Yes | e.g. Add, Replace. |
To find payrollprocessingjobid:
Earnings
| DataBlend Query Object (SDK) | ADP Object (API) | Required | Notes |
| earningcode | codeValue | Conditional | Triggers an earning row. Required if earning data is present. Options can be found in the pay input metadata collector. |
| numberofhours | numberOfHours | ||
| earningsamount | amountValue | ||
| earningsamount_currencycode | currencyCode | e.g. USD. | |
| workweekstartdate | startDate | Format: YYYY-MM-DD. | |
| ratecode | codeValue | ||
| rate | rateValue | ||
| rate_basemultipliervalue | baseMultiplierValue | NextGen-only field.NextGen | |
| allocationid | allocationID | ||
| allocationtypecode | codeValue | ||
| cancelautomaticpayindicator | cancelAutomaticPayIndicator | Boolean: true / false. |
Deduction
| DataBlend Query Object (SDK) | ADP Object (API) | Required | Notes |
| deductioncode | codeValue | Conditional | Triggers a deduction row. Required if deduction data is present. |
| deductionrate | rateValue |
Memo
| DataBlend Query Object (SDK) | ADP Object (API) | Required | Notes |
| memocode | codeValue | Conditional | Triggers a memo row. Required if memo data is present. |
| memoamount | amountValue | ||
| memoamount_currencycode | currencyCode | e.g. USD. Not currently mapped; reserved for future use. |
Reimbursement
| DataBlend Query Object (SDK) | ADP Object (API) | Required | Notes |
| reimbursementcode | codeValue | Conditional | Triggers a reimbursement row. Required if reimbursement data is present. NextGen |
| reimbursementamount | amountValue | ||
| reimbursementamount_currencycode | currencyCode | e.g. USD. |
Reportable Earnings & Benefits
| DataBlend Query Object (SDK) | ADP Object (API) | Required | Notes |
| reportableearningandbenefitcode | codeValue | Conditional | Triggers a reportable earnings & benefits row. Required if reportable data is present. |
| reportableearningandbenefitamount | amountValue | ||
| reportableearningandbenefitamount_currencycode | currencyCode | e.g. USD. |
Tax
| DataBlend Query Object (SDK) | ADP Object (API) | Required | Notes |
| taxcyclecode | codeValue | Conditional | Triggers a tax row. Required if tax data is present. |
More questions about API requirements? Please visit the ADP API site: https://developers.adp.com/guides/api-guides/payroll-data-input-payroll-worksheet-api-guide-for-adp-workforce-now-next-gen