Connectors

HR & People

UKG Pro

HR and payroll: employee data, earnings, deductions, time, and import tools

Signs in with: Username and password
Runs on: Cloud or On-Prem Worker
Operations: 215
Ready-made triggers: 0

Connect UKG Pro

In Neblex open Connect › Connections and click New Connection.
Search for UKG Pro and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

Field	What to enter
Service hostRequired	Your UKG Pro service endpoint host without https://, from System Configuration > Security > Web Services (for example service4.ultipro.com).Example: `service4.ultipro.com`
Web service account userRequired	The user name of the UKG Pro web service account.
Web service account passwordRequiredSecret	That account's password.
Customer API keyRequiredSecret	The five-character customer API key from the Web Services page; sent in the US-CUSTOMER-API-KEY header.

Use it in a flow

Open a flow, open the node library and search for UKG Pro.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from UKG Pro without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if UKG Pro can send webhooks, a Webhook trigger receives them at its own URL.

Operations

215 operations in 116 groups. Each one is a step you can add to a flow.

Audit: Audit Details1

Get Audit Details DatagetAuditDetailsData GET If no pagination parameters are specified, the default/max is applied.

Audit: Integration Audit Configuration1

Retrieve Integration Audit Configuration DataretrieveIntegrationAuditConfigurationData GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: Allergy3

Create a new allergy configuration`postAllergy`	POST	'Creates a new UKG Pro HCM allergy configuration.'
Retrieve all allergy configurations`getAllergyList`	GET	Returns information about the UKG Pro HCM allergy configurations.
Update a single allergy configuration`putAllergy`	PUT	Provides the ability to update a single allergy configuration.

Configuration Setup: Award Type3

Create a new awardType configuration`postawardType`	POST	'Creates a new UKG Pro HCM awardType configuration.'
Retrieve all awardType configurations`getawardTypeList`	GET	Returns information about the UKG Pro HCM awardType configurations.
Update a single awardType configuration`putawardType`	PUT	Provides the ability update a single awardType configuration.

Configuration Setup: Career Provider3

Create a new careerProvider configuration`postcareerProvider`	POST	'Creates a new UKG Pro HCM careerProvider configuration.'
Retrieve all careerProvider configurations`getcareerProviderList`	GET	Returns information about the UKG Pro HCM careerProvider configurations.
Update a single careerProvider configuration`putcareerProvider`	PUT	Provides the ability update a single careerProvider configuration.

Configuration Setup: Child Support Type3

Create a new childSupportType configuration`postchildSupportType`	POST	'Creates a new UKG Pro HCM childSupportType configuration.'
Retrieve all childSupportType configurations`getchildSupportTypeList`	GET	Returns information about the UKG Pro HCM childSupportType configurations.
Update a single childSupportType configuration`putchildSupportType`	PUT	Provides the ability update a single childSupportType configuration.

Configuration Setup: Cobra Status3

Create a new cobraStatus configuration`postcobraStatus`	POST	'Creates a new UKG Pro HCM cobraStatus configuration.'
Retrieve all cobraStatus configurations`getcobraStatusList`	GET	Returns information about the UKG Pro HCM cobraStatus configurations.
Update a single cobraStatus configuration`putcobraStatus`	PUT	Provides the ability update a single cobraStatus configuration.

Configuration Setup: Code Tables1

Get Code Tables informationgetCodeTablesInformation GET UKG Pro HCM codes table lookup, will contain a list of all tables with HATEOAS links to make a subsequent call to get all the codes for that table.

Configuration Setup: CodeTables1

Post Code Tables informationpostCodeTablesInformation POST Creates a new UKG Pro HCM Code table configuration, Array of objects is permitted for multi-records support.

Configuration Setup: Company Details1

Get Company DetailscompanyDetailsGetCompanyDetails GET Get all master company and component company details.

Configuration Setup: Company Property3

