UKG Ready
API integration

list_all_ukg_ready_company_profiles

List company profiles in UKG Ready, optionally filtered by profile type. Deprecated as of April 03, 2023; see the v2 companies lookup profiles endpoints as an alternative. Returns: id, name, type. No required parameters. The filter supports field name `type` with the `IN` operator, e.g. type:in:PAY_CALC_PROFILE,ACCESS_PROFILE_DEVICE.

list_all_ukg_ready_employees

List employees the authenticated user has permission to view in UKG Ready. Returns: id, full_name, account_status, employee_id, username, external_id. Optional: ein_id, terminated. Required: cid.

get_single_ukg_ready_employee_by_id

Get a single UKG Ready employee by id. Returns the core employee record including id, full_name, account_status, employee_id, username, and external_id. Required: id, cid.

create_a_ukg_ready_employee

Create a new employee record in UKG Ready covering core employee fields. Additional API calls are required for related data such as pay information or demographics. Returns: id. Requires a JSON request body. Required: cid.

delete_a_ukg_ready_employee_by_id

Delete a UKG Ready employee by id. Deletion is restricted when the Pay Statement status is Open, Closed, or Finalized, and employees who are their own manager cannot self-delete. Returns an empty 204 response on success. Required: id, cid.

ukg_ready_employees_me

Get basic information about the currently authenticated UKG Ready employee, along with links to operations providing detailed employee information. Returns: id. Required: cid.

update_a_ukg_ready_employee_by_id

Apply partial updates to a UKG Ready employee by id using JSON Patch. Returns: id. Accepts a JSON Patch request body. Required: id, cid.

ukg_ready_employees_overwrite

Update the core employee information for a UKG Ready employee by id. Returns: id. Accepts a JSON request body with updated employee fields. Required: id, cid.

list_all_ukg_ready_employees_info

List employee information for a specific pay group in UKG Ready. Returns employee information records scoped to the specified pay group. Default limit 50, max 200 per page. Required: cid, pay_group_id.

list_all_ukg_ready_employee_accrual_balances

Search through employee accrual balances in UKG Ready. Returns: acc_id, time_off_id, hours. Restricted to companies with TA or PR subsystems and Accruals functionality. Required: filter.

create_a_ukg_ready_employee_accrual_balance

Create employee accrual balances in UKG Ready. Returns an array of accrual balance items. The hours, external_accrued, external_taken, and external_carry_over fields use HH:MM (or HH.DD) format. To set updated_to_date to end of accrual year, leave date empty and set set_to_end_of_accrual_year to true.

ukg_ready_employee_accrual_balances_bulk_update

Update employee accrual balances in UKG Ready. Returns an array of accrual balance items. The hours, external_accrued, external_taken, and external_carry_over fields use HH:MM (or HH.DD) format. To set updated_to_date to end of accrual year, leave date empty and set set_to_end_of_accrual_year to true.

list_all_ukg_ready_employee_deductions

List scheduled deductions for an employee in UKG Ready. Returns: id. Required: cid, employee_id.

get_single_ukg_ready_employee_deduction_by_id

Get a single employee scheduled deduction by id in UKG Ready. Returns: id. Required: id, cid, employee_id.

create_a_ukg_ready_employee_deduction

Create a new scheduled deduction for an employee in UKG Ready. Returns: id. Required: cid, employee_id.

update_a_ukg_ready_employee_deduction_by_id

Update an employee scheduled deduction by id in UKG Ready. Returns: id. Required: id, cid, employee_id.

delete_a_ukg_ready_employee_deduction_by_id

Delete an employee scheduled deduction by id in UKG Ready. Returns: id. Required: id, cid, employee_id.

create_a_ukg_ready_company_direct_deposit

Create a new direct deposit account in UKG Ready. Returns the created direct deposit object including id, routingType, account_number, account_type, percentage, and amount. If the calculation method is GROSS_EARNING, NET_PAY, or DIRECT_DEPOSIT_PER_OF_REMAINDER, the percentage property is required; if FLAT_AMOUNT, the amount property is required. Required: cid.

ukg_ready_company_direct_deposits_mass_edit

Perform a mass edit on selected direct deposits in UKG Ready. Returns the updated direct deposit objects including id, routingType, account_number, account_type, percentage, and amount. A JSON request body specifying the selected deposits and changes is required. Required: cid.

get_single_ukg_ready_company_direct_deposit_by_id

Get a single employee direct deposit account by id in UKG Ready. Returns the direct deposit object including id, type, account_number, account_type, active_from, active_to, routingType, amount, and percentage. Required: id, cid.

update_a_ukg_ready_company_direct_deposit_by_id

Update an existing employee direct deposit account by id in UKG Ready. Returns the updated direct deposit object including id, routingType, account_number, account_type, percentage, and amount. A JSON request body with the fields to update is required. Required: id, cid.

delete_a_ukg_ready_company_direct_deposit_by_id

Delete an existing employee direct deposit account by id in UKG Ready. Returns: id, type. Required: id, cid.

create_a_ukg_ready_company_contact

Create employee contacts in UKG Ready. Returns: id. The national_id_numbers field is ignored if the request includes any of the backward-compatible fields (bsn, social_insurance, social_security, national_insurance). Required: cid.

get_single_ukg_ready_company_contact_by_id

Get a single employee contact by id in UKG Ready. Returns: id. Backward-compatible fields (bsn, social_insurance, social_security, national_insurance) are populated only if data exists; national_id_numbers is the new pattern for national identification numbers. Required: id, cid.

update_a_ukg_ready_company_contact_by_id

Update an existing employee contact in UKG Ready. Returns: id. The national_id_numbers field is ignored if the request includes any of the backward-compatible fields. Required: id, cid.

delete_a_ukg_ready_company_contact_by_id

Delete an employee contact by id in UKG Ready. Returns: id. Required: id, cid.

list_all_ukg_ready_compensation_histories

List Base Compensation history entries for all subordinates in a UKG Ready company. Each item contains an id referencing a detailed compensation resource. Returns: id. Required: cid.

create_a_ukg_ready_compensation_history

Create an Employee Base Compensation entry in UKG Ready. The auto_pay field is processed only for companies with the Payroll subsystem. Returns: id. Required: cid.

get_single_ukg_ready_compensation_history_by_id

Get detailed information about a specific Employee Base Compensation entry in UKG Ready. Returns: id. Required: id, cid.

update_a_ukg_ready_compensation_history_by_id

Update an Employee Base Compensation entry in UKG Ready by id. The auto_pay field is processed only for companies with the Payroll subsystem. Returns: id. Required: id, cid.

delete_a_ukg_ready_compensation_history_by_id

Delete a specific Employee Base Compensation entry in UKG Ready by id. Returns: id. Required: id, cid.

ukg_ready_compensation_histories_list_by_employee

List Base Compensation history entries for a specific employee in UKG Ready. Each item contains a reference to a detailed resource. Returns: id. Required: cid, employee_id.

list_all_ukg_ready_company_timeoffs

List time off categories from a company in UKG Ready. If no filter is provided, returns all time offs of the company. Returns: id, parent, visible, priority, default_counter, def_pay_category, populate_scheduled, duration.

create_a_ukg_ready_company_timeoff

Create time off categories in UKG Ready. Set parent to null for a root-level category; the visible property can be set only by SA users. Priority defaults to 50 if not specified. Returns: id.

get_single_ukg_ready_company_timeoff_by_id

Get a single time off category by id in UKG Ready. Returns all time off properties including id, visible, priority, default_counter, def_pay_category, populate_scheduled, and duration, with certain fields conditionally populated based on the company's enabled functionality. Required: id.

ukg_ready_company_timeoffs_bulk_update

Update existing time off categories in UKG Ready. A correct time off id must be provided in the body. Set parent to null to make a category root in hierarchy. Returns: id.

ukg_ready_company_timeoffs_bulk_delete

Delete multiple time off categories by ids in UKG Ready. Returns: id. Required: filter.

create_a_ukg_ready_company_employee_type

Create new employee-types in UKG Ready. The name must be unique for each type. Returns: items.

ukg_ready_company_employee_types_bulk_update

Update existing employee-types in UKG Ready. Existing types can be referenced by either id or name; to change the name of a type, the id must be specified. Returns: items.

list_all_ukg_ready_company_pay_period_profiles

