ADP WorkForceNow API Integration

These are the list of integration use cases supported by Knit for ADP WorkForceNow API as part of the HRIS category

Create Employee Canada Maximum Payload

ID: create_employee_canada_maximum_payload
Operation: write
Entities: employee, mobiles, emails, person
Summary: The Create Employee Canada Maximum Payload API is used to onboard a new employee with maximum payload details. It requires an OAuth 2.0 token for authorization and the content type must be 'application/json'. The request body must include the employee's first name, last name, employment details, work email, personal emails, and work address. The response includes event details such as service category code, event name code, originator and actor associate OIDs, and detailed applicant information including personal details, communication methods, and job offer terms.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee Canada Minimum Payload

ID: create_employee_canada_minimum_payload
Operation: write
Entities: employee, mobiles, emails, person
Summary: The Create Employee Canada Minimum Payload API is used to onboard an applicant as an employee in Canada. It requires the applicant's first name, last name, and work address with the country set to 'CAN' (Canada). The API uses OAuth 2.0 for authorization and requires the 'Content-Type' header to be 'application/json'. The response includes detailed information about the onboarding event, including the applicant's personal details, job offer terms, and communication details. The response also provides the status of the event and the effective date and time.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee US Maximum Payload

ID: create_employee_us_maximum_payload
Operation: write
Entities: employee, mobiles, emails, person
Summary: The Create Employee US Maximum Payload API is used to onboard a new employee with maximum payload details in the US. It requires an OAuth 2.0 token for authorization and the content type must be 'application/json'. The request body must include the employee's first and last name, employment details with position ID, work email, personal emails, work address, and metadata. The response includes event details such as service category code, event name code, originator and actor associate OIDs, and detailed applicant information including personal details, communication methods, and job offer terms.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee US Minimum Payload

ID: create_employee_us_minimum_payload
Operation: write
Entities: employee, mobiles, emails, person
Summary: The Create Employee US Minimum Payload API is used to onboard a new applicant by providing their basic information. The API requires an OAuth 2.0 token for authorization and the content type must be 'application/json'. The request body must include the applicant's first and last name, and their work address, which should be in the US. Metadata can also be included optionally. The response includes detailed information about the onboarding event, including the applicant's personal details, job offer terms, and communication details. The response is structured as a list of events, each containing codes and identifiers for the service category, event name, originator, and actor, along with the applicant's data and job offer details.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee with Maximum Payload

ID: create_employee_with_maximum_payload
Operation: write
Entities: employee, mobiles, emails, person
Summary: The Create Employee with Maximum Payload API allows for the onboarding of a new employee with comprehensive details. The API requires an OAuth 2.0 token for authorization and expects a JSON payload containing the employee's first and last names, work email, personal emails, work address, and metadata. The employment position ID is optional. The response includes detailed information about the onboarding event, including the applicant's personal details, communication methods, and job offer specifics. The API is designed to handle maximum payloads for employee creation.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employee with Minimum Payload

ID: create_employee_with_minimum_payload
Operation: write
Entities: employee, mobiles, emails, person
Summary: The Create Employee with Minimum Payload API allows you to onboard a new employee with minimal required information. The API requires an OAuth 2.0 token for authorization and expects a JSON payload with the employee's first name, last name, and work address country code. The response includes detailed information about the onboarding event, including the event status, effective date, applicant details, and job offer information. The API is designed to streamline the onboarding process by providing essential employee data and job offer details.
Input Fields: Input Fields
Output Fields: Output Fields

Read Additional Corporate Groups Metadata

ID: get_additional_corporate_groups_metadata
Operation: read
Entities: work assignment, worker, corporate group
Summary: This API endpoint is used to read additional metadata about corporate groups associated with a worker's work assignment. It requires the worker's ID (aoid) and the work assignment ID (assignment-id) as path parameters. The request must include an OAuth 2.0 Bearer token for authentication and specify 'application/json' as the content type. The response returns metadata about the corporate groups in JSON format, including the datatype of the metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Get Applicant Onboarding Metadata

ID: get_applicant_onboarding_metadata
Operation: read
Entities: onboarding process, applicant, template
Summary: The Get Applicant Onboarding Metadata API retrieves metadata information related to the applicant onboarding process. It is accessed via a GET request to the endpoint '/hcm/v2/applicant.onboard/meta'. The API requires OAuth 2.0 authentication with client id and client secret. Optional headers include 'ADP-Acting-SessionID', 'ADP-Acting-Session-Expires', 'Cache-Control', 'sm_transactionid', 'ETag', and 'Content-Type'. The response includes metadata such as payroll group codes, personal profile names, onboarding template codes, and hire dates, with details on their properties like read-only status, optionality, and sequence.
Input Fields: Input Fields
Output Fields: Output Fields

Get Associate Work Locations from Validation Table

ID: get_associate_work_locations_from_validation_table
Operation: read
Entities: validation table, location, contact
Summary: This API retrieves a list of items from the validation table 'Associate Work Locations'. It uses the GET method and requires an Oauth 2.0 token for authorization. The API accepts optional query parameters such as $search for specifying search criteria, $filter for filter criteria, and version for the version of the validation table. The response includes a list of location codes set up for the client, with details such as name, custom tags, contact information, and an inactive indicator. The response headers include ETag and Content-Type. A 404 error is returned if an invalid API URI is used.
Input Fields: Input Fields
Output Fields: Output Fields

Get Business Units Validation Table

ID: get_business_units_validation_table
Operation: read
Entities: business unit, validation table, contact
Summary: This API retrieves a list of items in the validation table for Business Units. It uses the GET method and requires OAuth 2.0 authentication with a bearer token. The API accepts optional query parameters such as $search for specifying search criteria, $filter for filter criteria, and version for the version of the validation table. The response includes meta information about the business units, with details such as payroll group codes, name codes, custom tags, and contact information. The response headers include ETag and Content-Type.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Event Metadata for Worker Personal Communication Pager Removal

ID: get_event_metadata_for_worker_personal_communication_pager_removal
Operation: read
Entities: communication, event, worker
Summary: This API retrieves metadata for the event of removing a worker's personal communication pager. It requires the 'roleCode' header to specify the user's role, which can be employee, manager, practitioner, administrator, or supervisor. The 'Accept-Language' header is optional and specifies the preferred language for the response. The '$filter' query parameter is also optional and can be used to specify filter criteria. The response includes metadata information about the event.
Input Fields: Input Fields
Output Fields: Output Fields

Get Job Details from Validation Table

ID: get_job_details_from_validation_table
Operation: read
Entities: validation table, job title, job function
Summary: This API retrieves the details of a specific job record from the validation table. It requires the 'item-id' as a path parameter, which is the unique identifier of the job in the validation table. The request must include an OAuth 2.0 token in the Authorization header and specify 'application/json' as the Content-Type. The response includes headers such as ETag and Content-Type, and the body contains details like job code, name, alternate names, management position indicator, job function code, pay scale code, pay grade code, wage law coverage, industry classifications, job family code, occupational classifications, and inactive indicator.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Available Workers

ID: get_list_of_available_workers
Operation: read
Entities: work assignment, worker, organization unit
Summary: This API endpoint retrieves a list of all available workers that the requester is authorized to view. It uses the GET method and accepts optional query parameters such as $skip, $top, ADP-Acting-SessionID, $filter, $select, and $count to refine the results. The request can include a SiteMinder transaction ID in the headers if the request is initiated from an external service consumer authenticated by SMS. The response includes detailed information about each worker, including personal details, communication methods, work assignments, and more. The response headers provide additional metadata such as cache control and entity tags.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve List of Cost Centers from Validation Table

ID: get_list_of_cost_centers
Operation: read
Entities: cost center, payroll group, validation table
Summary: This API retrieves a list of cost centers from the validation table. It requires OAuth 2.0 authentication with a bearer token. The request can include optional query parameters such as $search for specifying search criteria, $filter for filtering results, and version for specifying the version of the validation table. The response includes a list of cost centers with details such as code, name, inactive status, and payroll group code.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Departments from Validation Table

ID: get_list_of_departments_from_validation_table
Operation: read
Entities: department, validation table, contact
Summary: This API retrieves a list of departments from the validation table. It supports optional query parameters such as $search for specifying search criteria, $filter for filtering results, and version for specifying the version of the validation table. The response includes department details such as payroll group code, department name, custom tags, contact information, and an inactive indicator. The API requires OAuth 2.0 authentication with a bearer token and accepts requests with 'application/json' content type.
Input Fields: Input Fields
Output Fields: Output Fields

