Sign in

v1

latestSwagger 2.02026-07-133225142.0 KB
Employee Staging

Add new employee to Web Link

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

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

Path parameters

companyIdstring required

Company Id

Request body

birthDatestring paylocity-date nullable

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

disabilityDescriptionstring nullable

Indicates if employee has disability status.

employeeIdstring nullable

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

ethnicitystring nullable

Employee ethnicity.<br /> Max length: 10

firstNamestring nullable

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

fitwExemptReasonstring nullable

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

futaExemptReasonstring nullable

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

genderstring nullable

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

isEmployee943boolean nullable

Indicates if employee in agriculture or farming.

isSmokerboolean nullable

Indicates if employee is a smoker.

lastNamestring nullable

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

maritalStatusstring nullable

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

medExemptReasonstring nullable

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

middleNamestring nullable

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

preferredNamestring nullable

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

priorLastNamestring nullable

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

salutationstring nullable

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

sitwExemptReasonstring nullable

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

ssExemptReasonstring nullable

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

ssnstring nullable

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

suffixstring nullable

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

suiExemptReasonstring nullable

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

suiStatestring nullable

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

taxDistributionCode1099Rstring nullable

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

taxFormstring nullable

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

veteranDescriptionstring nullable

Indicates if employee is a veteran.

Response

Successfully Added

trackingNumberstring

The unique tracking number