List pay period profiles in UKG Ready. Returns: pay_period_profiles. If no filter is provided, all profiles for the authenticated company are returned. Use the filter parameter with id:in: to select specific profiles by id.

create_a_ukg_ready_company_pay_period_profile

Create pay period profiles in UKG Ready. Returns: items. Set auto_lock_pp to -1 to disable Auto Lock Pay Period; otherwise set the number of days after period end. Use -1 for day of month or week number to select Last.

ukg_ready_company_pay_period_profiles_bulk_update

Update existing pay period profiles in UKG Ready. Returns: items. Provide id or name in the request body to identify the target profile — at least one is required. Set auto_lock_pp to -1 to disable Auto Lock Pay Period; otherwise set the number of days after period end. Use -1 for day of month or week number to select Last.

ukg_ready_company_pay_period_profiles_bulk_delete

Delete pay period profiles by ids in UKG Ready. Returns: items. Use the id field with the IN operator to specify which profiles to delete (e.g. id:in:111111,111113,111151). Required: filter.

list_all_ukg_ready_company_pay_types

List all existing pay types in a UKG Ready company. Returns: pay_types. If no company parameter is supplied, the operation runs against the company of the current authentication token.

create_a_ukg_ready_company_pay_type

Create pay types in a UKG Ready company. A unique name must be passed for each new pay type. Returns: items.

ukg_ready_company_pay_types_bulk_update

Update pay types in a UKG Ready company. A correct id or name must identify the pay type; to change the name itself, the id is required. Returns: items.

ukg_ready_company_pay_types_bulk_delete

Delete multiple pay types in a UKG Ready company by ids in one call. Returns: items. Required: filter.

create_a_ukg_ready_profiles_holiday

Create a new holiday profile in UKG Ready. The name must be unique among holiday profiles. Returns: items.

ukg_ready_profiles_holidays_bulk_update

Update an existing holiday profile in UKG Ready. Existing profiles can be referenced by either id or name; to update the name itself, id must be specified. Returns: items. At least one of id or name must be provided to identify the target profile.

ukg_ready_employee_passwords_bulk_update

Update the existing password for the current logged-in user in UKG Ready. Returns: index. Requires a JSON request body with the password update details.

list_all_ukg_ready_employee_todos

List workflow To Do items for a user in UKG Ready. Returns only Overtime Request, Time Off Request, Timesheet Approval, Timesheet Change Request, and Counter Distribution workflows; each workflow type has its own response body. Returns: items. Specify the target user and company via optional employee and company identifier parameters.

create_a_ukg_ready_todo_action

Perform an Approve or Reject action on an employee workflow To Do item in UKG Ready. Returns: processed. Only Overtime Request, Time Off Request, Timesheet Approval, and Timesheet Change Request workflow types are supported; allowed actions are Approve and Reject.

list_all_ukg_ready_todo_counts

Get the count of an employee's to-do items in UKG Ready. Returns: count. Company can be specified via company, company_shortname, company_id, or company_external_id; if none are provided, the current user's company is used.

list_all_ukg_ready_employee_work_time_preferences

List work time preferences for an employee in UKG Ready. The target employee is identified by one of several optional identifier parameters and the target company by one of several optional company parameters. Returns: id, employee, cycle_day_count, cycle_start_date, type, preferences, weight.

create_a_ukg_ready_employee_work_time_preference

Create employee work time preferences in UKG Ready. Returns: id, type. If cycle_day_count or cycle_start_date change, all previous preferences are deleted.

ukg_ready_employee_work_time_preferences_bulk_update

Update existing employee work time preferences in UKG Ready, looked up by id and employee. Returns: id, type. If cycle_day_count or cycle_start_date change, all previous preferences are deleted.

ukg_ready_employee_work_time_preferences_bulk_delete

Delete multiple employee work time preferences in UKG Ready by filter (ids) or by employee-specific fields. Returns: id, type. If only employee fields are specified, all preferences for that employee are deleted.

list_all_ukg_ready_employees_v_1

List employees in a UKG Ready company. Returns: account_id, full_name, account_status. The fields parameter controls which fields are included; account_id is always returned as a base field. Deprecated as of June 22, 2017 — use the v2 companies employees endpoint instead.

create_a_ukg_ready_employees_v_1

Create employees in UKG Ready. Returns: account_id. The country attribute must conform to ISO 3166-1 alpha-3. Deprecated as of June 22, 2017 — use the v2 companies employees endpoint instead.

get_single_ukg_ready_employees_v_1_by_id

Get a single employee's account information in UKG Ready by id. Returns: account_id. Deprecated as of June 22, 2017 — use the v2 companies employees endpoint instead. Required: id, company.

ukg_ready_employees_v_1_bulk_update

Update existing employees in UKG Ready. Returns: account_id. Identify the target employee using one of account_id, employee_id, username, external_id, ein_name, or ein_tax_id. Deprecated as of June 22, 2017 — use the v2 companies employees endpoint instead.

ukg_ready_employees_status_bulk_update

Update an employee account status in UKG Ready. Returns an items array of updated status records whose shape depends on company configuration. For termination, the status value must match an existing account status with type "Terminated" and termination_details is required. The request body schema varies by company configuration including enabled sub-systems and manager settings.

list_all_ukg_ready_company_accounts

List system accounts in a UKG Ready company that the user has permissions to view. The response schema varies by company configuration (enabled sub-systems, manager permissions). Returns: id, attributes. Required: cid.

create_a_ukg_ready_company_account

Create a new system account record in UKG Ready. The Id field is ignored if included in the request body. Returns: id. Required: cid.

get_single_ukg_ready_company_account_by_id

Get the core system account record by id in UKG Ready, containing the bulk of the account information. The response schema varies by company configuration (enabled sub-systems, manager permissions). Returns: id, attributes. Required: id, cid.

update_a_ukg_ready_company_account_by_id

Update the core system account information by id in UKG Ready. The id field is ignored if included in the request body. Returns: id. Required: id, cid.

delete_a_ukg_ready_company_account_by_id

Delete a system account by id in UKG Ready. Returns an empty 204 response on success. Required: id, cid.

ukg_ready_company_accounts_delete_lock

Remove the lock from a ukgready system account, re-enabling login. During unlock the user's password and TOTP Authenticator can optionally be reset. Returns a success response object. Required: cid, account_id.

ukg_ready_company_accounts_bulk_update

Lock a ukgready system account, preventing the user from logging in. Returns a success response object. Required: cid, account_id.

list_all_ukg_ready_company_benefits

List employee benefit plans for employees in a UKG Ready company, filtered by a coverage date range. Returns: id. Required: cid, coverage_start, coverage_end.

get_single_ukg_ready_company_benefit_by_id

Get a single employee benefit plan by id in UKG Ready. Returns: id. Required: id, cid.

list_all_ukg_ready_employee_ptorequests

List time off requests for the authenticated employee in UKG Ready. Returns: id, from_date, to_date. Requires TA|TALITE|HR functionality enabled in company setup.

get_single_ukg_ready_employee_ptorequest_by_id

Get a single time off request by id in UKG Ready. Returns an employee object containing the time off request details. Required: id.

create_a_ukg_ready_employee_ptorequest

Create a new time off request in UKG Ready, either for self or on behalf of an employee. Returns a success object whose inner fields are not documented upstream. Allowed request types: FullDay, Partial, PartialBlk, Multiple, Dynamic.

ukg_ready_employee_ptorequests_list_v_2

List time off requests for the authenticated employee in a specific UKG Ready company. Returns: id, from_date, to_date. Required: cid.

ukg_ready_employee_ptorequests_get_v_2

Get information about a single time off request for an employee in UKG Ready. Returns: employee. Required: cid, ptorequest_id.

ukg_ready_employee_ptorequests_create_v_2

Create a new time off request in UKG Ready. The `timeoff` field is required; allowed request types are FullDay, Partial, PartialBlk, Multiple, and Dynamic. Returns a success confirmation object. Required: cid.

ukg_ready_employee_ptorequests_delete_v_2

Delete one or more time off requests in UKG Ready by providing comma-separated request IDs. Returns a success confirmation object. Required: cid, ids.

ukg_ready_employee_ptorequests_bulk_delete

Delete time off requests in UKG Ready using a filter to identify requests for deletion. Returns: id. A filter should be specified to identify which requests to delete.

create_a_ukg_ready_employee_contract

