ADP Workforce Now
API integration

list_all_adp_workforce_now_worker_demographics

List all worker demographics in ADP Workforce Now that the requester is authorized to view. Returns the workers collection with each record's associateOID, workerID, person (legalName), businessCommunication, and customFieldGroup.

adp_workforce_now_worker_demographics_get_meta

Get the Worker Demographic meta for ADP Workforce Now. Returns the meta envelope whose queryCriteria entries list the supported OData query options, including itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_workers_add_government_id

Add a government ID for a worker in ADP Workforce Now. Submits a worker.governmentID.add event and returns the confirmed event envelope (events). Required: events (carrying the event data with the worker and government ID details).

adp_workforce_now_workers_change_government_id

Change a worker's government ID in ADP Workforce Now. Submits a worker.governmentID.change event and returns the confirmed event envelope (events). Required: events (carrying the event data with the worker and government ID details).

list_all_adp_workforce_now_workers

List all workers in ADP Workforce Now that the requester is authorized to view. Returns the workers collection with each worker's associateOID, workerID (idValue), person.legalName, businessCommunication, and customFieldGroup. Supports OData $filter, $select, $top, $skip, and asOfDate.

adp_workforce_now_workers_get_meta

Get the metadata for ADP Workforce Now's workers endpoint, describing the OData query options and worker resource paths that can be used on the collection. Returns: events.

adp_workforce_now_workers_get_rehire_meta

Get the event metadata for ADP Workforce Now's worker rehire event, used when hiring an employee who has previously worked for the organization. Returns: events.

adp_workforce_now_workers_rehire

Rehire an employee who has previously worked for your organization in adpworkforcenow via the worker.rehire event. Returns the event confirmation payload, whose fields follow the Worker Rehire event schema exposed by the worker.rehire meta endpoint. Use the applicant onboard APIs instead for first-time hires.

adp_workforce_now_data_collection_entries_get_event

Get a data collection entries process event instance from ADP Workforce Now by event id. Returns the event instance envelope: an events array whose entries carry eventNameCode (codeValue, shortName), data.eventContext, and transform. Required: data_collection_entries.proces_id.

adp_workforce_now_data_collection_entries_process

Process a data collection entries event instance from one to many data collection terminals (e.g. time clocks) in ADP Workforce Now. Returns the processed event instance envelope: an events array whose entries carry eventNameCode (codeValue, shortName), data.eventContext, and transform.

adp_workforce_now_labor_charge_codes_get_meta

Get the Labor Allocation Code Types configured for a company in ADP Workforce Now. Returns the query-option definition descriptors with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_labor_charge_codes_get_upload_status

Get the status of a previous labor charge code import in ADP Workforce Now. Returns the confirm message for the upload request (payload shape undocumented). Required: request_id.

adp_workforce_now_labor_charge_codes_upload

Upload (import) labor charge code values to ADP Workforce Now. Returns the confirmation for the submitted import request; use get_upload_status to retrieve the outcome. Each laborAllocationCodes entry sets _modificationTypeCode to added, changed, or removed. Required: laborAllocationCodes.

create_a_adp_workforce_now_schedule_entry_upload

Upload work schedule entries for multiple employees to ADP Workforce Now via the TLM Import Work Schedule API. Returns: request_id. Requires a JSON payload of the schedule entry data to import.

adp_workforce_now_schedule_entry_uploads_get_status

Get the status of a schedule entry import previously submitted to ADP Workforce Now. Returns: request_id, status. Required: request_id.

list_all_adp_workforce_now_team_time_cards

List the time cards for all members of a worker's team in adpworkforcenow, identified by the worker's Associate OID. Returns each time card's id, dayEntries, and time-system-specific attributes (day entries included when expanded). Required: aoid.

adp_workforce_now_time_entries_modify

Modify a set of ADP Workforce Now time entries by uploading time entry event data for employee positions. Returns 202 Accepted with Location and Retry-After headers for polling import and timecard posting status via meta.resourceSetID. Required: workAssignmentID (Entry ID), plus AOID and PFID in the event payload. Allow at least 30 seconds between bulk upload requests.

adp_workforce_now_time_off_balances_get_meta

Retrieve the event metadata for the time-off-balances.modify event in ADP Workforce Now. Returns meta entries with itemID, queryOptionCode, queryOptionTypeCode, and the supported resourcePaths.

adp_workforce_now_time_off_balances_list_balances_v_2

List a worker's time off balances and entries in ADP Workforce Now, as of today per the Time system of record by default. Returns: balances, entries. Required: aoid.

adp_workforce_now_time_off_balances_list_configurations

List the paid time off configurations for a target associate in ADP Workforce Now; the returned set may be constrained by the requestor's authorization (e.g. manager). Returns: configurations. Required: aoid.

adp_workforce_now_time_off_balances_modify

Modify a set of time off balances for an individual in ADP Workforce Now by submitting a time-off-balances.modify event instance. Returns the processed events array. Required: events.

adp_workforce_now_time_off_requests_cancel

Cancel an existing paid time off request in ADP Workforce Now. Returns: id. Required: aoid, request_id.

create_a_adp_workforce_now_time_off_request

Create a paid time off request in ADP Workforce Now. The request is managed by the Time system and is complete once successfully created; its status can be viewed in the list of paid time off details. Returns: id. Required: aoid. The JSON body follows ADP's Time Off Request schema.

adp_workforce_now_time_off_requests_get_meta

Get API metadata for the worker time off request summaries endpoint in ADP Workforce Now, including the supported OData query options. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. Required: aoid.

list_all_adp_workforce_now_time_off_requests

List a worker's time off request summaries in ADP Workforce Now, returning only the requests the requester is authorized to view. Returns: id. Required: aoid.

adp_workforce_now_time_off_requests_list_details

List a worker's detailed time off requests in ADP Workforce Now for the associate identified by aoid, returning only requests the requestor is authorized to view. Returns: id. Required: aoid.

adp_workforce_now_time_off_requests_list_team_summaries

List time off request summaries for a manager's team in ADP Workforce Now. Returns the teamTimeOffRequestSummaries collection of summaries for all time off requests the requester is authorized to view. Required: aoid. Supports an OData $filter on request start and end dates.

adp_workforce_now_work_schedules_add_day

Add a new day with one or more shifts to an employee's work schedule in adpworkforcenow. Returns: scheduleEntryId. Shifts that fail are reported individually without blocking the others.

adp_workforce_now_work_schedules_change_day

Change a day within an employee's existing work schedule in adpworkforcenow. Returns: scheduleEntryId. Individual shift failures are reported in the response without blocking the remaining shifts.

adp_workforce_now_work_schedules_change_entry

Change a single shift entry within an employee's existing work schedule in adpworkforcenow. Returns: scheduleEntryId.

adp_workforce_now_work_schedules_change_schedule

Change an employee's existing work schedule in adpworkforcenow, which can span multiple days and shifts. Returns: scheduleEntryId.

adp_workforce_now_work_schedules_copy_day

Copy all schedule entries from one day to another day within an employee's existing work schedule in adpworkforcenow. Returns: scheduleEntryId.

adp_workforce_now_work_schedules_copy_schedule

Copy an existing employee's work schedule to another employee in ADP Workforce Now by posting the work-schedule.copy event. Returns an opaque event acknowledgement; no field-level response body is documented. Requires a JSON request payload (application/json).

adp_workforce_now_work_schedules_get_add_day_meta

Get the event metadata for the ADP Workforce Now add-schedule-day event (work-schedule-day.add). Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. No required parameters.

adp_workforce_now_work_schedules_get_change_day_meta

Get the event metadata for the ADP Workforce Now change-schedule-day event (work-schedule-day.change). Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. No required parameters.

adp_workforce_now_work_schedules_get_change_meta

Get the event metadata for the ADP Workforce Now change-employee-work-schedule event (work-schedule.change). Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. No required parameters.

adp_workforce_now_work_schedules_get_copy_day_meta

Get the event metadata for the ADP Workforce Now copy-schedule-day event (work-schedule-day.copy), which copies all entries from one day to another within an existing employee schedule. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. No required parameters.

adp_workforce_now_work_schedules_get_copy_meta

Get the event metadata for ADP Workforce Now's copy-employee-work-schedule event (work-schedule.copy). Returns an event metadata object with itemID, queryOptionCode, queryOptionTypeCode, and the resourcePaths the event's OData query options cover.

adp_workforce_now_work_schedules_get_remove_day_meta

Get the event metadata for ADP Workforce Now's remove-schedule-day event (work-schedule-day.remove). Returns an event metadata object with itemID, queryOptionCode, queryOptionTypeCode, and the resourcePaths the event's OData query options cover.

adp_workforce_now_work_schedules_get_remove_meta

Get the event metadata for ADP Workforce Now's remove-employee-work-schedule event (work-schedule.remove). Returns an event metadata object with itemID, queryOptionCode, queryOptionTypeCode, and the resourcePaths the event's OData query options cover.

