GuidesRecipesAPI ReferenceChangelog
Login
API Reference
Login
Start typing to search…

Add new employee to Web Link

post
https://dc1demogw.paylocity.com/api/v2/weblinkstaging/companies//employees/newemployees

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 completed by company administrator or authorized Paylocity Service Bureau employee.

Path Params
Body Params

StagedEmployee Model

additionalDirectDeposit
array of objects
length ≤ 4

Add up to 19 direct deposit accounts in addition to the main direct deposit account. IMPORTANT: A direct deposit update will remove ALL existing main and additional direct deposit information in WebPay and replace with information provided on the request. GET API will not return direct deposit data.

additionalDirectDeposit
benefitSetup
array of objects
length ≤ 1

Add setup values used for employee benefits integration, insurance plan settings, and ACA reporting.

benefitSetup
string

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

customBooleanFields
array of objects
length ≤ 8

Up to 8 custom fields of boolean (checkbox) type value.

If your company is using the Unlimited Custom Fields platform, DO NOT USE THIS PARAMETER. Instead, please follow the bulk upload process described in Peak article PCTY-148055.

customBooleanFields
customDateFields
array of objects
length ≤ 8

Up to 8 custom fields of the date type value.

If your company is using the Unlimited Custom Fields platform, DO NOT USE THIS PARAMETER. Instead, please follow the bulk upload process described in Peak article PCTY-148055.

customDateFields
customDropDownFields
array of objects
length ≤ 8

Up to 8 custom fields of the dropdown type value.

If your company is using the Unlimited Custom Fields platform, DO NOT USE THIS PARAMETER. Instead, please follow the bulk upload process described in Peak article PCTY-148055.

customDropDownFields
customNumberFields
array of objects
length ≤ 8

Up to 8 custom fields of numeric type value.

If your company is using the Unlimited Custom Fields platform, DO NOT USE THIS PARAMETER. Instead, please follow the bulk upload process described in Peak article PCTY-148055.

customNumberFields
customTextFields
array of objects
length ≤ 8

Up to 8 custom fields of text type value.

If your company is using the Unlimited Custom Fields platform, DO NOT USE THIS PARAMETER. Instead, please follow the bulk upload process described in Peak article PCTY-148055.

customTextFields
departmentPosition
array of objects
length ≤ 1

Add home department cost center, position, supervisor, reviewer, employment type, EEO class, pay settings, and union information.

departmentPosition
string

Indicates if employee has disability status.

string

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

string

Employee ethnicity.
Max length: 10

federalTax
array of objects
length ≤ 1

Add federal tax amount type (taxCalculationCode), amount or percentage, filing status, and exemptions.

federalTax
string

Employee first name.
Max length: 40

string

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

string

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

string

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

homeAddress
array of objects
length ≤ 1

Add employee's home address, personal phone numbers, and personal email.

homeAddress
boolean

Indicates if employee in agriculture or farming.

boolean

Indicates if employee is a smoker.

string

Employee last name.
Max length: 40

localTax
array of objects
length ≤ 5

Add local tax code, filing status, and exemptions including PA-PSD taxes.

localTax
mainDirectDeposit
array of objects
length ≤ 1

Add the main direct deposit account. After deposits are made to any additional direct deposit accounts, the remaining net check is deposited in the main direct deposit account. IMPORTANT: A direct deposit update will remove ALL existing main and additional direct deposit information in WebPay and replace with what is provided on the request. GET API will not return direct deposit data.

mainDirectDeposit
string

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

string

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

string

Employee middle name.
Max length: 20

nonPrimaryStateTax
array of objects
length ≤ 1

Add non-primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, supplemental check (specialCheckCalc), and reciprocity code information.

nonPrimaryStateTax
string

Employee preferred display name.
Max length: 20

primaryPayRate
array of objects
length ≤ 1

Add hourly or salary pay rate, effective date, and pay frequency.

primaryPayRate
primaryStateTax
array of objects
length ≤ 1

Add primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, and supplemental check (specialCheckCalc) information. Only one primary state is allowed.

primaryStateTax
string

Prior last name if applicable.
Max length: 40

string

Employee preferred salutation.
Max length: 10

string

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

string

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

string

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

status
array of objects
length ≤ 1

Add employee status, change reason, effective date, and adjusted seniority date. Note that companies that are still in Implementation cannot hire future employees.

status
string

Employee name suffix. Common values are Jr, Sr, II.
Max length: 30

string

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

string

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

string

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

string

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

string

Indicates if employee is a veteran.

webTime
object

Add Web Time badge number and charge rate and synchronize Web Pay and Web Time employee data.

workAddress
array of objects
length ≤ 1

Add employee's work address, phone numbers, and email. Work Location drop down field is not included.

workAddress
workEligibility
array of objects
length ≤ 1

Add I-9 work authorization information.

workEligibility
Responses

403

Forbidden

429

Too Many Requests

Updated 2 months ago

Language
Credentials
OAuth2
Response 
 Choose an example:
application/json
Updated 2 months ago