Create employee contracts in UKG Ready (v1, deprecated as of October 20, 2022 — use create_v2 instead). If working_days is not specified, all days are marked as working; if an empty array, all days are not working. Returns an array of contract objects including id, start_date, end_date, working_days, days_per_week, and fte.

ukg_ready_employee_contracts_create_v_2

Create employee contracts in UKG Ready (v2). If working_days is not specified, all days are marked as working; if an empty array, all days are not working. Returns an array of created contract objects including id, start_date, end_date, working_days, days_per_week, and fte. Required: cid.

ukg_ready_employee_contracts_update_v_2

Update existing employee contracts in UKG Ready (v2). Contracts are looked up using id (contract_id or external_id) and/or start_date and end_date; error code 13004 is returned if a contract cannot be found. Returns an array of updated contract objects including id, start_date, end_date, working_days, days_per_week, and fte. Required: cid.

ukg_ready_employee_contracts_delete_v_2

Delete multiple employee contracts in UKG Ready by their IDs. Returns an empty 204 response on success. Required: cid, contract_ids.

ukg_ready_employee_contracts_bulk_update

Update existing employee contracts in UKG Ready (v1, deprecated as of October 20, 2022 — use update_v2 instead). Contracts are looked up using id (contract_id or external_id) and/or start_date and end_date. Returns an array of updated contract objects including id, start_date, end_date, working_days, days_per_week, and fte.

ukg_ready_employee_contracts_bulk_delete

Delete multiple employee contracts by ids in UKG Ready (v1, deprecated as of October 20, 2022). Returns an array of deleted contract objects including id, start_date, end_date, working_days, and fte. Required: filter.

list_all_ukg_ready_notes

List notes for a specified Base Compensation history entry in UKG Ready. Returns: notes. Required: cid, history_id.

list_all_ukg_ready_compensation_additionals

List additional compensation records for all subordinates in UKG Ready. Returns: id. Required: cid.

get_single_ukg_ready_compensation_additional_by_id

Get detailed information about a specific additional compensation record in UKG Ready by id. Returns: id. Required: id, cid.

update_a_ukg_ready_compensation_additional_by_id

Update an employee's additional compensation record in UKG Ready by id. Returns: id. Required: id, cid.

delete_a_ukg_ready_compensation_additional_by_id

Delete an employee's additional compensation record in UKG Ready by id. Returns an empty 204 response on success. Required: id, cid.

ukg_ready_compensation_additionals_list_by_employee

List additional compensation records for a specific employee in UKG Ready. Returns: id. Required: cid, employee_id.

create_a_ukg_ready_compensation_additional

Create an Additional Compensation record for an employee in UKG Ready. Returns the created additional compensation record including its id. Required: cid, employee_id.

list_all_ukg_ready_company_payrolls

List company payrolls in UKG Ready for payroll processing. Returns: id, pay_date, start_date, end_date, status, type, ein_id. Date range must be less than one year; pay_date and pay_date_from may not be used together. Required: cid.

create_a_ukg_ready_company_payroll

Create a new unscheduled payroll in UKG Ready. Supports types such as Historical, Regular, and Void; available types vary by company. Returns: id, type. A JSON request body specifying the payroll configuration is required. Required: cid.

get_single_ukg_ready_company_payroll_by_id

Get detailed information about a specific payroll in UKG Ready. Returns: id, type. Required: id, cid.

delete_a_ukg_ready_company_payroll_by_id

Delete a specific payroll in UKG Ready. Returns: id, type. Required: id, cid.

ukg_ready_company_payrolls_clear_messages

Clear error messages for specified payrolls in UKG Ready. Returns a success response. A JSON request body specifying the target payrolls is required. Required: cid.

ukg_ready_company_payrolls_close

Close specified payrolls in UKG Ready by performing the closing process. Returns: jobs. A request body specifying the target payrolls is required. Required: cid.

ukg_ready_company_payrolls_deliver

Deliver specified payrolls in UKG Ready, performing the delivery process on payrolls that are already closed. Returns: jobs. A request body specifying the target payrolls is required. Required: cid.

ukg_ready_company_payrolls_finalize

Finalize specified payrolls in UKG Ready, performing the finalize process on payrolls that are already closed. Returns: jobs. A request body specifying the target payrolls is required. Required: cid.

ukg_ready_company_payrolls_initiate

Initiate one or more payrolls in UKG Ready. Returns: jobs. A request body specifying the target payrolls is required. Required: cid.

ukg_ready_company_payrolls_recalculate

Recalculate pay statements on specified payrolls in UKG Ready. Returns: jobs. A request body specifying the target payrolls is required. Required: cid.

ukg_ready_company_payrolls_reopen

Reopen the specified payrolls in UKG Ready. Returns: jobs. A JSON request body identifying the payrolls to reopen is required. Required: cid.

ukg_ready_company_payrolls_rollback

Roll back the specified finalized payrolls in UKG Ready. Returns: jobs. A JSON request body identifying the payrolls to roll back is required. Required: cid.

ukg_ready_company_payrolls_submit

Submit the specified closed payrolls in UKG Ready. Returns: jobs. A JSON request body identifying the payrolls to submit is required. Required: cid.

ukg_ready_company_payrolls_sync_time

Sync time entries on the specified payrolls in UKG Ready. Returns: jobs. A JSON request body identifying the payrolls to sync time for is required. Required: cid.

ukg_ready_company_payrolls_delete_sync_time

Delete synced time entries on the specified payrolls in UKG Ready. Returns: jobs. A JSON request body identifying the payrolls to delete synced time for is required. Required: cid.

ukg_ready_company_payrolls_finalize_deliver

Finalize and deliver closed payrolls in UKG Ready. Returns the jobs array containing job objects for each processed payroll. Required: cid.

ukg_ready_company_payrolls_execute_accruals

Execute the accruals process on specified payrolls in UKG Ready. Returns a generic success object. Required: cid.

ukg_ready_company_payrolls_execute_accrual_balances

Execute accrual balances on specified payrolls, payroll, or pay period in UKG Ready. Returns a task_id object for tracking the accrual balances execution. Required: cid.

list_all_ukg_ready_lookup_additional_compensation_types

List additional compensation types configured for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_asset_categories

List all asset categories defined within a company in UKG Ready. Returns an items array of asset category objects. The company identifier is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_lookup_asset_types

List all asset types within a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_assets

List all Company Assets for a company in UKG Ready. Returns: items. The company id is resolved from the credential context. Required: cid.

list_all_ukg_ready_lookup_benefit_plans

List benefit plans configured for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_benefit_types

List all benefit types configured for a company in UKG Ready. Returns: items. The company identifier is supplied by the credential, so no caller-supplied parameters are required. Required: cid.

list_all_ukg_ready_lookup_credential_types

List credential types configured for a company in UKG Ready. Returns: items. The company identifier is resolved from the integration credential. Required: cid.

list_all_ukg_ready_lookup_deduction_codes

List supported deduction codes for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_degrees

List degrees configured in a UKG Ready company. Returns: items. Requires the HR or HR (Small Business Edition) subsystem. Required: cid.

list_all_ukg_ready_lookup_document_types

List defined document types for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_earning_codes

List supported earning codes for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_education_levels

List education levels configured for a company in UKG Ready. Returns: items. Requires the HR or HR (Small Business Edition) subsystem. Required: cid.

list_all_ukg_ready_lookup_eins

List supported EINs (Employer Identification Numbers) for a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_lookup_employee_types

List enabled employee types for a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_lookup_eye_colors

List eye colors in UKG Ready based on data already entered in account demographics for other accounts. Returns: items. Required: cid.

list_all_ukg_ready_lookup_first_screens

List supported first screens for a UKG Ready company. Returns: items. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_lookup_groups

List company or account groups in UKG Ready filtered by object type. Returns: groups. Optional free-text search matches against group name, description, and type_name; sort by name, description, or type_name with `-` prefix for descending. Required: cid, object_type.

list_all_ukg_ready_lookup_hiring_stages

List all hiring stages for a company in UKG Ready. Returns: items. The company must have the Recruitment marketplace product and an HR or HR Small Business Edition subsystem. Required: cid.

list_all_ukg_ready_lookup_interview_locations

List interview locations for a company in UKG Ready. Returns a collection of interview location records in the items array. Required: cid.

list_all_ukg_ready_lookup_interview_names

List interview names for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_job_application_status

List job application statuses available for a company in UKG Ready. Returns an array of job application status objects. Required: cid.

list_all_ukg_ready_lookup_job_categories