list_all_adp_workforce_now_work_schedules

List the work schedules ADP Workforce Now holds for one associate. Returns each schedule's id and its upstream TLM attributes (associate, days, and shifts, where processed shifts carry a generated scheduleEntryId). Required: aoid.

adp_workforce_now_work_schedules_list_team

List all team work schedules the requester is authorized to view in ADP Workforce Now. Returns each schedule's id and its upstream TLM attributes (associate, days, and shifts, where processed shifts carry a generated scheduleEntryId). Deprecated upstream — prefer the per-worker list.

adp_workforce_now_work_schedules_remove_day

Remove a day from an existing employee work schedule in ADP Workforce Now. Returns an event confirmation response whose payload structure is defined upstream rather than enumerated in the ADP API Explorer source; the JSON request body supplies the schedule-day identification details.

adp_workforce_now_work_schedules_remove_schedule

Remove an existing employee work schedule in ADP Workforce Now. Returns an event confirmation response whose payload structure is defined upstream rather than enumerated in the ADP API Explorer source; the JSON request body supplies the schedule identification details.

adp_workforce_now_worker_communication_add_email

Add a worker's business email in ADP Workforce Now by POSTing the worker.business-communication.email.add event. Returns an acknowledgement containing status and timestamp. Body: status, timestamp.

adp_workforce_now_worker_communication_add_fax

Add a worker's business fax number in ADP Workforce Now by POSTing the worker.business-communication.fax.add event. Returns an acknowledgement containing status and timestamp. Body: status, timestamp.

adp_workforce_now_worker_communication_add_landline

Add a worker's business landline in ADP Workforce Now by POSTing the worker.business-communication.landline.add event. Returns an acknowledgement containing status and timestamp. Body: status, timestamp.

adp_workforce_now_worker_communication_add_mobile

Add a worker's business mobile telephone in ADP Workforce Now by POSTing the worker.business-communication.mobile.add event. Returns an acknowledgement containing status and timestamp. Body: status, timestamp.

adp_workforce_now_worker_communication_add_pager

Add a worker's business pager number in ADP Workforce Now by POSTing the worker.business-communication.pager.add event. Returns an acknowledgement containing status and timestamp. Body: status, timestamp.

adp_workforce_now_worker_communication_change_email

Change a worker's business email in ADP Workforce Now by submitting the worker.business-communication.email.change event. Accepts a JSON request body; the source does not document its fields. Returns an event acknowledgement whose body is not documented.

adp_workforce_now_worker_communication_change_fax

Change a worker's business fax number in ADP Workforce Now by submitting the worker.business-communication.fax.change event. Accepts a JSON request body; the source does not document its fields. Returns an event acknowledgement whose body is not documented.

adp_workforce_now_worker_communication_change_landline

Change a worker's business landline number in ADP Workforce Now by submitting the worker.business-communication.landline.change event. Accepts a JSON request body; the source does not document its fields. Returns an event acknowledgement whose body is not documented.

adp_workforce_now_worker_communication_change_mobile

Change a worker's business mobile telephone number in ADP Workforce Now by submitting the worker.business-communication.mobile.change event. Accepts a JSON request body; the source does not document its fields. Returns an event acknowledgement whose body is not documented.

adp_workforce_now_worker_communication_change_pager

Change a worker's business pager number in ADP Workforce Now by submitting the worker.business-communication.pager.change event. Accepts a JSON request body; the source does not document its fields. Returns an event acknowledgement whose body is not documented.

adp_workforce_now_worker_communication_remove_email

Remove a worker's business email in ADP Workforce Now by submitting the worker.business-communication.email.remove event. Returns the event acknowledgement: status and timestamp.

adp_workforce_now_worker_communication_remove_fax

Remove a worker's business fax number in ADP Workforce Now by submitting the worker.business-communication.fax.remove event. Returns the event acknowledgement: status and timestamp.

adp_workforce_now_worker_communication_remove_landline

Remove a worker's business landline number in ADP Workforce Now by submitting the worker.business-communication.landline.remove event. Returns the event acknowledgement: status and timestamp.

adp_workforce_now_worker_communication_remove_mobile

Remove a worker's business mobile telephone in ADP Workforce Now by submitting the worker.business-communication.mobile.remove event. Returns the event acknowledgement: status and timestamp.

adp_workforce_now_worker_communication_remove_pager

Remove a worker's business pager number in ADP Workforce Now by submitting the worker.business-communication.pager.remove event. Returns the event acknowledgement: status and timestamp.

worker_compensation_add_additional_remuneration

Add a worker's additional remuneration (e.g. bonus, commission) to a work assignment in ADP Workforce Now by submitting the additional remuneration add event. Returns: status, timestamp. Requires the application/json event body.

worker_compensation_change_additional_remuneration

Change a worker's existing additional remuneration (e.g. bonus, commission) on a work assignment in ADP Workforce Now by submitting the additional remuneration change event. Returns: status, timestamp. Requires the application/json event body.

adp_workforce_now_worker_compensation_change_base_remuneration

Change a worker's base remuneration on a work assignment in ADP Workforce Now by submitting the base remuneration change event. Returns: status, timestamp. Requires the application/json event body.

worker_compensation_get_add_additional_remuneration_meta

Get the event metadata for ADP Workforce Now's additional remuneration add event. Returns: status, timestamp.

worker_compensation_get_change_additional_remuneration_meta

Get the event metadata for ADP Workforce Now's additional remuneration change event. Returns: status, timestamp.

worker_compensation_get_change_base_remuneration_meta

Get event metadata for the base remuneration change event in ADP Workforce Now. Returns: meta, status, timestamp.

worker_compensation_get_remove_additional_remuneration_meta

Get event metadata for the additional remuneration remove event in ADP Workforce Now. Returns: meta, status, timestamp.

worker_compensation_remove_additional_remuneration

Remove a worker's additional remuneration (e.g. bonus, commission) from a work assignment in ADP Workforce Now by posting the removal event. Returns a confirmation with status and timestamp.

worker_work_assignment_get_modify_assigned_organizational_units_

Get the metadata for ADP Workforce Now's assigned organizational units modify event. Returns an event metadata document whose structure is event-specific; it defines the fields and constraints the corresponding modify event accepts.

adp_workforce_now_worker_work_assignment_get_modify_meta

Get the metadata for ADP Workforce Now's work assignment modify event. Returns an event metadata document whose structure is event-specific; it defines the fields and constraints the corresponding modify event accepts.

worker_work_assignment_get_modify_reports_to_meta

Get the metadata for ADP Workforce Now's modify worker reports-to event. Returns an event metadata document whose structure is event-specific; it defines the fields and constraints the corresponding modify event accepts.

adp_workforce_now_worker_work_assignment_modify

Modify a worker's work assignment details — such as job title and job function — in ADP Workforce Now. Returns an event-specific response; the JSON body structure follows the Work Assignment API Guide.

worker_work_assignment_modify_assigned_organizational_units

Modify a worker's assigned organizational units — such as department or division — in ADP Workforce Now. Returns an event-specific response; the JSON body structure follows the Work Assignment API Guide.

adp_workforce_now_worker_work_assignment_modify_reports_to

Modify the details of a worker's supervisors (reports-to relationships) in ADP Workforce Now by submitting a worker.reports-to.modify event. Sends a JSON event payload identifying the worker and the updated supervisor details; the API returns an event confirmation whose response body fields are not documented by ADP.

adp_workforce_now_worker_work_assignment_terminate

Terminate a worker's work assignment in ADP Workforce Now by submitting a worker.work-assignment.terminate event. Sends a JSON event payload identifying the worker and the termination details; the API returns an event confirmation whose response body fields are not documented by ADP.

adp_workforce_now_worker_work_deployment_change_standard_hours

Submit a change to a worker's number of standard hours on their work assignment in adpworkforcenow. Returns ADP's opaque event confirmation response; the docs enumerate no response fields. Requires the standard-hours change event payload in the JSON body.

adp_workforce_now_worker_work_deployment_change_worker_type

Submit a worker-type change event for a worker's work assignment in adpworkforcenow. Returns ADP's opaque event confirmation response; the docs enumerate no response fields. Requires the worker-type change event payload in the JSON body.

worker_work_deployment_get_change_worker_type_meta

Get the event metadata for the worker-type change event in adpworkforcenow. Returns the meta envelope containing queryCriteria entries with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Takes no parameters.

adp_workforce_now_person_custom_fields_change_person_amount

Publish a worker.person.customField.amount.change event to update a person-level custom field that holds an amount (currency value) in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new amountValue and currencyCode under transform.worker.person.customFieldGroup.amountField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.amountField.itemID, events[].data.transform.

adp_workforce_now_person_custom_fields_change_person_code

Publish a worker.person.customField.code.change event to update a person-level custom field that holds a code in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new codeValue (and optional shortName/longName) under transform.worker.person.customFieldGroup.codeField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.codeField.itemID, events[].data.transform.

