Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Employee Staging

Create New Employee in Web Link

Create New Employee in Web Link will send partially completed or potentially erroneous new hire record to Web Link, where it can be corrected and completed by company administrator or authorized Paylocity Service Bureau employee.

post/v2/weblinkstaging/companies/{companyId}/employees/newemployees

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

Request body

birthDatestring paylocity-date

Employee birthdate. Common formats include MM-DD-CCYY, CCYY-MM-DD.

disabilityDescriptionstring

Indicates if employee has disability status.

employeeIdstring

Leave blank to have Web Pay automatically assign the next available employee ID.<br /> Max length: 10

ethnicitystring

Employee ethnicity.<br /> Max length: 10

firstNamestring

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

fitwExemptReasonstring

Reason code for FITW exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30

futaExemptReasonstring

Reason code for FUTA exemption. Common values are 501 (5019c)(3) Organization), IC (Independent Contractor).<br /> Max length: 30

genderstring

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

isEmployee943boolean

Indicates if employee in agriculture or farming.

isSmokerboolean

Indicates if employee is a smoker.

lastNamestring

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

medExemptReasonstring

Reason code for Medicare exemption. Common values are 501 (5019c)(3) Organization), IC (Independent Contractor).<br /> Max length: 30

middleNamestring

Employee middle name.<br /> Max length: 20

preferredNamestring

Employee preferred display name.<br /> Max length: 20

priorLastNamestring

Prior last name if applicable.<br />Max length: 40

salutationstring

Employee preferred salutation. <br />Max length: 10

sitwExemptReasonstring

Reason code for SITW exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30

ssExemptReasonstring

Reason code for Social Security exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30

ssnstring

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

suffixstring

Employee name suffix. Common values are Jr, Sr, II.<br />Max length: 30

suiExemptReasonstring

Reason code for SUI exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30

suiStatestring

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

taxDistributionCode1099Rstring

Employee 1099R distribution code. Common values are 7 (Normal Distribution), F (Charitable Gift Annuity). <br />Max length: 1

taxFormstring

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

veteranDescriptionstring

Indicates if employee is a veteran.

Response

Successfully Added

trackingNumberstring

The unique tracking number