Create a new companyProperty configuration`postcompanyProperty`	POST	'Creates a new UKG Pro HCM companyProperty configuration.'
Retrieve all companyProperty configurations`getcompanyPropertyList`	GET	Returns information about the UKG Pro HCM companyProperty configurations.
Update a single companyProperty configuration`putcompanyProperty`	PUT	Provides the ability update a single companyProperty configuration.

Configuration Setup: Course Category3

Create a new courseCategory configuration`postcourseCategory`	POST	'Creates a new UKG Pro HCM courseCategory configuration.'
Retrieve all courseCategory configurations`getcourseCategoryList`	GET	Returns information about the UKG Pro HCM courseCategory configurations.
Update a single courseCategory configuration`putcourseCategory`	PUT	Provides the ability update a single courseCategory configuration.

Configuration Setup: Course Delivery Met3

Create a new courseDeliveryMet configuration`postcourseDeliveryMet`	POST	'Creates a new UKG Pro HCM courseDeliveryMet configuration.'
Retrieve all courseDeliveryMet configurations`getcourseDeliveryMetList`	GET	Returns information about the UKG Pro HCM courseDeliveryMet configurations.
Update a single courseDeliveryMet configuration`putcourseDeliveryMet`	PUT	Provides the ability update a single courseDeliveryMet configuration.

Configuration Setup: Course Sub Category3

Create a new courseSubCategory configuration`postcourseSubCategory`	POST	'Creates a new UKG Pro HCM courseSubCategory configuration.'
Retrieve all courseSubCategory configurations`getcourseSubCategoryList`	GET	Returns information about the UKG Pro HCM courseSubCategory configurations.
Update a single courseSubCategory configuration`putcourseSubCategory`	PUT	Provides the ability update a single courseSubCategory configuration.

Configuration Setup: Disability3

Create a new disability configuration`postdisability`	POST	'Creates a new UKG Pro HCM disability configuration.'
Retrieve all disability configurations`getdisabilityList`	GET	Returns information about the UKG Pro HCM disability configurations.
Update a single disability configuration`putdisability`	PUT	Provides the ability update a single disability configuration.

Configuration Setup: Earnings3

Get a list of all earnings configurations`getAListOfAllEarningsConfigurations`	GET	Get details of all earnings configuration setup at company level.
Get a specific earning configuration`getASpecificEarningConfiguration`	GET	Get details of the earning configuration requested.
Get list of earnings configurations filtered by Parameter including pagination params`getListOfEarningsConfigurationsFilteredByParameterIncludingPaginationParams`	GET	Get all the earning configuration filtered by the parameter(s) passed.

Configuration Setup: Employee Type3

Create a new employeeType configuration`postemployeeType`	POST	'Creates a new UKG Pro HCM employeeType configuration.'
Retrieve all employeeType configurations`getemployeeTypeList`	GET	Returns information about the UKG Pro HCM employeeType configurations.
Update a single employeeType configuration`putemployeeType`	PUT	Provides the ability update a single employeeType configuration.

Configuration Setup: Insurance Rate1

Get Insurance RateinsRateGetInsRate GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: Job Family3

Create a new jobFamily configuration`postjobFamily`	POST	'Creates a new UKG Pro HCM jobFamily configuration.'
Retrieve all jobFamily configurations`getjobFamilyList`	GET	Returns information about the UKG Pro HCM jobFamily configurations.
Update a single jobFamily configuration`putjobFamily`	PUT	Provides the ability update a single jobFamily configuration.

Configuration Setup: Job Group1

Get All Job GroupsjobGroupGet GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: Jobs4

Retrieve All Job Configurations`getjobsList`	GET	Returns information about Pro Job configurations.
Retrieve All Job Configurations - V1`getjobsListV1`	GET	This operation has a newer version available -- Use Retrieve All Job Configurations (GET /configuration/v2/jobs) instead.
Retrieve Job Configuration`getjobs`	GET	Returns information about a single Job configuration.
Retrieve Job Configuration - V1`getjobsV1`	GET	This operation has a newer version available -- Use Retrieve Job Configuration (GET /configuration/v2/jobs/{code}) instead.

