paylocity.
Guides and Resources
Connection Setup Guide
Step-by-step instructions to connect your Paylocity account to Kombo.
Supported Features & Coverage
- Models
- Actions
- Features
- Create Employee with Form
Legal Entities
Legal Entities
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name |
Work Locations
Work Locations
Work locations are currently derived from employee work addresses and are only available when Paylocity provides a location name.
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address | |
| remote_data |
Employees
Employees
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_number | |
| first_name | |
| last_name | |
| job_title | |
| work_email | |
| personal_email | |
| mobile_phone_number | |
| ssn | |
| gender | |
| ethnicity | |
| marital_status | |
| employment_status | |
| employment_type | |
| weekly_hours | |
| work_location_id | |
| legal_entity_id | |
| manager_id | |
| home_address | |
| bank_accounts | |
| date_of_birth | |
| start_date | |
| termination_date | |
| custom_fields | |
| integration_fields | |
| remote_data |
Employments
Employments
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| job_title | |
| pay_rate | |
| pay_period | |
| pay_frequency | |
| employment_type | |
| pay_currency | |
| effective_date | |
| remote_data | |
| custom_fields | |
| integration_fields |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type |
Timesheets
Timesheets
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| started_at | |
| ended_at | |
| timezone | |
| payable_hours | |
| unpaid_break_minutes | |
| breaks | |
| custom_fields | |
| integration_fields | |
| remote_data |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Create employee
Create employee
Created Paylocity employees will enter the ‘pre-hire’ status and be deleted on the next sync. They will reappear after the onboarding process is completed. Valid phone format are: ”(###) ###-####” or ”###-###-####” or ”### ### ####” or ”##########” or, if international, starts with ”+#”, only spaces and digits allowed. Paylocity does not allow specifying the employee’s country via API. It will always be set to “US”.
| Input Field | Notes |
|---|---|
| first_name | |
| last_name | |
| work_email | |
| gender | |
| home_address.street_1 | |
| home_address.street_2 | |
| home_address.city | |
| home_address.state | |
| home_address.zip_code | |
| date_of_birth | |
| mobile_phone_number | |
| start_date |
Create employee (v2)
Create employee (v2)
For detailed information about creating employees with form, please see the Create Employee with Form tab above.
| Input Field | Notes |
|---|---|
| staffing_entity_id | |
| properties |
| Feature | Notes |
|---|---|
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Per Field Tests | |
| Custom Field Explorer | |
| Employees | |
| Connection Guide | |
| Create credentials | |
| Group Types | |
| COST_CENTER |
Some required form fields are referencing the following data models:
- Legal Entities
single_select
required
Legal Entity
Select the legal entity to create the employee for.
References
Select the legal entity to create the employee for.
References
/v1/hris/legal-entities?remote_model=legal_entitytext
Address 1
Employee home 1st address line.
Unified field:
Employee home 1st address line.
Unified field:
home_address.street_1text
Address 2
Employee home 2nd address line.
Unified field:
Employee home 2nd address line.
Unified field:
home_address.street_2single_select
Auto Pay Type
The type of auto pay for the employee.
The type of auto pay for the employee.
number
Base Rate (hourly employees)
Employee base rate, used for Hourly employees.
Employee base rate, used for Hourly employees.
text
City
Employee home city.
Unified field:
Employee home city.
Unified field:
home_address.citysingle_select
Cost Center 1
Employer defined location, like branch, division, department, etc.
Employer defined location, like branch, division, department, etc.
single_select
Cost Center 2
Employer defined location, like branch, division, department, etc.
Employer defined location, like branch, division, department, etc.
single_select
Cost Center 3
Employer defined location, like branch, division, department, etc.
Employer defined location, like branch, division, department, etc.
number
Default Hours
Employee default hours consistently worked.
Employee default hours consistently worked.
single_select
Employee Status
Employee current work status.
Employee current work status.
single_select
Employment Type
Employee employment type.
Employee employment type.
single_select
Federal Filing Status
Employee federal filing status.
Employee federal filing status.
text
required
First Name
The first name of the employee
Unified field:
The first name of the employee
Unified field:
first_namesingle_select
Sex
Employee gender.
Employee gender.
date
Hire Date
Employee hire date.
Unified field:
Employee hire date.
Unified field:
start_datetext
Home Phone Number
Employee home phone number.
Unified field:
Employee home phone number.
Unified field:
home_phone_numbertext
required
Last Name
The last name of the employee
Unified field:
The last name of the employee
Unified field:
last_namesingle_select
Marital Status
Employee marital status.
Employee marital status.
text
Mobile Phone Number
Employee personal mobile phone number.
Unified field:
Employee personal mobile phone number.
Unified field:
mobile_phone_numbersingle_select
Pay Frequency
Employee pay frequency.
Employee pay frequency.
text
Private Email
Employee personal email address.
Unified field:
Employee personal email address.
Unified field:
private_emailsingle_select
Pay Type
Employee pay type.
Employee pay type.
single_select
Rate Per
Employee base rate frequency (only used with payType Hourly).
Employee base rate frequency (only used with payType Hourly).
number
Yearly Salary
Employee yearly gross salary (only used with payType Salary).
Unified field:
Employee yearly gross salary (only used with payType Salary).
Unified field:
yearly_salarysingle_select
State
Employee home state.
Unified field:
Employee home state.
Unified field:
home_address.statetext
Social Security Number
Employee social security number. Leave it blank if valid social security number not available.
Employee social security number. Leave it blank if valid social security number not available.
single_select
State Filing Status
Employee state filing status.
Employee state filing status.
single_select
SUI State
Employee SUI (State Unemployment Insurance) state.
Employee SUI (State Unemployment Insurance) state.
single_select
Tax Form
Employee tax form for reporting income.
Employee tax form for reporting income.
single_select
Tax State
Employee tax state.
Employee tax state.
text
required
User Name
Employer assigned username to log into Onboarding. Duplicate usernames are not allowed. The username cannot have special characters other than . (period) and _ (underscore)
Employer assigned username to log into Onboarding. Duplicate usernames are not allowed. The username cannot have special characters other than . (period) and _ (underscore)
text
Work Email Address
Employee work email address.
Unified field:
Employee work email address.
Unified field:
work_emailtext
Zip
Employee home zip code.
Unified field:
Employee home zip code.
Unified field:
home_address.zip_codeIntegration Variants
Current connector: Paylocity For Paylocity, we also offer the following other connector variants:
Paylocity ATS
Paylocity for the ATS category