PApaylocity
Onboarding

Create Employee Onboarding

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.

post/v1/companies/{companyId}/onboarding/employees

Request

  • Base URL
    https://dc1demogw.paylocity.com/api
  • URL
    https://dc1demogw.paylocity.com/api/v1/companies/{companyId}/onboarding/employees
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.paylocity.com/IdentityServer/connect/token scopes: WebLinkAPI

Path parameters

companyIdstring required

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

Headers

Authorizationstring required

Bearer + JWT

Request body

employeeIdstring

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

address1string

Employee home 1st address line. <br />Max length: 40

address2string

Employee home 2nd address line. <br />Max length: 40

autoPayTypestring

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). <br />Max length: 3

baseRatenumber

Employee base rate, used for Hourly employees. <br />Decimal (12,2)

citystring

Employee home city. <br />Max length: 40

costCenter1string

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

costCenter2string

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

costCenter3string

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

defaultHoursnumber

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

employeeStatusstring

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

employmentTypestring

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

federalFilingStatusstring

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

firstNamestring required

Employee first name. <br />Max length: 40

sexstring

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

hireDatestring

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

homePhonestring

Employee home phone number. <br />Max length: 12

lastNamestring required

Employee last name. <br />Max length: 40

maritalStatusstring

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

personalMobilePhonestring

Employee personal mobile phone number. <br />Max length: 12

payFrequencystring

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

personalEmailAddressstring

Employee personal email address. <br />Max length: 50

payTypestring

Employee pay type. Valid values are Hourly or Salary. <br />Max length: 10

ratePerstring

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

salarynumber

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

statestring

Employee home state. <br />Max length: 2

ssnstring

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

stateFilingStatusstring

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

suiStatestring

Employee SUI (State Unemployment Insurance) state. <br />Max length: 2

taxFormstring

Employee tax form for reporting income. Valid values are W2, 1099M, 1099R, 1099NEC, Non-US. Default is W2. <br />Max length: 15

taxStatestring

Employee primary tax state. <br />Max Length: 2

userNamestring

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

workEmailAddressstring

Employee work email. <br />Max length: 50

zipstring

Employee home zip code. <br />Max length: 10

Response

Successfully Added

Changes

No recorded changes to this operation across all 1 revision of this API.