> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# UKG Ready HRIS Integration
> UKG Ready connector for Kombo's HRIS API
The UKG Ready HRIS integration allows you to sync HRIS data between UKG Ready and your application through Kombo's unified API. The tool slug for this connector is `ukgready`.
## Guides and Resources
Step-by-step instructions to connect your UKG Ready account to Kombo.
## Supported Features & Coverage
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| address | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_number | |
| first\_name | |
| last\_name | |
| display\_full\_name | |
| work\_email | |
| personal\_email | The personal email is not exposed via the API. |
| mobile\_phone\_number | |
| ssn | |
| gender | |
| ethnicity | |
| employment\_status | |
| employment\_type | |
| weekly\_hours | Calculated by multiplying "standard\_work\_day" by 5 days. |
| avatar | |
| work\_location\_id | |
| legal\_entity\_id | |
| manager\_id | |
| home\_address | |
| date\_of\_birth | |
| start\_date | |
| termination\_date | |
| custom\_fields | |
| integration\_fields | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| unit | |
| half\_days\_supported | |
| exact\_times\_supported | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| start\_date | |
| end\_date | |
| start\_time | |
| end\_time | |
| amount | |
| unit | |
| status | |
| type\_id | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| job\_title | |
| pay\_rate | |
| pay\_period | |
| pay\_currency | |
| effective\_date | |
| remote\_data | |
| custom\_fields | |
| integration\_fields | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| type | |
| parent\_id | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| started\_at | |
| ended\_at | |
| timezone | |
| payable\_hours | |
| approval\_status | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| start\_date | |
| end\_date | |
| legal\_entity\_id | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| pay\_run\_id | |
| remote\_data | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| Field | Notes |
| - | - |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| payslip\_id | |
| salary\_type\_id | |
| amount | |
| remote\_data | |
| Field | Notes |
| - | - |
| employee\_id | |
| team\_id | |
| id | |
| changed\_at | |
| remote\_deleted\_at | |
For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.
| Input Field | Notes |
| - | - |
| staffing\_entity\_id | |
| properties | |
| Feature | Notes |
| - | - |
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Delta Syncs | |
| Custom Field Explorer | |
| Employees | |
| Employments | |
| Connection Guide | |
| Group Types | |
| COST\_CENTER | |
This integration supports multiple employee creation forms for different use cases:
**Username**
Username for the employee. If not provided, a random value is generated.
**External Id**
**New Employee Id**
**Badge Id**
**Badge Id 2**
**Badge Id 3**
**EIN Tax Id**
**EIN Name**
**Primary EIN**
Set to "Y" to mark this EIN as primary for the employee
**Employee Sync**
**Salutation**
**First Name**
Maximum 75 characters
Unified field: `first_name`
**Middle Initial**
**Last Name**
The last name of the employee
Unified field: `last_name`
**Nick Name**
**Social Security**
Valid format: 111-11-1111
**Allow Change To Social Security**
Setting value to "Y" allows changing Social Security Number
**Social Insurance Number**
Available only for Canada companies. Valid formats: 111-111-111 or 111111111
**Primary National ID Type**
**Tax File Number**
Available only for Australian companies. 8 digits
**Social Security Number (France)**
National ID number for France. Available only for French companies. 13-15 digits
**Private Email**
The private email address of the employee
Unified field: `private_email`
**Secondary Email**
**Personal Email**
**Security Question**
**Security Question Answer**
**Disable Only Login Using SSO**
Maximum 25 characters
**Locale**
**Home Phone**
**Work Phone**
**Cell Phone**
The mobile phone number of the employee
Unified field: `mobile_phone_number`
**Primary Phone**
Valid Values: Home Phone, Work Phone, Cell Phone. Abbreviations H, W, C will also be accepted.
**Address 1**
The street address of the employee
Unified field: `home_address.street_1`
**Address 2**
Alternative address
Unified field: `home_address.street_2`
**Address 3**
Alternative address
**City**
Maximum 25 characters
Unified field: `home_address.city`
**State**
Two character state code (e.g., NJ for New Jersey) or NA for non-USA
Unified field: `home_address.state`
**Zip**
Valid formats: 11111 or 11111-1111
Unified field: `home_address.zip_code`
**Country**
The uppercase two-letter ISO country (e.g., DE)
Unified field: `home_address.country`
**Address Latitude**
**Address Longitude**
**Status**
**Status External Id**
**Employee Type**
**Standard Work Day**
Length of standard work day in HH:MM or HH.00 format (e.g., 8:00 or 8.00)
**Pay Type**
**Pay Type External Id**
**Default Shift**
**Medical Eligibility**
**Dental Eligibility**
**Dependent Benefits Eligibility**
**Union**
**Pay Grade**
**Step**
**Hired**
Start date of the employee. Also considered to be the hire date
Unified field: `start_date`
**Started**
**Birthday**
The employee's date of birth
Unified field: `date_of_birth`
**Review**
**Seniority**
**Benefits**
**Terminated**
REQUIRED if employee has been terminated
**Re Hired**
**Frozen Benefit**
**Retirement**
**Custom Date 1**
**Custom Date 2**
**Custom Date 3**
**Custom Date 4**
**Custom Date 5**
**Time Zone**
**First Screen**
**Root Cost Center 1**
**Root Cost Center 1 Effective From**
**Root Cost Center 2**
**Root Cost Center 2 Effective From**
**Root Cost Center 3**
**Root Cost Center 3 Effective From**
**Root Cost Center 4**
**Root Cost Center 4 Effective From**
**Root Cost Center 5**
**Root Cost Center 5 Effective From**
**Root Cost Center 6**
**Root Cost Center 6 Effective From**
**Root Cost Center 7**
**Root Cost Center 7 Effective From**
**Root Cost Center 8**
**Root Cost Center 8 Effective From**
**Root Cost Center 9**
**Root Cost Center 9 Effective From**
**Root Cost Center 10**
**Root Cost Center 10 Effective From**
**Limit Cost Center List 1**
**Limit Cost Center List 1 Effective From**
**Limit Cost Center List 2**
**Limit Cost Center List 2 Effective From**
**Limit Cost Center List 3**
**Limit Cost Center List 3 Effective From**
**Limit Cost Center List 4**
**Limit Cost Center List 4 Effective From**
**Limit Cost Center List 5**
**Limit Cost Center List 5 Effective From**
**Limit Cost Center List 6**
**Limit Cost Center List 6 Effective From**
**Limit Cost Center List 7**
**Limit Cost Center List 7 Effective From**
**Limit Cost Center List 8**
**Limit Cost Center List 8 Effective From**
**Limit Cost Center List 9**
**Limit Cost Center List 9 Effective From**
**Limit Cost Center List 10**
**Limit Cost Center List 10 Effective From**
**Default Cost Center 1**
**Default Cost Center 2**
**Default Cost Center 3**
**Default Cost Center 4**
**Default Cost Center 5**
**Default Cost Center 6**
**Default Cost Center 7**
**Default Cost Center 8**
**Default Cost Center 9**
**Default Cost Center 10**
**Job Last Changed**
**Access**
**Access On New Only**
**Accruals**
**Accruals Profile Effective From**
**Accruals On New Only**
**Attestation Profile**
**Attestation Profile Effective From**
**Attestation Profile On New Only**
**Beacon (Mo) Profile**
**Beacon (Mo) Profile On New Only**
**Benefit Profile**
**Benefit Profile Effective From**
**Benefit Profile On New Only**
**Competency Profile**
**Competency Profile On New Only**
**Counter Distribution Profile**
**Counter Distribution Profile Effective From**
**Counter Distribution Profile On New Only**
**Dashboard Layout Profile**
**Dashboard Layout Profile Effective From**
**Dashboard Layout Profile On New Only**
**Holiday**
**Holiday On New Only**
**InTouch Schedule Restrictions Profile**
**InTouch Schedule Restrictions Profile On New Only**
**Labor Distribution Profile**
**Labor Distribution Profile On New Only**
**Onboarding Profile**
**Onboarding Profile On New Only**
**Pay Calculations**
**Pay Calculations Profile Effective From**
**Pay Calculations On New Only**
**Pay Period**
**Pay Period On New Only**
**Pay Prep**
**Pay Prep On New Only**
**Points Profile**
**Points Profile On New Only**
**PST Delivery Policy**
**PST Delivery Policy On New Only**
**PST Population Profile**
**PST Population Profile On New Only**
**Retirement Plan**
**Retirement Plan On New Only**
**Role**
**Role On New Only**
**Second Retirement Plan**
**Second Retirement Plan On New Only**
**Employee Perspectives Profile**
**Employee Perspectives Profile Effective From**
**Employee Perspectives Profile On New Only**
**Work Schedule**
**Work Schedule Start Pattern On**
**Work Schedule Start Pattern Type**
REQUIRED if "Schedule Pattern On" is specified. Default Value - "Day" is set if empty or CLEAR.
**Work Schedule On New Only**
**Scheduler**
**Scheduler On New Only**
**Security**
**Security On New Only**
**Timesheet**
**Timesheet On New Only**
**Timesheet Autopopulate**
**Timesheet Autopopulate On New Only**
**Training Profile**
**Training Profile On New Only**
**Performance Review Profile**
**Performance Review Profile On New Only**
**W2 Delivery Policy**
**W2 Delivery Policy On New Only**
**Workday Breakdown**
**Workday Breakdown Profile Effective From**
**Workday Breakdown On New Only**
**Working Time Regulations**
**Expense Tracking Profile On New Only**
**Expense Tracking Profile**
**Data Retention Profile**
**Data Retention Profile Effective From**
**Data Retention Profile On New Only**
**Hardware RSI Hand Template**
**Hardware Asher PIN**
**Hardware ZK Password**
**Hardware ATS PIN**
**Hardware ATS Security Level**
**Hardware InTouch PIN**
**Hardware InTouch Security Level**
**Gender**
The gender of the employee
Unified field: `gender`
**Eye Color**
**Height**
**Disability**
**Citizenship**
**Ethnicity**
**EEO Classification**
**EEO-4 Classification**
**EEO-4 Function**
**Primary Language**
**Secondary Language**
**Smoker**
**Seasonal**
**FT Student**
**Referral**
**Visa Type**
**Recruiter**
**Worker Type**
**Manager 1**
**Manager 1 EIN Tax Id**
**Manager 1 EIN Name**
**Manager 2**
**Manager 2 EIN Tax Id**
**Manager 2 EIN Name**
**Manager 3**
**Manager 3 EIN Tax Id**
**Manager 3 EIN Name**
**Manager 4**
**Manager 4 EIN Tax Id**
**Manager 4 EIN Name**
**Manager 5**
**Manager 5 EIN Tax Id**
**Manager 5 EIN Name**
**Manager 6**
**Manager 6 EIN Tax Id**
**Manager 6 EIN Name**
**Managed Cost Centers Enabled**
**Managed Cost Centers Allow Save Of Other Cost Centers**
**Managed Cost Centers Restrict Editing Approved Timesheets**
**Time Entry Extra 1**
**Time Entry Extra 2**
**Time Entry Extra 3**
**Time Entry Extra 4**
**Time Entry Extra 5**
**Account Extra 1**
Additional employee attributes - Maximum 255 characters
**Account Extra 2**
Additional employee attributes - Maximum 255 characters
**Account Extra 3**
Additional employee attributes - Maximum 255 characters
**Account Extra 4**
Additional employee attributes - Maximum 255 characters
**Account Extra 5**
Additional employee attributes - Maximum 255 characters
**Account Extra 1 Effective From**
**Account Extra 2 Effective From**
**Account Extra 3 Effective From**
**Account Extra 4 Effective From**
**Account Extra 5 Effective From**
**Account Extra Mode**
Controls whether account extra field entries are added as new records (ADD) or overwrite existing (SET). Default: ADD
**Rate X Base**
**Rate X Base Eff Date**
**Rate X Table**
**Rate X Ext Z Table**
**Rate X Ext Z Type**
**Base Compensation**
**Base Compensation Type**
**Base Compensation Amount Earning Code**
**Base Compensation Hours Earning Code**
**Base Compensation Effective From**
**Autopay Schedule**
**Autopay Schedule Effective From**
**Emergency Contact First Name**
**Emergency Contact Last Name**
**Emergency Contact Relationship**
REQUIRED if any Emergency Contact fields are defined (unless disabled in company settings)
**Emergency Contact Work Phone**
**Emergency Contact Home Phone**
**Emergency Contact Cell Phone**
**Emergency Contact Address 1**
**Emergency Contact Address 2**
**Emergency Contact Address 3**
**Emergency Contact City**
**Emergency Contact State**
**Emergency Contact Zip**
**Emergency Contact Country**
**Accruals X Def**
**Accruals X Hrs**
**Last Pay Period End Date**
**Default Workers Comp Code**
**Default Workers Comp Code On New Only**
**Is W2**
**Is 1099**
**Is Draw**
**Reciprocity Override**
**Is Commission Only (Canada)**
**Add To New Hire Export**
**Add To New Hire Export On New Only**
**Actual Marital Status**
**HR Action History Type**
Some **optional** form fields are referencing the following data models:
* Employees
Consider enabling these in your [scope configuration](/hris/features/scopes).
**Username**
The username for the employee.
**First Name**
The first name of the employee
Unified field: `first_name`
**Last Name**
The last name of the employee
Unified field: `last_name`
**Middle Name**
**Nickname (Preferred Name)**
**Private Email**
The private email address of the employee
Unified field: `private_email`
**Secondary Email**
**Employee ID**
External Employee ID
**Home Address**
**Country**
The country of the employee. Use the ISO 3166-1 alpha-3 code.
**Street 1**
The street address of the employee
Unified field: `home_address.street_1`
**Street 2**
The street address of the employee
Unified field: `home_address.street_2`
**City**
The city of the employee
Unified field: `home_address.city`
**State**
State/Province (Max 3 characters). Only for supported Countries.
Unified field: `home_address.state`
**ZIP Code**
The ZIP code of the employee
Unified field: `home_address.zip_code`
**Phone Numbers**
**Mobile Phone Number**
The mobile phone number of the employee
Unified field: `mobile_phone_number`
**Home Phone**
**Work Phone**
**Managers**
The managers for the employee.
**National Insurance Number**
**Social Insurance Number**
**Social Security Number**
**Add to New Hire Export**
**Important Dates**
**Start Date**
Start date of the employee. Also considered to be the hire date
Unified field: `start_date`
**Date of Birth**
The employee's date of birth
Unified field: `date_of_birth`
**Hired Date**
**Re-Hired Date**
**Terminated Date**
## Integration Variants
**Current connector:** UKG Ready
For **UKG Ready**, we also offer the following other connector variants:
UKG Ready for the ATS category
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.