Guides

TOPIC
authorization-process-end-user-apps
Understanding the End-User App Authorization Process

End-user applications typically require an individual to log in using their ADP credentials. These applications must obtain authorization to gain access to the end-user's data. This article describes the authorization process with respect to ADP's security model.

View
UI/long arrow right
common-api-operations-for-run-powered-by-adp
Common API Operations for RUN Powered by ADP

This guide describes common API design pattern for RUN Powered by ADP APIs.

View
UI/long arrow right
regular-pay-api-guide-for-adp-workforce-now
Regular Pay API Guide for ADP Workforce Now

Used to change the base remuneration details of an employee.

View
UI/long arrow right
payroll-data-input-api--guide-for-adp-workforce-now
Payroll Data Input API Guide for ADP Workforce Now

Enables users to create a Pay Data batch for a payroll cycle.

View
UI/long arrow right
partner-development-learning-guide
ADP Marketplace Partner Development Learning Guide

Provides a high-level overview of the ADP Marketplace platform, applications, APIs, and integrations for developers and product owners, so you can learn how to plan ADP Marketplace development projects.

View
UI/long arrow right
pay-data-input-api-guide-for-vantage-hcm
Payroll Data Input API Guide for ADP Vantage HCM

Enables you to build a data connector application for clients to transmit data sourced in your application to a specific Pay Data batch in ADP Vantage HCM.

View
UI/long arrow right
payroll-output-api-guide-turbo-api-for-midsized-to-enterprise-businesses
Payroll Output API Guide (Turbo API) for Midsized to Enterprise Businesses

Provides the results of a payroll run in the JSON format and provides company level payroll details, company totals, associate payment summaries, and payment distribution details.

View
UI/long arrow right
taxable-benefits-api-guide-for-adp-workforce-now
Taxable/Reportable Benefits API Guide for ADP Workforce Now

Used to retrieve, add, and change an employee's taxable benefits details.

View
UI/long arrow right
all-you-need-to-know-about-processing-notification-messages-in-adp-workforce-now
All You Need to Know About Processing Notification Messages for ADP Workforce Now

Provides the data dictionary for resources in notification messages generated by ADP Workforce Now.

View
UI/long arrow right
about-this-api
Leave Request API Guide for ADP Workforce Now

Covers an employee's leave requests, changes, return and leave cancellations.

View
UI/long arrow right
talent-profile---awards-and-recognitions-api-guide-for-adp-workforce-now
Talent Profile Awards and Recognitions API Guide for ADP Workforce Now

Supports the management of an associate's awards and recognitions.

View
UI/long arrow right
talent-profile-languages-api-guide-for-adp-workforce-now
Talent Profile Languages API Guide for ADP Workforce Now

Covers the APIs which retrieve, add, update, and remove a worker's languages.

View
UI/long arrow right
us-local-tax-withholdings-api-guide-for-adp-workforce-now
U.S. Local Tax Withholdings API Guide for ADP Workforce Now

Enables users to add, change, or remove a worker's Local tax withholding information.

View
UI/long arrow right
adp-enterprise-hr-api-data-dictionary
ADP Enterprise HR API Data Dictionary for Release 5.04.07.07

Describes ADP Enterprise HR application field mapping to API payload properties.

View
UI/long arrow right
personal-contacts-api-guide-for-adp-workforce-now
Personal Contacts API Guide for ADP Workforce Now

Allows you to retrieve, add, update, and delete an associate's emergency contacts.

View
UI/long arrow right
time-and-labor-management-tlm-import-work-schedule-api-guide-for-adp-workforce-now
Time and Labor Management (TLM) Import Work Schedule API Guide for ADP Workforce Now

Used to upload employees' schedule entry data. This is data that comprises of an Employee Position's Schedule.

View
UI/long arrow right
beneficiaries-api-guide-for-adp-workforce-now
Beneficiaries API Guide for ADP Workforce Now

Gets the beneficiary information added for an associate ID. The beneficiary can be a person, dependent, or organization.

View
UI/long arrow right
worker-management-api-guide-for-run-powered-by-adp
Worker Management API Guide for RUN Powered by ADP

Supports the management of workers in an organization. The Worker Management API can be used to obtain a list of all an organization's workers and to get information about work assignments.

View
UI/long arrow right
job-applicant-external-screening-apis-assessment-apis-for-adp-workforce-now
Job Applicant External Screening APIs (Assessment APIs) Guide for ADP Workforce Now

Used to publish assessment packages, initiate assessments, and update assessment results.

View
UI/long arrow right
team-time-cards-api-guide-foradp-workforce-now
Team Time Cards API Guide forADP Workforce Now

