# UKG

> Read UKG Pro HCM employee, employment, compensation and company configuration data.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/ukg

## Actions

### Get compensation details by employee

Get compensation details by employee.

**Inputs**

- Employee id (`employee_id`, text, required): employeeId.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "annualSalary": 0,
    "avgPayRateCurPer": 0,
    "bonusTotalHrs": 0,
    "bonusTotalOtHrs": 0,
    "companyID": "",
    "currencyCode": "",
    "dateInJob": "",
    "dateLastPaid": "",
    "dateLastWorked": "",
    "dateOfLastSalaryReview": "",
    "dateOfNextSalayrReview": "",
    "datePaidThru": "",
    "distributionCenterCode": "",
    "emplStatus": "",
    "employeeID": "",
    "fullTimeOrPartTimeCode": "",
    "hourlyPayRate": 0,
    "isAutoAllocated": false,
    "isAutoPaid": false,
    "isHighlyCompensated": false,
    "isMultipleJob": false,
    "isSeasonalWorker": false,
    "jobChangeReasonCode": "",
    "jobGroupCode": "",
    "jobSalaryGrade": "",
    "jobTitle": "",
    "numberOfPayments": 0,
    "otherRate1": 0,
    "otherRate2": 0,
    "otherRate3": 0,
    "otherRate4": 0,
    "payGroupCode": "",
    "payGroupDescription": "",
    "payPeriod": "",
    "payPeriodPayRate": 0,
    "payScaleCode": "",
    "performanceReviewRating": "",
    "performanceReviewType": "",
    "piecePayRate": 0,
    "primaryJobCode": "",
    "primaryShiftCode": "",
    "primaryShiftGroupCode": "",
    "salaryOrHourlyCode": "",
    "scheduledAnnualWorkHours": 0,
    "scheduledFullTimeEquivalency": 0,
    "scheduledPeriodWorkHours": 0,
    "totalAnnSalary": 0,
    "weeklyHours": 0,
    "weeklyPayRate": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get person details by employee

Get person details by employee.

**Inputs**