Get List of Items in Person Custom Fields

ID: get_list_of_items_in_person_custom_fields
Operation: read
Entities: custom field, validation table, item
Summary: This API retrieves a list of items in the Person Custom Fields validation table. It uses the GET method and requires OAuth 2.0 authentication with a bearer token. The API accepts optional query parameters such as $search for specifying search criteria, $filter for filter criteria, and version for the version of the validation table. The response includes headers like ETag and Content-Type, and the body contains details about the validation table title, list of items with their attributes, and any exception messages.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Meta Information for Jobs Validation Tables

ID: get_meta_information_for_jobs_validation_tables
Operation: read
Entities: job, meta, validation table
Summary: This API retrieves meta information for jobs validation tables. It requires an OAuth 2.0 token for authentication and accepts 'application/json' as the content type. The API endpoint is '/hcm/v1/validation-tables/jobs/meta' and it uses the GET method. The query parameter '$method' is mandatory and must be set to 'get'. The response includes various headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', and 'sm_transactionid'. The response body contains detailed meta information about job codes, names, alternate names, job function codes, job family codes, pay scale codes, pay grade codes, wage law coverage codes, occupational classification IDs, industry classification IDs, and inactive indicators.
Input Fields: Input Fields
Output Fields: Output Fields

Get Meta Worker's Reportable Benefit Metadata

ID: get_meta_worker_reportable_benefit_metadata
Operation: read
Entities: assignment, benefit, worker
Summary: This API operation retrieves metadata information about a worker's reportable benefits for a specific work assignment. It requires the associate OID and work assignment ID as path parameters. The request must include an OAuth 2.0 Bearer token for authentication and specify 'application/json' as the content type. The response includes details such as the associate OID, worker ID, work assignment ID, and a list of reportable benefits with their earning codes, amounts, inactive indicators, and effective dates.
Input Fields: Input Fields
Output Fields: Output Fields

Get Metadata for US Tax Profile Local Income Tax Instruction

ID: get_metadata_for_us_tax_profile_local_income_tax_instruction
Operation: read
Entities: income tax instruction, payroll group, tax profile
Summary: This API endpoint retrieves metadata for the US Tax Profile Local Income Tax Instruction. It requires a roleCode header to specify the role of the user, which can be employee, manager, practitioner, administrator, or supervisor. The Authorization header is optional and provides the client's authorization token. The Accept-Language header is also optional and specifies the acceptable languages for the response. The response includes metadata details such as data event context and data transforms, which provide information about various tax profile attributes and their properties.
Input Fields: Input Fields
Output Fields: Output Fields

Get Paid Time Off Configurations for Associate

ID: get_paid_time_off_configurations_for_associate
Operation: read
Entities: associate, time off configuration, paid time off policy
Summary: This API endpoint retrieves the list of paid time off configurations for a specified associate, identified by the 'aoid' path parameter. The requestor's authorization may constrain the configuration details returned. The request requires an OAuth 2.0 token with client id and client secret scope. The 'ADP-Acting-SessionID' header is optional and used for 'Act-As' or 'On-Behalf-Of' scenarios. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'. The response body contains detailed information about the paid time off configurations, including position references, time notation codes, and various indicators related to time off policies.
Input Fields: Input Fields
Output Fields: Output Fields

Get Payroll Instructions for Worker

ID: get_payroll_instructions_for_worker
Operation: read
Entities: payroll instruction, deduction, worker
Summary: This API endpoint retrieves the list of all available payroll instructions for a specific worker identified by the Associate OID (aoid). The request requires the roleCode and Authorization headers, where roleCode specifies the role of the user (e.g., employee, manager) and Authorization provides the OAuth 2.0 token. The aoid is a required path parameter. Optional query parameters include $filter for specifying filter criteria and effectiveDate for filtering records based on their effective date. The response includes payroll instructions with details such as work assignment status, deduction instructions, payroll group code, file number, and agreement ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get Person Custom Fields Record Details

ID: get_person_custom_fields_record_details
Operation: read
Entities: custom field, validation table, item
Summary: This API retrieves the details of a specific record in the Custom Fields - Person Custom Fields. It requires the 'item-id' as a path parameter, which is the unique identifier of the item in a validation table. The request must include an OAuth 2.0 Bearer token in the Authorization header and accept 'application/json' as the content type. The response includes headers such as ETag and Content-Type, and the body contains the details of the person custom fields record.
Input Fields: Input Fields
Output Fields: Output Fields

Get Time Off Balances for a Worker

ID: get_time_off_balances_for_a_worker
Operation: read
Entities: time off balance, policy balance, worker
Summary: This API endpoint retrieves the time off balances for a specific worker identified by the 'aoid' path parameter. It supports optional query parameters such as 'asofdate', 'pfid', 'policycode', and 'earningtypecode' to filter the results based on date, position, policy, and earning type respectively. The request can include an optional 'ADP-Acting-SessionID' header for session management. The response includes detailed time off balances for various policies and positions, with headers providing metadata such as session expiration and caching directives. The API requires OAuth 2.0 authentication with client id and secret.
Input Fields: Input Fields
Output Fields: Output Fields

Get Time Off Requests for Associate

ID: get_time_off_requests_for_associate
Operation: read
Entities: organization, time off request, worker
Summary: This API endpoint retrieves the list of time off requests for an associate identified by the Associate Object Identifier (AOID) in the URI. The requestor is identified by the Organization Object ID (OOID) and associate-id in the header. The API uses the GET method and requires the 'application/json' content type. The 'aoid' path parameter is required, while the 'ADP-Acting-SessionID' header is optional. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', and 'ETag'. The response body contains detailed information about the paid time off requests, including request status, total quantity, and paid time off entries.
Input Fields: Input Fields
Output Fields: Output Fields

Get US Tax Profile Federal Income Tax Instruction Change Metadata

ID: get_us_tax_profile_federal_income_tax_instruction_change_metadata
Operation: read
Entities: payroll, federal income tax instruction, tax profile
Summary: This API endpoint retrieves metadata for changes in the US Tax Profile Federal Income Tax Instruction. It requires a 'roleCode' header to specify the user's role, which can be employee, manager, practitioner, administrator, or supervisor. The 'Authorization' header is optional and provides the client's authorization token. The 'Accept-Language' header is also optional and specifies the acceptable response languages. The response includes detailed metadata about the event context and transformations related to the US Tax Profile, including various tax instructions and codes.
Input Fields: Input Fields
Output Fields: Output Fields

Get US Tax Profile Local Income Tax Instruction Change Metadata

ID: get_us_tax_profile_local_income_tax_instruction_change_metadata
Operation: read
Entities: payroll, local income tax instruction, tax profile
Summary: This API endpoint retrieves metadata for the US Tax Profile Local Income Tax Instruction Change. It requires a roleCode header to specify the user's role, which can be employee, manager, practitioner, administrator, or supervisor. The Authorization header is optional and provides the client's OAuth 2.0 token. The Accept-Language header is also optional and specifies the preferred language for the response. The response includes metadata details such as data event context and data transforms, which provide information about various tax-related codes and indicators.
Input Fields: Input Fields
Output Fields: Output Fields

Get US Tax Profile Local Income Tax Instruction Metadata

ID: get_us_tax_profile_local_income_tax_instruction_metadata
Operation: read
Entities: us tax profile, event metadata, local income tax instruction
Summary: This API endpoint returns metadata for the US Tax Profile Local Income Tax Instruction removal event. It requires a roleCode header to specify the user's role, which can be employee, manager, practitioner, administrator, or supervisor. The Authorization header is optional and provides the client's OAuth 2.0 token. The Accept-Language header is also optional and specifies the preferred language for the response. The response includes metadata about the data event context and data transformations, detailing various attributes such as workerAssociateOID, usTaxProfilePayrollGroupCodeCodeValue, and effectiveDateTime.
Input Fields: Input Fields
Output Fields: Output Fields

Get US Tax Profiles for Workers

ID: get_us_tax_profiles_for_workers
Operation: read
Entities: federal tax instruction, us tax profile, worker
Summary: This API endpoint retrieves the list of all available US tax profiles for a specified worker, identified by the Associate OID (aoid). The request requires a roleCode header indicating the user's role (e.g., employee, manager, practitioner, administrator, supervisor) and optionally an Authorization header for OAuth 2.0 token. The aoid is a required path parameter, and an optional query parameter asOfDate can be used to specify the effective date for the tax profiles. The response includes detailed information about the worker's US tax profiles, including payroll file number, payroll group code, federal tax instructions, social security tax instructions, medicare tax instructions, federal unemployment tax instructions, and form 1099 instructions. The API returns a 200 status code for successful requests and a 400 status code for invalid requests, such as when the aoid is invalid or when the asOfDate is invalid.
Input Fields: Input Fields
Output Fields: Output Fields