Gets all the timecards for the members of a worker's team.

View
UI/long arrow right
Making-Your-First-API-Call-With-POSTMAN
Making your first API call with POSTMAN

This guide provides an overview of using Postman to make your first Application Programming Interface (API) call to ADP®. If you are already familiar with Postman then you can skip this document.

View
UI/long arrow right
additional-earnings-api-guide-for-adp-workforce-now
Additional Earnings API Guide for ADP Workforce Now

Used to add, update, or get an employee's additional remuneration details.

View
UI/long arrow right
deduction-instruction-guide-for-adp-workforce-now
Deduction Instruction API Guide for ADP Workforce Now

Used to start/stop/change a worker's payroll deduction, view a worker's deduction instructions, retrieve and send employee deductions to ADP, and capture taxable employer contributions.

View
UI/long arrow right
applicant-onboard-v2-api-guide-for-run-powered-by-adp
Applicant Onboard V2 API Guide for RUN Powered by ADP

Implemented to support onboarding a new employee or contractor.

View
UI/long arrow right
run-powered-by-adp-api-catalog
RUN Powered by ADP API Catalog

The ADP Marketplace API Catalog lists common Integration Use Cases supported by RUN Powered by ADP. It is used to help understand API availability and evaluate work effort for your use case.

View
UI/long arrow right
time-and-labor-management-tlm-work-schedule-day-api-guide-for-adp-workforce-now
Time and Labor Management (TLM) Work Schedule Day API Guide for ADP Workforce Now

Used to add, change, remove, copy, and read an employee's work schedule for a day.

View
UI/long arrow right
talent-profile---certifications-api-guide-for-adp-workforce-now
Talent Profile Certifications API Guide for ADP Workforce Now

Covers the APIs which retrieve, add, update, and remove certifications for a worker.

View
UI/long arrow right
talent-profile-membership-api-guide-for-adp-workforce-now
Talent Profile Membership API Guide for ADP Workforce Now

Supports the management of an associate's memberships.

View
UI/long arrow right
direct-deposit-api-guide-for-run-powered-by-adp
Direct Deposit API Guide for RUN Powered by ADP

Enables users to view, add, update, and remove employees' direct deposit setup.

View
UI/long arrow right
job-requisitions-api-guide-for-adp-workforce-now
Job Requisitions API Guide for ADP Workforce Now

Used to retrieve a specific job requisition or a list of all job requisitions the requester is authorized to view.

View
UI/long arrow right
time-off-request-api-guide-for-adp-workforce-now
Time Off Request API Guide for ADP Workforce Now

Supports the viewing of time off requests (if an employee can make time off requests).

View
UI/long arrow right
dependents-api-guide-for-adp-workforce-now
Dependents API Guide for ADP Workforce Now

Gets dependent information added for an associate ID and works to get all the dependents added for an employee.

View
UI/long arrow right
work-assignment-api-guide-for-adp-workforce-now
Work Assignment API Guide for ADP Workforce Now

Updates the work assignments details such as a worker's Job Title and Job Function.

View
UI/long arrow right
job-applications-v2-api-guide-for-adp-workforce-now
Job Applications V2 API Guide for ADP Workforce Now

Used to retrieve details of a job application or a list of applications, along with the Job Applicant External Screening Status Change API, which is used to change the screening status of the job applicant.

View
UI/long arrow right
deduction-instructions-api-guide-for-run-powered-by-adp
Deduction Instructions API Guide for RUN Powered by ADP

Allows applications to retrieve, start, change, and stop deductions for an employee or contractor.

View
UI/long arrow right
us-state-tax-withholdings-guide-for-adp-workforce-now
U.S. State Tax Withholdings Guide for ADP Workforce Now

Enables users to add or change a worker's state tax withholding information.

View
UI/long arrow right
worker-termination-api-guide-for-adp-workforce-now
Worker Termination API Guide for ADP Workforce Now

Used to terminate a worker's work assignment.

View
UI/long arrow right
payroll-data-input-api-guide-fo-run-powered-by-adp
Payroll Data Input API Guide for RUN Powered by ADP

Enables users to create a pay data batch for a payroll cycle.

View
UI/long arrow right
benefit-spending-account-plan-api-guide-hropen-for-adp-workforce-now
Benefit Spending Account Enrollment API Guide (HROpen) for ADP Workforce Now

Provides external benefits providers with employee benefits enrollment data.

View
UI/long arrow right
validation-table-code-list-api-guide-for-adp-workforce-now
Validation Table Code List API Guide for ADP Workforce Now

Used to retrieve data defined in the Validation tables.

View
UI/long arrow right
deduction-api-guide-for-adp-vantage-hcm
Deduction API Guide for ADP Vantage HCM