- Employee id (`employee_id`, text, required): employeeId.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "additionalName1": "",
    "additionalName2": "",
    "addressCity": "",
    "addressCountry": "",
    "addressCounty": "",
    "addressId": "",
    "addressIsOnTaxBoundary": false,
    "addressLatitude": 0,
    "addressLine1": "",
    "addressLine2": "",
    "addressSms": "",
    "addressState": "",
    "addressZipCode": "",
    "chkCashingInstCode": "",
    "cobraExport": "",
    "cobraIsActive": false,
    "cobraNotes": "",
    "cobraReason": "",
    "cobraStatus": "",
    "cobraStatusDate": "",
    "communityBroadcastSmsCode": "",
    "companyId": "",
    "consentElectronicW2": false,
    "consentElectronicw2pr": false,
    "dateDeceased": "",
    "dateOfBirth": "",
    "dateOfCobraEvent": "",
    "dateOfCobraExport": "",
    "dateOfCobraLetter": "",
    "dateOfI9Expiration": "",
    "datetimeChanged": "",
    "datetimeCreated": "",
    "disabilityType": "",
    "emailAddress": "",
    "emailAddressAlternate": "",
    "employeeId": "",
    "ethnicDescription": "",
    "ethnicIDCode": "",
    "firstName": "",
    "formerName": "",
    "gender": "",
    "healthBloodType": "",
    "healthEyes": "",
    "healthHair": "",
    "healthHeightFeet": "",
    "healthHeightInches": "",
    "healthLastDonateDate": "",
    "healthWeight": 0,
    "homePhone": "",
    "homePhoneCountry": "",
    "homePhoneIsPrivate": false,
    "i9AlienNumber": "",
    "i9DocA": "",
    "i9DocB": "",
    "i9DocC": "",
    "i9Verified": false,
    "i9VisaExpirationDate": "",
    "i9VisaType": "",
    "i9WorkAuth": "",
    "isDisabled": false,
    "isMultiPayGroup": false,
    "isSmoker": false,
    "lastName": "",
    "lastNameNotSameAsSSCard": "",
    "maritalStatusCode": "",
    "middleName": "",
    "militaryBranchServed": "",
    "militaryEra": "",
    "militaryIsActiveWartimeVet": "",
    "militaryIsDisabledVet": "",
    "militaryIsMedalVet": "",
    "militaryIsOthEligVet": "",
    "militaryIsOthEligVetBasis": "",
    "militarySeparationDate": "",
    "militaryService": false,
    "nameFormer": "",
    "namePrefixCode": "",
    "nameSufixCode": "",
    "nationalId": "",
    "nationalIdCountry": "",
    "nationality1": "",
    "nationality2": "",
    "nationality3": "",
    "originCountry": "",
    "originLocation": "",
    "personId": "",
    "preferredName": "",
    "previousSSN": "",
    "smsApprovals": false,
    "smsPayNotification": false,
    "ssn": "",
    "ssnIsSuppressed": false,
    "userName": "",
    "w2IsDeceased": false
  },
  "has_more": false,
  "next_cursor": null
}
```

### List audit details

List audit details. Returns one page; use the continuation value for more records.

**Inputs**

- Start date time (`start_date_time`, date and time, required): startDateTime.
- End date time (`end_date_time`, date and time, required): endDateTime.
- Table name (`table_name`, text, required): tableName.
- Field name (`field_name`, text, required): fieldName.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List company details

List company details. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text): 5 character value represents a UKG Pro HCM CompanyID
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List compensation details

List compensation details. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text): companyId.
- Employee id (`employee_id`, text): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List compensation details by company

List compensation details by company. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text, required): companyId.
- Employee id (`employee_id`, text): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List compensation details by company and employee

List compensation details by company and employee. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text, required): companyId.
- Employee id (`employee_id`, text, required): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List employee demographic details

List employee demographic details. Returns one page; use the continuation value for more records.

**Inputs**

- Employee id (`employee_id`, text): employeeId.
- Company (`company_id`, text): companyId.
- Last name (`last_name`, text): lastName.
- Email address (`email_address`, text): emailAddress.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List employee security user details

List employee security user details. Returns one page; use the continuation value for more records.

**Inputs**

- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List employee supervisor details

List employee supervisor details. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text): companyId.
- Employee id (`employee_id`, text): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List employment details

List employment details. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text): companyId.
- Employee id (`employee_id`, text): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List employment details by company

List employment details by company. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text, required): companyId.
- Employee id (`employee_id`, text): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List employment details by company and employee

List employment details by company and employee. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text, required): companyId.
- Employee id (`employee_id`, text, required): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List jobs

List jobs.

**Inputs**: None.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List locations

List locations.

**Inputs**: None.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List org levels

List org levels.

**Inputs**: None.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List person details

List person details. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text): companyId.
- Employee id (`employee_id`, text): employeeId.
- Last name (`last_name`, text): lastName.
- Email address (`email_address`, text): emailAddress.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List person details by company

List person details by company. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text, required): companyId.
- Employee id (`employee_id`, text): employeeId.
- Last name (`last_name`, text): lastName.
- Email address (`email_address`, text): emailAddress.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List person details by company and employee

List person details by company and employee. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text, required): companyId.
- Employee id (`employee_id`, text, required): employeeId.
- Last name (`last_name`, text): lastName.
- Email address (`email_address`, text): emailAddress.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List user profile details

List user profile details. Returns one page; use the continuation value for more records.

**Inputs**

- Company (`company_id`, text): companyId.
- Employee id (`employee_id`, text): employeeId.
- Page (`page`, number): page. From 1 to 2147483647.
- Per page (`per_page`, number): per_Page. From 1 to 1000.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```