List job categories in UKG Ready as defined inside cost center jobs. Returns: items. The company identifier is supplied automatically from credentials. Required: cid.

list_all_ukg_ready_lookup_job_change_reasons

List supported job change reasons in UKG Ready. Returns: items. The company identifier is supplied by the credential. Required: cid.

list_all_ukg_ready_job_req_job_categories

List job categories from open and active job requisitions in a UKG Ready company. Returns: items. Requires the HR subsystem and RecruitmentSaaSHR marketplace product. The company id is supplied by the integration credential; optionally pass ein_id to filter by a specific EIN. Required: cid.

list_all_ukg_ready_job_req_job_locations

List job locations associated with open and active job requisitions in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_lookup_jobs

List jobs defined by cost center 10 in UKG Ready. Requires at least one of the TLM, HR, or HR Small Business Edition subsystems. Returns: items. The upstream schema does not enumerate individual job fields. Required: cid.

list_all_ukg_ready_loa_reasons

List leave of absence reasons defined in a UKG Ready company. Returns: items. Optional: account_id to filter reasons for a specific account. Required: cid.

list_all_ukg_ready_lookup_locales

List supported locales for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_manual_counters

List manual counters defined in a UKG Ready company for a given timesheet date and owner. Returns: items. Required: cid, date, owner_id.

list_all_ukg_ready_lookup_notification_tags

List all notification tags for a company in UKG Ready, filtered by event. Returns: items. Example event_id: APPLICANT_COMMUNICATION. Required: cid, event_id.

list_all_ukg_ready_notification_profiles

List all notification profiles in a UKG Ready company, filtered by a notification event. Returns: items. Example event_id: APPLICANT_COMMUNICATION. Required: cid, event_id.

list_all_ukg_ready_lookup_object_lists

List object lists of a given type in UKG Ready. Returns: items. Required: cid, type.

list_all_ukg_ready_overtime_reasons

List the defined overtime reasons for a company in UKG Ready. Returns an items array of overtime reason objects. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_lookup_pay_cal_profiles

List pay calculation profiles defined in a UKG Ready company when Pay Calculation 1 or 2 is enabled. Returns an items array of pay calculation profile objects. Required: cid.

list_all_ukg_ready_lookup_pay_categories

List defined pay categories for a UKG Ready company, filtered by timesheet date, owner, and record type. Returns: items. Valid type values: TIME, EXTRA_PAY, ADJUSTMENT. Required: cid, date, owner_id, type.

list_all_ukg_ready_lookup_pay_grades

List supported pay grades in a UKG Ready company. Returns: items. The company id is supplied by the credential and does not need to be provided by the caller. Required: cid.

list_all_ukg_ready_lookup_pay_period_profiles

List pay period profiles for a company in UKG Ready. Returns: items. Optional: include_emp_profile to include the active employee pay period profile in the results. Required: cid.

list_all_ukg_ready_lookup_pay_statement_types

List supported pay statement types in UKG Ready. Returns: items. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_lookup_pay_types

List pay types for a company in UKG Ready. Returns a list of pay type objects in the items array. Requires at least one active subsystem: TLM, HR, HR (Small Business Edition), PR, or SCHEDULE. Required: cid.

list_all_ukg_ready_lookup_payroll_batch_types

List supported payroll batch types in UKG Ready. Returns: items. The company id is supplied by the credential and is not caller-provided. Required: cid.

list_all_ukg_ready_lookup_payroll_types

List supported payroll types for a company in UKG Ready. Returns an items array of payroll type objects. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_profile_specific_eins

List supported EINs in UKG Ready based on the user's security profile configuration. Returns: items. Required: cid.

list_all_ukg_ready_profiles_accrual_profiles

List Accruals(1.0) Profiles in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_profiles_accruals

List Accruals Profiles in a specified UKG Ready company. Returns: items. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_profiles_attestation_profiles

List Attestation Profiles for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_profiles_counter_distribution_profiles

List Counter Distribution Profiles in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_profiles_data_retention_profiles

List Data Retention Profiles in a UKG Ready company. Returns: items. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_profiles_delivery_policies

List delivery policies in a UKG Ready company. Returns: items. The type parameter is functionally required to return results — if omitted, an empty list is returned. Example type values: PayStatementPR (US), PayStatementPRCanada (Canada). Required: cid.

list_all_ukg_ready_profiles_demographic_profiles

List Demographic Profiles in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_profiles_device_acceses

List Device Access Profiles for a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_profiles_employee_perspective_profiles

List Employee Perspectives Profiles in a UKG Ready company. Returns: items. The company id is resolved from the linked account credential. Required: cid.

list_all_ukg_ready_profiles_holiday_profiles

List Holiday Profiles in a UKG Ready company. Returns: items. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_profiles_leave_of_absence_profiles

List Leave of Absence Profiles in a UKG Ready company. Returns: items. The company is determined by the credential context. Required: cid.

list_all_ukg_ready_profiles_pay_calc_profiles

List Pay Calculation Profiles in a UKG Ready company. Returns: items. The company identifier is resolved from the credential, so no caller-supplied parameters are required. Required: cid.

list_all_ukg_ready_profiles_pay_calc_2_profiles

List Pay Calculation 2.0 Profiles for a company in UKG Ready. Returns: items.0 Profile objects; individual profile fields are not documented in the upstream API specification). Required: cid.

list_all_ukg_ready_profiles_pay_grades

List Pay Grades configured in a UKG Ready company. Returns an items array of pay grade objects. Required: cid.

list_all_ukg_ready_profiles_pay_period_profiles

List Pay Period Profiles for a company in UKG Ready. Returns: items. The company id is supplied by the credential, so no caller-supplied parameters are required. Required: cid.

list_all_ukg_ready_profiles_pay_prep_profiles

List Pay Prep Profiles available in a UKG Ready company. Returns: items. The company id is resolved automatically from the credential. Required: cid.

list_all_ukg_ready_profiles_performance_reviews

List Performance Review Profiles for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_profiles_points

List Points profiles in a UKG Ready company. Returns: items. The company is identified by the credential context, not by a caller-supplied parameter. Required: cid.

list_all_ukg_ready_profiles_pst_populations

List paystatement population profiles in a specified UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_profiles_retirement_plan_profiles

List retirement plan profiles for a specified company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_profiles_role_profiles

List role profiles for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_profiles_scheduler_profiles

List scheduler profiles in a UKG Ready company. Returns: items. The company identifier is resolved from the credential. Required: cid.

list_all_ukg_ready_profiles_security_profiles

List security profiles for a company in UKG Ready. Returns: items. The company identifier is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_profiles_succession_profiles

List Succession profiles for a specific UKG Ready company. Returns a collection of succession profile objects in an items array. Required: cid.

list_all_ukg_ready_profiles_system_acceses

List system access profiles for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_profiles_time_off_planning_profiles

List Time Off Planning Profiles for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_profiles_timesheet_profiles

List Timesheet Profiles available in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_profiles_trainings

List Training Profiles for a company in UKG Ready. Returns: items. The company identifier is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_profiles_ts_auto_population_profiles

List TS Auto Population Profiles in a UKG Ready company. Returns: items. The upstream API does not enumerate individual profile fields. Required: cid.

list_all_ukg_ready_profiles_workday_breakdown_profiles

List Workday Breakdown Profiles in UKG Ready. Returns: items. The company identifier is resolved from the credential, not supplied by the caller. Required: cid.

list_all_ukg_ready_profiles_working_time_regulations

List Working Time Regulation Profiles in a UKG Ready company. Returns a collection of working time regulation profile objects via the items array. The company id is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_profiles_workschedule_profiles

List Work Schedule profiles in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_lookup_questionnaires

List questionnaires in UKG Ready for Job Requisition, Benefit Enrollment, Recruitment Evaluation, or Peer Feedback. Returns: items. Required: cid, type.

list_all_ukg_ready_lookup_reason_codes

List reason codes defined in a UKG Ready company for a specific timesheet context. Returns: items. Required: cid, date, owner_id, type.

list_all_ukg_ready_lookup_referrals

List supported referrals for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_shift_premiums

List defined shift premiums in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_lookup_skills

List defined skills in a UKG Ready company. Returns: items. Required: cid.

list_all_ukg_ready_lookup_tax_codes

List supported tax codes for a company in UKG Ready. Returns the items array containing tax code objects for the company. Required: cid.