Used to start/stop/change a worker's payroll deduction setup, view all deduction instructions for a worker, and retrieve/send employee deductions to ADP.

View
UI/long arrow right
time-and-labor-management-tlm-work-schedule-api-guide-for-adp-workforce-now
Time and Labor Management (TLM) Work Schedule API Guide for ADP Workforce Now

Used to add a work schedule for an employee. This data includes an Employee Positions schedule.

View
UI/long arrow right
applicant-onboard-api-v1-guide-for-run-powered-by-adp
Applicant Onboard API v1 Guide for RUN Powered by ADP

The Applicant Onboard API is implemented to support onboarding a new employee or contractor. A successful API call creates a new hire and a notification in RUN Powered by ADP, enabling a practitioner to login and supplement the new hire data, launching the Employee Setup Wizard to complete the hire.

View
UI/long arrow right
payroll-output-api-guide-for-run-powered-by-adp
Payroll Output API Guide for RUN Powered by ADP

Retrieves the output of a payroll run.

View
UI/long arrow right
direct-deposit-api-guide-for-adp-workforce-now
Direct Deposit API Guide for ADP Workforce Now

Allows your application to manage an employee's Direct Deposit setup.

View
UI/long arrow right
adp-vantage-hcm-data-dictionary-for-release-191
ADP Vantage HCM Data Dictionary

Helps Developers, tasked with implementing solutions using ADP’s APIs, to understand how to use and work with ADP Vantage HCM APIs.

View
UI/long arrow right
benefit-spending-account-plan-api-guide-hropen-for-adp-workforce-now-1
Benefit Spending Account Plan API Guide (HROpen) for ADP Workforce Now

Allows external benefit providers to create and update spending account plans in ADP Workforce Now.

View
UI/long arrow right
adp-recruiting-management-api-data-dictionary
ADP Recruiting Management API Data Dictionary

Helps Developers, tasked with implementing solutions using ADP’s APIs, to understand how to use and work with ADP Recruiting Management APIs.

View
UI/long arrow right
us-federal-tax-profile-api-guide-for-run-powered-by-adp
U.S. Federal Tax Profile API Guide for RUN Powered by ADP

Enables users to add or change a worker's Federal Tax Profile.

View
UI/long arrow right
worker-management-api-guide-for-adp-workforce-now
Worker Management API Guide for ADP Workforce Now

Describes how your application can access and manage information about workers in the ADP Workforce Now application.

View
UI/long arrow right
processing-notification-messages-for-run
All You Need to Know About Processing Notification Messages for RUN Powered by ADP

Provides the data dictionary for resources in notification messages generated by RUN Powered by ADP.

View
UI/long arrow right
auth-process-data-connector-apps
Understanding the Data Connector App Authorization Process

Data Connector applications connect to and consume data without an end-user's involvement. Each organization that subscribes to the app is issued a unique set of credentials by ADP. The app then uses these credentials within the OAuth 2.0 authorization framework to get permission to access ADP data for the organization.

View
UI/long arrow right
using-consent-manager
Using Consent Manager to Control Access to Your Data

The Consent Manager application provides an easy way to control which Marketplace apps can access your company's ADP data

View
UI/long arrow right
talent-profile-educational-degree-api-guide-for-adp-workforce-now
Talent Profile Educational Degree API Guide for ADP Workforce Now

Supports the management of an associate's educational degrees.

View
UI/long arrow right
corporate-groups-api-guide-for-adp-workforce-now
Corporate Groups API Guide for ADP Workforce Now

Used to change the corporate group details of an employee.

View
UI/long arrow right
time-off-balances-api-guide-for-adp-workforce-now
Time Off Balances API Guide for ADP Workforce Now

Enables viewing of employees' time off balances.

View
UI/long arrow right
worker-hire-event-api-guide-for-adp-workforce-now
Worker Hire Event API Guide for ADP Workforce Now

Posts a new hire into ADP Workforce Now.

View
UI/long arrow right
adp-workforce-now-api-catalog
Marketplace API Catalog for ADP Workforce Now

Lists common integration use cases supported by ADP Workforce Now.

View
UI/long arrow right
applicant-onboard-v2-api-guide-for-workforce-now
Applicant Onboard V2 API Guide for ADP Workforce Now

Posts an applicant as an in-progress and completed hire into ADP Workforce Now.

View
UI/long arrow right
57731108243b3abd9311b9695b891ed987a09d70
Termination API Guide - ADP Workforce Nowpdf