adp_workforce_now_person_custom_fields_change_person_date

Publish a worker.person.customField.date.change event to update a person-level custom field that holds a date in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new dateValue under transform.worker.person.customFieldGroup.dateField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.dateField.itemID, events[].data.transform.

adp_workforce_now_person_custom_fields_change_person_indicator

Publish a worker.person.customField.indicator.change event to update a person-level custom field that holds an indicator (true/false) in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new indicatorValue under transform.worker.person.customFieldGroup.indicatorField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.indicatorField.itemID, events[].data.transform.

adp_workforce_now_person_custom_fields_change_person_number

Publish a worker.person.customField.number.change event to update a person-level custom field that holds a number in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new numberValue under transform.worker.person.customFieldGroup.numberField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.numberField.itemID, events[].data.transform.

adp_workforce_now_person_custom_fields_change_person_percentage

Publish a worker.person.customField.percent.change event to update a person-level custom field that holds a percentage in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new percentValue under transform.worker.person.customFieldGroup.percentField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.percentField.itemID, events[].data.transform.

adp_workforce_now_person_custom_fields_change_person_string

Publish a worker.person.customField.string.change event to update a person-level custom field that holds a string in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new stringValue under transform.worker.person.customFieldGroup.stringField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.stringField.itemID, events[].data.transform.

adp_workforce_now_person_custom_fields_change_person_telephone

Publish a worker.person.customField.telephone.change event to update a person-level custom field that holds a telephone number in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new countryDialing, areaDialing, dialNumber, extension, or formattedNumber under transform.worker.person.customFieldGroup.telephoneField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.person.customFieldGroup.telephoneField.itemID, events[].data.transform.

person_custom_fields_get_change_person_amount_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.amount.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level amountField values can be set and their allowed codes. Use it before change_person_amount to discover valid values. Optional: \$filter.

person_custom_fields_get_change_person_code_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.code.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level codeField values can be set and their allowed codes. Use it before change_person_code to discover valid values. Optional: \$filter.

person_custom_fields_get_change_person_date_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.date.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level dateField values can be set and their allowed codes. Use it before change_person_date to discover valid values. Optional: \$filter.

person_custom_fields_get_change_person_indicator_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.indicator.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level indicatorField values can be set and their allowed codes. Use it before change_person_indicator to discover valid values. Optional: \$filter.

person_custom_fields_get_change_person_number_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.number.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level numberField values can be set and their allowed codes. Use it before change_person_number to discover valid values. Optional: \$filter.

person_custom_fields_get_change_person_percentage_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.percent.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level percentField values can be set and their allowed codes. Use it before change_person_percentage to discover valid values. Optional: \$filter.

person_custom_fields_get_change_person_string_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.string.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level stringField values can be set and their allowed codes. Use it before change_person_string to discover valid values. Optional: \$filter.

person_custom_fields_get_change_person_telephone_meta

Get the event metadata for the ADP Workforce Now worker.person.customField.telephone.change event. Returns a meta object describing the supported query criteria and the transform template, including which person-level telephoneField values can be set and their allowed codes. Use it before change_person_telephone to discover valid values. Optional: \$filter.

adp_workforce_now_worker_biological_data_change_birth_date

Publish a worker birth date change event to ADP Workforce Now. Returns the events payload with the event's eventNameCode.codeValue, the affected worker's associateOID under data.eventContext, and the transform carrying the new value. Required: events.

adp_workforce_now_worker_biological_data_change_gender

Publish a worker gender change event to ADP Workforce Now. Returns the events payload with the event's eventNameCode.codeValue, the affected worker's associateOID under data.eventContext, and the transform carrying the new gender value. Required: events.

adp_workforce_now_worker_biological_data_change_gender_identity

Publish a worker gender identity (Self-ID) change event to ADP Workforce Now. Returns the events payload with the event's eventNameCode.codeValue, the affected worker's associateOID under data.eventContext, and the transform carrying the new value. Required: events.

adp_workforce_now_worker_biological_data_change_race

Publish a worker race change event to ADP Workforce Now, recording how the worker's race is classified within a context. Returns the events payload with the event's eventNameCode.codeValue, the affected worker's associateOID under data.eventContext, and the transform carrying the new value. Required: events.

worker_biological_data_get_change_gender_identity_meta

Get the event metadata for the ADP Workforce Now worker gender identity (Self-ID) change event. Returns the events metadata payload for the change. Takes no parameters.

adp_workforce_now_worker_custom_fields_change_amount

Publish a worker.customField.amount.change event to update a worker-level custom field that holds an amount (currency value) in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new amountValue and currencyCode under transform.worker.customFieldGroup.amountField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.amountField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_change_code

Publish a worker.customField.code.change event to update a worker-level custom field that holds a code in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new codeValue (and optional shortName/longName) under transform.worker.customFieldGroup.codeField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.codeField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_change_date

Publish a worker.customField.date.change event to update a worker-level custom field that holds a date in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new dateValue under transform.worker.customFieldGroup.dateField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.dateField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_change_indicator

Publish a worker.customField.indicator.change event to update a worker-level custom field that holds an indicator (true/false) in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new indicatorValue under transform.worker.customFieldGroup.indicatorField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.indicatorField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_change_number

Publish a worker.customField.number.change event to update a worker-level custom field that holds a number in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new numberValue under transform.worker.customFieldGroup.numberField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.numberField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_change_percentage

Publish a worker.customField.percent.change event to update a worker-level custom field that holds a percentage in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new percentValue under transform.worker.customFieldGroup.percentField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.percentField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_change_string

Publish a worker.customField.string.change event to update a worker-level custom field that holds a string in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new stringValue under transform.worker.customFieldGroup.stringField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.stringField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_change_telephone

Publish a worker.customField.telephone.change event to update a worker-level custom field that holds a telephone number in ADP Workforce Now. Identify the worker by associateOID and the field by its itemID in eventContext, and send the new countryDialing, areaDialing, dialNumber, extension, or formattedNumber under transform.worker.customFieldGroup.telephoneField. Returns the processed event with the updated field in data.output. Required: events[].data.eventContext.worker.associateOID, events[].data.eventContext.worker.customFieldGroup.telephoneField.itemID, events[].data.transform.

adp_workforce_now_worker_custom_fields_get_change_amount_meta

Get the event metadata for the ADP Workforce Now worker.customField.amount.change event. Returns a meta object describing the supported query criteria and the transform template, including which amountField values can be set and their allowed codes. Use it before change_amount to discover valid values. Optional: \$filter.

adp_workforce_now_worker_custom_fields_get_change_code_meta

Get the event metadata for the ADP Workforce Now worker.customField.code.change event. Returns a meta object describing the supported query criteria and the transform template, including which codeField values can be set and their allowed codes. Use it before change_code to discover valid values. Optional: \$filter.

adp_workforce_now_worker_custom_fields_get_change_date_meta

Get the event metadata for the ADP Workforce Now worker.customField.date.change event. Returns a meta object describing the supported query criteria and the transform template, including which dateField values can be set and their allowed codes. Use it before change_date to discover valid values. Optional: \$filter.

adp_workforce_now_worker_custom_fields_get_change_indicator_meta

Get the event metadata for the ADP Workforce Now worker.customField.indicator.change event. Returns a meta object describing the supported query criteria and the transform template, including which indicatorField values can be set and their allowed codes. Use it before change_indicator to discover valid values. Optional: \$filter.

adp_workforce_now_worker_custom_fields_get_change_number_meta

Get the event metadata for the ADP Workforce Now worker.customField.number.change event. Returns a meta object describing the supported query criteria and the transform template, including which numberField values can be set and their allowed codes. Use it before change_number to discover valid values. Optional: \$filter.

worker_custom_fields_get_change_percentage_meta

Get the event metadata for the ADP Workforce Now worker.customField.percent.change event. Returns a meta object describing the supported query criteria and the transform template, including which percentField values can be set and their allowed codes. Use it before change_percentage to discover valid values. Optional: \$filter.

adp_workforce_now_worker_custom_fields_get_change_string_meta

Get the event metadata for the ADP Workforce Now worker.customField.string.change event. Returns a meta object describing the supported query criteria and the transform template, including which stringField values can be set and their allowed codes. Use it before change_string to discover valid values. Optional: \$filter.

adp_workforce_now_worker_custom_fields_get_change_telephone_meta

Get the event metadata for the ADP Workforce Now worker.customField.telephone.change event. Returns a meta object describing the supported query criteria and the transform template, including which telephoneField values can be set and their allowed codes. Use it before change_telephone to discover valid values. Optional: \$filter.

adp_workforce_now_worker_demographic_data_change_birth_name

Update a worker's birth name in adpworkforcenow by submitting a birth-name change event. Sends the ADP event envelope identifying the worker's associateOID with the new birth-name values in the event transform. Returns an event acknowledgement whose payload is event-specific. Required: events.

adp_workforce_now_worker_demographic_data_change_legal_name