list_all_ukg_ready_lookup_termination_reasons

List termination reasons defined in a UKG Ready company. Returns: items. The company_id path parameter is resolved from the credential, not supplied by the caller. Required: cid.

list_all_ukg_ready_lookup_timezones

List defined timezones for a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_unions

List active unions for a company in UKG Ready. Returns: _total_count. Required: cid.

list_all_ukg_ready_lookup_vehicles

List all vehicles within a company in UKG Ready. Returns: items. Required: cid.

list_all_ukg_ready_lookup_vendors

List active vendors for a company in UKG Ready. Returns: items. The company identifier is supplied by the credential, not by the caller. Required: cid.

list_all_ukg_ready_lookup_worker_types

List worker types for a company in UKG Ready. Returns: items. Requires at least one of the TLM, HR, HR Small Business Edition, PR, or SCHEDULE subsystems. Required: cid.

list_all_ukg_ready_lookup_workers_comp_codes

List active workers' comp codes for a company in UKG Ready. Returns a list of workers comp code records in an items array. Required: cid.

list_all_ukg_ready_employee_announcements

List active announcements for a UKG Ready employee based on their security profile and group. Returns: announcements. The is_popup filter can be used to retrieve only popup-level and company-level announcements. Required: cid, employee_id.

ukg_ready_announcement_popups_bulk_delete

Disable the announcement popup on login for a specific employee and announcement in UKG Ready. Returns a generic success response object. Required: cid, employee_id, announcement_id.

ukg_ready_announcements_statistics_bulk_update

Update announcement popup statistics for an employee in UKG Ready, optionally indicating whether the popup was closed via the close button. Returns a success response object. Required: cid, employee_id.

list_all_ukg_ready_employee_attendances

List attendance data for a specific employee in UKG Ready. Returns a status object containing the employee's attendance information. Required: cid, employee_id.

list_all_ukg_ready_employee_badges

List badge information for a UKG Ready employee. Returns: badges. Required: cid, employee_id.

ukg_ready_employee_badges_bulk_update

Update badge information for a UKG Ready employee. Returns the updated badge information as an object whose field-level shape is not further documented by the API. Required: cid, employee_id.

list_all_ukg_ready_employee_benefits

List an employee's benefit plans in UKG Ready. Returns the benefits array containing the employee's benefit plan objects. Required: cid, employee_id.

list_all_ukg_ready_employee_contacts

List employee contacts for a specific employee in UKG Ready. Returns: contacts. Required: cid, employee_id.

list_all_ukg_ready_employee_country_fields

List the country-specific field values for a UKG Ready employee. Returns: country_fields. Required: cid, employee_id.

ukg_ready_employee_country_fields_bulk_update

Replace the country-specific field values for a UKG Ready employee. Returns the updated country_fields array. Required: cid, employee_id.

list_all_ukg_ready_employee_credentials

List employee credentials for a specific employee in UKG Ready. Returns: employee_credentials. Required: cid, employee_id.

list_all_ukg_ready_employee_currencies

Get the currency configuration for a specific employee in UKG Ready. Returns the employee's currency object containing currency details. Required: cid, employee_id.

list_all_ukg_ready_employee_demographics

Get the employee demographic information in UKG Ready. Returns: citizenship. Required: cid, employee_id.

ukg_ready_employee_demographics_partial_update

Partially update the employee demographic information in UKG Ready using JSON Patch. Required field validation is not performed for fields marked as required in the demographic profile. Returns: citizenship. Required: cid, employee_id.

ukg_ready_employee_demographics_bulk_update

Replace the full employee demographic information in UKG Ready. Required field validation is not performed for fields marked as required in the demographic profile. Returns: citizenship. Required: cid, employee_id.

list_all_ukg_ready_employee_direct_deposits

List an employee's direct deposit accounts in UKG Ready. Returns each deposit record including id, type, account_number, account_type, active_from, active_to, and routingType (the country-specific bank routing standard such as ABA for US or EFT for Canada). Required: cid, employee_id.

list_all_ukg_ready_employee_holidays

List holidays from a Holiday Profile assigned to a single employee in UKG Ready. Returns: holidays. The optional year parameter returns holidays from a specific year; if omitted, holidays from the current year are returned. Required: cid, employee_id.

list_all_ukg_ready_employee_hr_custom_fields

List HR custom fields for a specific employee in UKG Ready. Returns the hr_custom_fields array containing company-configured HR custom field objects whose field names and values are company-specific and not enumerable from the API schema. Required: cid, employee_id.

ukg_ready_employee_hr_custom_fields_bulk_update

Update HR custom fields for a specific employee in UKG Ready. Returns the updated employee HR custom fields response object with company-configured field names and values that are not enumerable from the API schema. Required: cid, employee_id.

list_all_ukg_ready_employee_ids

List uploaded documents for an employee in UKG Ready. Each document object represents metadata for a single uploaded file, covering both global and attached documents. Returns: documents. Required: cid, employee_id.

list_all_ukg_ready_employee_manager_replacements

List manager replacements for an employee in UKG Ready. Returns: has_failed_replacements. Required: cid, employee_id.

list_all_ukg_ready_employee_password_policies

Get the password policy for a specific UKG Ready employee. Returns: name. Required: cid, employee_id.

list_all_ukg_ready_employee_pay_infos

Get employee pay information from UKG Ready. Returns: default_job. Required: cid, employee_id.

ukg_ready_employee_pay_infos_bulk_update

Update employee pay information in UKG Ready. Returns the updated pay information including default_job. Required: cid, employee_id.

list_all_ukg_ready_employee_profiles

List employee profiles information for a specific employee in UKG Ready. Returns: attestation. Required: cid, employee_id.

ukg_ready_employee_profiles_bulk_update

Update employee profiles information for a specific employee in UKG Ready. If a profile does not support effective dates, send a single-element array and effective_from is ignored. Returns: attestation. Required: cid, employee_id.

list_all_ukg_ready_employee_skills

List employee skills for a specific employee in UKG Ready. Returns: employee_skills. Required: cid, employee_id.

ukg_ready_employee_skills_bulk_update

Update employee skills for a specific employee in UKG Ready. Returns a success response object whose fields are not documented in the API source. Required: cid, employee_id.

list_all_ukg_ready_employee_tax_infos

Get employee tax information for a specific employee in UKG Ready. Returns: employee-tax-type. Required: cid, employee_id.

ukg_ready_employee_tax_infos_bulk_update

Update employee tax information for a specific employee in UKG Ready. Returns: employee-tax-type. Required: cid, employee_id.

list_all_ukg_ready_employee_time_entries

List existing time entries for a specified UKG Ready employee within a given date range. Returns: employee. Maximum date range is 31 days. Required: cid, employee_id, start_date, end_date.

ukg_ready_employee_time_entries_bulk_delete

Delete existing time entries for a specified UKG Ready employee within a given date range. Returns an empty 204 response on success. Maximum date range is 31 days. Required: cid, employee_id, start_date, end_date.

list_all_ukg_ready_employee_timeoff_calendar_syncs

Sync time off calendar for an employee to a personal calendar in UKG Ready. Returns the calendar sync data as a JSON object whose specific fields are not enumerated by the upstream spec. Required: cid, employee_id, sync_token.

list_all_ukg_ready_employee_timeoff_team_calendar_syncs

Sync the time off team calendar for an employee or manager in UKG Ready. Returns a calendar sync response object whose field structure is not documented upstream. Required: cid, employee_id, sync_token.

list_all_ukg_ready_employee_timesheets

List timesheets for a single employee in UKG Ready. Returns: timesheets. Exactly one of date, current, previous, or next must be supplied to fulfil the request. Required: cid, employee_id.

list_all_ukg_ready_training_certifications

List employee training and certifications information in UKG Ready for a specific employee. Returns the employee_training_course_history array containing training course and certification records. Required: cid, employee_id.

list_all_ukg_ready_employee_vca_report_dialog_settings

List the employee VCA configuration for report dialogs in notifications in UKG Ready. Returns: enabled. Report Dialogs In Notifications functionality must be enabled in the company. Required: cid, employee_id.

ukg_ready_employee_vca_report_dialog_settings_bulk_update

Update the employee VCA configuration for report dialogs in notifications in UKG Ready. Returns: enabled. Report Dialogs In Notifications functionality must be enabled in the company. Required: cid, employee_id.

list_all_ukg_ready_employees_changeds

