UKG Wallet and UKG Ready Integration

To allow the API user account to access all employees, add the API as a manager of the All Company Employees group.

1. At the All Company Employees Group, select the Team icon.
2. Select Add Manager.
3. Search for the API user account.
4. Select Add.
5. Configure the following permissions:
   • For Employee Time, select View.
   • For Employee Schedule, select View.
   • For Extra Pay and Counter Adjustment, select View.
   • For Employee Base Compensation, select View.
   • For Employee Pay Statement, select View and Edit.
   • For Account Information, select Edit.

Assign the API user account to a security profile. A best practice is to configure a security profile specifically for the integration.

1. Select New Security Profile.
2. Enter the name and description of the profile.
3. On the Global tab, configure the following permissions:
   1. Select the Deductions box and the following nested boxes:
      • Arrearage
      • Federal Taxability
      • Local Taxability
      • State Taxability
   2. Select the Earnings box and the following nested boxes:
      • Federal Taxability
      • Local Taxability
      • State Taxability
   3. In the Object Lists section, select the View box for Company Taxes.
4. On the TML tab, configure the following permissions:
   1. In the Timesheets section, select the View/Edit box.
   2. In the Available Views section, select the All box.
5. On the Payroll tab, configure the following permissions:
   1. In the Global Setup section, for Company taxes, select the View box. Configure the following nested permissions:
      • For Tax Documents, select the View box
      • For Tax Export Codes, select the View box
   2. In the Global Setup section, for Pay Statement Types, select the View box. Configure the following nested permissions:
      • For Block Taxabilities, select the View box
      • For Federal Taxability, select the View box
      • For State Taxability, select the View box
      • For Local Taxability, select the View box
      • For All Taxability, select the View box
   3. In the Payroll > Payrolls section, select the Create/Edit Payroll box.
   4. In the Payroll > Pay Statements section, select the View/Edit/Add box and the Payroll Tax box.
6. On the HR tab, configure the following permissions:
   1. In the Employee section, select View for the following fields:
      • Employee Information
      • Account/Personal Information
      • Additional Compensation
      • Additional Compensation Settings
      • Base Compensation
      • Dates
      • Deductions
      • Demographics
      • Demographics Custom Views
      • Earnings
      • Employee Badges
      • Employee Contacts
      • External Id
      • Extra Fields
      • HR Custom Values
      • Jobs
      • Profiles
      • Tax Jurisdiction
      • Termination Details
      • Total Compensation
      • Year End Tax Forms
   2. In the Employee section, for Direct Deposits, select View/Edit, Add, and Delete.
7. On the Modules tab, configure the following permissions:
   1. In the Imports section, select the following boxes:
      • Employees
      • Import Overview/Templates
   2. In the Rest API Resources section, select the following boxes:
      • Employee Pay Information View and Edit boxes
      • Employee Tax Information View and Edit boxes
      • Employees View box
8. On the Reports tab, configure the following permissions:
   1. In the Reports section, select the Export Reports box and the following fields listed next to Export Reports:
      • CSV/Text
      • Excel
      • HTML
      • XML
   2. In the Calculated Time Reports section, select the Detailed Calculated Time box.
   3. In the Payroll Reports section, select the E/D/T Listing box.
   4. Select the Pay Statement History box.
9. Select Save.

After the security profile has been created, open the API user account.

1. Select the User Account.
2. Search for "Profile." The Profile menu appears.
3. From the Profile menu, select the Security field. The Browse and Select Security window appears.
4. Select the new security profile.
5. Select Save.

Complete the following steps to add a deduction code.

1. Select Add New Deduction Code.
2. From the Roll Up Deduction dropdown, you can select UKG Wallet Advance. It is recommended to consult with payroll and tax experts before finalizing the deduction.
3. Review the following guidelines for deductions:
   1. The deduction should be a post-tax deduction.
   2. The deduction should only have employee contribution. Employer contribution is not applicable.
   3. There is no minimum or maximum value.
   4. The Default Amount is Flat $ amount.
   5. The deduction is not a scheduled deduction. Payactiv posts deductions only when an employee takes an advance.
   6. If an employee is under-deducted, Payactiv sends arrears in the subsequent pay period. The Arrearage Function field should be set to Discard Underdfunded Amount and the Arrears Happen field should be set to With the Deduction.