PApaylocity
Employee

Update Employee

Update Employee API will update existing employee data in WebPay.

patch/v2/companies/{companyId}/employees/{employeeId}

Request

  • Base URL
    https://dc1demogw.paylocity.com/api
  • URL
    https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}
  • 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

employeeIdstring required

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

Request body

birthDatestring paylocity-date

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

coEmpCodestring

Unique identifier for SSO.<br />Max length: 20

companyNamestring

Company name as defined in Web Pay, applicable with GET requests only.<br /> Max length: 50

currencystring

Employee is paid in this currency. <br />Max length: 30

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

genderstring

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

isHighlyCompensatedboolean

Indicates if employee meets the highly compensated employee criteria.

isRothCatchupRequiredEmployeeboolean

Indicates whether the employee has to make ROTH catch-up contributions for their retirement plan in the current year. Introduced by SECURE Act 2.0.

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

middleNamestring

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

ownerPercentnumber

Percentage of employee's ownership in the company, entered as a whole number. <br /> Decimal (12,2)

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

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

veteranDescriptionstring

Indicates if employee is a veteran.

Response

Successfully Updated

Changes

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