Get Validation Tables Meta Information

ID: get_validation_tables_meta_information
Operation: read
Entities: filter criterion, meta information, validation table
Summary: This API endpoint retrieves meta information for validation tables. It requires an OAuth 2.0 Bearer token for authentication. The request can include optional query parameters such as $filter to specify filter criteria and $method to specify the HTTP method for which the meta is requested. The response includes headers like ADP-Acting-Session-Expires, Cache-Control, sm_transactionid, ETag, and ADP-Acting-SessionID, and a body containing meta information about various fields such as /nameCode/code, /nameCode/name, /payrollGroupCode, and /inactiveIndicator.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker's Additional Remuneration Metadata

ID: get_worker_additional_remuneration_metadata
Operation: read
Entities: work assignment, worker, additional remuneration
Summary: This API endpoint retrieves metadata for a worker's additional remuneration. It requires the worker's unique identifier (aoid) and the work assignment's unique identifier (assignment-id) as path parameters. The request must include an OAuth 2.0 Bearer token in the Authorization header and accept 'application/json' as the content type. The response provides metadata details such as read-only status, optional status, and visibility for various remuneration attributes like rate, currency code, effective date, name code, and inactive indicator.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker's Base Remuneration Update Metadata

ID: get_worker_base_remuneration_update_metadata
Operation: read
Entities: work assignment, worker, base remuneration
Summary: This API operation retrieves metadata about a worker's base remuneration update. It requires the worker's unique identifier (aoid) and the work assignment's unique identifier (assignment-id) as path parameters. The request must include an OAuth 2.0 Bearer token in the Authorization header and specify 'application/json' as the accepted content type. The response includes metadata about the base remuneration update in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Birth Name Change Event Metadata

ID: get_worker_birth_name_change_event_metadata
Operation: read
Entities: event metadata, session ID, worker
Summary: This API endpoint retrieves metadata for the worker birth name change event. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The API accepts optional headers such as 'ADP-Acting-SessionID' for acting session scenarios and 'sm_transactionid' for requests initiated from an external service consumer authenticated by SMS. The response includes metadata about the event in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Custom Field Details

ID: get_worker_custom_field_details
Operation: read
Entities: custom field, validation table, item
Summary: This API retrieves the details of a specific record in the Custom Fields validation table. It requires the 'item-id' as a path parameter, which is the unique identifier of the item in the validation table. The request must include an OAuth 2.0 Bearer token in the Authorization header and accept 'application/json' as the content type. The response includes details such as the validation table title, list of items with their IDs, codes, names, alternate names, custom attributes, and inactive indicators. The response headers include ETag and Content-Type.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Custom Fields

ID: get_worker_custom_fields
Operation: read
Entities: worker custom field, validation table, item
Summary: The Get Worker Custom Fields API retrieves a list of items in the Worker Custom Fields validation table. It supports optional query parameters such as $search for specifying search criteria, $filter for filtering results, and version for specifying the version of the validation table. The API requires OAuth 2.0 authentication with a bearer token. The response includes details of each item such as itemID, code, name, alternate names, custom attributes, and an inactive indicator. The response headers include ETag and Content-Type.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Details

ID: get_worker_details
Operation: read
Entities: address, communication, worker
Summary: The Get Worker Details API retrieves detailed information about a worker identified by the Associate OID (aoid). The API requires an OAuth 2.0 token and accepts optional query parameters such as ADP-Acting-SessionID and $select for specifying selection criteria. The response includes detailed worker information, including personal details, addresses, communication methods, and custom fields. The API returns headers like ADP-Acting-Session-Expires, Cache-Control, sm_transactionid, ETag, and Content-Type, along with a comprehensive JSON body containing worker details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker General Deduction Instruction

ID: get_worker_general_deduction_instruction
Operation: read
Entities: payroll instruction, deduction, worker
Summary: This API retrieves a worker's general deduction instruction based on the provided payroll instruction ID and associate OID. It requires the roleCode and Authorization headers, where roleCode specifies the user's role (e.g., employee, manager) and Authorization provides the OAuth 2.0 token. The path parameters include 'aoid' for the associate OID and 'payroll-instruction-id' for the payroll instruction ID. An optional query parameter '$filter' can be used to filter the results. The response includes details of the deduction instruction such as instruction ID, amount, description, and status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker General Deduction Instruction Change Metadata

ID: get_worker_general_deduction_instruction_change_metadata
Operation: read
Entities: event metadata, payroll instruction, worker
Summary: This API endpoint retrieves metadata for the Worker General Deduction Instruction Change event. It requires a roleCode header to specify the user's role, which can be employee, manager, practitioner, administrator, or supervisor. An optional $filter query parameter can be used to specify filter criteria. The API uses OAuth 2.0 for authorization, requiring a client id and client secret. The response includes metadata about the event, such as service category code, event name code, and various payroll instruction details. The response headers include Cache-Control, ETag, and Content-Type.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker General Deduction Instruction Start Metadata

ID: get_worker_general_deduction_instruction_start_metadata
Operation: read
Entities: event, worker, payroll instruction
Summary: The Get Worker General Deduction Instruction Start Metadata API returns metadata related to the start of a worker's general deduction instruction. It requires the 'roleCode' header to specify the role of the user, such as employee, manager, or administrator. Optional headers include 'Authorization' for OAuth 2.0 token. Query parameters like '$filter', 'payrollGroupCode', 'deductionCode', and 'associateOID' can be used to filter the results. The response includes metadata about the payroll service category, event name, and various payroll instruction details, including deduction codes and effective dates.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker General Deduction Instruction Stop Event Metadata

ID: get_worker_general_deduction_instruction_stop_event_metadata
Operation: read
Entities: event, deduction code, payroll instruction
Summary: This API endpoint retrieves metadata for the Worker General Deduction Instruction Stop event. It requires a roleCode header to specify the user's role, which can be employee, manager, practitioner, administrator, or supervisor. An optional Authorization header can be included for OAuth 2.0 token authentication. The API supports an optional $filter query parameter for specifying filter criteria. The response includes metadata about the event, such as service category code, event name code, and various payroll instruction details. The response headers include Cache-Control, ETag, and Content-Type.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Legal Name Change Event Metadata

ID: get_worker_legal_name_change_event_metadata
Operation: read
Entities: legal name change, event, worker
Summary: This API endpoint retrieves the metadata for a worker's legal name change event. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The request can include optional headers such as 'ADP-Acting-SessionID' for session identification in 'Act-As' scenarios and 'sm_transactionid' for SiteMinder transaction identification. The response includes metadata about the event in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Marital Status Change Event Metadata

ID: get_worker_marital_status_change_event_metadata
Operation: read
Entities: marital status, event metadata, worker
Summary: This API endpoint retrieves metadata for the event of a worker's marital status change. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The API accepts optional headers such as 'ADP-Acting-SessionID' for session management in 'Act-As' and 'On-Behalf-Of' scenarios, and 'sm_transactionid' for SiteMinder transaction identification. The response includes headers like 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'. The response body contains metadata about the worker's marital status change, including details about the worker, associate OID, effective date, and marital status code with a list of possible values such as 'Married', 'Single', 'Divorced', etc.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Meta Information

ID: get_worker_meta_information
Operation: read
Entities: worker information, worker profile, worker
Summary: The Get Worker Meta Information API retrieves metadata about workers. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The API accepts optional query parameters such as ADP-Acting-SessionID and $filter to specify filter criteria. The request headers may include sm_transactionid for SiteMinder transaction identification. The response includes headers like ADP-Acting-Session-Expires, Cache-Control, sm_transactionid, ETag, and Content-Type, and returns a meta in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Military Classification Change Event Metadata

ID: get_worker_military_classification_change_event_metadata
Operation: read
Entities: military classification, event metadata, worker
Summary: This API endpoint retrieves the metadata for the worker military classification change event. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The API accepts optional headers such as 'ADP-Acting-SessionID' for acting session scenarios and 'sm_transactionid' for SiteMinder transaction ID. The response includes metadata about the event in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Military Status Change Event Metadata