Update a worker's legal name in adpworkforcenow for a given context by submitting a legal-name change event. Sends the ADP event envelope identifying the worker's associateOID with the new legal-name values in the event transform. Returns an event acknowledgement whose payload is event-specific. Required: events.

adp_workforce_now_worker_demographic_data_change_marital_status

Record a worker's marital status change in adpworkforcenow by submitting a marital-status change event. Sends the ADP event envelope identifying the worker's associateOID with the new marital-status value in the event transform. Returns an event acknowledgement whose payload is event-specific. Required: events.

worker_demographic_data_change_military_classification

Update a worker's military classification (e.g. VETS-100 reporting indicators) in adpworkforcenow by submitting a military-classification change event. Sends the ADP event envelope identifying the worker's associateOID with the new classification values in the event transform. Returns an event acknowledgement whose payload is event-specific. Required: events.

adp_workforce_now_worker_demographic_data_change_military_status

Update a worker's military status in adpworkforcenow by submitting a military-status change event. Sends the ADP event envelope identifying the worker's associateOID with the new military-status value in the event transform. Returns an event acknowledgement whose payload is event-specific. Required: events.

adp_workforce_now_worker_demographic_data_change_preferred_name

Submit a preferred-name change event to update a worker's preferred name in ADP Workforce Now. Returns the processed event confirmation, whose fields follow ADP's Worker Management event schemas and are not enumerated in the endpoint documentation. Requires a JSON event payload (application/json) built to the Worker Management event format.

worker_demographic_data_get_change_birth_name_meta

Get the event metadata for the worker birth-name change event in ADP Workforce Now. Returns the event metadata document, whose fields follow ADP's event schemas and are not enumerated in the endpoint documentation. Takes no parameters.

worker_demographic_data_get_change_legal_name_meta

Get the event metadata for the worker legal-name change event in ADP Workforce Now. Returns the event metadata document, whose fields follow ADP's event schemas and are not enumerated in the endpoint documentation. Takes no parameters.

worker_demographic_data_get_change_marital_status_meta

Get the event metadata for the worker marital-status change event in ADP Workforce Now. Returns the event metadata document, whose fields follow ADP's event schemas and are not enumerated in the endpoint documentation. Takes no parameters.

worker_demographic_data_get_change_military_classification_meta

Get the event metadata for the worker military-classification change event in ADP Workforce Now. Returns the event metadata document, whose fields follow ADP's event schemas and are not enumerated in the endpoint documentation. Takes no parameters.

worker_demographic_data_get_change_military_status_meta

Get event metadata for the ADP Workforce Now worker military-status change event. Returns meta containing queryCriteria entries with queryOptionCode, queryOptionTypeCode, and resourcePaths (plus filter value lists and logical operators where present). Takes no parameters.

worker_demographic_data_get_change_preferred_name_meta

Get event metadata for the ADP Workforce Now worker preferred-name change event. Returns meta containing queryCriteria entries with queryOptionCode, queryOptionTypeCode, and resourcePaths (plus filter value lists and logical operators where present). Takes no parameters.

adp_workforce_now_deduction_instructions_change

Change a worker's payroll general deduction instruction in ADP Workforce Now. Requires the event JSON payload describing the instruction change. Returns ADP's event confirmation; the available documentation does not enumerate its fields.

adp_workforce_now_deduction_instructions_get_change_meta

Get the event metadata for changing a general deduction instruction in ADP Workforce Now. Returns the OData query-option metadata: itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_deduction_instructions_get_start_meta

Get the event metadata for starting a general deduction instruction in ADP Workforce Now. Returns the OData query-option metadata: itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_deduction_instructions_get_stop_meta

Get the event metadata for stopping a general deduction instruction in ADP Workforce Now. Returns the OData query-option metadata: itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_deduction_instructions_start

Start a worker's payroll general deduction instruction in ADP Workforce Now. Requires the event JSON payload describing the new instruction. Returns ADP's event confirmation; the available documentation does not enumerate its fields.

adp_workforce_now_deduction_instructions_stop

