Add Employee to Onboarding

post https://dc1demogw.paylocity.com/api/v1/companies/{companyId}/onboarding/employees

Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Paylocity Payroll/HR solution.

Path Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

Body Params

onboarding Model

employeeId

string

(optional) The Paylocity Employee ID. This is a unique value per Paylocity Company ID.
Allowable Values:
10 char max

address1

string

Employee home 1st address line.
Max length: 40

address2

string

Employee home 2nd address line.
Max length: 40

autoPayType

string

Valid values are N, D, S. (N- employee won't automatically receive a salary or hours during payroll, D - employee will be automatically paid in defaultHours during payroll, S - employee will be automatically paid Salary amount during payroll).
Max length: 3

baseRate

number

Employee base rate, used for Hourly employees.
Decimal (12,2)

city

string

Employee home city.
Max length: 40

costCenter1

string

Employer defined location, like branch, division, department, etc. Must match Company setup.
Max length: 10

costCenter2

string

Employer defined location, like branch, division, department, etc. Must match Company setup.
Max length: 10

costCenter3

string

Employer defined location, like branch, division, department, etc. Must match Company setup.
Max length: 10

defaultHours

number

Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours.
Decimal (12,2)

employeeStatus

string

Employee current work status. Common values are A (Active), L (Leave of Absence), T (Terminated).
Max length: 20

employmentType

string

Employee current employment type. Common values RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time).
Max length: 10

federalFilingStatus

string

Employee federal filing status. Common values M (Married), S (Single).
Max length: 10

firstName

string

required

Employee first name.
Max length: 40

sex

string

Employee gender. Common values M (Male), F (Female).
Max length: 1

hireDate

string

Employee hired date. Common formats are MM-DD-CCYY, CCYY-MM-DD

homePhone

string

Employee home phone number.
Max length: 12

lastName

string

required

Employee last name.
Max length: 40

maritalStatus

string

Employee marital status. Common values D (Divorced), M (Married), S (Single), W (Widowed).
Max length: 10

personalMobilePhone

string

Employee personal mobile phone number.
Max length: 12

payFrequency

string

Employee current pay frequency. Common values are A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly).
Max length: 5

personalEmailAddress

string

Employee personal email address.
Max length: 50

payType

string

Employee pay type. Valid values are Hourly or Salary.
Max length: 10

ratePer

string

Employee base rate frequency used with payType Hourly. Common values are Hour or Week. Default is Hour
Max length: 10

salary

number

Employee gross salary per pay period used with payType Salary.
Decimal (12,2)

state

string

Employee home state.
Max length: 2

ssn

string

Employee social security number. Leave it blank if valid social security number not available.
Max length: 11

stateFilingStatus

string

Employee state filing status. Common values are M (Married), S (Single).
Max length: 50

suiState

string

Employee SUI (State Unemployment Insurance) state.
Max length: 2

taxForm

string

Employee tax form for reporting income. Valid values are W2, 1099M, 1099R. Default is W2.
Max length: 15

taxState

string

Employee primary tax state.
Max Length: 2

userName

string

Required. Employer assigned username to log into Onboarding. Duplicate usernames are not allowed.
Must be between 3 and 20 characters and cannot have special characters other than . (period) and _ (underscore)

workEmailAddress

string

Employee work email.
Max length: 50

zip

string

Employee home zip code.
Max length: 10

Headers

Authorization

string

required

Bearer + JWT

Responses

201

Successfully Added

403

Forbidden

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://dc1demogw.paylocity.com/api/v1/companies/companyId/onboarding/employees \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

400Bad Request

500Internal Server Error