ID: get_worker_military_status_change_event_metadata
Operation: read
Entities: military status, event metadata, worker
Summary: This API endpoint retrieves metadata for the worker military status change event. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The request can include optional headers such as 'ADP-Acting-SessionID' for session management in 'Act-As' scenarios and 'sm_transactionid' for SiteMinder transaction identification. The response includes headers like 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and provides a detailed JSON body with metadata about the worker's military status, including code values and discharge date information.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Photo Remove Event Metadata

ID: get_worker_photo_remove_event_metadata
Operation: read
Entities: photo, event, worker
Summary: The Get Worker Photo Remove Event Metadata API retrieves metadata information related to the removal of a worker's photo. It uses the GET method and requires OAuth 2.0 authentication with client id/client secret. The API accepts optional query parameters such as ADP-Acting-SessionID and $filter for specifying filter criteria. The response includes headers like ADP-Acting-Session-Expires, Cache-Control, sm_transactionid, ETag, and Content-Type, along with a body containing metadata about the event context, including worker details and photo information.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Photo Upload Event Metadata

ID: get_worker_photo_upload_event_metadata
Operation: read
Entities: photo, event metadata, worker
Summary: The Get Worker Photo Upload Event Metadata API returns metadata related to the worker photo upload event. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The API accepts optional query parameters such as ADP-Acting-SessionID and $filter for specifying filter criteria. The response includes headers like ADP-Acting-Session-Expires, Cache-Control, sm_transactionid, ETag, and Content-Type, along with a detailed JSON body containing metadata about the worker photo upload event.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Preferred Name Change Event Metadata

ID: get_worker_preferred_name_change_event_metadata
Operation: read
Entities: preferred name, event metadata, worker
Summary: This API endpoint retrieves metadata for the event of changing a worker's preferred name. It uses the GET method and requires OAuth 2.0 authentication with client id and client secret. The API accepts optional headers such as 'ADP-Acting-SessionID' for session management in 'Act-As' scenarios and 'sm_transactionid' for SiteMinder transaction identification. The response includes headers like 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body containing metadata about the worker's preferred name change event, including details about the worker and their preferred name attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker Profile Picture

ID: get_worker_profile_picture
Operation: read
Entities: photo, image management, worker
Summary: This API retrieves a worker's profile picture using the GET method. The endpoint requires the 'aoid' path parameter, which is the Associate OID. Optionally, a query parameter 'ADP-Acting-SessionID' can be provided. The request headers may include 'sm_transactionid' for SiteMinder transaction ID. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'sm_transactionid', 'ETag', and 'Content-Type'. The API returns the worker's corporate contact photo, and there is no sample response body provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker's Taxable Benefits and Allowances

ID: get_worker_taxable_benefits_and_allowances
Operation: read
Entities: assignment, benefit, worker
Summary: This API retrieves a worker's tax taxable benefits and allowances, such as auto and cellular benefits, for a specific work assignment. The API requires the Associate Object ID (aoid) and Work Assignment ID (assignment-id) as path parameters. It uses OAuth 2.0 for authentication and accepts requests with 'application/json' content type. The response includes details such as the associateOID, workerID, workAssignmentID, and a list of reportable benefits with their earning codes, amounts, inactive indicators, and effective dates. If the aoid or assignment-id is invalid, a 400 status code is returned with an error message.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker US Local Tax Profile Details

ID: get_worker_us_local_tax_profile_details
Operation: read
Entities: local tax instruction, tax profile, worker
Summary: This API retrieves the complete details of a worker's US Local tax profile. It requires the 'aoid' and 'us-tax-profile-id' as path parameters, and the 'roleCode' as a required header. The 'Authorization' header is optional and provides the client's authorization token. The response includes detailed information about the worker's local tax profile, such as payroll file number, payroll group code, local tax instructions, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker US State Tax Profile Details

ID: get_worker_us_state_tax_profile_details
Operation: read
Entities: state tax instruction, us tax profile, worker
Summary: This API retrieves the complete details of a worker's US State tax profile. It requires the 'aoid' (Associate OID) and 'us-tax-profile-id' (US Tax Profile ID) as path parameters. The 'roleCode' header is mandatory and specifies the role of the user making the request, with possible values including employee, manager, practitioner, administrator, and supervisor. An optional 'Authorization' header can be included to provide the client's authorization token. The response includes detailed information about the worker's state income tax instructions, payroll region code, payroll group code, and payroll file number. The API supports OAuth 2.0 for authentication.
Input Fields: Input Fields
Output Fields: Output Fields

Get Worker's Additional Remunerations

ID: get_workers_additional_remunerations
Operation: read
Entities: remuneration, work assignment, worker
Summary: This API retrieves the additional remunerations for a worker, such as bonuses and commissions. It requires the Associate Object ID (aoid) and Work Assignment ID (assignment-id) as path parameters. The request must include an OAuth 2.0 Bearer token for authentication and specify 'application/json' as the content type. The response includes details of the worker's additional remunerations, including effective dates, remuneration types, and rates. If the aoid or assignment-id is invalid, a 400 status code is returned with an error message.
Input Fields: Input Fields
Output Fields: Output Fields

Add Business Mobile Telephone for Worker

ID: post_add_business_mobile_telephone_for_worker
Operation: write
Entities: mobile, business communication, worker
Summary: This API allows a worker to add a business mobile telephone number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.mobile.add' with a JSON body containing the worker's associateOID and the mobile number details (areaDialing and dialNumber). The request headers must include 'roleCode' to specify the user's role, and optionally 'Accept-Language' and 'Authorization'. The response includes the status of the event and the added mobile number details, with headers providing session expiration, cache control, ETag, and content type information.
Input Fields: Input Fields
Output Fields: Output Fields

Add Business Pager Number for Worker

ID: post_add_business_pager_number_for_worker
Operation: write
Entities: pager, business communication, worker
Summary: This API allows a worker to add a business pager number. It requires a POST request to the endpoint /events/hr/v1/worker.business-communication.pager.add with a JSON body containing the worker's associateOID and the pager details including countryDialing, areaDialing, and dialNumber. The request headers must include a roleCode indicating the user's role, and optionally Accept-Language and Authorization headers. The response includes headers such as ADP-Acting-Session-Expires, Cache-Control, ETag, and Content-Type, and a body with the event status and the added pager details.
Input Fields: Input Fields
Output Fields: Output Fields

Add New Code to Business Units Validation Table

ID: post_add_new_code_to_business_units_validation_table
Operation: write
Entities: business unit, validation table, contact
Summary: This API allows the addition of new business unit codes to a validation table. It requires a POST request to the endpoint '/hcm/v1/validation-tables/business-units' with a JSON body containing a list of items. Each item includes a 'nameCode' with a 'code' and optional 'name', 'customTags' with 'tagCode' and optional 'tagValue', 'contacts' with optional 'personName', 'address' with required fields 'lineOne', 'cityName', 'subdivisionCode', 'postalCode', and 'countryCode', and 'communication' with 'emails' and 'landlines'. The response includes the added business unit details. The API uses OAuth 2.0 for authentication and requires a bearer token in the header.
Input Fields: Input Fields
Output Fields: Output Fields

Add New Code to Cost Centers Validation Table

ID: post_add_new_code_to_cost_centers
Operation: write
Entities: cost center, payroll group, validation table
Summary: This API allows adding a new code to the Cost Centers validation table. It requires an OAuth 2.0 token for authorization and accepts requests in JSON format. The request body must include a list of items with details such as nameCode (code and name), payrollGroupCode, and an optional inactiveIndicator. The response will include the added cost center details or an error message if the operation fails, such as invalid payrollGroupCode or duplicate entries.
Input Fields: Input Fields
Output Fields: Output Fields

Add New Code to Validation Table - Associate Work Locations

ID: post_add_new_code_to_validation_table_associate_work_locations
Operation: write
Entities: work location, validation table, contact
Summary: This API allows adding a new code to a validation table for associating work locations. It requires a POST request to the endpoint '/hcm/v1/validation-tables/associate-work-locations' with a JSON body containing 'listItems'. Each item in 'listItems' includes 'nameCode' with 'code' and 'name', 'customTags' with 'tagCode' and 'tagValue', 'contacts' with 'personName', 'address', and 'communication' details. The response returns the added location details. The API requires OAuth 2.0 authorization with a client id/client secret scope. Possible error responses include missing required fields, invalid data formats, and uniqueness violations.
Input Fields: Input Fields
Output Fields: Output Fields

Add New Code to Validation Table - Departments