List employee records that have been updated within a given time frame in UKG Ready, including links to related resources that changed in the same period. Returns: entries. The since parameter cannot be more than 31 days in the past; terminatedEmployees defaults to true. Required: cid.

get_single_ukg_ready_employees_currency_by_id

Get the currency for the current employee in UKG Ready. Returns: currency. Required: id.

get_single_ukg_ready_employees_navigation_menu_by_id

Get the navigation menu for the current employee in UKG Ready. Returns four navigation item arrays — employee, manager, settings, and favorites — each containing nested child items. Required: id.

list_all_ukg_ready_audit_requests

List HR Action Audit Requests in UKG Ready. Returns: audit_requests. Supports sorting by the created field; prefix with - for descending order. Required: cid.

create_a_ukg_ready_audit_request

Create a new HR Action Audit Request in UKG Ready. Returns: id. A JSON request body is required. Required: cid.

get_single_ukg_ready_audit_request_by_id

Get a specific HR Action Audit Request by id in UKG Ready. Returns: id. Required: id, cid.

list_all_ukg_ready_benefits_benefit_plans

List benefit plans for a company in UKG Ready, including information about earnings, deductions, and coverages. Returns: . Required: cid.

list_all_ukg_ready_compensation_totals

List total compensation information for all subordinates in UKG Ready. Returns: total_compensations. Required: cid.

ukg_ready_compensation_totals_list_by_employee

Get total compensation for a specific employee in UKG Ready. Returns: total_compensations. Required: cid, employee_id.

ukg_ready_contact_active_status_bulk_update

Update the active status of an employee contact in UKG Ready. When deactivating a contact marked as primary, the primary flag is automatically unset. Returns a success response object. Required: cid, contact_id.

ukg_ready_direct_deposits_cancel_pre_notes_bulk_update

Cancel the pre-note for selected direct deposits in UKG Ready. Returns a success response object whose fields are not enumerated in the upstream specification. Requires a JSON request body specifying the direct deposits whose pre-note should be cancelled; the company id is supplied by the credential. Required: cid.

list_all_ukg_ready_employee_schedules

List schedule items for a single employee in UKG Ready within a required date range (max 31 days). The employee is identified by one of several optional identifier parameters. Returns: schedules. Required: cid, from_date, to_date.

ukg_ready_employee_schedules_bulk_update

Update an employee's schedule for a specified date range in UKG Ready, replacing all existing schedule data in that range. Returns: items. Date range must not exceed 31 days. shift_num defaults to 1 if omitted. Required: cid.

ukg_ready_employee_schedules_bulk_delete

Delete an employee's schedule for a specified date range in UKG Ready. Returns: items. Dates must be in yyyy-MM-dd format. Required: cid, date_from, date_to.

ukg_ready_account_security_questions_bulk_update

Update the security question for an employee account in UKG Ready. Returns a success response object whose fields depend on the company's UKG Ready configuration. Required: cid, account_id.

list_all_ukg_ready_employee_counter_adjustments

List counter adjustments for a specific employee in UKG Ready within a given date range. Returns: counter_adjustments. The maximum date range of the request is 31 days. Required: cid, employee_id, start_date, end_date.

create_a_ukg_ready_employee_counter_adjustment

Create a counter adjustment for a specific employee in UKG Ready. Returns: id. Required: cid, employee_id.

update_a_ukg_ready_employee_counter_adjustment_by_id

Update a counter adjustment for a specific employee in UKG Ready. Returns: id. Required: id, cid, employee_id.

delete_a_ukg_ready_employee_counter_adjustment_by_id

Delete a counter adjustment for a specific employee in UKG Ready. Returns a success object. Required: id, cid, employee_id.

list_all_ukg_ready_forms_customs

List available custom forms for an employee in UKG Ready, with optional filters for date range and form item state. Returns: forms. The from and to date range cannot exceed one year. Required: cid, employee_id.

list_all_ukg_ready_forms_pays

List an employee's pay forms (1099, W2) for various tax years in UKG Ready. Returns a forms array of pay form objects. Deprecated as of October 8, 2022; use the forms/system endpoint as an alternative. Required: cid, employee_id.

list_all_ukg_ready_forms_systems

List an employee's system forms (such as W-2, W-4, 1099, and I-9) in UKG Ready, filterable by form type and creation-date range. Returns: forms. Required: cid, employee_id.

list_all_ukg_ready_punches_recents

List recent punches for an employee in UKG Ready. Returns: punches. The optional num parameter controls how many punches to return (default 10, must be between 1 and 64); the optional types parameter filters by comma-separated calc punch types. Required: cid, employee_id.

list_all_ukg_ready_notifications_mailbox_items

List mailbox items for a particular employee in UKG Ready, with optional filtering by creation date range and read/unread status. Returns: items. Required: cid, employee_id.

create_a_ukg_ready_notifications_mailbox_item

Create a new mailbox item for a particular employee in UKG Ready. Returns: id, created_at. Required: cid, employee_id.

list_all_ukg_ready_notifications_todo_items

List to-do items for a particular employee in UKG Ready. Items are sorted by date in descending order. Returns: items. Required: cid, employee_id.

list_all_ukg_ready_loa_cases

List leave of absence cases for a specific employee in UKG Ready. Returns: cases. Leave of absence functionality must be enabled in the company. Required: cid, employee_id.

ukg_ready_loa_cases_list_company

List all leave of absence cases for a UKG Ready company with only basic data per case. Returns: cases. Leave of absence functionality must be enabled in the company. Required: cid.

create_a_ukg_ready_loa_case

Create a new leave of absence case in UKG Ready. Returns: id. Status can only be 'open' or omitted; sub_status and resolution are read-only. Does not support entries generation or case auto-closing. Required: cid.

get_single_ukg_ready_loa_case_by_id

Get a single leave of absence case by id in UKG Ready. Returns the full case object including id, case_number, status, sub_status, resolution, reason, employee, start_date, actual_end_date, and est_end_date. Leave of absence functionality must be enabled in the company. Required: id, cid.

update_a_ukg_ready_loa_case_by_id

Update a leave of absence case by id in UKG Ready. Returns: id. Read-only on update: status, sub_status, resolution, ignore_look_back_rules, reason, employee. Required: id, cid.

delete_a_ukg_ready_loa_case_by_id

Delete a leave of absence case in UKG Ready by id. Returns: id. Leave of absence functionality must be enabled in the company. Required: id, cid.

list_all_ukg_ready_loa_counters

List leave of absence counters for a UKG Ready employee. Returns each counter with category, taken, taken_as_of, entitlement, entitlement_as_of, and balance. Leave of absence functionality must be enabled in the company. Required: cid, employee_id.

ukg_ready_loa_counters_bulk_update

Update leave of absence counters for a UKG Ready employee, modifying balances and entitlements. Returns the updated counter with category, taken, taken_as_of, entitlement, entitlement_as_of, and balance. Leave of absence functionality must be enabled in the company. Required: cid, employee_id.

list_all_ukg_ready_loa_requests

List an employee's leave of absence requests in UKG Ready within a required date range. Returns: loa_requests. Date range must not exceed 366 days. Required: cid, employee_id, date_from, date_to.

ukg_ready_loa_requests_list_company

List leave of absence requests for all subordinates in a UKG Ready company within a required date range. Returns: loa_requests. Required: cid, date_from, date_to.

create_a_ukg_ready_loa_request

Submit a new leave of absence request in UKG Ready. Returns the created request including its id. Required: cid.

get_single_ukg_ready_loa_request_by_id

Get detailed information about a specific leave of absence request in UKG Ready. Returns: id. Required: id, cid.

delete_a_ukg_ready_loa_request_by_id

Delete a specific leave of absence request in UKG Ready. Returns: id. Required: id, cid.

list_all_ukg_ready_overtime_requests

List overtime requests for a specific employee in UKG Ready within a required date range. Returns: overtime_requests. Date range must be ≤ 366 days. Required: cid, employee_id, date_from, date_to.

ukg_ready_overtime_requests_list_company

List overtime requests for a manager's group members in UKG Ready within a required date range. Returns: overtime_requests. Required: cid, date_from, date_to.

create_a_ukg_ready_overtime_request

Create an overtime request in UKG Ready, either for oneself or on behalf of an employee. Returns: id. Required: cid.

get_single_ukg_ready_overtime_request_by_id

Get a single overtime request by id in UKG Ready. Returns the overtime request object including its id. Required: id, cid.