Configuration Setup: License Type3

Create a new licenseType configuration`postlicenseType`	POST	'Creates a new UKG Pro HCM licenseType configuration.'
Retrieve all licenseType configurations`getlicenseTypeList`	GET	Returns information about the UKG Pro HCM licenseType configurations.
Update a single licenseType configuration`putlicenseType`	PUT	Provides the ability update a single licenseType configuration.

Configuration Setup: Loan Type3

Create a new loanType configuration`postloanType`	POST	'Creates a new UKG Pro HCM loanType configuration.'
Retrieve all loanType configurations`getloanTypeList`	GET	Returns information about the UKG Pro HCM loanType configurations.
Update a single loanType configuration`putloanType`	PUT	Provides the ability update a single loanType configuration.

Configuration Setup: Locations2

Retrieve a single location configuration`getlocations`	GET	Returns information about the UltiPro locations configuration.
Retrieve all locations configurations`getlocationsList`	GET	Returns information about the UltiPro locations configurations.

Configuration Setup: Marital Status3

Create a new maritalStatus configuration`postmaritalStatus`	POST	'Creates a new UKG Pro HCM maritalStatus configuration.'
Retrieve all maritalStatus configurations`getmaritalStatusList`	GET	Returns information about the UKG Pro HCM maritalStatus configurations.
Update a single maritalStatus configuration`putmaritalStatus`	PUT	Returns the ability update a single maritalStatus configuration.

Configuration Setup: Military Branches3

Create a new militaryBranches configuration`postmilitaryBranches`	POST	'Creates a new UKG Pro HCM militaryBranches configuration.'
Retrieve all militaryBranches configurations`getmilitaryBranchesList`	GET	Returns information about the UKG Pro HCM militaryBranches configurations.
Update a single militaryBranches configuration`putmilitaryBranches`	PUT	Provides the ability update a single militaryBranches configuration.

Configuration Setup: Military Era3

Create a new militaryEra configuration`postmilitaryEra`	POST	'Creates a new UKG Pro HCM militaryEra configuration.'
Retrieve all militaryEra configurations`getmilitaryEraList`	GET	Returns information about the UKG Pro HCM militaryEra configurations.
Update a single militaryEra configuration`putmilitaryEra`	PUT	Provides the ability update a single militaryEra configuration.

Configuration Setup: Name Prefix3

Create a new namePrefix configuration`postnamePrefix`	POST	'Creates a new UKG Pro HCM namePrefix configuration.'
Retrieve all namePrefix configurations`getnamePrefixList`	GET	Returns information about the UKG Pro HCM namePrefix configurations.
Update a single namePrefix configuration`putnamePrefix`	PUT	Provides the ability update a single namePrefix configuration.

Configuration Setup: Option Rate1

Get Option Rate DatagetOptionRateData GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: Organization Reporting Category1

Get Organization Reporting CategorygetOrganizationReportingCategory GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: Other Phone Types3

Create a new otherPhoneTypes configuration`postotherPhoneTypes`	POST	'Creates a new UKG Pro HCM otherPhoneTypes configuration.'
Retrieve all otherPhoneTypes configurations`getotherPhoneTypesList`	GET	Returns information about the UKG Pro HCM otherPhoneTypes configurations.
Update a single otherPhoneTypes configuration`putotherPhoneTypes`	PUT	Provides the ability update a single otherPhoneTypes configuration.

Configuration Setup: Position Report1

Get Position ReportpositionReportGet GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: Positions1

Returns a list of employee position information filtered on various parametersreturnsAListOfEmployeePositionInformationFilteredOnVariousParameters GET If no pagination parameters specified, the default/max is applied.

Configuration Setup: Project3

Create a new project configuration`postProject`	POST	'Creates a new UKG Pro HCM project configuration.'
Retrieve all Project configurations`getProjectList`	GET	Returns information about the UKG Pro HCM Project configurations.
Update a single project configuration`putProject`	PUT	Provides the ability update a single project configuration.

Configuration Setup: School3