ID: post_add_new_code_to_validation_table_departments
Operation: write
Entities: department, validation table, contact
Summary: This API allows the addition of a new department code and its details to a validation table. The request is made using the POST method to the endpoint /hcm/v1/validation-tables/departments. The request body must include a list of items, each containing a payroll group code, department name and code, custom tags, contact details, and an inactive indicator. The contact details include a person's name, address, and communication details such as email and landlines. The response will return the added department details if successful. Various error responses are possible, including invalid landline name code, invalid payroll group code, invalid postal code, and more, each with a specific error message and code.
Input Fields: Input Fields
Output Fields: Output Fields

Add New Code to Validation Table - Jobs

ID: post_add_new_code_to_validation_table_jobs
Operation: write
Entities: job, industry classification, validation table
Summary: This API allows the addition of a new job title code and its details to the validation tables. It requires an OAuth 2.0 token for authorization and accepts requests in JSON format. The request body must include details such as the job code, name, management position indicator, alternate names, job function code, pay scale code, pay grade code, wage law coverage, industry classifications, job family code, occupational classifications, and an inactive indicator. The response includes the same details if the addition is successful. In case of errors, such as invalid codes or missing required fields, the API returns appropriate error messages.
Input Fields: Input Fields
Output Fields: Output Fields

Add Personal Fax Number for Worker

ID: post_add_personal_fax_number_for_worker
Operation: write
Entities: communication, worker, fax
Summary: This API allows a worker to add a personal fax number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.fax.add'. The request must include a 'roleCode' header indicating the user's role, and optionally an 'Authorization' token and 'Accept-Language' header. The request body should contain the worker's associateOID and the fax details including area dialing code and dial number. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body that confirms the addition of the fax number with details such as the formatted number.
Input Fields: Input Fields
Output Fields: Output Fields

Add US Tax Profile Local Income Tax Instruction

ID: post_add_us_tax_profile_local_income_tax_instruction
Operation: write
Entities: us tax profile, local income tax instruction, worker
Summary: This API allows the addition of a new US tax profile local income tax instruction. It requires a POST request to the endpoint '/events/payroll/v1/us-tax-profile.local-income-tax-instruction.add'. The request must include a 'roleCode' header specifying the user's role, and optionally 'Authorization' and 'Accept-Language' headers. The body of the request should contain event data including worker's associate OID, payroll file number, payroll group code, and work assignment ID. The transform section includes details like effective date, notification indicator, local tax code, jurisdiction indicators, tax type code, tax withholding status, tax allowance quantity, additional tax amount, and worked in allocation percentage. The response will confirm the addition of the local tax code to the worker's profile, with details of the event status and context.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker Business Email

ID: post_add_worker_business_email
Operation: write
Entities: business communication, worker, email
Summary: This API allows a worker to add a business email address. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.email.add' with a JSON body containing the worker's associateOID and the emailUri to be added. The request must include a 'roleCode' header indicating the user's role, and optionally an 'Authorization' token and 'Accept-Language' header. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body confirming the addition of the email with a status code of 'complete'.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker Business Fax Number

ID: post_add_worker_business_fax_number
Operation: write
Entities: business communication, worker, fax
Summary: This API allows a worker to add a business fax number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.fax.add' with a JSON body containing the worker's associateOID and the fax details (area dialing code and dial number). The request headers must include 'roleCode' to specify the user's role, and optionally 'Accept-Language' and 'Authorization'. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body that confirms the addition of the fax number with details such as the formatted number and status code.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker Business Landline

ID: post_add_worker_business_landline
Operation: write
Entities: landline, business communication, worker
Summary: This API allows a worker to add a business landline number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.landline.add'. The request must include a 'roleCode' header specifying the user's role, and optionally 'Accept-Language' and 'Authorization' headers. The request body should contain the worker's associateOID and the landline details including area dialing and dial number. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body that confirms the addition of the landline with details such as the formatted number.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker's Legal Address

ID: post_add_worker_legal_address
Operation: write
Entities: role code, legal address, worker
Summary: This API allows a worker to add a legal address. It requires a POST request to the endpoint /events/hr/v1/worker.legal-address.add with a JSON body containing the worker's associateOID and the details of the legal address including lineOne, lineTwo, cityName, countryCode, postalCode, and countrySubdivisionLevel1. The roleCode header is required to specify the role of the user making the request. The response includes the status of the event and the updated legal address details.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker Personal Address

ID: post_add_worker_personal_address
Operation: write
Entities: role, personal address, worker
Summary: The Add Worker Personal Address API allows a worker to add their personal address information. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-address.add' with a JSON body containing the worker's address details. The request must include the 'roleCode' header specifying the user's role, and optionally the 'Accept-Language' header for language preferences. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body confirming the addition of the address with status code 'complete'.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker's Personal Email

ID: post_add_worker_personal_email
Operation: write
Entities: communication, worker, email
Summary: This API allows a worker to add a personal email address. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.email.add'. The request must include a 'roleCode' header indicating the role of the user, and optionally an 'Authorization' token and 'Accept-Language' header. The body of the request should contain the worker's associateOID and the email address to be added. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body indicating the status of the event and the email address that was added.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker's Personal Landline

ID: post_add_worker_personal_landline
Operation: write
Entities: communication, landline, worker
Summary: This API allows a worker to add a personal landline number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.landline.add' with a JSON body containing the worker's associateOID and the landline details (areaDialing and dialNumber). The request headers must include 'roleCode' to specify the user's role, and optionally 'Accept-Language' to specify the preferred response language. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body that confirms the addition of the landline with details like the formatted number.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker Personal Mobile Telephone

ID: post_add_worker_personal_mobile_telephone
Operation: write
Entities: communication, mobile telephone, worker
Summary: This API allows a worker to add their personal mobile telephone number. The request requires a roleCode header to specify the role of the user, which can be employee, manager, practitioner, administrator, or supervisor. The Authorization header is optional and provides the client's authorization token. The Accept-Language header is also optional and specifies the acceptable languages for the response. The request body must include the worker's associateOID and the mobile number details, including areaDialing and dialNumber. The response includes headers such as ADP-Acting-Session-Expires, Cache-Control, ETag, and Content-Type, and the body contains the status of the event and the details of the added mobile number.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker's Personal Pager Number

ID: post_add_worker_personal_pager_number
Operation: write
Entities: communication, pager, worker
Summary: This API allows a worker to add a personal pager number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.pager.add'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.) and can optionally include an 'Accept-Language' header to specify the preferred language for the response. The request body should contain the worker's associateOID and the pager details including area dialing and dial number. The response will confirm the addition of the pager number and include headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'.
Input Fields: Input Fields
Output Fields: Output Fields

Add Worker's Taxable Benefits and Allowances

ID: post_add_worker_taxable_benefits
Operation: write
Entities: reportable benefit, work assignment, worker
Summary: This API operation allows the addition of a worker's tax taxable benefits and allowances, such as auto and cellular benefits. It requires the worker's unique identifier (aoid) and the work assignment's unique identifier (assignment-id) as path parameters. The request body must include details of the reportable benefits, including the earning code, amount, inactive indicator, and effective date. The API uses OAuth 2.0 for authentication and requires a bearer token. The response includes the associate's unique identifier, worker ID, work assignment ID, and the details of the reportable benefits added.
Input Fields: Input Fields
Output Fields: Output Fields

Applicant Onboarding

ID: post_applicant_onboarding
Operation: write
Entities: onboarding template, applicant onboarding, applicant profile
Summary: The Applicant Onboarding API is used to onboard applicants by providing necessary details such as onboarding template code, onboarding status, personal profile, worker profile, payroll profile, and tax profile. The API requires an OAuth 2.0 token for authentication and accepts requests in JSON format. Optional headers include 'ADP-Acting-SessionID' for acting session scenarios. The response includes a confirmation message with a unique message ID, the date and time of the message, the request status, and a list of messages with resource IDs and message codes.
Input Fields: Input Fields
Output Fields: Output Fields

Change US Tax Profile Federal Income Tax Instruction

ID: post_change_us_tax_profile_federal_income_tax_instruction
Operation: write
Entities: payroll, federal income tax instruction, tax profile
Summary: This API allows users to change a US tax profile federal income tax instruction. It requires a POST request to the specified endpoint with headers including 'roleCode', 'Accept-Language', and 'Authorization'. The request body should contain event data with details about the worker, tax profiles, and federal tax instructions. The response will confirm the change in the tax profile.
Input Fields: Input Fields
Output Fields: Output Fields

Change US Tax Profile Local Income Tax Instruction