delete_a_ukg_ready_overtime_request_by_id

Delete an overtime request by id in UKG Ready. Own requests must be in state 'NEW' or 'DELETED'. Returns an empty 204 response on success. Required: id, cid.

list_all_ukg_ready_ptorequest_alls

List PTO requests for subordinate employees in UKG Ready. Returns the ptorequests array, with each item including id and from_date. Supports filtering by acc_id, acc_ext_id, and acc_username; sortable by from_date.

ukg_ready_ptorequest_alls_list_v_2

List PTO requests for subordinate employees in UKG Ready (v2 company-scoped endpoint). Returns the ptorequests array, with each item including id and from_date. Supports filtering by acc_ids, ext_ids, and user_names; sortable by from_date. Required: cid.

list_all_ukg_ready_ptorequest_notes

List all notes attached to a time off request thread in UKG Ready. Returns: notes. Required: note_thread_id.

ukg_ready_ptorequest_notes_list_v_2

List all notes attached to a time off request thread in UKG Ready using the v2 API. Returns: notes. Required: cid, note_thread_id.

list_all_ukg_ready_time_entries_notes

List time entry notes in UKG Ready filtered by time entry ID. Returns a time_entry_notes array of note objects; the source does not document individual note fields. Deprecated as of August 19, 2021; use list_v2 instead. Required: filter.

create_a_ukg_ready_time_entries_note

Create time entry notes in UKG Ready by submitting a JSON request body. Returns an items array of created note objects; the source does not document individual note fields. Deprecated as of August 19, 2021; use the v2 collection endpoint instead.

ukg_ready_time_entries_notes_list_v_2

List time entry notes for a specific company in UKG Ready using the v2 endpoint. Returns a time_entry_notes array of note objects; the source does not document individual note fields. Required: cid, time_entry_ids.

ukg_ready_time_entries_notes_bulk_delete

Delete time entry notes in UKG Ready filtered by note ID. Returns an items array of deleted note objects; the source does not document individual note fields. Deprecated as of August 19, 2021; use the v2 collection endpoint instead. Required: filter.

list_all_ukg_ready_payroll_batches

List all payroll batches for a specific payroll in UKG Ready. Returns a batches array of payroll batch objects; the source does not enumerate individual batch fields. Required: cid, payroll_id.

delete_a_ukg_ready_payroll_batch_by_id

Delete a specific payroll batch from a payroll in UKG Ready. Returns an empty 204 response on success. Required: id, cid.

list_all_ukg_ready_payroll_pay_statements

List all payroll pay statements for a given payroll in UKG Ready. Returns an array of pay statement records in the pay_statements field. Required: cid, payroll_id.

create_a_ukg_ready_payroll_pay_statement

Create a new pay statement for a given employee in a specific payroll in UKG Ready. Supports pre-defined types including 3rd Party Sick, Bonus, Void, Regular, and Historical. Returns: id. Required: cid, payroll_id.

get_single_ukg_ready_payroll_pay_statement_by_id

Get detailed information about a specific employee pay statement in UKG Ready. Returns the employee object containing pay statement details. Required: id, cid.

delete_a_ukg_ready_payroll_pay_statement_by_id

Delete a specific pay statement by id in UKG Ready. Returns an empty 204 response on success. Required: id, cid.

delete_a_ukg_ready_pay_statements_mass_delete_by_id

Delete multiple pay statements for a specific payroll in UKG Ready by providing a key_set_ref or list of pay statement ids in the request body. Returns a success response object. Required: id, cid.

create_a_ukg_ready_payrolls_multi_pay_statement

Create new pay statements for multiple employees in bulk in UKG Ready, providing payroll (start_date/end_date) and ein (id/display_name) along with complex data entry for each employee. Returns: items. The optional `type` attribute defaults to regular and `batch` defaults to master when omitted. Required: cid.

create_a_ukg_ready_payrolls_employee

Fetch a list of UKG Ready payroll employees by posting filter criteria (EIN, pay period profile, or employee list). With no filters provided, returns all accounts with active, non-deleted EIN and pay period profile assignments. Returns: employees. A request body is required; its contents vary based on the chosen filter criteria. Required: cid.

list_all_ukg_ready_company_schedules

List schedules in a UKG Ready company filtered by a required date range. Returns: schedules. Advanced Scheduler (__SCHEDULE__) subsystem must be enabled in company setup. Required: cid, from, to.

create_a_ukg_ready_company_schedule

Create a new schedule in a UKG Ready company. Returns: id. Advanced Scheduler (__SCHEDULE__) subsystem must be enabled. Open Shift Managing Strategy controls how open shifts are handled: 0 = NONE (default), 1 = ADD_DROP, 2 = POST_OPEN_SHIFT. Required: cid.

ukg_ready_company_schedules_mass_delete

Delete multiple schedules asynchronously via a background job in a UKG Ready company. Returns an opaque response confirming the mass deletion job was initiated. Advanced Scheduler (__SCHEDULE__) subsystem must be enabled. Required: cid.

get_single_ukg_ready_company_schedule_by_id

Get a single schedule by id in a UKG Ready company. Returns: id. Advanced Scheduler (__SCHEDULE__) subsystem must be enabled in company setup. Required: id, cid.

delete_a_ukg_ready_company_schedule_by_id

Delete a schedule by id in a UKG Ready company. Returns an empty 204 response on success. Advanced Scheduler (__SCHEDULE__) subsystem must be enabled in company setup. Required: id, cid.

list_all_ukg_ready_schedules_cost_estimates

List schedule cost estimates in UKG Ready, including full schedule estimated costs and daily cost estimates per employee on each schedule. Returns: cost_estimations. Defaults to a 2-month date range (first day of previous month to first day of next month) if from/to are omitted; date range must not exceed one quarter (3 months). Required: cid.

list_all_ukg_ready_schedules_settings

List schedule settings available in a UKG Ready company, which are required when creating a schedule. Returns: settings. The Advanced Scheduler (SCHEDULE) Subsystem must be enabled in company setup. Required: cid.

create_a_ukg_ready_schedule_action

Execute an action on a given schedule in UKG Ready. Returns a generic JSON object reflecting the action execution result. The Advanced Scheduler (SCHEDULE) Subsystem must be enabled in company setup. Required: cid, schedule_id, action.

list_all_ukg_ready_rates_tables

List all rate tables (company and personal) configured in a UKG Ready company. Returns: rate_tables. Required: cid.

create_a_ukg_ready_rates_table

Create a rate table in UKG Ready. Returns the created rate table object including its id. A JSON request body with rate table configuration is required. Required: cid.

get_single_ukg_ready_rates_table_by_id

Get a single rate table by id in UKG Ready. Returns: id. Rates functionality must be enabled in the company. Required: id, cid.

update_a_ukg_ready_rates_table_by_id

Update a rate table by id in UKG Ready. Returns: user_messages. Rates functionality must be enabled in the company. A JSON request body with rate table updates is required. Required: id, cid.

delete_a_ukg_ready_rates_table_by_id

Delete a rate table by id in UKG Ready. Only company rate tables that are not in use can be deleted. Returns an empty 204 response on success. Required: id, cid.

ukg_ready_rates_tables_reapply_rates

Reapply rates for a specific rate table in UKG Ready. Returns: user_messages. Rates functionality must be enabled in the company. Required: cid, table_id.

list_all_ukg_ready_table_schedules

List all rate schedules for a specific rate table in UKG Ready. Returns: rate_schedules. Filter by status using ALL, ACTIVE, or INACTIVE. Required: cid, table_id.

create_a_ukg_ready_table_schedule

Create a new rate schedule for a rate table in UKG Ready. Returns the created schedule's id and attributes. Required: cid, table_id.

update_a_ukg_ready_table_schedule_by_id

Update an existing rate schedule in UKG Ready by id. Returns the updated rate schedule object. Required: id, cid, table_id.

delete_a_ukg_ready_table_schedule_by_id

Delete a rate schedule from a rate table in UKG Ready by id. Returns the deleted schedule's id and attributes. Required: id, cid, table_id.

list_all_ukg_ready_positions

List all active and effective Positions in a UKG Ready company as of a specified date. Returns: Positions. Max 200 items per page. Required: cid.

get_single_ukg_ready_position_by_id

Get a single UKG Ready position by id, returning details irrespective of whether the position is currently active and effective. Returns: position_id. Required: id, cid.

