PApaylocity
Employee Benefit Setup

Add/update employee's benefit setup

Sends new or updated employee benefit setup information directly to Web Pay.

put/v2/companies/{companyId}/employees/{employeeId}/benefitSetup

Request

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

benefitClassstring nullable

Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.<br />Max length: 30

benefitClassEffectiveDatestring paylocity-date nullable

Date when Benefit Class takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.

benefitSalarynumber nullable

Salary used to configure benefits.<br />Decimal(12,2)

benefitSalaryEffectiveDatestring paylocity-date nullable

Date when Benefit Salary takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.

doNotApplyAdministrativePeriodboolean nullable

Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.

isMeasureAcaEligibilityboolean nullable

Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.

Response

Successfully added or updated

Changes

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