/ukg-employee-core | Type: Application | PCID required: Yes
Tools
ukg-employee-core_changes_get
Changes By Employee ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | Employee Id |
ukg-employee-core_changes_get_all
Changes By Date Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startDate | string | No | — | Used to lookup employee changes within time span |
endDate | string | No | — | Used to lookup employee changes within time span |
page | number | No | — | Pagination, which page you want to see |
per_page | number | No | — | Pagination, how many records per page you want to see |
ukg-employee-core_cobra_details_get
Get Employee Cobra Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
cobraIsActive | boolean | No | — | Cobra Is Active |
cobraStatus | string | No | — | Cobra Status |
dateOfCobraEvent | string | No | — | Date Of Cobra Event |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_contract_get
Get all employment contract details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
contractNumber | string | No | — | Contract Number |
contractTypeCode | string | No | — | Contract Type Code |
effectiveDate | string | No | — | Used to find contracts effective date less than, greater than, equal to, or between passed date(s) |
dateTimeCreated | string | No | — | Used to find contract record created date less than, greater than, equal to, or between passed date(s) |
rowLastChanged | string | No | — | Used to find contract record changed date less than, greater than, equal to, or between passed date(s) |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_education_get
Get all education details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
systemId | string | No | — | System Id |
employeeId | string | No | — | Employee Id |
country | string | No | — | The country value |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_emp_global_localization_element_get
Get all global employee localization fields added to UKG Pro Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | No | — | Employee Id |
companyId | string | No | — | Company Id |
created | string | No | — | Used to find employee localization fields created less than, greater than, equal to, or between passed date(s) |
effective | string | No | — | Used to find employee localization fields effective less than, greater than, equal to, or between passed date(s) |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_emp_multiple_positions_get
Get Employee Multiple Positions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | No | — | Employee Id |
companyId | string | No | — | Company Id |
jobCode | string | No | — | Job Code |
positionCode | string | No | — | Position Code |
isPrimary | string | No | — | Is Primary |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_extended_elements_get
Get Employee Extended Elements Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
dateTimeCreated | string | No | — | Date Time Created |
dateTimeChanged | string | No | — | Date Time Changed |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_compensation_details
Get all compensation details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
primaryJobCode | string | No | — | Primary Job Code |
jobGroupCode | string | No | — | Job Group Code |
jobTitle | string | No | — | Job Title |
payGroupCode | string | No | — | Pay Group Code |
fullTimeOrPartTimeCode | string | No | — | Full Time Or Part Time Code |
salaryOrHourlyCode | string | No | — | Salary Or Hourly Code |
primaryShiftCode | string | No | — | Primary Shift Code |
primaryShiftGroupCode | string | No | — | Primary Shift Group Code |
dateInJob | string | No | — | Used to find date in job less than, greater than, equal to, or between passed date(s) |
dateLastPaid | string | No | — | Used to find date last paid less than, greater than, equal to, or between passed date(s) |
datePaidThru | string | No | — | Used to find date paid through less than, greater than, equal to, or between passed date(s) |
isAutoAllocated | string | No | — | Is Auto Allocated |
isAutoPaid | string | No | — | Is Auto Paid |
isSeasonalWorker | string | No | — | Is Seasonal Worker |
isHighlyCompensated | string | No | — | Is Highly Compensated |
isMultipleJob | string | No | — | Is Multiple Job |
performanceReviewRating | string | No | — | Performance Review Rating |
performanceReviewType | string | No | — | Performance Review Type |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_compensation_details_employee_id
Get all compensation details by employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | Employee Id |
ukg-employee-core_get_personnel_v1_contacts
Get all details for a person assigned to an employee as a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | No | — | Employee Id |
isActive | string | No | — | Is Active |
relationshipCode | string | No | — | Relationship Code |
contactId | string | No | — | Contact Id |
countryCode | string | No | — | Country Code |
cobraIsActive | string | No | — | Cobra Is Active |
cobraStatus | string | No | — | Cobra Status |
isBeneficiary | string | No | — | Is Beneficiary |
isDependent | string | No | — | Is Dependent |
dateOfCobraEvent | string | No | — | Used to find date of COBRA event less than, greater than, equal to, or between passed date(s) |
statusAsOfDate | string | No | — | Used to find contact status as of date less than, greater than,equal to, or between passed date(s) |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_contacts_contact_id
Get all details for a single person assigned to an employee as a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | Contact Id |
employeeId | string | No | — | Employee Id |
isActive | string | No | — | Is Active |
relationshipCode | string | No | — | Relationship Code |
countryCode | string | No | — | Country Code |
cobraIsActive | string | No | — | Cobra Is Active |
cobraStatus | string | No | — | Cobra Status |
isBeneficiary | string | No | — | Is Beneficiary |
isDependent | string | No | — | Is Dependent |
dateOfCobraEvent | string | No | — | Used to find date of COBRA event less than, greater than, equal to, or between passed date(s) |
statusAsOfDate | string | No | — | Used to find contact status as of date less than, greater than, equal to, or between passed date(s) |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_empl_multiple_jobs
Get employee multiple jobs details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | No | — | Employee Id |
companyId | string | No | — | Company Id |
jobCode | string | No | — | Job Code |
isPrimaryJob | string | No | — | Is Primary Job |
jobIsInActive | string | No | — | Job Is In Active |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_employee_demographic_details
Get Employee Demographic Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | No | — | Employee Id |
companyId | string | No | — | Company Id |
lastName | string | No | — | Last Name |
emailAddress | string | No | — | Email Address |
addressState | string | No | — | Address State |
addressCountry | string | No | — | Address Country |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_employee_job_history_details_system_id
Get a single job history detail record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
systemId | string | Yes | — | System Id |
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
isOrgChange | string | No | — | Is Org Change |
isJobChange | string | No | — | Is Job Change |
isRateChange | string | No | — | Is Rate Change |
isPromotion | string | No | — | Is Promotion |
jobEffectiveDate | string | No | — | Used to find job history effective date less than, greater than, equal to, or between passed date(s) |
dateTimeCreated | string | No | — | Used to find job history created less than, greater than, equal to, or between passed date(s) |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_employee_security_user_details
Get employee security user details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userName | string | No | — | User Name |
employeeID | string | No | — | Employee ID |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_employment_details
Retrieve Employment Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
primaryJobCode | string | No | — | Primary Job Code |
jobTitle | string | No | — | Job Title |
fullTimeOrPartTimeCode | string | No | — | Full Time Or Part Time Code |
primaryWorkLocationCode | string | No | — | Primary Work Location Code |
primaryProjectCode | string | No | — | Primary Project Code |
deductionGroupCode | string | No | — | Deduction Group Code |
earningGroupCode | string | No | — | Earning Group Code |
employeeTypeCode | string | No | — | Employee Type Code |
employeeStatusCode | string | No | — | Employee Status Code |
employeeNumber | string | No | — | Employee Number |
supervisorID | string | No | — | Supervisor ID |
originalHireDate | string | No | — | Original Hire Date |
lastHireDate | string | No | — | Last Hire Date |
dateOfTermination | string | No | — | Date Of Termination |
dateOfRetirement | string | No | — | Date Of Retirement |
dateTimeCreated | string | No | — | Date Time Created |
dateTimeChanged | string | No | — | Date Time Changed |
dateLastPayDatePaid | string | No | — | Date Last Pay Date Paid |
payGroup | string | No | — | Pay Group |
isHomeCompany | boolean | No | — | Is Home Company |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_international_employees_employee_id
Get a single employees international details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | Employee Id |
countryCode | string | No | — | Country Code |
effectiveDate | string | No | — | Effective Date |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_person_details
Get all person details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
lastName | string | No | — | Last Name |
emailAddress | string | No | — | Email Address |
addressState | string | No | — | Address State |
addressCountry | string | No | — | Address Country |
cobraIsActive | string | No | — | Cobra Is Active |
cobraStatus | string | No | — | Cobra Status |
dateOfCobraEvent | string | No | — | Used to find date of COBRA event less than, greater than, equal to, or between passed date(s) |
dateTimeCreated | string | No | — | Used to find person record created less than, greater than, equal to, or between passed date(s) |
dateTimeChanged | string | No | — | Used to find person record changed less than, greater than, equal to, or between passed date(s) |
nationalId | string | No | — | National Id |
nationalIdCountry | string | No | — | National Id Country |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_get_personnel_v1_person_details_employee_id
Get a single person detail record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | Employee Id |
ukg-employee-core_get_personnel_v1_user_profile_details
Get all user profile details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
masterCompany | string | No | — | Master Company |
userStatus | string | No | — | User Status |
userId | string | No | — | User Id |
roleId | string | No | — | Role Id |
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_global_bank_get
Get all direct deposit details for global employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
employeeCountry | string | No | — | Employee Country |
payGroup | string | No | — | Pay Group |
dateModified | string | No | — | Used to find global employee’s direct deposit modified date less than, greater than, equal to, or between passed date(s) |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_ids
Employee ID Lookup Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | Yes | — | Request body |
ukg-employee-core_international_employee_get
Get international employee details for all employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
countryCode | string | No | — | Country Code |
effectiveDate | string | No | — | Effective Date |
employeeId | string | No | — | Employee Id |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_job_history_detail_get
Get all employee job history details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
isOrgChange | string | No | — | Is Org Change |
isJobChange | string | No | — | Is Job Change |
isRateChange | string | No | — | Is Rate Change |
isPromotion | string | No | — | Is Promotion |
systemId | string | No | — | System Id |
jobEffectiveDate | string | No | — | Used to find job history effective date less than, greater than, equal to, or between passed date(s) |
dateTimeCreated | string | No | — | Used to find job history created less than, greater than, equal to, or between passed date(s) |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_multi_phone_numbers_get
Get employee multiple phone numbers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | No | — | Employee Id |
systemId | string | No | — | System Id |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_national_document_get
All employee national document details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | No | — | Contact Id |
employeeId | string | No | — | Employee Id |
nationalDocumentIssuingCountryCode | string | No | — | National Document Issuing Country Code |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_position_report_get
Get Position Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
positionCode | string | No | — | Position Code |
reportsToPositionCode | string | No | — | Reports To Position Code |
effectiveStartDate | string | No | — | Effective Start Date |
effectiveStopDate | string | No | — | Effective Stop Date |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_retrieve_employee_employment_details
Retrieve Employee Employment Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyID | string | No | — | The unique identifier for the company associated with an employee. |
employeeID | string | No | — | The unique identifier for an employee within the organization. |
primaryJobCode | string | No | — | A code which refers to the primary job code assigned to the employee. |
jobTitle | string | No | — | The official job title of the employee. |
fullTimeOrPartTimeCode | string | No | — | A code indicating whether the employee is full-time or part-time. |
primaryWorkLocationCode | string | No | — | A code indicating the primary work location. |
primaryProjectCode | string | No | — | A code indicating the primary project or assignment. |
deductionGroupCode | string | No | — | A code indicating the group of deductions. |
earningGroupCode | string | No | — | A code indicating the group of earnings. |
employeeTypeCode | string | No | — | A code indicating the type of employee. |
employeeStatusCode | string | No | — | A code representing the current status of the employee. |
employeeNumber | string | No | — | The employee number or identifier. |
supervisorId | string | No | — | The unique identifier of the employee’s supervisor. |
originalHireDate | string | No | — | he date when the employee was originally hired. |
lastHireDate | string | No | — | The most recent hire date (if rehired) |
dateOfTermination | string | No | — | The date an employee was terminated. |
dateOfRetirement | string | No | — | The date an employee retired. |
dateTimeCreated | string | No | — | The date and time an employee record was created. |
dateTimeChanged | string | No | — | The date and time an employee record was last changed. |
dateLastPayDatePaid | string | No | — | The date of an employee’s most recently paid pay date. |
payGroup | string | No | — | A code representing the pay group or category. |
isHomeCompany | string | No | — | A Boolean indicator of whether or not the current company is the employee’s home company. |
page | integer | No | — | The page number of a paginated response set. |
per_Page | integer | No | — | The number of results contained per page in a paginated response set. |
ukg-employee-core_supervisor_details_get
Get Employee Supervisor Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
employeeId | string | No | — | Employee Id |
supervisorCompanyId | string | No | — | Supervisor Company Id |
supervisorEmployeeId | string | No | — | Supervisor Employee Id |
supervisorCompanyCode | string | No | — | Supervisor Company Code |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |
ukg-employee-core_user_details_get_user_details
Get User Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userName | string | No | — | User Name |
userStatus | string | No | — | User Status |
employeeId | string | No | — | Employee Id |
page | integer | No | — | Page number for pagination |
per_Page | integer | No | — | Number of results per page |