Stop a worker's payroll general deduction instruction in ADP Workforce Now. Returns the confirmation event object for the stop, including the worker's associateOID, the payroll instruction details, the stop effective date, and the deduction instruction code list codes. Required: id (the deduction instruction's associateOID).

get_single_adp_workforce_now_general_ledger_document_by_id

Get (download) a single general ledger document from ADP Workforce Now by id. Returns the document's id and its document-specific attributes. Required: id (the general ledger document id).

list_all_adp_workforce_now_general_ledger_documents

List available general ledger documents in ADP Workforce Now. Returns: id, created_at, updated_at. No additional required parameters.

adp_workforce_now_pay_distributions_change

Replace a worker's direct deposit pay distribution records in adpworkforcenow with an updated collection — there are no separate add/update/remove endpoints, so edit the existing array to add, update, or delete deposits. Returns: id, account_number, routing_number. Required: the events payload with associateID under eventContext and the updated collection under transform. Supported for US and…

get_single_adp_workforce_now_pay_distribution_by_id

Get a single direct deposit pay distribution for a worker in adpworkforcenow by id (the pay-distribution-id obtained from the list call). Returns: id, account_number, routing_number. Required: aoid and id.

adp_workforce_now_pay_distributions_get_change_meta

Get event metadata for the pay distribution change event in adpworkforcenow. Returns meta.queryCriteria entries with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths describing the OData query options the change API supports.

list_all_adp_workforce_now_pay_distributions

List a worker's active direct deposit pay distributions in adpworkforcenow, up to the current effective date. Returns: id, account_number, routing_number. Required: aoid; supports effectiveDate and inactive filters.

get_single_adp_workforce_now_pay_statement_by_id

Get a specific monthly pay statement selected by id for a worker in ADP Workforce Now. Returns the pay statement record including its id and data payload. Required: aoid, id.

adp_workforce_now_pay_statements_get_image

Get a specific pay statement in ADP Workforce Now as a downloadable image (pdf or zip). Returns the raw pdf or zip file content rather than a JSON object. Required: aoid, pay_statement_id, image_id, image_extension.

list_all_adp_workforce_now_pay_statements

List all pay statements for a worker in ADP Workforce Now, covering net/gross payment amounts, deductions, earnings, and YTD accruals. Returns the pay statement records including their id and data payloads. Required: aoid.

list_all_adp_workforce_now_payroll_instructions

List all payroll (deduction) instructions for a worker in ADP Workforce Now to view their general deduction setups. Returns each instruction record's id plus vendor-specific instruction detail fields (attributes). Required: aoid. Behavior differs for WFN Next Gen accounts.

list_all_adp_workforce_now_payroll_outputs

List payroll run results via the ADP Workforce Now Payroll Output API (Turbo API). Each item in the collection returns an id and an attributes object carrying the payroll-run-specific result fields; the attributes shape depends on the payroll configuration defined upstream in adpworkforcenow. No required parameters.

adp_workforce_now_associate_certifications_add

Fire the ADP Workforce Now certification add event to record that an associate's certification was added. Returns an empty 204 response on success.

adp_workforce_now_associate_certifications_change

Fire the ADP Workforce Now certification change event to record that an associate's certification was changed. Returns an empty 204 response on success.

get_single_adp_workforce_now_associate_certification_by_id

Get a specific certification for an associate in ADP Workforce Now. Returns the certification record including its id and certification attributes such as effective and expiration dates and renewal requirements. Required: aoid and id.

adp_workforce_now_associate_certifications_get_add_meta

Get the event metadata for the ADP Workforce Now certification add event, listing the supported OData query options. Returns the meta envelope with queryCriteria items (itemID, queryOptionCode, queryOptionTypeCode) and their resourcePaths.

adp_workforce_now_associate_certifications_get_change_meta

Get the event metadata for the ADP Workforce Now certification change event, listing the supported OData query options. Returns the meta envelope with queryCriteria items (itemID, queryOptionCode, queryOptionTypeCode) and their resourcePaths.

adp_workforce_now_associate_certifications_get_meta

Get the ADP Workforce Now metadata describing which OData query options are supported for an associate's certifications. Returns meta items with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: aoid.

adp_workforce_now_associate_certifications_get_remove_meta

Get the ADP Workforce Now event metadata for associate certification remove events (associate.ksaoc.certification.remove). Returns meta items with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

list_all_adp_workforce_now_associate_certifications

List all certifications recorded for a given associate in ADP Workforce Now, limited to certifications the requester is authorized to view. Returns each certification record with its id and certification-specific attributes (such as certification IDs, effective and expiration dates, and renewal requirements). Required: aoid.

adp_workforce_now_associate_certifications_remove

Remove an associate's certification in ADP Workforce Now by submitting a certification.remove event. The event body identifies the worker being changed via events[].data.eventContext.worker.associateOID and the triggering event via events[].eventNameCode.codeValue. Returns an empty 200 response on success.

adp_workforce_now_associate_competencies_add

Add an associate's competency in ADP Workforce Now by posting the associate.ksaoc.competency.add event. Returns an acknowledgment with status and timestamp.

adp_workforce_now_associate_competencies_change

Change an associate's competency in ADP Workforce Now by posting the associate.ksaoc.competency.change event. Returns an acknowledgment with status and timestamp.

get_single_adp_workforce_now_associate_competency_by_id

Get a specific competency for a given associate in ADP Workforce Now. Returns an event-style response with status and timestamp. Required: aoid, id.

adp_workforce_now_associate_competencies_get_add_meta

Get the event metadata for the associate.ksaoc.competency.add event in ADP Workforce Now. Returns a meta object whose queryCriteria entries list itemID, queryOptionCode, queryOptionTypeCode, and the supported resourcePaths.

adp_workforce_now_associate_competencies_get_change_meta

Get the event metadata for the associate.ksaoc.competency.change event in ADP Workforce Now. Returns a meta object whose queryCriteria entries list itemID, queryOptionCode, queryOptionTypeCode, and the supported resourcePaths.

adp_workforce_now_associate_competencies_get_meta

Get OData query metadata for ADP Workforce Now associate competencies. Returns the supported query options, including each item's itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: aoid.

adp_workforce_now_associate_competencies_get_remove_meta

Get the event metadata for the ADP Workforce Now associate.ksaoc.competency.remove event, describing the query options supported when posting this event. Returns the supported query options, including each item's itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

list_all_adp_workforce_now_associate_competencies

List all competencies recorded for a given associate in ADP Workforce Now that the requester is authorized to view. Returns: id, status, timestamp. Required: aoid.

adp_workforce_now_associate_competencies_remove

Remove an associate's competency in ADP Workforce Now by submitting the associate.ksaoc.competency.remove event. Returns: status, timestamp.

adp_workforce_now_associate_educational_degrees_add

Add an educational degree for an associate in ADP Workforce Now by submitting an educational-degree add event. Returns: events. Required: events.

adp_workforce_now_associate_educational_degrees_change

Change an associate's educational degree in ADP Workforce Now by submitting an educational-degree change event. Returns: events. Required: events.

get_single_adp_workforce_now_associate_educational_degree_by_id

Get a specific educational degree for an associate in ADP Workforce Now. Returns: id, attributes. Required: aoid and id.

adp_workforce_now_associate_educational_degrees_get_add_meta

Get the event metadata for educational-degree add events in ADP Workforce Now. Returns the meta envelope whose queryCriteria entries describe each supported OData query option via itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths — and, for $filter options, the queryValueCodeList of valid values and logicalOperators.

adp_workforce_now_associate_educational_degrees_get_change_meta

Get the event metadata for educational-degree change events in ADP Workforce Now. Returns the meta envelope whose queryCriteria entries describe each supported OData query option via itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths — and, for $filter options, the queryValueCodeList of valid values and logicalOperators.

adp_workforce_now_associate_educational_degrees_get_meta

Get the read metadata for an associate's educational degrees in ADP Workforce Now. Returns the meta envelope whose queryCriteria entries list itemID, queryOptionCode, queryOptionTypeCode, and the resourcePaths each OData option applies to. Required: aoid.

adp_workforce_now_associate_educational_degrees_get_remove_meta

Get the event metadata for the educational-degree remove event in ADP Workforce Now. Returns the meta envelope whose queryCriteria entries list itemID, queryOptionCode, queryOptionTypeCode, and the resourcePaths each OData option applies to.

list_all_adp_workforce_now_associate_educational_degrees

List all educational degrees recorded for an associate in ADP Workforce Now that the requester is authorized to view. Returns each degree record's id and schema-defined attributes covering the learning institution, degree, education level, start/end dates, credit type, area of study, GPA, and honorary-degree flags. Required: aoid.

adp_workforce_now_associate_educational_degrees_remove

Remove an educational degree from an associate's record in ADP Workforce Now by posting the educational-degree remove event (application/json). Returns an empty 204 response on success.

adp_workforce_now_associate_languages_add

Add a language to an associate's talent profile in ADP Workforce Now by submitting the associate.ksaoc.language.add event. Returns the event response payload; its fields follow ADP's event message format and are not enumerated in the source.

adp_workforce_now_associate_languages_change

Change an existing language on an associate's talent profile in ADP Workforce Now by submitting the associate.ksaoc.language.change event. Returns the event response payload; its fields follow ADP's event message format and are not enumerated in the source.

get_single_adp_workforce_now_associate_language_by_id

Get a specific associate language for a given associate in ADP Workforce Now. Returns the associate language record identified by id. Required: aoid, id.

adp_workforce_now_associate_languages_get_add_meta

Get the event metadata for the language add event in ADP Workforce Now. Returns meta containing queryCriteria entries with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_associate_languages_get_change_meta

Get the event metadata for the language change event in ADP Workforce Now. Returns meta containing queryCriteria entries with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_associate_languages_get_item_meta

Get the OData query-option metadata for a specific language record of an associate in ADP Workforce Now. Returns the meta object with queryCriteria items exposing itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: aoid, language_id.

adp_workforce_now_associate_languages_get_meta

Get the OData query-option metadata for an associate's languages endpoint in ADP Workforce Now. Returns the meta object with queryCriteria items exposing itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: aoid.

adp_workforce_now_associate_languages_get_remove_meta

Get the event metadata for the associate language remove event in ADP Workforce Now. Returns the meta object with queryCriteria items exposing itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

list_all_adp_workforce_now_associate_languages

List all available languages recorded for a given associate in ADP Workforce Now. Returns the associate's language records; each item has an id plus schema-specific language detail fields (attributes). Required: aoid.

adp_workforce_now_associate_languages_remove

Remove an associate's language in ADP Workforce Now by submitting the language.remove event as a JSON payload. Returns an empty 204 response on success.

adp_workforce_now_associate_licenses_add

Add a license for an associate in ADP Workforce Now by submitting the associate.ksaoc.license.add event. Returns the added license record's id and its license attributes (license IDs, effective and expiration dates, renewal requirements). Requires the license.add event payload body; ADP publishes the field-level shape in its Talent Profile Licenses API guide.

adp_workforce_now_associate_licenses_change

Change an associate's license in ADP Workforce Now by submitting the associate.ksaoc.license.change event. Returns the updated license record's id and its license attributes (license IDs, effective and expiration dates, renewal requirements). Requires the license.change event payload body; ADP publishes the field-level shape in its Talent Profile Licenses API guide.

get_single_adp_workforce_now_associate_license_by_id

Get a specific license for a given associate in ADP Workforce Now. Returns the license record's id and its license attributes (the documentation covers license IDs, effective and expiration dates, and renewal requirements). Required: id, aoid.

adp_workforce_now_associate_licenses_get_add_meta

Get the query-option metadata for the associate.ksaoc.license.add event in ADP Workforce Now. Returns a list of OData query-option entries, each with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths (worker resource paths such as workers/associateOID usable with each option).

adp_workforce_now_associate_licenses_get_change_meta

Get the query-option metadata for the associate.ksaoc.license.change event in ADP Workforce Now. Returns a list of OData query-option entries, each with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths (worker resource paths such as workers/associateOID usable with each option).

adp_workforce_now_associate_licenses_get_item_meta

Get the OData query-option metadata for reading a specific associate license in ADP Workforce Now. Returns metadata items with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: aoid, license_id.

adp_workforce_now_associate_licenses_get_meta

Get the OData query-option metadata for listing an associate's licenses in ADP Workforce Now. Returns metadata items with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: aoid.

adp_workforce_now_associate_licenses_get_remove_meta

Get the event metadata for the associate.ksaoc.license.remove event in ADP Workforce Now. Returns metadata items with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

list_all_adp_workforce_now_associate_licenses

List all licenses on an associate's talent profile in ADP Workforce Now. Returns license records including id and license attribute fields (IDs, effective and expiration dates, renewal requirements). Required: aoid.

adp_workforce_now_associate_licenses_remove

Remove an associate's license from their talent profile in ADP Workforce Now by submitting the associate.ksaoc.license.remove event. Returns an empty 204 response on success.

adp_workforce_now_associate_memberships_add

Post an associate membership add event to ADP Workforce Now, signaling that an associate's membership in an organization was added. Sends the event as a JSON payload; the response body is not documented by ADP.

adp_workforce_now_associate_memberships_add_notify

Post a membership add event notification to ADP Workforce Now, communicating the occurrence of an associate's membership add event. Sends the notification as a JSON payload; the response body is not documented by ADP.

adp_workforce_now_associate_memberships_change

Post an associate membership change event to ADP Workforce Now, signaling that an associate's organization membership changed. Sends the event as a JSON payload; the response body is not documented by ADP.

adp_workforce_now_associate_memberships_change_notify

Post a membership change event notification to ADP Workforce Now, communicating the occurrence of an associate's membership change event. Sends the notification as a JSON payload; the response body is not documented by ADP.

get_single_adp_workforce_now_associate_membership_by_id

Get a specific membership for a given associate in ADP Workforce Now. Returns the membership event payload including meta and events entries. Required: aoid, id.

adp_workforce_now_associate_memberships_get_add_meta

Get event metadata for ADP Workforce Now membership add events, describing the OData query options and worker resource paths supported by the associate.ksaoc.membership.add event. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, queryValueCodeList, logicalOperators.

adp_workforce_now_associate_memberships_get_change_meta

Get event metadata for ADP Workforce Now membership change events, describing the OData query options and worker resource paths supported by the associate.ksaoc.membership.change event. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, queryValueCodeList, logicalOperators.

adp_workforce_now_associate_memberships_get_item_meta

Get API metadata for a single membership of an associate in ADP Workforce Now, describing the OData query options and worker resource paths supported when reading that membership. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, queryValueCodeList, logicalOperators. Required: aoid, membership_id.

adp_workforce_now_associate_memberships_get_meta

Get API metadata for an associate's memberships in ADP Workforce Now, describing the OData query options and worker resource paths supported when listing memberships. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, queryValueCodeList, logicalOperators. Required: aoid.

adp_workforce_now_associate_memberships_get_remove_meta

Get event metadata for ADP Workforce Now membership remove events, describing the OData query options and worker resource paths supported by the associate.ksaoc.membership.remove event. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, queryValueCodeList, logicalOperators.

adp_workforce_now_associate_memberships_get_review_add_meta

Get the event metadata for the review-add-membership event in ADP Workforce Now. Returns the meta document with queryCriteria entries listing itemID, queryOptionCode, queryOptionTypeCode, and the supported resourcePaths.

adp_workforce_now_associate_memberships_get_review_change_meta

Get the event metadata for the review-change-membership event in ADP Workforce Now. Returns the meta document with queryCriteria entries listing itemID, queryOptionCode, queryOptionTypeCode, and the supported resourcePaths.

adp_workforce_now_associate_memberships_get_review_remove_meta

Get the event metadata for the review-remove-membership event in ADP Workforce Now. Returns the meta document with queryCriteria entries listing itemID, queryOptionCode, queryOptionTypeCode, and the supported resourcePaths.

list_all_adp_workforce_now_associate_memberships

List all organization memberships for a given associate in ADP Workforce Now that the requester is authorized to view. Returns membership records with id plus content-type-specific membership attributes defined by the talent schema. Required: aoid.

adp_workforce_now_associate_memberships_remove

Remove an associate's organization membership in ADP Workforce Now by submitting the membership remove event as a JSON payload. Returns an opaque event confirmation; the upstream response body shape is not documented.

adp_workforce_now_associate_memberships_remove_notify

Communicates the occurrence of an associate's organization membership removal event to ADP Workforce Now. Sends a JSON event notification payload and returns an opaque acknowledgement response with no documented fields.

adp_workforce_now_associate_memberships_review_add

Submit an associate's membership add review request to ADP Workforce Now, capturing a review event when an associate adds a new organization membership. Accepts a JSON review payload and returns an opaque acknowledgement response with no documented fields.

adp_workforce_now_associate_memberships_review_add_notify

Communicates the occurrence of a membership add review event for an associate in ADP Workforce Now. Sends a JSON event notification payload and returns an opaque acknowledgement response with no documented fields.

adp_workforce_now_associate_memberships_review_change

Submit an associate's membership change review request to ADP Workforce Now, capturing a review event when an associate changes an organization membership. Accepts a JSON review payload and returns an opaque acknowledgement response with no documented fields.

adp_workforce_now_associate_memberships_review_change_notify

Communicates the occurrence of a membership change review event for an associate in ADP Workforce Now. Sends a JSON event notification payload and returns an opaque acknowledgement response with no documented fields.

adp_workforce_now_associate_memberships_review_remove

Submit an associate's membership remove review event in ADP Workforce Now, capturing a review instance when an associate removes an organization membership. Accepts a JSON event request payload and returns an opaque upstream event acknowledgment; the response body shape is not enumerated by ADP.

adp_workforce_now_associate_memberships_review_remove_notify

Communicate the occurrence of an associate's membership remove review event through ADP Workforce Now's event-notification pipeline. Accepts a JSON event notification payload and returns an opaque acknowledgment; the response body shape is not enumerated by ADP.

adp_workforce_now_associate_recognitions_add

Add a recognition to an associate's talent profile in ADP Workforce Now by posting a recognition.add event. Returns an event confirmation payload whose fields are defined by ADP's event framework (not enumerated in the docs). Requires a JSON event body.

adp_workforce_now_associate_recognitions_change

Change an associate's recognition in ADP Workforce Now by posting a recognition.change event. Returns an event confirmation payload whose fields are defined by ADP's event framework (not enumerated in the docs). Requires a JSON event body.

adp_workforce_now_associate_recognitions_get_add_meta

Get the event metadata for ADP Workforce Now's recognition add event, including the supported OData query options. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths.

adp_workforce_now_associate_recognitions_get_change_meta

Get the event metadata for ADP Workforce Now's recognition change event, including the supported OData query options. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths.

adp_workforce_now_associate_recognitions_get_meta

Get the metadata for an associate's recognitions resource in ADP Workforce Now, including the supported OData query options. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. Required: aoid.

adp_workforce_now_associate_recognitions_get_remove_meta

Get the event metadata for the ADP Workforce Now remove-recognition event. Returns the meta object, whose queryCriteria entries list the OData query options the event supports, including itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

list_all_adp_workforce_now_associate_recognitions

List all award and recognition records for an associate in ADP Workforce Now. Returns each recognition's id and its attributes as defined by the ADP Talent Profile Awards and Recognitions schema. Required: aoid.

adp_workforce_now_associate_recognitions_remove

Remove an associate's recognition in ADP Workforce Now by posting the recognition-remove event. Returns an empty 204 response on success.

adp_workforce_now_worker_ksaoc_change_highest_education

Send a worker.highest-level-education.change event to ADP Workforce Now to record that a worker's highest level of education changed. Returns an opaque acknowledgment from ADP's event manager for the submitted event.

adp_workforce_now_worker_ksaoc_get_change_highest_education_meta

Get the event metadata for the worker.highest-level-education.change event in ADP Workforce Now. Returns query option descriptors including itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_applicant_onboarding_create_onboarding

Initiate a new applicant onboarding in ADP Workforce Now by posting the applicant's New Hire Template data in the request body. The applicant is created as an In-Progress hire that a practitioner then completes in ADP Workforce Now. Returns an opaque confirmation response with no documented fields.

adp_workforce_now_applicant_onboarding_get_meta

Get the applicant onboarding API metadata for ADP Workforce Now. Returns the supported OData query options, each with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_corporate_directory_get_contact_photo

Download an employee's corporate contact photo from ADP Workforce Now. Returns the photo image itself rather than a JSON object — use the image_id and image_extension from the photo href returned by the Workers API. Required: sor_id, image_id, image_extension.

job_applicants_change_external_assessment_status

Report a change to a job applicant's external agency assessment status in adpworkforcenow, for a single or multiple job applications identified by their application item IDs. The upstream docs do not document a response payload for this event endpoint.

job_applicants_change_external_screening_status

Report a change to a job applicant's external agency background screening status (including the results link) in adpworkforcenow, for a single or multiple job applications identified by their application item IDs. The upstream docs do not document a response payload for this event endpoint.

adp_workforce_now_job_applicants_initiate_external_screening

Initiate a job applicant's background screening handled by an external agency in adpworkforcenow, for a single or multiple job applications identified by their application item IDs. The upstream docs do not document a response payload for this event endpoint.

job_applicants_modify_external_screening_packages

Modify the background screening packages associated with a job applicant's external agency screening in adpworkforcenow, for a single or multiple job applications identified by their application item IDs. The upstream docs do not document a response payload for this event endpoint.

adp_workforce_now_pay_data_input_get_meta

Get event metadata for the pay data input modify operation in ADP Workforce Now. Returns the meta envelope with queryCriteria entries carrying itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, and logicalOperators.

update_a_adp_workforce_now_pay_data_input_by_id

Modify pay data input information in ADP Workforce Now — create or append a Pay Data batch for a payroll cycle (earnings, deductions, reimbursements, allocations, and more) by posting a JSON payload. Returns the event response with meta.queryCriteria entries carrying itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

adp_workforce_now_personal_contacts_add_contact

Add a personal contact for a worker in ADP Workforce Now by posting the worker.personalContact.add event. Returns the event confirmation record including its id and content-specific event attributes.

adp_workforce_now_personal_contacts_change_contact

Update an existing personal contact for a worker in ADP Workforce Now by posting the worker.personalContact.change event. Returns the event confirmation record including its id and content-specific event attributes.

get_single_adp_workforce_now_personal_contact_by_id

Get a single personal contact for an associate in ADP Workforce Now. Returns the contact record identified by id along with its content-specific fields (attributes). Required: id and aoid.

adp_workforce_now_personal_contacts_get_add_meta

Get the event metadata for adding a personal contact in ADP Workforce Now (worker.personal-contact.add). Returns metadata items with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths describing the OData query options and worker resource paths the event supports.

adp_workforce_now_personal_contacts_get_change_meta

Get the event metadata for changing an existing personal contact in ADP Workforce Now (worker.personal-contact.change). Returns metadata items with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths describing the OData query options and worker resource paths the event supports.

adp_workforce_now_personal_contacts_get_meta

Get the personal contacts metadata for an associate in ADP Workforce Now, describing the OData query options the personal contacts endpoints support. Returns the meta envelope including its queryCriteria entries listing itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, and for $filter options queryValueCodeList and logicalOperators. Required: aoid.

adp_workforce_now_personal_contacts_get_remove_meta

Get the event metadata for the ADP Workforce Now worker.personal-contact.remove event, describing the OData query options the remove event endpoints support. Returns the meta envelope including its queryCriteria entries listing itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, and for $filter options queryValueCodeList and logicalOperators.

list_all_adp_workforce_now_personal_contacts

List an associate's personal contacts in ADP Workforce Now. Returns each contact's id plus attributes (the upstream personal-contact fields; the shape is defined by ADP). Required: aoid.

adp_workforce_now_personal_contacts_remove_contact

Remove a personal contact from an associate's record in ADP Workforce Now by submitting the worker.personal-contact.remove event. Returns an empty 204 response on success.

adp_workforce_now_worker_leaves_cancel

Cancel a worker's leave in ADP Workforce Now by submitting a worker.leave.cancel event to the leave management system. No caller-supplied query or body fields are documented for this endpoint.

adp_workforce_now_worker_leaves_change

Change a worker's leave in ADP Workforce Now by submitting a worker.leave.change event to the leave management system. No caller-supplied query or body fields are documented for this endpoint.

adp_workforce_now_worker_leaves_get_absence_meta

Get the event metadata for ADP Workforce Now's request-leave-of-absence event. Returns the supported OData query options including itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Takes no parameters.

adp_workforce_now_worker_leaves_get_cancel_meta

Get the event metadata for ADP Workforce Now's cancel-worker-leave event. Returns the supported OData query options including itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Takes no parameters.

adp_workforce_now_worker_leaves_get_change_meta

Get the event metadata for ADP Workforce Now's change-worker-leave event. Returns the supported OData query options including itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Takes no parameters.

adp_workforce_now_worker_leaves_get_return_meta

Get the event metadata for the Request Return From Leave Of Absence event in ADP Workforce Now. Returns the meta envelope with queryCriteria entries including itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths.

list_all_adp_workforce_now_worker_leaves

List a worker's leave details in ADP Workforce Now. Returns the response envelope with data (the worker's leaves details) and meta. Required: aoid.