ID: post_change_us_tax_profile_local_income_tax_instruction
Operation: write
Entities: local income tax instruction, us tax profile, event
Summary: This API allows changing a US tax profile's local income tax instruction. It requires a POST request to the endpoint '/events/payroll/v1/us-tax-profile.local-income-tax-instruction.change' with headers including 'roleCode' (required), 'Authorization', and 'Accept-Language'. The request body must contain an array of events detailing the worker's associateOID, payroll file number, payroll group code, item ID, effective date, and local tax instruction details such as local code, jurisdiction indicators, tax type code, tax withholding status, tax allowance quantity, and additional tax details. The response includes the updated tax profile details and a status code indicating success or failure.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker Business Email

ID: post_change_worker_business_email
Operation: write
Entities: business communication, worker, email
Summary: This API allows a worker to change their business email address. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.email.change' with a JSON body containing the worker's associateOID and the new emailUri. The request must include the 'roleCode' header specifying the user's role, and optionally 'Accept-Language' and 'Authorization' headers. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body detailing the event's status, originator, actor, and updated worker information.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Business Landline

ID: post_change_worker_business_landline
Operation: write
Entities: landline, business communication, worker
Summary: This API allows a worker to change their business landline number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.landline.change'. The request must include a 'roleCode' header specifying the role of the user (e.g., employee, manager, etc.). The request body should contain the worker's associateOID and the new landline details (areaDialing and dialNumber). The response includes the updated landline information, including the formatted number and item ID. The API uses OAuth 2.0 for authorization and supports optional headers for authorization token and language preferences.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Business Mobile Telephone

ID: post_change_worker_business_mobile_telephone
Operation: write
Entities: mobile telephone, business communication, worker
Summary: This API allows a worker to change their business mobile telephone number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.mobile.change' with a JSON body containing the worker's associateOID and the new mobile number details (areaDialing and dialNumber). The request must include a 'roleCode' header indicating the user's role, and optionally 'Accept-Language' and 'Authorization' headers. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body detailing the updated mobile number information.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker General Deduction Instruction

ID: post_change_worker_general_deduction_instruction
Operation: write
Entities: general deduction instruction, payroll instruction, worker
Summary: The Change Worker General Deduction Instruction API allows users to modify the general deduction instructions for a worker in the payroll system. The API requires a POST request to the endpoint '/events/payroll/v2/worker-general-deduction-instruction.change' with a JSON body containing the events data. The request headers must include 'roleCode' to specify the user's role, and optionally 'Authorization' for the client's authorization token. The body must include details such as 'associateOID', 'payrollGroupCode', 'payrollFileNumber', 'payrollAgreementID', 'itemID', and 'deductionCode'. The response includes headers like 'Cache-Control', 'ETag', and 'Content-Type', and a body with the updated deduction instructions and confirmation messages. The API supports OAuth 2.0 for authentication and requires specific client id/client secret scopes.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Legal Name

ID: post_change_worker_legal_name
Operation: write
Entities: event, legal name, worker
Summary: This API allows a worker to change their legal name in a given context. It requires a POST request to the endpoint '/events/hr/v1/worker.legal-name.change' with a JSON body containing the worker's associateOID and the new legal name details including given name, family name, middle name, nickname, salutation code, generation affix code, and qualification affix code. Optional headers include 'ADP-Acting-SessionID' and 'sm_transactionid'. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'sm_transactionid', 'ETag', 'ADP-Acting-SessionID', and 'Content-Type', along with a body that confirms the updated legal name details and the event status code.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Marital Status

ID: post_change_worker_marital_status
Operation: write
Entities: marital status, session, worker
Summary: This API is used to change a worker's marital status. It requires a POST request to the endpoint '/events/hr/v1/worker.marital-status.change' with a JSON body containing the worker's associateOID and the new marital status code. Optional headers include 'ADP-Acting-SessionID' and 'sm_transactionid'. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'sm_transactionid', 'ETag', 'ADP-Acting-SessionID', and 'Content-Type'. The response body contains the updated marital status and an event status code indicating the completion of the request.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker Military Classification

ID: post_change_worker_military_classification
Operation: write
Entities: military classification, event, worker
Summary: The Change Worker Military Classification API allows for updating a worker's military classification details, such as vets100 reporting indicators. It uses the POST method at the endpoint /events/hr/v1/worker.military-classification.change. The request requires an OAuth 2.0 token with client id/client secret scope. Optional headers include ADP-Acting-SessionID and sm_transactionid. The request body must include the worker's associateOID and the new military classification codes. The response includes headers like ADP-Acting-Session-Expires, Cache-Control, sm_transactionid, ETag, and ADP-Acting-SessionID, and a body confirming the updated military classification details.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker Military Status

ID: post_change_worker_military_status
Operation: write
Entities: military status, session, worker
Summary: This API is used to change the military status of a worker. It requires a POST request to the endpoint '/events/hr/v1/worker.military-status.change' with a JSON body containing the worker's associateOID and the new militaryStatusCode. The request headers may include optional parameters such as 'ADP-Acting-SessionID' and 'sm_transactionid'. The response includes headers like 'ADP-Acting-Session-Expires', 'Cache-Control', and 'ETag', and a body that confirms the change with an event status code.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Personal Email

ID: post_change_worker_personal_email
Operation: write
Entities: personal communication, worker, email
Summary: This API allows a worker to change their personal email address. It requires a POST request to the endpoint /events/hr/v1/worker.personal-communication.email.change with a JSON body containing the worker's associateOID and the new email address. The roleCode header is mandatory and specifies the role of the user making the request. Optional headers include Authorization for the client's token and Accept-Language for specifying the response language. The response includes headers such as ADP-Acting-Session-Expires, Cache-Control, ETag, and Content-Type, and a body confirming the change with the status code and updated email address.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Personal Fax Number

ID: post_change_worker_personal_fax_number
Operation: write
Entities: communication, fax number, worker
Summary: This API allows a worker to change their personal fax number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.fax.change' with a JSON body containing the worker's associateOID and the new fax number details (areaDialing and dialNumber). The request must include a 'roleCode' header indicating the user's role (e.g., employee, manager, etc.). Optionally, an 'Accept-Language' header can be included to specify the preferred language for the response. The response includes the updated fax number details and various headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Personal Landline

ID: post_change_worker_personal_landline
Operation: write
Entities: communication, landline, worker
Summary: This API allows a worker to change their personal landline number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.landline.change' with a JSON body containing the worker's associateOID and the new landline details (areaDialing and dialNumber). The request must include a 'roleCode' header specifying the user's role (e.g., employee, manager, etc.). Optionally, an 'Accept-Language' header can be included to specify the preferred language for the response. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body that confirms the change with details of the updated landline.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Personal Mobile Telephone

ID: post_change_worker_personal_mobile_telephone
Operation: write
Entities: communication, mobile, worker
Summary: This API allows a worker to change their personal mobile telephone number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.mobile.change' with a JSON body containing the worker's associateOID and the new mobile phone details. The request must include a 'roleCode' header specifying the user's role, and optionally an 'Accept-Language' header. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body detailing the updated mobile phone information.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker Personal Pager Number

ID: post_change_worker_personal_pager_number
Operation: write
Entities: communication, pager, worker
Summary: This API allows a worker to change their personal pager number. The request requires a roleCode header indicating the role of the user, which can be employee, manager, practitioner, administrator, or supervisor. An optional Accept-Language header can specify the preferred language for the response. The request body must include the worker's associateOID and the new pager details, including areaDialing and dialNumber. The response includes headers such as ADP-Acting-Session-Expires, Cache-Control, ETag, and Content-Type, and a body detailing the updated pager information, including nameCode, areaDialing, dialNumber, formattedNumber, and itemID.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Preferred Name

ID: post_change_worker_preferred_name
Operation: write
Entities: name, event, worker
Summary: This API allows a worker to change their preferred name in a given context. It uses the POST method at the endpoint /events/hr/v1/worker.preferred-name.change. The request must include a JSON body with the worker's associateOID and the new preferred name details (givenName, middleName, familyName1). Optional headers include ADP-Acting-SessionID and sm_transactionid for session and transaction identification. The response includes the updated preferred name details and status code indicating the completion of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Business Fax Number

ID: post_change_workers_business_fax_number
Operation: write
Entities: business communication, worker, fax
Summary: This API allows a worker to change their business fax number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.fax.change' with a JSON body containing the worker's associateOID and the new fax number details (areaDialing and dialNumber). The request headers must include a roleCode indicating the user's role (e.g., employee, manager) and optionally an Accept-Language and Authorization token. The response includes headers such as ADP-Acting-Session-Expires, Cache-Control, ETag, and Content-Type, and a body detailing the updated fax information, including the formatted number and item ID.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Business Pager Number

