Actions

139 actions

Action

Description

List Benefits

Retrieve benefit plans for all employees

Get Benefit

Retrieve a specific employee benefit enrollment by its enrollment ID

List Benefit Plans

Retrieve detailed benefit plan list

List Additional Compensation

Retrieve additional compensation records for all subordinates

Get Additional Compensation

Retrieve detailed information about a specific additional compensation record

List Compensation History

Retrieve base compensation history for all subordinates

List Total Compensation

Retrieve total compensation information for all subordinates

Create Employee Contracts

Create employee contracts with working hours and schedule details

Update Employee Contracts

Update existing employee contracts

Delete Employee Contracts

Delete multiple employee contracts by their IDs

List Employees

Retrieve a list of all employees for the company from UKG Ready

Get Employee

Retrieve detailed information for a specific employee by account ID

Get Current Employee

Retrieve information for the currently authenticated employee

List Changed Employees

Retrieve a list of employees with recent changes or modifications

Get Current Employee Currency

Retrieve currency preference for the currently authenticated employee

Get Employee Accrual Balances (v1)

Retrieve accrual balance information for an employee (version 1.0)

Get Employee Accrual Balances (v2)

Retrieve accrual balance information for an employee (version 2.0)

List Employee Announcements

Retrieve announcements for a specific employee

List Employee Attendance Records

Retrieve attendance records for a specific employee

List Employee Badges

Retrieve badge information for a specific employee

List Employee Benefits

Retrieve benefit enrollments for a specific employee

List Employee Additional Compensation

Retrieve additional compensation records for a specific employee

List Employee Compensation History

Retrieve compensation history for a specific employee

Get Employee Total Compensation

Retrieve total compensation summary for a specific employee

List Employee Contacts

Retrieve emergency contacts for a specific employee

List Employee Counter Adjustments

Retrieve counter adjustments for a specific employee

List Employee Credentials

Retrieve professional credentials for a specific employee

List Employee Deductions

Retrieve payroll deductions for a specific employee

Get Employee Demographics

Retrieve demographic information for a specific employee

List Employee Direct Deposits

Retrieve direct deposit information for a specific employee

List Employee Documents

Retrieve documents for a specific employee

List Employee Custom Forms

Retrieve custom form data for a specific employee

List Employee Pay Forms

Retrieve pay form data for a specific employee

List Employee System Forms

Retrieve system form data for a specific employee

List Employee Holidays

Retrieve holiday schedule for a specific employee

List Employee HR Custom Fields

Retrieve HR custom field data for a specific employee

List Employee LOA Cases

Retrieve leave of absence cases for a specific employee

List Employee LOA Counters

Retrieve leave of absence counter balances for a specific employee

List Employee LOA Requests

Retrieve leave of absence requests for a specific employee

List Employee Managed Cost Centers

Retrieve cost centers managed by a specific employee

Create Employee Managed Cost Center

Create a managed cost center for an employee

List Employee Manager Replacements

Retrieve manager replacement configurations for a specific employee

List Employee Mailbox Notifications

Retrieve mailbox notifications for a specific employee

List Employee Todo Notifications

Retrieve todo item notifications for a specific employee

List Employee Overtime Requests

Retrieve overtime requests for a specific employee

Get Employee Pay Info

Retrieve pay information for a specific employee

Get Employee Profiles

Retrieve profile assignments for a specific employee

List Employee Recent Punches

Retrieve recent time clock punches for a specific employee

Get Employee Tax Info

Retrieve tax information for a specific employee

List Employee Time Entries

Retrieve time entries for a specific employee

List Employee Timesheets

Retrieve timesheets for a specific employee

Get Employee Timeoff Calendar Sync

Retrieve time-off calendar synchronization settings for a specific employee

List Employee Training

Retrieve training records for a specific employee

List Employee Skills

Retrieve skills for a specific employee

Get Employee VCA Report Settings

Retrieve VCA report settings for a specific employee

Create Employee

Create a new employee record with required core information

Update Employee

Update an existing employee record with new information

Delete Employee

Terminate or delete an employee record from the system

Create Employee Additional Compensation

Creates an additional compensation record for an employee

Set Employee Accrual Balance (V1)

Sets the accrual balance for an employee using V1 accruals module

Change Employee Accrual Balance

Applies a change to an employee's remaining accrual balance

Update Employee Demographics

Update employee demographic information

Update Employee HR Custom Fields

Update employee HR custom fields

Update Employee Pay Info

Update employee pay information

List Cost Center Jobs

Retrieve all cost center jobs available within the company

Create Cost Center Job

Create a new cost center job within the company

Get Cost Center Job

Retrieve a specific cost center job by ID

Update Cost Center Job

Update a specific cost center job