The worker assignment Application Programming Interfaces (API's) are to terminate a worker from a work assignment.

View
ec33b7cfa8701ef4aae103abaa559a65a9a5219f
US Federal Tax Withholding API Guide - ADP Workforce Nowpdf

APIs to retrieve and update the worker's U.S. Federal Tax Withholdings.

View
1f213a50bfe13cc3de2e06d5d96ccfc79adce828
The Wisely Pay by ADP Card API Guidepdf

The Wisely Pay by ADP card Application Programming Interfaces (APIs) includes a library of APIs for theWisely Pay by ADP card. This guide helps you create your first Wisely Pay by ADP card management application in your environment.

View
96de2c0e67cf643656d549ef8514d24fd23f2668
Work Schedule Day API Guide - ADP Workforce Nowpdf

The TLM Work Schedule Day API is used to add a work schedule for a day and for an employee. This is also data that includes an Employee Position's Schedule.

View
c4f02b680b11c61b151fa5ead43d2e5d7baefc2a
Applicant Onboard API Guide - ADP Vantage HCMpdf

ADP Vantage HCM® allows client practitioners to add new employees without specifying any template. The Applicant Onboard API posts an employee applicant into ADP Vantage HCM.

View
0b16847be8e6f53912402d7a3bed5f73cc1f2d08
Import Work Schedule API Guide - Workforce Nowpdf

The TImport Work Schedule API is used to upload schedule entry data for Employees. This is data that comprises an Employee Position's Schedule.

View
82f633cbebcb730a22c4973082ed29542ed3bebc
Applicant Onboard API Guide - ADP Workforce Nowpdf

ADP Workforce Now® (ADP WFN) allows client practitioners to add new employees using the New Hire Template. The Applicant Onboard API posts an applicant into ADP WFN using a template.

View
f6ecd4e7bb3b56d2a1a3319a808a2b47510a5455
Team Time Cards API Guide - ADP Workforce Nowpdf

The Team Time Cards Application Programming Interface (API) retrieval of all the timecards for the members of a worker's team.

View
7b3f7a7f6429034cad9954627d5d5390e0c0cd02
Work Assignment API Guide - ADP Workforce Nowpdf

Work Assignment API updates the work assignments details such as a worker’s Job Title and Job Function.

View
6acb1d964e5e6cf55e06357b015157a2b033b589
Deduction Instruction API Guide - ADP Vantage HCMpdf

The Deduction Instruction API allows your application to manage employee's deduction setup, such as start, stop or change deductions.

View
b05ffb8337394710458c4b71c79a15774ee3d8e6
U.S. Federal Tax Withholding API Guide for ADP Vantage HCMpdf

The U.S. Federal Tax Withholding API enables users to add or change a worker’s tax withholding information.

View
d8e4cc0c492826652d7c5a1b078f894513086856
U.S. State Tax Profile API Guide - RUN Powered by ADPpdf

This guide describes United States (U.S.) State Tax Profile API and enable users to view, add, or change a worker's State Tax Profile.

View
e20ff7eee87c60506c71b40d50cc89546eb7b0c6
Beneficiaries API Guide - ADP Workforce Nowpdf

This guide will help you understand how to retrieve Beneficiaries of a worker in ADP Workforce Now.

View
9430c2b05c3ccb126903c2338139f2fab75947a7
ADP MasterTax API Guidepdf

The MasterTax File Import Application Programming Interface (API) allows users to import data files directly from their payroll system without user intervention. Use this guide to consume this API.

View
80b6db78a7294b307f87742a186c686244a8cbb6
U.S. State Tax Withholding API Guide for ADP Workforce Nowpdf

Allows applications to retrieve, add or change a worker's state tax withholding configuration.

View
03181eb5019d9a1c40a9631a0f04586184a4bcc2
Worker Hire API Guide - ADP Workforce Nowpdf

The Worker Hire Event API posts a new hire into ADP Workforce Now® and generate a new employee record.

View
bb83b7832f649e294b1483b8acaa66a67f4adef1
Work Schedule API Guide for ADP Workforce Now Essential Timepdf

Work Schedule API is used to add a work schedule for an employee.

View
12ba92c59f957870f34b48903cbf0de15a61042d
Time Entries Modify - ADP Time Labor Managementpdf

The Time Entries Modify TLM Application Programming Interface (API) is used to upload time entry data for employee positions

View
2c7ea32aae40fa510bb2c08751314e66ceb579fc
Partner Guidepdf

This guide describes the process of becoming an ADP Marketplace partner. It also provides an overview of Marketplace Security review process.

View
7128764b129aea27a7d738586c71091f9ff689cf
Direct Deposit API Guide for ADP Vantage HCMpdf

The Direct Deposit API allows your application to retrieve, update, insert and delete am employee's direct deposit setup.

View