Applicant Onboard V2 API Guide for ADP Workforce Now
 

Applicant Onboard API Guide V1 for ADP Workforce Now (Deprecating. Will no longer be supported by end of 2021)

Applicant Onboard Event APIs post an applicant onto ADP Workforce Now using a template for an In-Progress Hire and complete an In-Progress Hire into a Completed Hire. This enables a practitioner to log into ADP Workforce Now and supplement the new hire data to complete the hiring process.  

March 2021

• Added Note points for payrollFileNumber, WorkerID and position fields under Chapter 3 > Data Dictionary section.

Feb 2021

• Added a limitation under chapter 5 "WFNINDIATW-32357 - There is no validation that happens when assigning a non manager to an employee via the Applicant Onboard V2 API for WFN".

January 2021

• Updated Step 2 in Under "Sequence of Interactions" section in Chapter 3-Use Case: Adding a Worker's Additional Remunerations/Earnings
• Updated Step 2 in Under "Sequence of Interactions" section in Chapter 4-Use Case: Updating a Worker's Additional Remunerations/Earnings

Deduction Instruction API Guide for ADP Workforce Now

Deduction Instruction APIs support the following:

• Starting, stopping, or changing the payroll deduction setup for a worker.
• Viewing all deduction instructions for a worker.
• Retrieving and sending employee deductions commonly used by Benefits Solutions.
• Capturing taxable employer contributions.

March 2021

• Removed a limitation under chapter 8,  "WFNWATERVI-49045: Worker Payroll Instruction GET call is missing the position status for the employee"

Feb 2021

• Added a limitation under chapter 8,  "WFNWATERVI-49045: Worker Payroll Instruction GET call is missing the position status for the employee"

Direct Deposit API Guide for ADP Workforce Now

Direct Deposit APIs support, retrieve, add, update, and delete an employee's Direct Deposit configuration.

Payroll Data Input API Guide for ADP Workforce Now

Payroll Data Input APIs import a specific Pay Data batch to ADP Workforce Now.

NA

February 2021

• Updated details about old payroll requests in Turbo (Calling Historical Data section)
• Updated information about FLSA config Tag.

January 2021

• Updated some recent changes in user guide new configuration tags added. Also included Canadian related configuration tags.
• Updated a few FAQs and some additional clarifications that were added recently on our internal Turbo User guide page.
• Added earnings section in payment summary part.
• Updated IAT samples (Included samples from RATE region instead of fit and dit regions)

Personal Contacts API Guide for ADP Workforce Now

Personal Contact APIs retrieve, add, update, and delete workers' personal emergency contacts.

March 2021

Added URI and sample response for Get meta under API Usage section in Chapter 2: Retrieving a Worker's Personal Contact Details

Talent Profile Languages API Guide for ADP Workforce Now

Talent Profile Certifications API Guide for ADP Workforce Now

Talent Profile Certifications APIs retrieve, add, update, and delete workers' certification data from their talent profile.

Talent Profile Skills and Competencies API Guide for ADP Workforce Now

The Talent Profile Skills and Competencies Application Programming Interfaces (APIs) support the management of an associate's skills, which can be used to track your employees' abilities to perform specific tasks. The skill is listed, along with:

• Information about when the skill was last used by the employee
• Experience level
• Proficiency
• Testing requirements

Talent Profile Licenses API Guide For ADP WorkForce Now

The Talent Profile Licenses Application Programming Interfaces (APIs) support the management of an employee's licenses. These can be used to track your employees' licenses, along with IDs, effective and expiration dates, and renewal requirements. You can also set up custom fields for license information, using Setup > Tools > Custom Fields in the ADP Workforce Now user interface (UI).
Talent Profile Licenses APIs are used to do the following:

• View all License details of a worker.
• Add, Update, and Remove Licenses for a worker.

Retrieving an Associate's Licenses-Support for WFN Next GEN

March 2021

• Added a Event notification information in Chapter 3- Use Case: Synchronizing Work assignment details Using Notifications
• Updated the description in known issues and limitation in Chapter 4-Known Issues and Limitations

U.S. State Tax Withholding API Guide for ADP Workforce Now

U.S. State Tax Withholding APIs support, retrieve, and update an employee's U.S. State Tax Withholding Election.

March 2021

• Added a column "API Supported for WFN Next Gen" under API usage section for all APIs in Chapter 4: Worker Management V3 codeLists

February 2021

• Added an important note point under Chapter 4: Worker Management V3 codeLists
• Updated API URI for Canada Tax Province or Worked in Province Code API under Chapter 2: Payroll Management Code Lists

Validation Tables Cost Number API Guide for ADP WorkForce Now

Validation Tables Business Unit API Guide for ADP WorkForce Now

Validation Tables Departments API Guide for ADP WorkForce Now

Validation Tables Location API Guide for ADP WorkForce Now

Validation Tables Job Title API Guide for ADP WorkForce Now

Worker Hire Event API Guide for ADP Workforce Now Deprecating. Will no longer be supported by end of 2021.

Applicant Onboard V2 API Guide for ADP Workforce Now should be used instead