Create a new school configuration`postschool`	POST	'Creates a new UKG Pro HCM school configuration.'
Retrieve all school configurations`getschoolList`	GET	Returns information about the UKG Pro HCM school configurations.
Update a single school configuration`putschool`	PUT	Provides the ability update a single school configuration.

Configuration Setup: Shift Code1

Shift Codes API DatashiftCodesAPIData GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: Single Organization Level3

Get single org-level`getorgLevels`	GET	Returns information about the UltiPro organizational level configurations.
Patch one org-level`patchorgLevels`	PATCH	Allows the ability update one or more properties of a single org-level configuration.
Update one org-level`putorgLevels`	PUT	Allows the ability update a single organizational level configuration.

Configuration Setup: Skill Proficiency Level3

Create a new skillProficiencyLevel configuration`postskillProficiencyLevel`	POST	'Creates a new UKG Pro HCM skillProficiencyLevel configuration.'
Retrieve all skillProficiencyLevel configurations`getskillProficiencyLevelList`	GET	Returns information about the UKG Pro HCM skillProficiencyLevel configurations.
Update a single skillProficiencyLevel configuration`putskillProficiencyLevel`	PUT	Provides the ability update a single skillProficiencyLevel configuration.

Configuration Setup: Skills3

Create a new skills configuration`postskills`	POST	'Creates a new UKG Pro HCM skills configuration.'
Retrieve all skills configurations`getskillsList`	GET	Returns information about the UKG Pro HCM skills configurations.
Update a single skills configuration`putskills`	PUT	Provides the ability update a single skills configuration.

Configuration Setup: Tax Groups1

Get all tax group detailsgetAllTaxGroupDetails GET taxCalcGroupIdCode optional parameter can take in multiple IDs separated by comma.

Configuration Setup: Term Type3

Create a new termType configuration`posttermType`	POST	'Creates a new UKG Pro HCM termType configuration.'
Retrieve all termType configurations`gettermTypeList`	GET	Returns information about the UKG Pro HCM termType configurations.
Update a single termType configuration`puttermType`	PUT	Provides the ability update a single termType configuration.

Configuration Setup: User Profile Details1

Get all user profile detailsgetAllUserProfileDetails GET If no pagination parameters are specified, the default/max is applied.

Configuration Setup: View or Create Organization Levels2

Create org-level configuration`postorgLevels`	POST	Creates a new UltiPro org-level configuration, Array of objects is permitted for multi-records support.
Get all org-levels`getorgLevelsList`	GET	Returns information about the Pro org-level configurations.

Configuration Setup: Waive Reason3

Create a new waiveReason configuration`postwaiveReason`	POST	'Creates a new UKG Pro HCM waiveReason configuration.'
Retrieve all waiveReason configurations`getwaiveReasonList`	GET	Returns information about the UKG Pro HCM waiveReason configurations.
Update a single waiveReason configuration`putwaiveReason`	PUT	Provides the ability update a single waiveReason configuration.

Payroll: Accruals3

Delete Accrual by Batch ID`deleteAccrualByBatchId`	DELETE	Deletes data by Batch ID from the Accruals staging table in UKG Pro.
Delete Accrual by Batch ID and Source ID`deleteAccrualByBatchIdAndSourceId`	DELETE	Deletes data by Batch ID and Source ID from the Accruals staging table table in UKG Pro.
Import Accruals Information`addAccruals`	POST	Imports Accruals information into the Accruals staging table in UKG Pro.

Payroll: Company Pay Statement2

Get employee(s) pay statement(s) for a company or pay group for a given date range.`getEmployeeSPayStatementSForACompanyOrPayGroupForAGivenDateRange`	POST	This method returns zero or more full pay statement documents for a given start date and end date.
Get employee(s) pay statement(s) summary for a company or pay group for a given date range.`getEmployeeSPayStatementSSummaryForACompanyOrPayGroupForAGivenDateRange`	POST	This method returns zero or more pay statement summaries for a given start date and end date.

Payroll: Deductions4

