PApaylocity
Employee

Update employee

Update Employee API will update existing employee data in WebPay.

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

Request

  • Base URL
    https://api.paylocity.com/api
  • URL
    https://api.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

Company Id

employeeIdstring required

Employee Id

Request body

birthDatestring paylocity-date nullable

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

coEmpCodestring nullable

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

companyFEINstring nullable

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

companyNamestring nullable

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

currencystring nullable

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

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: 9

ethnicitystring nullable

Employee ethnicity.<br /> Max length: 10

firstNamestring nullable

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

genderstring nullable

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

isHighlyCompensatedboolean

Indicates if employee meets the highly compensated employee criteria.

isRothCatchupRequiredEmployeeboolean

Indicates employee's Roth catch-up requirement fitness which bases on wage amount. Introduced by SECURE Act 2.0.

isSmokerboolean

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

middleNamestring nullable

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

ownerPercentnumber nullable

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

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

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

veteranDescriptionstring nullable

Indicates if employee is a veteran.

Response

Successfully Updated

Changes

No recorded changes to this operation across all 4 revisions of this API.