adp_workforce_now_worker_leaves_request_absence

Request a leave of absence for a worker in ADP Workforce Now by submitting the worker.leave.absence.request event. Returns the event confirmation envelope with events entries.

adp_workforce_now_worker_leaves_request_return

Request a worker's return from leave of absence in ADP Workforce Now by submitting the worker.leave.return.request event. Returns the event confirmation envelope with events entries.

adp_workforce_now_worker_photos_get_photo

Get a worker's profile photo from ADP Workforce Now by aoid. Returns the profile picture image itself (binary image content, not a JSON object). Required: aoid (the worker's associate OID).

adp_workforce_now_worker_photos_get_remove_photo_meta

Get the event metadata for the worker.photo.remove event in ADP Workforce Now. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. Takes no parameters.

adp_workforce_now_worker_photos_get_upload_photo_meta

Get the event metadata for the worker.photo.upload event in ADP Workforce Now. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. Takes no parameters.

adp_workforce_now_worker_photos_remove_photo

Remove a worker's profile photo in ADP Workforce Now — both its metadata and image file — by submitting the worker.photo.remove event. Returns an event acknowledgement; the upstream docs document no response body shape for this event.

adp_workforce_now_worker_photos_upload_photo

Upload a worker's profile photo in ADP Workforce Now by submitting the worker.photo.upload event. The JSON event payload and the photo image file are posted together in a single multipart/mixed request. Returns an event acknowledgement; the upstream docs document no response body shape for this event.