Create Deduction Pending Pay Item`createDeductionPendingPayItem`	POST	Creates a new UKG Pro Pending Pay record.
Delete Deduction Pending Pay Item`deleteDeductionPendingPayItem`	DELETE	This operation deletes a deduction pending pay item for an employee.
Retrieve Deduction Pending Pay Item by ID`retrieveDeductionPendingPayItemByID`	GET	Returns information about a UKG Pro employee's deduction pending pay item by payroll pending item ID.
Retrieve Deduction Pending Pay Item by Source Key`retrieveDeductionPendingPayItemBySourceKey`	GET	This operation returns a list containing information about a UKG Pro employee's deduction pending pay item by source key.

Payroll: Direct Deposit2

Get list of direct deposit details for US and Canadian employees`getListOfDirectDepositDetailsForUSAndCanadianEmployees`	GET	Get list of direct deposit details for US and Canadian employees.
Get list of direct deposit details for US and Canadian employees by company`getListOfDirectDepositDetailsForUSAndCanadianEmployeesByCompany`	GET	Get list of direct deposit details for US and Canadian employees by company.

Payroll: Earning Pending Items2

Create Earnings Pending Pay Item`createEarningsPendingPayItem`	POST	Creates a UKG Pro Pending Pay record.
Retrieve Earnings Pending Pay Item by ID`retrieveEarningsPendingPayItemByID`	GET	Returns information about a UKG Pro employee's earnings pending pay item by payroll pending item ID.

Payroll: Earnings5

Delete Earning by ID`deleteEarningByID`	DELETE	Deletes a previously imported earning that has not been processed in payroll.
Delete Earnings Pending Pay Item`deleteEarningsPendingPayItem`	DELETE	This operation deletes an earnings pending pay item for an employee.
Import Earnings for Payroll`importEarningsForPayroll`	POST	Provides earnings to UKG Pro Payroll in preparation for payroll processing.
Retrieve Earning by ID`retrieveEarningByID`	GET	This operation retrieves an earning that was previously passed to UKG Pro Payroll in preparation for payroll processing.
Retrieve Earnings Pending Pay Item by Source Key`retrieveEarningsPendingPayItemBySourceKey`	GET	This operation returns a list containing information about a UKG Pro employee's earnings pending pay item by source key.

Payroll: Earnings History1

Get Earnings History Base ElementsearningsHistoryGetInsRate GET If no pagination parameters are specified, the default/max is applied.

Payroll: Employee Pay Statement3

Get employee last pay statement based on the passed employee identifier.`getEmployeeLastPayStatementBasedOnThePassedEmployeeIdentifier`	POST	This method allows you to retrieve an individual pay statement by providing an employee identifier.
Get employee pay statement based on the given pay identifier.`getEmployeePayStatementBasedOnTheGivenPayIdentifier`	GET	This method returns zero or one pay statements based on the given pay identifier.
Get employee pay statement(s) based on the passed employee identifier for a given date range.`getEmployeePayStatementSBasedOnThePassedEmployeeIdentifierForAGivenDateRange`	POST	This method returns zero or more pay statements for a specific employee identified by the passed-in employee identifier.

Payroll: General Ledger Run Details v22

Retrieve General Ledger Run by ID`generalLedgerRunDetailsV2GetByRunId`	GET	Returns a list of details for a general ledger run by run ID, filterable by block ID.
Retrieve General Ledger Runs`generalLedgerRunDetailsV2Get`	GET	Returns a list of details for multiple general ledger runs, filterable by run ID and block ID.

Payroll: Pay Details Report2

Retrieve finalized pay history details from UKG Pro (v1). This includes earnings, deductions, and tax data.`retrieveEmployeePayDetailsReportV1`	POST	Returns finalized pay details (pay history) including all earnings, deductions, and taxes data, for a given start date and end date which indicate the pay date.
Retrieve finalized pay history details from UKG Pro, including earnings, deductions, and tax data.`companyPayDetailGetPayStatementReportsV2`	POST	Retrieve finalized pay history details from UKG Pro, including earnings, deductions, and tax data.