Delete Cost Center Job

Delete a specific cost center job by ID

Lookup Jobs

Retrieve the list of job positions available in the organization

Lookup Groups

Retrieve company or account groups from the organization by object type

Lookup Employee Types

Retrieve the list of employee types or classifications

Lookup Pay Types

Retrieve the list of pay types available in the organization

Lookup Job Categories

Retrieve the list of job categories configured in the organization

Lookup Earning Codes

Retrieve the list of earning codes used for payroll

Lookup Deduction Codes

Retrieve the list of deduction codes used for payroll

Lookup Termination Reasons

Retrieve the list of termination reasons

Lookup Worker Types

Retrieve the list of worker types

Lookup Benefit Plans

Retrieve the list of benefit plans available to employees

Lookup Pay Grades

Retrieve the list of pay grades or compensation levels

Lookup Skills

Retrieve the list of skills tracked in the organization

Lookup Job Change Reasons

Retrieve the list of reasons for job or position changes

Lookup Timezones

Retrieve the list of timezones available in UKG Ready

Lookup Locales

Retrieve the list of locales or language preferences

Lookup Additional Compensation Types

Retrieve the list of additional compensation types

Lookup Benefit Types

Retrieve the list of benefit types

Lookup Document Types

Retrieve the list of document types

Lookup EINs

Retrieve the list of Employer Identification Numbers

Lookup Hiring Stages

Retrieve the list of hiring stages

Lookup Job Application Status

Retrieve the list of job application statuses

Lookup Credential Types

Retrieve the list of credential types

Lookup Job Requisition Categories

Retrieve the list of job requisition categories

Lookup Job Requisition Locations

Retrieve the list of job requisition locations

Lookup Eye Colors

Retrieve the list of eye color options

Lookup LOA Reasons

Retrieve the list of leave of absence reasons

Lookup Overtime Reasons

Retrieve the list of overtime reasons

Lookup Pay Categories

Timesheet-scoped: returns pay categories valid for a specific employee's timesheet entry on a given date (NOT a company-...

Lookup Pay Calculation Profiles

Retrieve the list of pay calculation profiles

Lookup Pay Period Profiles

Retrieve the list of pay period profiles

Lookup Pay Statement Types

Retrieve the list of pay statement types

Lookup Payroll Batch Types

Retrieve the list of payroll batch types

Lookup Payroll Types

Retrieve the list of payroll types

Lookup Tax Codes

Retrieve the list of tax codes

Lookup Unions

Retrieve the list of labor unions

Lookup Workers Compensation Codes

Retrieve the list of workers compensation codes

Lookup Profile-Specific EINs

Retrieve profile-specific Employer Identification Numbers

Lookup Accruals Profiles

Retrieve accrual profiles for time-off and leave management

Lookup Accrual Profiles (v1.0)

Retrieve accrual profiles (legacy endpoint)

Lookup Demographic Profiles

Retrieve demographic profiles

Lookup Leave Of Absence Profiles

Retrieve leave of absence profiles

Lookup Pay Grade Profiles

Retrieve pay grade profiles

Lookup Pay Period Profile Configs

Retrieve pay period profiles

Lookup Pay Prep Profiles

Retrieve pay prep profiles

Lookup Time Off Planning Profiles

Retrieve time off planning profiles

List Overtime Requests

Retrieve overtime requests for manager's group members

Create Overtime Request

Create a new overtime request for an employee

Get Overtime Request

Retrieve a single overtime request by ID

Delete Overtime Request

Delete an overtime request by ID

List Overtime Request Notes

Retrieve notes for a specific overtime request

List Pay Period Profiles

Retrieve a list of pay period profiles for the company

List Payrolls

Retrieve a list of company payrolls normally accessed to process payroll

Create Payroll

Create a new payroll that has not been scheduled

Get Payroll

Get detailed information about a specific payroll

Delete Payroll

Delete a specific payroll by ID

List Job Applications

Retrieve all job applications in the company

Create Job Application

Create a new job application for an applicant

Get Job Application

Retrieve a specific job application by ID

Update Job Application

Update an existing job application

Delete Job Application

Delete a specific job application by ID

List Job Requisitions

Retrieve all job requisitions available within the company

Get Job Requisition

Retrieve details of a specific job requisition by ID

Get Job Requisition Questionnaire

Retrieve questionnaire for a specific job requisition

List Applicants

Retrieve all applicant accounts in the company

List Schedule Settings

Retrieve the list of schedule settings

List Schedules

Retrieve a list of schedules for the company

Create Schedule

Create a new schedule for the company

List PTO Requests

Retrieve PTO requests for subordinate employees

Get PTO Request

Retrieve information about a single PTO request

List PTO Request Notes

Retrieve all notes for a PTO request