Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Employee Benefit Setup

Upsert Employee's Benefit Setup

Sends new or updated employee benefit setup information directly to Paylocity Payroll/HR solution.

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

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

benefitClassstring

Benefit Class code. Values are configured in Paylocity Payroll/HR solution Company > Setup > Benefits > Classes.<br />Max length: 30

benefitClassEffectiveDatestring paylocity-date

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

benefitSalarynumber

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

benefitSalaryEffectiveDatestring paylocity-date

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

doNotApplyAdministrativePeriodboolean

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

isMeasureAcaEligibilityboolean

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

Response

Successfully added or updated