list_all_ukg_ready_position_assignments

List all current, future, or past-dated position assignments for a company in UKG Ready. Returns: assignments. Optional parameters control the level of detail and whether to include future or only past assignments. Required: cid.

ukg_ready_position_assignments_list_by_employee

List all current, future, or past-dated position assignments for a specific employee in UKG Ready. Returns: assignments. Optional parameters control the level of detail and date filtering. Required: cid, employee_id.

list_all_ukg_ready_position_assignments_changeds

List position assignment changes in UKG Ready that have been created, modified, or deleted within a given time frame. Returns: entries. By default only basic assignment details are returned; use the req_details query parameter to request additional detail groups such as cost center or direct reporting manager information. Required: cid.

list_all_ukg_ready_case_notes

List notes for a leave of absence case in UKG Ready. Returns: notes. Required: cid, case_id.

create_a_ukg_ready_case_note

Create a note for a leave of absence case in UKG Ready. Returns the created note object; the upstream API specification does not enumerate individual note fields. Required: cid, case_id.

delete_a_ukg_ready_case_note_by_id

Delete a note from a leave of absence case in UKG Ready. Returns the deleted note object; the upstream API specification does not enumerate individual note fields. Required: id, cid.

list_all_ukg_ready_request_notes

List notes attached to a leave of absence request in UKG Ready. Returns: notes. Required: cid, request_id.

create_a_ukg_ready_request_note

Create a note on a leave of absence request in UKG Ready. Returns the created note with id. Required: cid, request_id.

delete_a_ukg_ready_request_note_by_id

Delete a note from a leave of absence request in UKG Ready. Returns: id. Required: id, cid.

ukg_ready_request_notes_list_overtime

List notes attached to an overtime request in UKG Ready. Returns: notes. Required: cid, request_id.

list_all_ukg_ready_employee_managed_cost_centers

List managed cost centers assigned to an employee in UKG Ready. Returns: managed_cost_centers. Required: cid, employee_id.

create_a_ukg_ready_employee_managed_cost_center

Create a managed cost center for an employee in UKG Ready. Returns the created managed cost center record including its id. Required: cid, employee_id.

get_single_ukg_ready_employee_managed_cost_center_by_id

Get a specific managed cost center for an employee in UKG Ready by managed cost center ACL id. Returns: id. Required: id, cid, employee_id.

update_a_ukg_ready_employee_managed_cost_center_by_id

Update a managed cost center for an employee in UKG Ready by managed cost center ACL id. Returns: id. Required: id, cid, employee_id.

list_all_ukg_ready_employee_accrual_balances_v_1

List accrual balances for a UKG Ready employee at the current or a specific date. Returns: accrual_balances. Use asOfDate to fetch balances as of a specific date and timeoff to filter by time-off ids. Required: cid, employee_id.

create_a_ukg_ready_employee_accrual_balances_v_1

Set the accrual balance for a UKG Ready employee using the V1 Accruals module. Returns: accrual_balances. The hours, external_accrued, external_taken, and external_carry_over fields use HH:MM (or HH.DD) format. Required: cid, employee_id.

ukg_ready_employee_accrual_balances_v_1_bulk_update

Update the accrual balance for a UKG Ready employee using the V1 Accruals module. Returns: accrual_balances. The hours, external_accrued, external_taken, and external_carry_over fields use HH:MM (or HH.DD) format. Required: cid, employee_id.

list_all_ukg_ready_employee_accrual_balances_v_2

List an employee's accrual balances in UKG Ready for the current period or as of a specific date. Returns: accrual_balances. Required: cid, employee_id.

ukg_ready_employee_accrual_balances_v_2_bulk_update

Apply a change to an employee's remaining accrual balance in UKG Ready by adding, setting, or deducting hours for a selected period date. Returns warnings if generated without committing; set ignore_warning to true on resend to commit and receive an empty response. Required: cid, employee_id.

create_a_ukg_ready_close_cancel

Cancel closing the specified payrolls in UKG Ready. Returns: jobs. Requires a JSON request body identifying the payrolls to cancel; the company identifier is supplied by the credential. Required: cid.

create_a_ukg_ready_delete_sync_time_cancel

Cancel Delete Sync Time on specified payrolls in UKG Ready. Returns a jobs array containing job objects for each cancelled delete sync time operation. Required: cid.

create_a_ukg_ready_finalize_cancel

Cancel a finalize payroll action on specified payrolls in UKG Ready. Returns: jobs. Required: cid.

create_a_ukg_ready_initiate_cancel

Cancel the initiation of specified payrolls in UKG Ready. Accepts a JSON request body identifying the payrolls to cancel. Returns: jobs. Required: cid.

create_a_ukg_ready_recalculate_cancel

Cancel a recalculate payroll action on the specified payrolls in UKG Ready. Returns: jobs. Required: cid.

create_a_ukg_ready_reopen_cancel

Cancel Reopen Payroll on the specified payrolls in UKG Ready. Returns: jobs. Requires a JSON request body identifying the payrolls to cancel. Required: cid.

create_a_ukg_ready_rollback_cancel

Cancel a rollback payroll action on the specified payrolls in UKG Ready. Returns: jobs. Required: cid.

create_a_ukg_ready_sync_time_cancel

Cancel Sync Time on the specified payrolls in UKG Ready. Returns: jobs. Requires a JSON request body identifying the target payrolls. Required: cid.

list_all_ukg_ready_schedule_shifts

Gets the list of Shifts being housed in a Schedule Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup. Returns: shifts. Required: cid, schedule_id.

get_single_ukg_ready_schedule_shift_by_id

Gets a Shift by ID Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup. Shifts should be referenced via Shift ID (Internal) or Shift external id using `|ex. Returns: id. Required: id, cid, schedule_id.

delete_a_ukg_ready_schedule_shift_by_id

Deletes a Shift Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup. Shifts should be referenced via Shift ID (Internal) or Shift external id using `|exter. Required: id, cid, schedule_id.

create_a_ukg_ready_shifts_collection

Bulk operation to create multiple Shifts Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup. If a shift in the payload contains `recurring_options`, opera. Returns: items. Required: cid, schedule_id.

ukg_ready_shifts_collections_bulk_update

Bulk operation to edit multiple Shifts Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup. For recurring shifts, use `recurring_options.apply_to` with val. Returns: items. Required: cid, schedule_id.

ukg_ready_shifts_collections_bulk_delete

Bulk operation to delete multiple Shifts Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup. For recurring shifts, include `apply_to` in body with values. Returns: items. Required: cid, schedule_id.

create_a_ukg_ready_shift_action

Posts or unposts an individual Shift, independently of the rest of the Schedule. Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup. This feature must be. Required: cid, schedule_id, shift_id, action.

ukg_ready_schedules_collections_bulk_update

Update rate schedules collection. Required: cid, table_id.

create_a_ukg_ready_workload_manager_transaction

Provides the ability to send volume data to Scheduler. Creates workload coverage and open shifts based on volume data sent. Advanced Scheduler (__SCHEDULE__) Subsystem must be enab. Returns: volume_data_entries_processed. Required: cid.

ukg_ready_workload_manager_transactions_bulk_delete

Provides the ability to delete volume data, workload coverage and generated open shifts from a schedule. Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setu. Required: cid, schedule_id.

create_a_ukg_ready_action_export

Submits an asynchronous job to export payroll data for the given pay period. Poll the URL in the __Location__ response header to track job progress and retrieve the download link w. Required: cid, pay_period_id.

list_all_ukg_ready_action_exports

Returns the current status and result of an asynchronous export job. When the job status is __DONE__, the __download_link__ field contains the URL to download the exported file. Re. Returns: id. Required: cid, pay_period_id, job_id.

create_a_ukg_ready_action_process_record

Submits an asynchronous job to process pay prep records for the given pay period. Poll the URL in the __Location__ response header to track job progress. Requires __PROCESS_PAY_PRE. Required: cid, pay_period_id.

list_all_ukg_ready_action_process_records

Returns the current status and result of an asynchronous process records job. Requires __PROCESS_PAY_PREP__ permission. At least one of the following sub-systems must be enabled: P. Returns: id. Required: cid, pay_period_id, job_id.

create_a_ukg_ready_action_snapshot

Creates a snapshot of the current pay period data. A snapshot captures the state of all pay prep records at the time of creation and can be used as a reference point for exports. P. Required: cid, pay_period_id.