adp_workforce_now_codelists_list_payroll_v_3

List available payroll instruction management codes for the requested codelist in ADP Workforce Now (legacy v3 schema). Returns code entries including codeValue, shortName, and category. Required: code_type, version_id.

adp_workforce_now_codelists_list_payroll_v_4

List available payroll instruction management codes for the requested codelist in ADP Workforce Now (nextgen v4 schema). Returns code entries including codeValue, shortName, and category. Required: code_type, version_id.

adp_workforce_now_codelists_list_worker_v_3

List available worker management codes for the requested codelist in ADP Workforce Now (legacy v3 schema). Returns code entries including codeValue, shortName, and category. Required: code_type, version_id.

adp_workforce_now_codelists_list_worker_v_4

List available worker management codes for the requested codelist in ADP Workforce Now (nextgen v4 schema). Returns code entries including codeValue, shortName, and category. Required: code_type, version_id.

create_a_adp_workforce_now_work_assignment

Create a work assignment (add a new position) for a worker in ADP Workforce Now. Returns: associateOID, workAssignments. Required: aoid.

adp_workforce_now_work_assignments_get_meta

Get the metadata for the work assignment add operation in ADP Workforce Now. Returns a meta object whose queryCriteria entries (itemID, queryOptionCode, queryOptionTypeCode, resourcePaths) list the supported OData query options. Required: aoid.

adp_workforce_now_worker_profile_create_additional_remunerations

Create additional remunerations, such as bonus or commission, on a worker's work assignment in ADP Workforce Now. Returns: id, attributes. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_create_corporate_group

Create a corporate group assignment for a worker's work assignment in ADP Workforce Now. Returns: id, attributes. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_create_reportable_benefits

Add taxable benefits and allowances, such as auto or cellular, to a worker's work assignment in ADP Workforce Now (Canada payroll only). Returns: id, attributes. Required: aoid, assignment_id.

worker_profile_get_additional_remunerations_meta

Get the add/update metadata for a worker's additional remunerations in ADP Workforce Now — the OData query options and worker resource paths supported for this work assignment. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, queryValueCodeList, logicalOperators. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_get_base_remuneration_meta

Get the update metadata for a worker's base remuneration in ADP Workforce Now — the OData query options and worker resource paths supported for this work assignment. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths, queryValueCodeList, logicalOperators. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_get_corporate_groups_meta

Get the add/update metadata for a work assignment's corporate groups in ADP Workforce Now: the supported OData query options, queryable resource paths, and field constraints used when adding or changing corporate groups. Returns an items list (itemID, queryOptionCode, queryOptionTypeCode, resourcePaths), meta, and messages. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_get_reportable_benefits_meta

Get the add/update metadata for a work assignment's reportable (taxable) benefits and allowances in ADP Workforce Now - the supported OData query options, queryable resource paths, and field constraints for benefit add/update calls. Returns an items list (itemID, queryOptionCode, queryOptionTypeCode, resourcePaths), meta, and messages. Required: aoid, assignment_id. Reportable benefits apply only…

adp_workforce_now_worker_profile_get_work_schedules

Read the work schedule details for a work assignment in ADP Workforce Now, such as scheduled hours, pay cycle, and full-time/part-time indicator. Returns an items list of schedule records, meta, and messages. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_get_work_schedules_meta

Get the metadata for updating a work assignment's work schedule in ADP Workforce Now - field-level constraints and display rules for the work schedule update call. Returns an items list (itemID, queryOptionCode, queryOptionTypeCode, resourcePaths), meta, and messages. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_list_additional_remunerations

List a worker's additional remunerations (e.g. bonus, commission) for a work assignment in ADP Workforce Now. Returns an items list of remuneration records, meta, and messages. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_list_reportable_benefits

List the taxable benefits and allowances (e.g. auto, cellular) on a worker's work assignment in ADP Workforce Now. Returns a reportable-benefits record with id and benefit-type-specific attributes defined by ADP's reportableBenefits.read schema. Required: aoid, assignment_id. Only for paid employees in Canada.

adp_workforce_now_worker_profile_update_base_remuneration

Update a worker's base remuneration details (e.g. salary, hourly rate) in ADP Workforce Now. Returns: id, attributes. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_update_primary_assignment

Change a worker's primary assignment (primary position) in ADP Workforce Now via the Employee Job Change operation. Returns: id, attributes. Required: aoid, assignment_id.

adp_workforce_now_worker_profile_update_reportable_benefits

Update a worker's taxable/reportable benefits and allowances (e.g. auto, cellular) in ADP Workforce Now. Returns: id, attributes. Required: aoid, assignment_id. Only for paid employees in Canada.

adp_workforce_now_worker_profile_update_worker_dates