Payroll: Pay Group Pay Period1

Get PayGroup PayPeriodspayGroupPayPeriodGetPayGroupPayPeriod GET If no pagination parameters are specified, the default/max is applied.

Payroll: Pay Register1

Get Pay RegisterpayRegisterGet GET If no pagination parameters are specified, the default/max is applied.

Payroll: Payroll Deductions History1

Get Payroll Deductions HistorypayrollDeductionsHistoryGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: BusinessStructureStatus1

Retrieves a list of Employees for which there is a change in business structureretrievesAListOfEmployeesForWhichThereIsAChangeInBusinessStructure GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: Changes By Date1

Changes By DateemployeeChangesGetAll GET Returns all of the employee information since the last API call (3 hour minimum).

Pro Employee Data: CompensationDetails4

Get all compensation details`getAllCompensationDetails`	GET	Get all compensation details.
Get all compensation details by company`getAllCompensationDetailsByCompany`	GET	Get all compensation details by company.
Get all compensation details by company and employee`getAllCompensationDetailsByCompanyAndEmployee`	GET	Get all compensation details by company and employee.
Get all compensation details by employee`getAllCompensationDetailsByEmployee`	GET	Get all compensation details by employee.

Pro Employee Data: Contact2

Get all details for a person assigned to an employee as a contact`getAllDetailsForAPersonAssignedToAnEmployeeAsAContact`	GET	Returns all details for a person assigned to an employee as a contact.
Get all details for a single person assigned to an employee as a contact`getAllDetailsForASinglePersonAssignedToAnEmployeeAsAContact`	GET	Returns all details for a single person assigned to an employee as a contact.

Pro Employee Data: DependentDeductions1

Get Dependent DeductionsdependentDeductionsGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmpDedBenOptionDate1

Get Employee Deduction Benefit Option Change DateempDedBenOptionDateGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmpDeductions1

Get employee deductionsgetEmployeeDeductions GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmpGlobalLocalizationElement1

Get all global employee localization fields added to UKG ProempGlobalLocalizationElementGet GET Returns all global employee localization fields added to UKG Pro through platform configuration with the prefix of 'GBLPay'.

Pro Employee Data: Employee Changes1

Changes By Employee IDemployeeChangesGet GET Returns all of the employee information since the last API call (minimum 3 hours), for a specific employeeId.

Pro Employee Data: Employee Deduction History Effective Date1

Deductions History Effective Change DatedeductionsHistoryEffectiveChangeDate GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: Employee Demographic Details1

Get Employee Demographic DetailsgetEmployeeDemographicDetails GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: Employee ID Lookup1

Employee ID LookupemployeeIds POST Look up Employee ID/Company ID.

Pro Employee Data: EmployeeCobraDetails1

Get Employee Cobra DetailsemployeeCobraDetailsGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmployeeContract1

Get all employment contract detailsemployeeContractGet GET Returns all employment contract details.

Pro Employee Data: EmployeeEducation1

Get all education detailsemployeeEducationGet GET Get all education details.

Pro Employee Data: EmployeeEmploymentDetails1

Retrieve Employee Employment DetailsretrieveEmployeeEmploymentDetails GET Returns an employee's employement details according to the specified query parameters.

Pro Employee Data: EmployeeExtendedElements1

Get Employee Extended ElementsemployeeExtendedElementsGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmployeeGlobalBank1

Get all direct deposit details for global employeesemployeeGlobalBankGet GET Returns all direct deposit details for global employees.

Pro Employee Data: EmployeeJobHistoryDetail2

Get a single job history detail record`getASingleJobHistoryDetailRecord`	GET	Returns a single job history detail record.
Get all employee job history details`employeeJobHistoryDetailGet`	GET	Returns all employee job history details.

Pro Employee Data: EmployeeMultiPhoneNumbers1

Get employee multiple phone numbersemployeeMultiPhoneNumbersGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmployeeMultipleJobsOPP1

