Create New Employee in Web Link

post

https://dc1demogw.paylocity.com/api/v2/weblinkstaging/companies/{companyId}/employees/newemployees

Path Params

companyId

string

required

Body Params

StagedEmployee Model

additionalDirectDeposit

array of objects

length ≤ 4

additionalDirectDeposit

benefitSetup

array of objects

length ≤ 1

benefitSetup

birthDate

string

customBooleanFields

array of objects

length ≤ 8

customBooleanFields

customDateFields

array of objects

length ≤ 8

customDateFields

customDropDownFields

array of objects

length ≤ 8

customDropDownFields

customNumberFields

array of objects

length ≤ 8

customNumberFields

customTextFields

array of objects

length ≤ 8

customTextFields

departmentPosition

array of objects

length ≤ 1

departmentPosition

disabilityDescription

string

employeeId

string

ethnicity

string

federalTax

array of objects

length ≤ 1

federalTax

firstName

string

fitwExemptReason

string

futaExemptReason

string

gender

string

homeAddress

array of objects

length ≤ 1

homeAddress

isEmployee943

boolean

isSmoker

boolean

lastName

string

localTax

array of objects

length ≤ 5

localTax

mainDirectDeposit

array of objects

length ≤ 1

mainDirectDeposit

maritalStatus

string

medExemptReason

string

middleName

string

nonPrimaryStateTax

array of objects

length ≤ 1

nonPrimaryStateTax

preferredName

string

primaryPayRate

array of objects

length ≤ 1

primaryPayRate

primaryStateTax

array of objects

length ≤ 1

primaryStateTax

priorLastName

string

salutation

string

sitwExemptReason

string

ssExemptReason

string

ssn

string

status

array of objects

length ≤ 1

status

suffix

string

suiExemptReason

string

suiState

string

taxDistributionCode1099R

string

taxForm

string

veteranDescription

string

webTime

object

workAddress

array of objects

length ≤ 1

workAddress

workEligibility

array of objects

length ≤ 1

workEligibility

Responses

403

Forbidden

429

Too Many Requests

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

201Successfully Added

400Bad Request

500Internal Server Error