Worker Hire APIs post a new hire into ADP Workforce Now.

Worker Management APIs retrieve and update workers' business and personal information. They are commonly used to synchronize worker data between ADP Workforce Now and other information systems.

Febraury 2021.

• Added the sample request and response payloads for the below POST APIs in Chapter 4 - Use Case: Updating Data for a Worker.  and also for events in Chapter 5 - Use Case: Synchronizing a Worker Using Event Notifications

          Birth-name.change
          Additionalremuneration.add (and .change and .remove)
          Base-remuneration.change
          Standard-hours.change
          Personalcommunication.email.remove
          Businesscommunication.email.remove
          Businesscommunication.pager.add (and .change and .remove)
          Highest-level-education.change
          Race.change
          military-classification.change
          military-status.change
          government-id.add

• Added a section "Supported $filter query parameters" in Chapter 2 - Retrieving Full Worker Information.

March 2021

• Added request and response payloads for person custom fields under Chapter 4 > People > Personal Information > Personal Profile > Custom Fields.
• Added  response payloads for [Birth Date,Gender,Marital Status] and updated column "API Supported for NextGen" under People > Personal Information > Personal Profile > Demographics  in Chapter 5 - Use Case: Synchronizing a Worker Using Event Notifications
• Added response payloads for [Original Hire Date, Deceased, retired ] and updated column "API Supported for NextGen" under People > Employment > Employment Profile > Status in Chapter 5 - Use Case: Synchronizing a Worker Using Event Notifications
• Added response payload for [Place on leave ] and updated column "API Supported for NextGen" under Process > HR in Chapter 5 - Use Case: Synchronizing a Worker Using Event Notifications
• Added response payload for [FLSA ] and updated column "API Supported for NextGen" under People > Employment > Employment Profile > Position in Chapter 5 - Use Case: Synchronizing a Worker Using Event Notifications

1. Below Event notifications support for WFN Next GEN

• worker.customField.date.change
• worker.customField.amount.change
• worker.customField.code.change
• worker.customField.indicator.change
• worker.customField.percentage.change
• worker.customField.number.change
• worker.customField.percentage.change.
• worker.customField.string.change
• worker.customField.telephone.change
• worker.workAssignment.standardHours.change
• worker.workAssignment.workerType.change
• worker.reportsTo.modify
• worker.workAssignment.baseRemuneration.change
• worker.race.change
• worker.workAssignment.homeWorkLocation.change
• worker.workAssignment.additionalRemuneration.add
• worker.workAssignment.additionalRemuneration.change
• worker.workAssignment.additionalRemuneration.remove
• worker.workAssignment.baseRemuneration.change

2. Employee Photo change support for WFN and WFN Next Gen.

Worker Termination API Guide for ADP Workforce Now

Worker Termination APIs support the termination of a worker in ADP Workforce Now.

NA

The Worker Rehire API Hires an employee who has previously worked for your organization.

Team Time Cards API Guide for ADP Workforce Now

Team Time Card APIs retrieve the time cards of all members of a team.

NA

Time Entries Modify TLM API Guide for ADP Workforce Now

Time Entries Modify TLM APIs are used to upload time entry data for employee positions.

NA

Time Off Balances API Guide for ADP Workforce Now

Time Off Balances APIs retrieve a worker's time-off balances.

Time Off Request API Guide for ADP Workforce Now

Time Off Request APIs support retrieval of time-off requests for authorized employees.

March 2021

• Updated the Important note under Chapter 3 :Time Off Request Summaries
• Updated Issue1 under Known Issues and Limitations section.

• POST API for creating Time off request.
• GET API for Time off Request configuration.
• Supports event notification for WFN Next Gen

Job Application v2 API supports the following:

• Retrieval of job applications for a requisition
• Updating the background screen status of a job application
• Retrieval of job application change details 

Job Applicant External Screening Assessment API supports:

• Publish assessment packages
• Initiate assessments
• Update assessment results

Beneficiaries API Guide for ADP Workforce Now

Beneficiaries APIs get the beneficiary information added for an associate object ID (AOID).
The beneficiary can be a person, dependent, or organization.

NA

Dependents API Guide for ADP Workforce Now

Dependent APIs get dependent information added for an associate ID.
It works to get all the dependents added for an employee. It does not facilitate getting details of an individual dependent.

The Benefit Spending Account Plan API allows external benefit providers to create spending account plans in ADP Workforce Now. This API currently supports the creation of the following:

• Health Savings Account (HSA)
• Parking
• Transit
• Medical Flexible Spending Account (FSA) plans
• Limited Purpose FSA plans
• Dependent Care FSA plans

Plans created using this API are in the in-progress state.

NA

The Benefit Spending Account Enrollments API provides external benefit providers with employee Benefits enrollment data. The API provides enrollment data of only those employees who are enrolled in the following plans provided by external benefit providers:

• Parking
• Transit
• Medical FSA plans
• Limited Purpose FSA plans
• Dependent Care FSA plans

This API also provides worker demographics, Employee, dependents and Position Information of an employee along with the Benefit enrollment data for an employee.

NA