ID: post_change_workers_business_pager_number
Operation: write
Entities: pager, business communication, worker
Summary: This API allows a worker to change their business pager number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.pager.change'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, practitioner, administrator, supervisor). Optional headers include 'Accept-Language' for specifying acceptable response languages and 'Authorization' for providing the client's authorization token. The request body should contain an 'events' array with details about the worker's associateOID and the new pager number (areaDialing and dialNumber). The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body with the updated pager information, including the formatted number and item ID.
Input Fields: Input Fields
Output Fields: Output Fields

Create Corporate Group for Work Assignment

ID: post_create_corporate_group_for_work_assignment
Operation: write
Entities: work assignment, worker, corporate group
Summary: This API endpoint allows the creation of a corporate group for a specified work assignment. It requires the worker's unique identifier (aoid) and the work assignment's unique identifier (assignment-id) as path parameters. The request must include an OAuth 2.0 Bearer token for authentication and the content type should be 'application/json'. The request body should contain details about the corporate group, including group status, home work location, home organizational units, worker groups, labor union, and bargaining unit. The response will return the created corporate group details if successful, or an error message if there are issues with the request.
Input Fields: Input Fields
Output Fields: Output Fields

Create Paid Time Off Request

ID: post_create_paid_time_off_request
Operation: write
Entities: policy, time off request, worker
Summary: The Create Paid Time Off Request API allows users to create a request for paid time off, managed by the Time System. The request is complete once successfully created, and its status can be viewed in the list of paid time off details. The API requires an Associate ID as a path parameter and accepts an optional session ID in the headers for 'Act-As' and 'On-Behalf-Of' scenarios. The request body must include details such as request status, position reference, total quantity, and paid time off entries. The response includes headers like ADP-Acting-Session-Expires, Cache-Control, ETag, and Content-Type, and provides details of the created request, including request ID, status, and paid time off entries. The API uses OAuth 2.0 for authentication and requires a client ID and secret.
Input Fields: Input Fields
Output Fields: Output Fields

Create Worker's Additional Remunerations

ID: post_create_worker_additional_remunerations
Operation: write
Entities: work assignment, worker, additional remuneration
Summary: This API endpoint is used to create additional remunerations for a worker, such as bonuses or commissions. The request requires the worker's unique identifier (aoid) and the work assignment's unique identifier (assignment-id) as path parameters. The request body must include details of the additional remunerations, such as the type, rate, effective date, and whether it is inactive. The response includes the worker's ID, work assignment ID, and details of the additional remunerations added. The API uses OAuth 2.0 for authentication and requires a bearer token in the request headers.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Business Mobile Telephone for Worker

ID: post_remove_business_mobile_telephone_for_worker
Operation: write
Entities: communication, mobile, worker
Summary: This API allows a worker to remove their business mobile telephone number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.mobile.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.). Optional headers include 'Accept-Language' for specifying acceptable response languages and 'Authorization' for providing the client's authorization token. The request body should contain an 'events' array with the 'associateOID' of the worker. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body indicating the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Remove US Tax Profile Local Income Tax Instruction

ID: post_remove_us_tax_profile_local_income_tax_instruction
Operation: write
Entities: us tax profile, local income tax instruction, worker
Summary: This API is used to remove an existing US tax profile local income tax instruction. It requires a POST request to the endpoint '/events/payroll/v1/us-tax-profile.local-income-tax-instruction.remove'. The request must include a 'roleCode' header indicating the user's role, and optionally 'Authorization' and 'Accept-Language' headers. The request body should contain event data specifying the worker's associate OID, payroll group code, payroll file number, work assignment ID, and local tax instruction details. The response will indicate the success or failure of the operation, providing details about the removed local tax instruction and any relevant messages.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker Business Email

ID: post_remove_worker_business_email
Operation: write
Entities: business communication, worker, email
Summary: The Remove Worker Business Email API allows a worker to remove their business email address. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.email.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.). Optional headers include 'Accept-Language' for specifying acceptable response languages and 'Authorization' for providing the client's authorization token. The request body should contain an 'events' array with the 'associateOID' of the worker whose email is to be removed. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body indicating the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker Business Fax Number

ID: post_remove_worker_business_fax_number
Operation: write
Entities: fax number, business communication, worker
Summary: This API allows a worker to remove their business fax number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.fax.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.). Optionally, 'Accept-Language' and 'Authorization' headers can be included. The request body should contain an 'events' array with the 'associateOID' of the worker whose fax number is to be removed. The response will confirm the removal with a status code of 200 and include headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'. The response body will indicate the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker Business Landline

ID: post_remove_worker_business_landline
Operation: write
Entities: landline, business communication, worker
Summary: This API allows a worker to remove a business landline. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.landline.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, practitioner, administrator, supervisor). Optional headers include 'Accept-Language' for specifying acceptable response languages and 'Authorization' for providing the client's authorization token. The request body should contain an 'events' array with the 'associateOID' of the worker. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body with the event status code and worker's 'associateOID'.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker's Business Pager Number

ID: post_remove_worker_business_pager_number
Operation: write
Entities: pager, business communication, worker
Summary: This API allows a worker to remove their business pager number. It requires a POST request to the endpoint '/events/hr/v1/worker.business-communication.pager.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.). Optionally, 'Accept-Language' and 'Authorization' headers can be included. The request body should contain an 'events' array with the 'associateOID' of the worker whose pager number is to be removed. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body indicating the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker's Personal Address

ID: post_remove_worker_personal_address
Operation: write
Entities: role, personal address, worker
Summary: This API allows a worker to remove a personal address. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-address.remove'. The request must include a 'roleCode' header specifying the role of the user (e.g., employee, manager, etc.). An optional 'Accept-Language' header can be included to specify the preferred language for the response. The request body must contain an 'events' array with details about the worker and the personal address to be removed. The response will confirm the removal of the address and include headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker's Personal Email

ID: post_remove_worker_personal_email
Operation: write
Entities: personal communication, worker, email
Summary: This API allows a worker to remove their personal email address. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.email.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.) and can optionally include an 'Accept-Language' header to specify the preferred language for the response. The request body should contain an 'events' array with the 'associateOID' of the worker whose email is to be removed. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body indicating the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker's Personal Fax Number

ID: post_remove_worker_personal_fax_number
Operation: write
Entities: communication, fax number, worker
Summary: This API allows a worker to remove their personal fax number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.fax.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.) and can optionally include an 'Accept-Language' header to specify the preferred language for the response. The request body should contain an 'events' array with the 'associateOID' of the worker whose fax number is to be removed. The response will confirm the removal with a status code of 200 and include headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'. The response body will indicate the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker's Personal Landline

ID: post_remove_worker_personal_landline
Operation: write
Entities: communication, landline, worker
Summary: This API allows a worker to remove their personal landline number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.landline.remove'. The request must include a 'roleCode' header indicating the user's role, and optionally an 'Accept-Language' header to specify the preferred response language. The request body should contain the 'associateOID' of the worker whose landline is to be removed. The response will confirm the removal with a status code of 200 and include headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker's Personal Mobile Telephone

ID: post_remove_worker_personal_mobile_telephone
Operation: write
Entities: communication, mobile telephone, worker
Summary: This API allows a worker to remove their personal mobile telephone number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.mobile.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.) and can optionally include an 'Accept-Language' header to specify the preferred language for the response. The request body should contain an 'events' array with the 'associateOID' of the worker whose mobile number is to be removed. The response will confirm the removal with a status code of 200 and include headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'. The response body will indicate the completion of the event with the 'associateOID' of the worker.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker's Personal Pager Number

ID: post_remove_worker_personal_pager_number
Operation: write
Entities: personal communication, pager, worker
Summary: This API allows a worker to remove their personal pager number. It requires a POST request to the endpoint '/events/hr/v1/worker.personal-communication.pager.remove'. The request must include a 'roleCode' header indicating the role of the user (e.g., employee, manager, etc.) and can optionally include an 'Accept-Language' header to specify the preferred language for the response. The request body should contain an 'events' array with the 'associateOID' of the worker whose pager number is to be removed. The response will confirm the removal with a status code of 200 and include headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type'. The response body will indicate the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Worker Photo