Get employee multiple jobs detailsgetEmployeeMultipleJobsDetails GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmployeePayDeductionElement1

Get Global Employee Payments and Deductions ServiceemployeePayDeductionElementGet GET Returns all global employee payments and deductions.

Pro Employee Data: EmployeeSupervisorDetails1

Get Employee Supervisor DetailsemployeeSupervisorDetailsGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: EmploymentDetails3

Retrieve Employment Details`retrieveEmploymentDetails`	GET	Returns all employment record details.
Retrieve Employment Details by Company ID`retrieveEmploymentDetailsByCompanyID`	GET	Returns all employment record details by company.
Retrieve Employment Details by Employee ID and Company`retrieveEmploymentDetailsByEmployeeIDAndCompany`	GET	Returns a single employment detail by employee ID and companyID.

Pro Employee Data: EmpMultiplePositions1

Get Employee Multiple PositionsempMultiplePositionsGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: Get All PTO Plans1

Get all pto-plansgetAllPtoPlans GET Returns information about an UltiPro employees PTO Plans.

Pro Employee Data: Get Specific Employees PTO Plans1

Get a specific employees pto-plansgetASpecificEmployeesPtoPlans GET Returns information about an UltiPro employees PTO Plans.

Pro Employee Data: Get Specific PTO Plan1

Get a specific pto-plangetASpecificPtoPlan GET Returns information about an UltiPro employees PTO Plans.

Pro Employee Data: InternationalEmployee2

Get a single employees international details`getASingleEmployeesInternationalDetails`	GET	Returns a single employees international details.
Get international employee details for all employees`internationalEmployeeGet`	GET	Returns all international employee details.

Pro Employee Data: KronosEmployeeProfiles1

Get list of employees profilegetListOfEmployeesProfile GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: KronosEmployeeStatus1

Get Employee StatuskronosEmployeeStatusGet GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: NationalDocument1

All employee national document detailsnationalDocumentGet GET All employee national document details.

Pro Employee Data: OpenEnrollmentDependentDeductions1

Get Open Enrollment Dependent Deductions DatagetOpenEnrollmentDependentDeductionsData GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: OpenEnrollmentEmployeeDeductions1

Get Open Enrollment Employee DeductionsopenEnrollmentEmployeeDeductionsGetAuditDetails GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: PersonDetails4

Get a single person detail record`getASinglePersonDetailRecord`	GET	Returns a single person detail record.
Get a single person detail record for a single company`getASinglePersonDetailRecordForASingleCompany`	GET	Returns a single person detail record for a single company.
Get all person details`getAllPersonDetails`	GET	Returns all person details.
Get all person details for a single company`getAllPersonDetailsForASingleCompany`	GET	Returns all person details for a single company.

Pro Employee Data: PTO Plan Patch1

Patch one PTO PlanpatchOnePTOPlan PATCH Allows the ability to update one PTO Plan for an employee.

Pro Employee Data: PTO Plan Post1

Create A PTO PlancreateAPTOPlan POST Creates a new UltiPro PTO plan record.

Pro Employee Data: User Preferences1

Get User Preferences DetailsgetUserPreferencesDetails GET If no pagination parameters are specified, the default/max is applied.

Pro Employee Data: UserDefinedFields3

Get User Defined Fields`getUserDefinedFields`	GET	If no pagination parameters are specified, the default/max is applied.
Get User Defined Fields for a single employee in a single company`getUserDefinedFieldsForASingleEmployeeInASingleCompany`	GET	If no pagination parameters are specified, the default/max is applied.
Get User Defined Fields for single company`getUserDefinedFieldsForSingleCompany`	GET	If no pagination parameters are specified, the default/max is applied.

Pro Import Tools: BusinessRuleImportTool4