Update a worker's dates on a work assignment in ADP Workforce Now. Returns ADP's change confirmation payload (the field-level response shape is not enumerated in the upstream explorer). Required: aoid, assignment_id.

adp_workforce_now_worker_profile_update_work_schedules

Update a work assignment's work schedule details (e.g. scheduled hours, pay cycle, full-time/part-time indicator) in ADP Workforce Now. Returns ADP's change confirmation payload (the field-level response shape is not enumerated in the upstream explorer). Required: aoid, assignment_id.

adp_workforce_now_worker_profile_bulk_update

Update a worker's additional remunerations (e.g. bonus, commission) in ADP Workforce Now. Returns: id, attributes. Required: aoid, assignment_id.

list_all_adp_workforce_now_beneficiaries

List all beneficiaries added for an associate in ADP Workforce Now. Returns the beneficiary records for the associate — beneficiary person, beneficiary organization, or dependent/beneficiary details depending on the beneficiary type; individual beneficiary lookups are not supported. Required: aoid (associate ID). Pass If-None-Match: true to get the latest data instead of a cached response.

list_all_adp_workforce_now_benefit_dependents

List all dependents added for an associate in ADP Workforce Now. Returns the Collection of Dependents records, each with an id and upstream-defined dependent attributes. Required: aoid (the associate's ID). Does not support fetching details of an individual dependent; send header If-None-Match:true to avoid a cached response.

list_all_adp_workforce_now_benefit_spending_accounts

List the benefit spending account enrollments for an associate in ADP Workforce Now (HROpen). Returns enrollment records with id and accountBasedCoverage, including the coverage effectivePeriod validFrom and validTo dates. Required: aoid.

list_all_adp_workforce_now_event_notifications

Retrieve the next event notification message from the adpworkforcenow message queue via the polling workflow. Returns: status, timestamp. The unique message id (adp-msg-msgid) is returned in the response header and is needed to delete the message. Messages are retrieved one at a time in FIFO order - bulk retrieval is not supported.

adp_workforce_now_event_notifications_bulk_delete

Delete an event notification message from the adpworkforcenow message queue after processing it. Returns an empty 204 response on success.eventContext), and the transformed record values. Required: adp_msg_msgid (obtained from the header of the message retrieved with list). Deleting the current message before retrieving the next one is required — only one notification can be retrieved and deleted…

adp_workforce_now_external_benefit_plans_confirm_data

Submit the carrier response for an external benefit plan event in ADP Workforce Now, confirming the outcome of a plan change through the event notification endpoint. Returns the plan response payload with fields defined by the LIMRA WBEDX specification. Requires a JSON request body per that specification.

adp_workforce_now_external_benefit_plans_create_plan

Create one or more employee benefit plans in ADP Workforce Now as an external carrier. Plans are created in an in-progress state until a practitioner or plan administrator reviews them and completes setup. Returns the plan payload with fields defined by the LIMRA WBEDX specification. Requires a JSON request body per that specification.

get_single_adp_workforce_now_job_application_by_id

Get a single job application from ADP Workforce Now by id. Returns: id, created_at, updated_at. Required: id.

list_all_adp_workforce_now_job_applications

List all job applications in ADP Workforce Now that the requester is authorized to view. Returns: id, created_at, updated_at.

get_single_adp_workforce_now_job_requisition_by_id

Get a single job requisition from ADP Workforce Now by id. Returns the requisition record including its id and the requisition's schema-defined attributes. Required: id.

list_all_adp_workforce_now_job_requisitions

List all job requisitions in ADP Workforce Now that the requester is authorized to view. Returns each requisition record including its id and schema-defined requisition attributes.

get_single_adp_workforce_now_recruiting_questionnaire_by_id

Get the list of questions for a recruiting questionnaire in ADP Workforce Now. Returns the questions posted for the specified questionnaire. Required: id.

adp_workforce_now_tax_policy_eligibility_read_request

Retrieve ADP Workforce Now statutory policies with applicable ADP codes and statutory data for the addresses supplied in the JSON request body. Returns: id, attributes.

us_tax_profiles_add_state_income_tax_instruction

Add a new US state income tax withholding instruction for a worker in ADP Workforce Now, submitting the state tax withholding details as a JSON event payload. Returns only an opaque event-processing acknowledgement, not a tax-profile record; the API reference does not enumerate the payload's field-level structure.

us_tax_profiles_change_state_income_tax_instruction

Change an existing US state income tax withholding instruction for a worker in ADP Workforce Now, submitting the updated state tax withholding details as a JSON event payload. Returns only an opaque event-processing acknowledgement, not a tax-profile record; the API reference does not enumerate the payload's field-level structure.

adp_workforce_now_us_tax_profiles_get_add_state_tax_meta

Get the event metadata for the add state income tax instruction event in ADP Workforce Now, showing the OData query options the event supports. Returns meta.queryCriteria entries with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: pfid.

adp_workforce_now_us_tax_profiles_get_change_state_tax_meta

Get the event metadata for the change state income tax instruction event in ADP Workforce Now, showing the OData query options the event supports. Returns meta.queryCriteria entries with itemID, queryOptionCode, queryOptionTypeCode, and resourcePaths. Required: pfid, state.

adp_workforce_now_validation_tables_add_business_unit

Add a new business unit code to the Business Units validation table in ADP Workforce Now. Sends the code as a JSON body and returns the upstream confirmation for the added code; field-level request and response shapes are not enumerated in the ADP documentation — use the validation-tables meta API (validationTableType and method parameters) to retrieve the schema.

adp_workforce_now_validation_tables_add_cost_center

Add a new cost center code to the Cost Centers validation table in ADP Workforce Now. Sends the code as a JSON body and returns the upstream confirmation for the added code; field-level request and response shapes are not enumerated in the ADP documentation — use the validation-tables meta API (validationTableType and method parameters) to retrieve the schema.

adp_workforce_now_validation_tables_add_department

Add a new department code to the Departments validation table in ADP Workforce Now. The request and response structures are defined per validation-table setup and are not enumerated here; fetch the exact schema from the companion validation-tables meta endpoint (validationTableType=departments, method=POST) before calling.

adp_workforce_now_validation_tables_add_item

Add a new code to the Associate Work Locations validation table in ADP Workforce Now. Returns a JSON confirmation response whose field set ADP defines per validation-table type. The request-body schema is not enumerated in the API Explorer docs; retrieve it from the validation-tables meta API (validationTableType AssociateWorkLocations, method POST).

adp_workforce_now_validation_tables_add_job

Add a new code (job title) to the Jobs validation table in ADP Workforce Now. Returns a JSON confirmation response whose field set ADP defines per validation-table type. The request-body schema is not enumerated in the API Explorer docs; retrieve it from the Jobs meta API (method POST).

adp_workforce_now_validation_tables_get_job

Get details of a specific record in the Jobs validation table of an ADP Workforce Now client. Returns the record's id and its validation-table-specific attribute fields. Required: job_id.

adp_workforce_now_validation_tables_get_jobs_meta

Get the OData query metadata for the Jobs validation table of an ADP Workforce Now client. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. Required: method (e.g. get or post) to select the appropriate response.

adp_workforce_now_validation_tables_get_meta

Get the OData query metadata for an ADP Workforce Now validation table. Returns: itemID, queryOptionCode, queryOptionTypeCode, resourcePaths. Required: method and validationTableType to select the appropriate response.

adp_workforce_now_validation_tables_get_person_custom_field

Get details of a specific record in the Person Custom Fields validation table of an ADP Workforce Now client. Returns the record's id and its table-specific attribute fields. Required: person_custom_field_id.

adp_workforce_now_validation_tables_get_worker_custom_field

Get details of a specific record in the Worker Custom Fields validation table of an ADP Workforce Now client. Returns the record's id and its table-specific attribute fields. Required: worker_custom_field_id.

adp_workforce_now_validation_tables_list_business_units

List Business Units validation table items in ADP Workforce Now. Returns each item as: id, attributes (item fields vary by validation table type).

adp_workforce_now_validation_tables_list_cost_centers

List Cost Centers validation table items in ADP Workforce Now. Returns each item as: id, attributes (item fields vary by validation table type).

adp_workforce_now_validation_tables_list_departments

List Departments validation table items in ADP Workforce Now. Returns each item as: id, attributes (item fields vary by validation table type).

adp_workforce_now_validation_tables_list_person_custom_fields

List Person Custom Fields validation table items in ADP Workforce Now. Returns each item as: id, attributes (item fields vary by validation table type).

adp_workforce_now_validation_tables_list_work_locations

List Associate Work Locations validation table items in ADP Workforce Now. Returns each item as: id, attributes (item fields vary by validation table type).

adp_workforce_now_validation_tables_list_worker_custom_fields

List all items in the ADP Workforce Now Worker Custom Fields validation table. Returns the collection of worker custom-field item records; each item's fields are client-defined upstream and not enumerated in the API reference.