ID: post_remove_worker_photo
Operation: write
Entities: photo, event, worker
Summary: The Remove Worker Photo API is used to remove the photo metadata and file of a worker. It is a POST request to the endpoint '/events/hr/v1/worker.photo.remove'. The request requires an OAuth 2.0 token and accepts 'application/json' as the content type. Optional parameters include 'ADP-Acting-SessionID' as a query parameter and 'sm_transactionid' as a header. The request body must include the 'associateOID' of the worker whose photo is to be removed and the event name code 'worker.photo.remove'. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'sm_transactionid', 'ETag', and 'Content-Type'. The response body confirms the removal of the worker's photo with a status code of 'complete' and a request status code of 'succeeded'.
Input Fields: Input Fields
Output Fields: Output Fields

Stop Worker General Deduction Instruction

ID: post_stop_worker_general_deduction_instruction
Operation: write
Entities: payroll instruction, deduction, worker
Summary: The Stop Worker General Deduction Instruction API is used to stop a general deduction instruction for a worker. It requires a POST request to the endpoint '/events/payroll/v2/worker-general-deduction-instruction.stop' with a JSON body containing event details. The request headers must include 'roleCode' to specify the user's role and optionally 'Authorization' for access. The body must include worker details such as 'associateOID', 'payrollFileNumber', 'payrollAgreementID', and 'itemID'. The response includes the stopped deduction instruction details and headers like 'Cache-Control', 'ETag', and 'Content-Type'. A 400 status code is returned for invalid 'payrollAgreementID' or 'payrollFileNumber'.
Input Fields: Input Fields
Output Fields: Output Fields

Update Worker's Birth Name

ID: post_update_worker_birth_name
Operation: write
Entities: event, worker, birth name
Summary: This API updates a worker's birth name. It requires a POST request to the endpoint '/events/hr/v1/worker.birth-name.change' with a JSON body containing the worker's associateOID and the new birth name. Optional headers include 'ADP-Acting-SessionID' and 'sm_transactionid'. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'sm_transactionid', 'ETag', 'ADP-Acting-SessionID', and 'Content-Type'. The response body confirms the update with the event status code and the updated birth name.
Input Fields: Input Fields
Output Fields: Output Fields

Upload Worker Photo

ID: post_upload_worker_photo
Operation: write
Entities: photo, event, worker
Summary: The Upload Worker Photo API allows clients to upload a worker's corporate contact photo using a 'multipart/mixed' Content-Type request header. This API accepts both JSON payload and photo image file in a single request. The request requires an OAuth 2.0 token and may include optional parameters such as ADP-Acting-SessionID and sm_transactionid. The response includes headers like ADP-Acting-Session-Expires, Cache-Control, sm_transactionid, ETag, and Content-Type, and provides a JSON body with details about the uploaded photo.
Input Fields: Input Fields
Output Fields: Output Fields

Start Worker General Deduction Instruction

ID: post_worker_general_deduction_instruction
Operation: write
Entities: payroll instruction, deduction, worker
Summary: The Start Worker General Deduction Instruction API is used to initiate a general deduction instruction for a worker in the payroll system. It requires a POST request to the endpoint '/events/payroll/v2/worker-general-deduction-instruction.start' with a JSON body containing details about the worker and the payroll instruction. The request headers must include 'roleCode' to specify the user's role, and optionally 'Authorization' for client authorization. The body includes details such as the worker's associateOID, payroll group code, payroll file number, payroll agreement ID, effective date, deduction code, deduction rate, and deduction goal. The API responds with a status code of 201 for successful creation, and includes headers like 'Cache-Control', 'ETag', and 'Content-Type'. The response body contains the details of the payroll instruction and a confirmation message with process messages if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Worker Legal Address Change

ID: post_worker_legal_address_change
Operation: write
Entities: address, event, worker
Summary: The Worker Legal Address Change API allows for updating the legal address of a worker. It requires a POST request to the endpoint '/events/hr/v1/worker.legal-address.change' with a JSON body containing the worker's associateOID and the new legal address details. The request headers must include 'roleCode' to specify the user's role, and optionally 'Authorization' for the client's token and 'Accept-Language' for language preferences. The response includes headers such as 'ADP-Acting-Session-Expires', 'Cache-Control', 'ETag', and 'Content-Type', and a body detailing the updated legal address and event status.
Input Fields: Input Fields
Output Fields: Output Fields

Worker Legal Address Remove

ID: post_worker_legal_address_remove
Operation: write
Entities: address, event, worker
Summary: The Worker Legal Address Remove API allows for the removal of a worker's legal address. It requires a POST request to the endpoint /events/hr/v1/worker.legal-address.remove with a JSON body containing the worker's associateOID. The request must include a roleCode header indicating the user's role, such as employee or manager. An optional Accept-Language header can specify the preferred language for the response. The response includes headers like ADP-Acting-Session-Expires and Cache-Control, and a body indicating the completion status of the event.
Input Fields: Input Fields
Output Fields: Output Fields

Worker Personal Address Change

ID: post_worker_personal_address_change
Operation: write
Entities: role code, personal address, worker
Summary: The Worker Personal Address Change API allows for updating the personal address of a worker. It requires a POST request to the endpoint /events/hr/v1/worker.personal-address.change with a JSON body containing the worker's associateOID and personal address details. The roleCode header is mandatory and specifies the role of the user making the request. The API supports an optional Accept-Language header to specify the preferred language for the response. The response includes headers such as ADP-Acting-Session-Expires, Cache-Control, ETag, and Content-Type, and a body that confirms the updated address details with a status code indicating completion.
Input Fields: Input Fields
Output Fields: Output Fields

Change Worker's Primary Assignment

ID: put_change_workers_primary_assignment
Operation: write
Entities: work assignment, worker
Summary: This API operation changes a worker's primary assignment. It requires the worker's AOID and the assignment ID as path parameters. The request must include an OAuth 2.0 Bearer token for authentication. The request body should specify the effective date and the list of work assignments with their details. The API can optionally accept an 'asOfDate' query parameter to specify the effective date for the change. The response includes the effective date, updated work assignments, and a confirmation message indicating the success or failure of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update Worker's Taxable Benefits and Allowances

ID: put_update_taxable_benefits
Operation: write
Entities: benefit, work assignment, worker
Summary: This API operation updates a worker's taxable benefits and allowances, such as auto and cellular benefits. It requires a PUT request to the endpoint '/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/reportable-benefits' with OAuth 2.0 authentication. The request body must include details of the reportable benefits, such as earning code, amount, inactive indicator, and effective date. The response will confirm the update with the worker's ID, work assignment ID, and the updated benefits. If the request is invalid, such as missing or incorrect earning codes, a 400 status code with an error message will be returned.
Input Fields: Input Fields
Output Fields: Output Fields

Update Worker's Base Remuneration

ID: put_update_worker_base_remuneration
Operation: write
Entities: work assignment, worker, base remuneration
Summary: This API operation updates a worker's base remuneration details such as salary, hourly rate, daily rate, or pay period rate. The request requires the worker's unique identifier (aoid) and the assignment-id as path parameters. The request body must include the reason code, base remuneration details (including effective date and rate amounts), pay cycle code, standard hours, wage law coverage, premium rate factor, and a tipped worker indicator. The API uses OAuth 2.0 for authentication and requires a bearer token in the headers. The response includes the updated remuneration details and confirms the successful update or provides error details if the update fails.
Input Fields: Input Fields
Output Fields: Output Fields

Update Worker Dates

ID: put_update_worker_dates
Operation: write
Entities: worker date, work assignment, worker
Summary: This API operation updates the worker dates for a specific work assignment. It requires the worker ID (aoid) and the assignment ID as path parameters. The request must include an OAuth 2.0 token for authorization and the content type must be 'application/json'. The request body should contain the seniority date, credited service date, adjusted service date, early retirement date, and retirement date of the worker. The response returns the updated dates in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Update Worker's Additional Remunerations

ID: put_worker_additional_remunerations
Operation: write
Entities: work assignment, worker, additional remuneration
Summary: This API operation updates a worker's additional remunerations such as bonuses and commissions. It requires the worker's ID and work assignment ID as path parameters. The request body must include details of the additional remunerations to be updated, including type, rate, currency, effective date, and an inactive indicator. The API uses OAuth 2.0 for authentication and requires a bearer token. The response includes the updated remunerations and a user message providing additional information about the operation's success or failure.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employee Details

ID: update_employee_details
Operation: write
Entities: employee, email, address, personalDetails
Summary: The Update Employee Details API allows you to update various details of an employee, including their name, email addresses, and addresses. The API requires an OAuth 2.0 token for authorization unless accessed through knit. The request must include the employee's unique ID in the path parameters and a JSON body with the updated details. The response provides detailed event information for each type of update, including address, personal email, work email, and name changes, with status codes and event metadata.
Input Fields: Input Fields
Output Fields: Output Fields