> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # ukg-employee-admin > UKG Pro Employee Admin - imports, deductions, benefits enrollment, PTO plans, and user preferences **Server path:** `/ukg-employee-admin` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | [`ukg-employee-admin_dependent_deductions_get`](#ukg-employee-admin_dependent_deductions_get) | Get Dependent Deductions | | [`ukg-employee-admin_emp_ded_ben_option_date_get`](#ukg-employee-admin_emp_ded_ben_option_date_get) | Get Employee Deduction Benefit Option Change Date | | [`ukg-employee-admin_get_personnel_v1_audit_details`](#ukg-employee-admin_get_personnel_v1_audit_details) | Get Audit Details Data | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_compensation_details`](#ukg-employee-admin_get_personnel_v1_companies_company_id_compensation_details) | Get all compensation details by company | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_compensation_details`](#ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_compensation_details) | Get all compensation details by company and employee | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_employment_details`](#ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_employment_details) | Retrieve Employment Details by Employee ID and Company | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_person_details`](#ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_person_details) | Get a single person detail record for a single company | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_pto_plans`](#ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_pto_plans) | Get a specific employees pto-plans | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_pto_plans_pto_plan`](#ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_pto_plans_pto_plan) | Get a specific pto-plan | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_user_defined_fields`](#ukg-employee-admin_get_personnel_v1_companies_company_id_employees_employee_id_user_defined_fields) | Get User Defined Fields for a single employee in a single company | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_employment_details`](#ukg-employee-admin_get_personnel_v1_companies_company_id_employment_details) | Retrieve Employment Details by Company ID | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_person_details`](#ukg-employee-admin_get_personnel_v1_companies_company_id_person_details) | Get all person details for a single company | | [`ukg-employee-admin_get_personnel_v1_companies_company_id_user_defined_fields`](#ukg-employee-admin_get_personnel_v1_companies_company_id_user_defined_fields) | Get User Defined Fields for single company | | [`ukg-employee-admin_get_personnel_v1_deduction_history_effective_change_dates`](#ukg-employee-admin_get_personnel_v1_deduction_history_effective_change_dates) | Deductions History Effective Change Date | | [`ukg-employee-admin_get_personnel_v1_emp_deductions`](#ukg-employee-admin_get_personnel_v1_emp_deductions) | Get employee deductions | | [`ukg-employee-admin_get_personnel_v1_integration_audit_configuration`](#ukg-employee-admin_get_personnel_v1_integration_audit_configuration) | Get Integration Audit Configuration Data | | [`ukg-employee-admin_get_personnel_v1_integration_kronos_business_structure_status`](#ukg-employee-admin_get_personnel_v1_integration_kronos_business_structure_status) | Gets a list of Employees for which there is a change in business structure | | [`ukg-employee-admin_get_personnel_v1_integration_kronos_employee_profiles`](#ukg-employee-admin_get_personnel_v1_integration_kronos_employee_profiles) | Get list of employees profile | | [`ukg-employee-admin_get_personnel_v1_open_enrollment_dep_deductions`](#ukg-employee-admin_get_personnel_v1_open_enrollment_dep_deductions) | Get Open Enrollment Dependent Deductions Data | | [`ukg-employee-admin_get_personnel_v1_pto_plans`](#ukg-employee-admin_get_personnel_v1_pto_plans) | Get all pto-plans | | [`ukg-employee-admin_get_personnel_v1_user_defined_fields`](#ukg-employee-admin_get_personnel_v1_user_defined_fields) | Get User Defined Fields | | [`ukg-employee-admin_get_personnel_v1_user_preferences`](#ukg-employee-admin_get_personnel_v1_user_preferences) | Get User Preferences Details | | [`ukg-employee-admin_import_tool_get_file_status`](#ukg-employee-admin_import_tool_get_file_status) | Fetches the status of the file. | | [`ukg-employee-admin_import_tool_get_file_summary`](#ukg-employee-admin_import_tool_get_file_summary) | Fetches a summary of the file. | | [`ukg-employee-admin_import_tool_get_status`](#ukg-employee-admin_import_tool_get_status) | Retrieves the status of an import tool transaction | | [`ukg-employee-admin_import_tool_get_transaction_status`](#ukg-employee-admin_import_tool_get_transaction_status) | Fetches the transaction name and status. | | [`ukg-employee-admin_import_tool_imports_xml_data`](#ukg-employee-admin_import_tool_imports_xml_data) | Takes an XML transaction and feeds it into the Import Tool | | [`ukg-employee-admin_import_tool_post`](#ukg-employee-admin_import_tool_post) | Takes an XML transaction and feeds it into the Import Tool | | [`ukg-employee-admin_kronos_employee_status_get`](#ukg-employee-admin_kronos_employee_status_get) | Get Employee Status | | [`ukg-employee-admin_open_enrollment_employee_deductions_get_audit_details`](#ukg-employee-admin_open_enrollment_employee_deductions_get_audit_details) | Get Open Enrollment Employee Deductions | | [`ukg-employee-admin_patch_personnel_v1_companies_company_id_employees_employee_id_pto_plans_pto_plan`](#ukg-employee-admin_patch_personnel_v1_companies_company_id_employees_employee_id_pto_plans_pto_plan) | Patch one PTO Plan | | [`ukg-employee-admin_pay_deduction_element_get`](#ukg-employee-admin_pay_deduction_element_get) | Get Global Employee Payments and Deductions Service | | [`ukg-employee-admin_pc_fields_data_get_fields_data`](#ukg-employee-admin_pc_fields_data_get_fields_data) | Platform Configuration Fields Data v1 | | [`ukg-employee-admin_pcfields_data_v2_get_fields_data`](#ukg-employee-admin_pcfields_data_v2_get_fields_data) | Platform Configuration Fields Data v2 | | [`ukg-employee-admin_post_personnel_v1_pto_plans`](#ukg-employee-admin_post_personnel_v1_pto_plans) | Create A PTO Plan | *** ## ukg-employee-admin\_dependent\_deductions\_get Get Dependent Deductions **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `companyId` | string | No | — | Company Id | | `contactId` | string | No | — | Contact Id | | `deductionCode` | string | No | — | Deduction Code | | `employeeId` | string | No | — | Employee Id | | `effectiveDate` | string | No | — | Effective Date | | `currentCOID` | string | No | — | Current COID | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "contactId": { "type": "string", "description": "Contact Id" }, "deductionCode": { "type": "string", "description": "Deduction Code" }, "employeeId": { "type": "string", "description": "Employee Id" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "currentCOID": { "type": "string", "description": "Current COID" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_emp\_ded\_ben\_option\_date\_get Get Employee Deduction Benefit Option Change Date **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `companyId` | string | No | — | Company Id | | `deductionCode` | string | No | — | Deduction Code | | `effectiveDate` | string | No | — | Effective Date | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "deductionCode": { "type": "string", "description": "Deduction Code" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_audit\_details Get Audit Details Data **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `startDateTime` | string | Yes | — | Start Date Time | | `endDateTime` | string | Yes | — | End Date Time | | `tableName` | string | Yes | — | Table Name | | `fieldName` | string | Yes | — | Field Name | | `action` | string | No | — | The action value | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "startDateTime": { "type": "string", "description": "Start Date Time" }, "endDateTime": { "type": "string", "description": "End Date Time" }, "tableName": { "type": "string", "description": "Table Name" }, "fieldName": { "type": "string", "description": "Field Name" }, "action": { "type": "string", "description": "The action value" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "startDateTime", "endDateTime", "tableName", "fieldName" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_compensation\_details Get all compensation details by company **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "primaryJobCode": { "type": "string", "description": "Primary Job Code" }, "jobGroupCode": { "type": "string", "description": "Job Group Code" }, "jobTitle": { "type": "string", "description": "Job Title" }, "payGroupCode": { "type": "string", "description": "Pay Group Code" }, "fullTimeOrPartTimeCode": { "type": "string", "description": "Full Time Or Part Time Code" }, "salaryOrHourlyCode": { "type": "string", "description": "Salary Or Hourly Code" }, "primaryShiftCode": { "type": "string", "description": "Primary Shift Code" }, "primaryShiftGroupCode": { "type": "string", "description": "Primary Shift Group Code" }, "dateInJob": { "type": "string", "description": "Used to find date in job less than, greater than, equal to, or between passed date(s)" }, "dateLastPaid": { "type": "string", "description": "Used to find date last paid less than, greater than, equal to, or between passed date(s)" }, "datePaidThru": { "type": "string", "description": "Used to find date paid through less than, greater than, equal to, or between passed date(s)" }, "isAutoAllocated": { "type": "string", "description": "Is Auto Allocated" }, "isAutoPaid": { "type": "string", "description": "Is Auto Paid" }, "isSeasonalWorker": { "type": "string", "description": "Is Seasonal Worker" }, "isHighlyCompensated": { "type": "string", "description": "Is Highly Compensated" }, "isMultipleJob": { "type": "string", "description": "Is Multiple Job" }, "performanceReviewRating": { "type": "string", "description": "Performance Review Rating" }, "performanceReviewType": { "type": "string", "description": "Performance Review Type" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_employees\_employee\_id\_compensation\_details Get all compensation details by company and employee **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | Company Id | | `employeeId` | string | Yes | — | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "primaryJobCode": { "type": "string", "description": "Primary Job Code" }, "jobGroupCode": { "type": "string", "description": "Job Group Code" }, "jobTitle": { "type": "string", "description": "Job Title" }, "payGroupCode": { "type": "string", "description": "Pay Group Code" }, "fullTimeOrPartTimeCode": { "type": "string", "description": "Full Time Or Part Time Code" }, "salaryOrHourlyCode": { "type": "string", "description": "Salary Or Hourly Code" }, "primaryShiftCode": { "type": "string", "description": "Primary Shift Code" }, "primaryShiftGroupCode": { "type": "string", "description": "Primary Shift Group Code" }, "dateInJob": { "type": "string", "description": "Used to find date in job less than, greater than, equal to, or between passed date(s)" }, "dateLastPaid": { "type": "string", "description": "Used to find date last paid less than, greater than, equal to, or between passed date(s)" }, "datePaidThru": { "type": "string", "description": "Used to find date paid through less than, greater than, equal to, or between passed date(s)" }, "isAutoAllocated": { "type": "string", "description": "Is Auto Allocated" }, "isAutoPaid": { "type": "string", "description": "Is Auto Paid" }, "isSeasonalWorker": { "type": "string", "description": "Is Seasonal Worker" }, "isHighlyCompensated": { "type": "string", "description": "Is Highly Compensated" }, "isMultipleJob": { "type": "string", "description": "Is Multiple Job" }, "performanceReviewRating": { "type": "string", "description": "Performance Review Rating" }, "performanceReviewType": { "type": "string", "description": "Performance Review Type" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId", "employeeId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_employees\_employee\_id\_employment\_details Retrieve Employment Details by Employee ID and Company **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | --------------------------- | | `companyId` | string | Yes | — | Company Id | | `employeeId` | string | Yes | — | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "primaryJobCode": { "type": "string", "description": "Primary Job Code" }, "jobTitle": { "type": "string", "description": "Job Title" }, "fullTimeOrPartTimeCode": { "type": "string", "description": "Full Time Or Part Time Code" }, "primaryWorkLocationCode": { "type": "string", "description": "Primary Work Location Code" }, "primaryProjectCode": { "type": "string", "description": "Primary Project Code" }, "deductionGroupCode": { "type": "string", "description": "Deduction Group Code" }, "earningGroupCode": { "type": "string", "description": "Earning Group Code" }, "employeeTypeCode": { "type": "string", "description": "Employee Type Code" }, "employeeStatusCode": { "type": "string", "description": "Employee Status Code" }, "employeeNumber": { "type": "string", "description": "Employee Number" }, "supervisorID": { "type": "string", "description": "Supervisor ID" }, "originalHireDate": { "type": "string", "description": "Original Hire Date" }, "lastHireDate": { "type": "string", "description": "Last Hire Date" }, "dateOfTermination": { "type": "string", "description": "Date Of Termination" }, "dateOfRetirement": { "type": "string", "description": "Date Of Retirement" }, "dateTimeCreated": { "type": "string", "description": "Date Time Created" }, "dateTimeChanged": { "type": "string", "description": "Date Time Changed" }, "dateLastPayDatePaid": { "type": "string", "description": "Date Last Pay Date Paid" }, "payGroup": { "type": "string", "description": "Pay Group" }, "isHomeCompany": { "type": "boolean", "description": "Is Home Company" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId", "employeeId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_employees\_employee\_id\_person\_details Get a single person detail record for a single company **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | Company Id | | `employeeId` | string | Yes | — | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "lastName": { "type": "string", "description": "Last Name" }, "emailAddress": { "type": "string", "description": "Email Address" }, "addressState": { "type": "string", "description": "Address State" }, "addressCountry": { "type": "string", "description": "Address Country" }, "cobraIsActive": { "type": "string", "description": "Cobra Is Active" }, "cobraStatus": { "type": "string", "description": "Cobra Status" }, "dateOfCobraEvent": { "type": "string", "description": "Used to find date of COBRA event less than, greater than, equal to, or between passed date(s)" }, "dateTimeCreated": { "type": "string", "description": "Used to find person record created less than, greater than, equal to, or between passed date(s)" }, "dateTimeChanged": { "type": "string", "description": "Used to find person record changed less than, greater than, equal to, or between passed date(s)" }, "nationalId": { "type": "string", "description": "National Id" }, "nationalIdCountry": { "type": "string", "description": "National Id Country" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId", "employeeId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_employees\_employee\_id\_pto\_plans Get a specific employees pto-plans **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------------------------------------------- | | `companyId` | string | Yes | — | Company Identifier | | `employeeId` | string | Yes | — | Employee Identifier | | `page` | number | No | — | Pagination, which page you want to see | | `per_page` | number | No | — | Pagination, how many records per page you want to see | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Identifier" }, "employeeId": { "type": "string", "description": "Employee Identifier" }, "page": { "type": "number", "description": "Pagination, which page you want to see" }, "per_page": { "type": "number", "description": "Pagination, how many records per page you want to see" } }, "required": [ "PCID", "companyId", "employeeId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_employees\_employee\_id\_pto\_plans\_pto\_plan Get a specific pto-plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------- | | `companyId` | string | Yes | — | Company Identifier | | `employeeId` | string | Yes | — | Employee Identifier | | `ptoPlan` | string | Yes | — | PTO Plan Identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Identifier" }, "employeeId": { "type": "string", "description": "Employee Identifier" }, "ptoPlan": { "type": "string", "description": "PTO Plan Identifier" } }, "required": [ "PCID", "companyId", "employeeId", "ptoPlan" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_employees\_employee\_id\_user\_defined\_fields Get User Defined Fields for a single employee in a single company **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------- | | `companyId` | string | Yes | — | Company Id | | `employeeId` | string | Yes | — | Employee Id | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId", "employeeId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_employment\_details Retrieve Employment Details by Company ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | --------------------------- | | `companyId` | string | Yes | — | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "primaryJobCode": { "type": "string", "description": "Primary Job Code" }, "jobTitle": { "type": "string", "description": "Job Title" }, "fullTimeOrPartTimeCode": { "type": "string", "description": "Full Time Or Part Time Code" }, "primaryWorkLocationCode": { "type": "string", "description": "Primary Work Location Code" }, "primaryProjectCode": { "type": "string", "description": "Primary Project Code" }, "deductionGroupCode": { "type": "string", "description": "Deduction Group Code" }, "earningGroupCode": { "type": "string", "description": "Earning Group Code" }, "employeeTypeCode": { "type": "string", "description": "Employee Type Code" }, "employeeStatusCode": { "type": "string", "description": "Employee Status Code" }, "employeeNumber": { "type": "string", "description": "Employee Number" }, "supervisorID": { "type": "string", "description": "Supervisor ID" }, "originalHireDate": { "type": "string", "description": "Original Hire Date" }, "lastHireDate": { "type": "string", "description": "Last Hire Date" }, "dateOfTermination": { "type": "string", "description": "Date Of Termination" }, "dateOfRetirement": { "type": "string", "description": "Date Of Retirement" }, "dateTimeCreated": { "type": "string", "description": "Date Time Created" }, "dateTimeChanged": { "type": "string", "description": "Date Time Changed" }, "dateLastPayDatePaid": { "type": "string", "description": "Date Last Pay Date Paid" }, "payGroup": { "type": "string", "description": "Pay Group" }, "isHomeCompany": { "type": "boolean", "description": "Is Home Company" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_person\_details Get all person details for a single company **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "lastName": { "type": "string", "description": "Last Name" }, "emailAddress": { "type": "string", "description": "Email Address" }, "addressState": { "type": "string", "description": "Address State" }, "addressCountry": { "type": "string", "description": "Address Country" }, "cobraIsActive": { "type": "string", "description": "Cobra Is Active" }, "cobraStatus": { "type": "string", "description": "Cobra Status" }, "dateOfCobraEvent": { "type": "string", "description": "Used to find date of COBRA event less than, greater than, equal to, or between passed date(s)" }, "dateTimeCreated": { "type": "string", "description": "Used to find person record created less than, greater than, equal to, or between passed date(s)" }, "dateTimeChanged": { "type": "string", "description": "Used to find person record changed less than, greater than, equal to, or between passed date(s)" }, "nationalId": { "type": "string", "description": "National Id" }, "nationalIdCountry": { "type": "string", "description": "National Id Country" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_companies\_company\_id\_user\_defined\_fields Get User Defined Fields for single company **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------- | | `companyId` | string | Yes | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_deduction\_history\_effective\_change\_dates Deductions History Effective Change Date **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `companyId` | string | No | — | Company Id | | `sessionDate` | string | No | — | Session Date | | `fieldName` | string | Yes | — | Field Name | | `deductionCode` | string | Yes | — | Deduction Code | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "sessionDate": { "type": "string", "description": "Session Date" }, "fieldName": { "type": "string", "description": "Field Name" }, "deductionCode": { "type": "string", "description": "Deduction Code" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "fieldName", "deductionCode" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_emp\_deductions Get employee deductions **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `employeeId` | string | No | — | Employee Id | | `companyId` | string | No | — | Company Id | | `dedCode` | string | Yes | — | Ded Code | | `benStatus` | string | No | — | Ben Status | | `benefitOption` | string | No | — | Benefit Option | | `endDateTime` | string | No | — | End Date Time | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "companyId": { "type": "string", "description": "Company Id" }, "dedCode": { "type": "string", "description": "Ded Code" }, "benStatus": { "type": "string", "description": "Ben Status" }, "benefitOption": { "type": "string", "description": "Benefit Option" }, "endDateTime": { "type": "string", "description": "End Date Time" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "dedCode" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_integration\_audit\_configuration Get Integration Audit Configuration Data **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------------------- | | `tableName` | string | No | — | Table Name | | `fieldName` | string | No | — | Field Name | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableName": { "type": "string", "description": "Table Name" }, "fieldName": { "type": "string", "description": "Field Name" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_integration\_kronos\_business\_structure\_status Gets a list of Employees for which there is a change in business structure **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | -------------------------- | | `modifiedAfterDateTime` | string | Yes | — | Modified After Date Time | | `companyId` | string | Yes | — | Company Id | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "modifiedAfterDateTime": { "type": "string", "description": "Modified After Date Time" }, "companyId": { "type": "string", "description": "Company Id" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "employeeId": { "type": "string", "description": "Employee Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "modifiedAfterDateTime", "companyId" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_integration\_kronos\_employee\_profiles Get list of employees profile **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------------- | ------- | -------- | ------- | ---------------------------------- | | `product` | string | Yes | — | The product value | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `effectiveDate` | string | No | — | Effective Date | | `changeWindow` | integer | No | — | Change Window | | `includeHistoryIfChangeDetected` | boolean | No | — | Include History If Change Detected | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "product": { "type": "string", "description": "The product value" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "changeWindow": { "type": "integer", "description": "Change Window" }, "includeHistoryIfChangeDetected": { "type": "boolean", "description": "Include History If Change Detected" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "product" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_open\_enrollment\_dep\_deductions Get Open Enrollment Dependent Deductions Data **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `startDateTime` | string | Yes | — | Start Date Time | | `endDateTime` | string | Yes | — | End Date Time | | `sessionType` | string | Yes | — | Session Type | | `deductionCode` | string | Yes | — | Deduction Code | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "startDateTime": { "type": "string", "description": "Start Date Time" }, "endDateTime": { "type": "string", "description": "End Date Time" }, "sessionType": { "type": "string", "description": "Session Type" }, "deductionCode": { "type": "string", "description": "Deduction Code" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "startDateTime", "endDateTime", "sessionType", "deductionCode" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_pto\_plans Get all pto-plans **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------------------------------- | | `page` | number | No | — | Pagination, which page you want to see | | `per_page` | number | No | — | Pagination, how many records per page you want to see | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "Pagination, which page you want to see" }, "per_page": { "type": "number", "description": "Pagination, how many records per page you want to see" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_user\_defined\_fields Get User Defined Fields **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------- | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_get\_personnel\_v1\_user\_preferences Get User Preferences Details **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | -------------------------- | | `userID` | string | No | — | User ID | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userID": { "type": "string", "description": "User ID" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_import\_tool\_get\_file\_status Fetches the status of the file. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------- | | `fileId` | string | Yes | — | A unique identifier for the file. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "string", "description": "A unique identifier for the file." } }, "required": [ "PCID", "fileId" ] } ``` *** ## ukg-employee-admin\_import\_tool\_get\_file\_summary Fetches a summary of the file. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------- | | `fileId` | string | Yes | — | A unique identifier for the file. | | `page` | integer | No | — | The number of pages in the file. Minimum = 1 and maximum = 2147483647. | | `per_Page` | integer | No | — | The name of the file. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "string", "description": "A unique identifier for the file." }, "page": { "type": "integer", "description": "The number of pages in the file. Minimum = 1 and maximum = 2147483647." }, "per_Page": { "type": "integer", "description": "The name of the file." } }, "required": [ "PCID", "fileId" ] } ``` *** ## ukg-employee-admin\_import\_tool\_get\_status Retrieves the status of an import tool transaction **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `stagingId` | string | Yes | — | Staging Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stagingId": { "type": "string", "description": "Staging Id" } }, "required": [ "PCID", "stagingId" ] } ``` *** ## ukg-employee-admin\_import\_tool\_get\_transaction\_status Fetches the transaction name and status. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_import\_tool\_imports\_xml\_data Takes an XML transaction and feeds it into the Import Tool ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_import\_tool\_post Takes an XML transaction and feeds it into the Import Tool **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | --------------------------------------- | | `transaction` | string | No | — | The XML Serialized transaction | | `uniqueFileName` | string | No | — | An optionally provided unique file name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "transaction": { "type": "string", "description": "The XML Serialized transaction" }, "uniqueFileName": { "type": "string", "description": "An optionally provided unique file name" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_kronos\_employee\_status\_get Get Employee Status **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | -------------------------- | | `effectiveDate` | string | No | — | Effective Date | | `companyId` | string | No | — | Company Id | | `employeeIds` | string | No | — | Employee Ids | | `inactiveTermWindow` | integer | No | — | Inactive Term Window | | `inactiveDisabledWindow` | integer | No | — | Inactive Disabled Window | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeIds": { "type": "string", "description": "Employee Ids" }, "inactiveTermWindow": { "type": "integer", "description": "Inactive Term Window" }, "inactiveDisabledWindow": { "type": "integer", "description": "Inactive Disabled Window" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_open\_enrollment\_employee\_deductions\_get\_audit\_details Get Open Enrollment Employee Deductions **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `startDateTime` | string | Yes | — | Start Date Time | | `endDateTime` | string | Yes | — | End Date Time | | `sessionType` | string | Yes | — | Session Type | | `deductionCode` | string | Yes | — | Deduction Code | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "startDateTime": { "type": "string", "description": "Start Date Time" }, "endDateTime": { "type": "string", "description": "End Date Time" }, "sessionType": { "type": "string", "description": "Session Type" }, "deductionCode": { "type": "string", "description": "Deduction Code" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "startDateTime", "endDateTime", "sessionType", "deductionCode" ] } ``` *** ## ukg-employee-admin\_patch\_personnel\_v1\_companies\_company\_id\_employees\_employee\_id\_pto\_plans\_pto\_plan Patch one PTO Plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------- | | `companyId` | string | Yes | — | Company Identifier | | `employeeId` | string | Yes | — | Employee Identifier | | `ptoPlan` | string | Yes | — | PTO Plan Identifier | | `earned` | number | No | — | Amount of hours earned for PTO | | `earnedThroughDate` | string | No | — | Date in which PTO is earned through, format should be YYYY-MM-DD | | `pendingBalance` | number | No | — | Balance of PTO hours | | `pendingMoveDate` | string | No | — | Date to be used if pending rules are relevant, format should be YYYY-MM-DD | | `reset` | string | No | — | Date in which the PTO reset's, format should be YYYY-MM-DD | | `taken` | number | No | — | Amount of hours taken for PTO | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Identifier" }, "employeeId": { "type": "string", "description": "Employee Identifier" }, "ptoPlan": { "type": "string", "description": "PTO Plan Identifier" }, "earned": { "type": "number", "description": "Amount of hours earned for PTO" }, "earnedThroughDate": { "type": "string", "description": "Date in which PTO is earned through, format should be YYYY-MM-DD" }, "pendingBalance": { "type": "number", "description": "Balance of PTO hours" }, "pendingMoveDate": { "type": "string", "description": "Date to be used if pending rules are relevant, format should be YYYY-MM-DD" }, "reset": { "type": "string", "description": "Date in which the PTO reset's, format should be YYYY-MM-DD" }, "taken": { "type": "number", "description": "Amount of hours taken for PTO" } }, "required": [ "PCID", "companyId", "employeeId", "ptoPlan" ] } ``` *** ## ukg-employee-admin\_pay\_deduction\_element\_get Get Global Employee Payments and Deductions Service **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `country` | string | No | — | The country value | | `payGroup` | string | No | — | Pay Group | | `payDeductionName` | string | No | — | Pay Deduction Name | | `periodStartName` | string | No | — | Period Start Name | | `paymentOrDeductionIndicator` | string | No | — | Payment Or Deduction Indicator | | `modifiedDate` | string | No | — | Used to find a payment or deduction modified less than, greater than, equal to, or between passed date(s) | | `startDate` | string | No | — | Used to find a payment or deduction where the pay period start is less than, greater than, equal to, or between passed date(s) | | `endDate` | string | No | — | Used to find a payment or deduction where the pay period end is 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "country": { "type": "string", "description": "The country value" }, "payGroup": { "type": "string", "description": "Pay Group" }, "payDeductionName": { "type": "string", "description": "Pay Deduction Name" }, "periodStartName": { "type": "string", "description": "Period Start Name" }, "paymentOrDeductionIndicator": { "type": "string", "description": "Payment Or Deduction Indicator" }, "modifiedDate": { "type": "string", "description": "Used to find a payment or deduction modified less than, greater than, equal to, or between passed date(s)" }, "startDate": { "type": "string", "description": "Used to find a payment or deduction where the pay period start is less than, greater than, equal to, or between passed date(s)" }, "endDate": { "type": "string", "description": "Used to find a payment or deduction where the pay period end is less than, greater than, equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-admin\_pc\_fields\_data\_get\_fields\_data Platform Configuration Fields Data v1 **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `className` | string | Yes | — | The name of a supported class, as listed above, to pull custom fields from. | | `keyName` | string | No | — | Optional keyName to allow filtering results by the corresponding keyValue. keyNames are specific IDs that apply to the class in question. | | `keyValue` | string | No | — | Optional keyValue. Allows filtering results to only include a specific keyValue(s). keyValues correspond to a supplied keyName. | | `fields` | string | No | — | The exact name of a custom field or fields in a comma seperated list. Filters results to only fields with those names. | | `employmentStatus` | string | No | — | Use in junction with employment specific queries to filter custom field results by an internal employment status. | | `page` | integer | No | — | Offsets results. Used with page number to allow filtering results to a specific range of custom fields. | | `per_Page` | integer | No | — | Offsets results. Used with page to allow filtering results to a specific range of custom fields. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "className": { "type": "string", "description": "The name of a supported class, as listed above, to pull custom fields from." }, "keyName": { "type": "string", "description": "Optional keyName to allow filtering results by the corresponding keyValue. keyNames are specific IDs that apply to the class in question." }, "keyValue": { "type": "string", "description": "Optional keyValue. Allows filtering results to only include a specific keyValue(s). keyValues correspond to a supplied keyName." }, "fields": { "type": "string", "description": "The exact name of a custom field or fields in a comma seperated list. Filters results to only fields with those names." }, "employmentStatus": { "type": "string", "description": "Use in junction with employment specific queries to filter custom field results by an internal employment status." }, "page": { "type": "integer", "description": "Offsets results. Used with page number to allow filtering results to a specific range of custom fields." }, "per_Page": { "type": "integer", "description": "Offsets results. Used with page to allow filtering results to a specific range of custom fields." } }, "required": [ "PCID", "className" ] } ``` *** ## ukg-employee-admin\_pcfields\_data\_v2\_get\_fields\_data Platform Configuration Fields Data v2 **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `className` | string | Yes | — | The name of a supported class, as listed above, to pull custom fields from. | | `fields` | string | No | — | The exact name of a custom field or fields in a comma seperated list. Filters results to only fields with those names. | | `keyValue` | string | No | — | keyValue to filter results by, allowing filtering by specific Ids. This value is dependent on the className, as listed in the implementation notes. | | `page` | integer | No | — | Offsets results. Used with page number to allow filtering results to a certain range of custom fields. | | `per_Page` | integer | No | — | Offsets results. Used with page to allow filtering results to a certain range of custom fields. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "className": { "type": "string", "description": "The name of a supported class, as listed above, to pull custom fields from." }, "fields": { "type": "string", "description": "The exact name of a custom field or fields in a comma seperated list. Filters results to only fields with those names." }, "keyValue": { "type": "string", "description": "keyValue to filter results by, allowing filtering by specific Ids. This value is dependent on the className, as listed in the implementation notes." }, "page": { "type": "integer", "description": "Offsets results. Used with page number to allow filtering results to a certain range of custom fields." }, "per_Page": { "type": "integer", "description": "Offsets results. Used with page to allow filtering results to a certain range of custom fields." } }, "required": [ "PCID", "className" ] } ``` *** ## ukg-employee-admin\_post\_personnel\_v1\_pto\_plans Create A PTO Plan **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | -------------------------- | | `body` | object\[] | Yes | — | The pto-plan to be written | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee Identifier" }, "companyId": { "type": "string", "description": "Company Identifier" }, "ptoPlan": { "type": "string", "description": "PTO Plan Identifier" }, "earned": { "type": "number", "format": "double", "description": "Amount of hours earned for PTO" }, "taken": { "type": "number", "format": "double", "description": "Amount of hours taken for PTO" }, "pendingBalance": { "type": "number", "format": "double", "description": "Balance of PTO hours" }, "earnedThroughDate": { "type": "string", "description": "Date in which PTO is earned through, format should be YYYY-MM-DD" }, "reset": { "type": "string", "description": "Date in which the PTO reset's, format should be YYYY-MM-DD" }, "pendingMoveDate": { "type": "string", "description": "Date to be used if pending rules are relevant, format should be YYYY-MM-DD" } }, "required": [ "employeeId", "companyId", "ptoPlan" ] }, "description": "The pto-plan to be written" } }, "required": [ "PCID", "body" ] } ```