Retrieve Business Rule Import Tool Transaction Status by File ID`businessRuleImportToolGetFileUploadStatus`	GET	Uses the File ID to fetch the Business Rule Import Tool Transaction Status.
Retrieve Business Rule Import Tool Transaction Status by Staging ID`businessRuleImportToolGetStagingStatus`	GET	Uses the Staging ID to fetch the Business Rule Import Tool Transaction Status.
Takes an XML transaction and feeds it into the Business Rule Import Tool`businessRuleImportToolBusinessRuleImportFileUpload`	POST	Submits an encoded XML transaction to the Business Rule Import Tool.
Takes an XML transaction and feeds it into the Business Rule Import Tool (Staging)`businessRuleImportToolImportsBusinessRuleStagingData`	POST	Submits an encoded XML transaction to the Business Rule Import Tool (Staging).

Pro Import Tools: ImportTool6

Fetches a summary of the file.`importToolGetFileSummary`	GET	Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).
Fetches the status of the file.`importToolGetFileStatus`	GET	Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).
Fetches the transaction name and status.`importToolGetTransactionStatus`	GET	Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).
Retrieves the status of an import tool transaction`importToolGetStatus`	GET	Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).
Takes an XML transaction and feeds it into the Import Tool`importToolImportsXmlData`	POST	Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).
Takes an XML transaction and feeds it into the Import Tool`importToolPost`	POST	Submits an encoded XML transaction to the Import Tool.

Pro Platform Configuration: PlatformConfigurationCustomFieldsSchema1

Gets Platform Configuration standard classes custom fields schemapcSchemaGetFieldsSchema GET Gets Platform Configuration standard classes custom fields schema info from the MetaDocument table.

Pro Platform Configuration: V1 PlatformConfigurationCustomFieldsData1

Platform Configuration Fields Data v1pcFieldsDataGetFieldsData GET Returns information about the UKG Pro Platform Configuration Custom Fields Data.

Pro Platform Configuration: V2 PlatformConfigurationCustomFieldsData1

Platform Configuration Fields Data v2pCFieldsDataV2GetFieldsData GET This API is similar to the v1 Platform Configuration Fields className API with added support of filtering data by KeyValue.

PRO Security: Employee Security User Details1

Get employee security user detailsgetEmployeeSecurityUserDetails GET If no pagination parameters specified, the default/max is applied.

PRO Security: RolesGet1

Gets Roles from security roles tablegetsRolesFromSecurityRolesTable GET If no pagination parameters specified, the default/max is applied.

PRO Security: UserDetails1

Get User DetailsuserDetailsGetUserDetails GET If no pagination parameters specified, the default/max is applied.

UTA: Activities1

Obtains all activities.getActivities GET Obtains all activities.

UTA: Assigned Holidays1

Obtains all assigned holidays.getAssignedHolidays GET Obtains all assigned holidays for a given employee.

UTA: Employee Jobs1

Obtains all jobs for an employee.getEmployeeJobs GET Obtains all jobs for an employee.

UTA: Employees1

Obtains all employees.getEmployees GET Obtains all employees which have been setup for scheduling.

UTA: Hour Types1

Obtains all hour types.getHourTypes GET Obtains all hour types.

UTA: Schedule Details1

Publish schedule details.putScheduleDetails PUT Publish schedule details.

UTA: Teams1

Obtains all teams.getTeams GET Obtains all teams.

UTA: Time4

Get pending clock transactions.`getClockPendingTransactions`	GET	Obtain all pending clock transactions.
Get processed clock transactions.`getClockTransactions`	GET	Obtain all processed clock transactions for a given date.
Obtain a work summary.`getWorkSummary`	GET	Obtain a work summary by the specified id.
Obtain work summaries.`getWorkSummaries`	GET	Obtain work summaries between the provided date range.

UTA: Time Codes1

Obtains all time codes.getTimeCodes GET Obtains all time codes.

UTA: Time Off Requests1

Obtains all time off requests.getTimeOffRequests GET Obtains all time off requests between the specified range.

UTA: User1

Obtains the current user information.getCurrentUser GET Retrieves the current user's details and roles.

UTA: UTA Employee1

Obtains a UTA Employee by coId and eeId.obtainsAUTAEmployeeByCoIdAndEeId GET Obtains a UTA Employee by coId and eeId.