GuidesRecipesAPI ReferenceChangelog
API Reference

Add/update employee's benefit setup

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

Path Params
string
required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

string
required

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

Body Params

BenefitSetup Model

string

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

string

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

number

Salary used to configure benefits.
Decimal(12,2)

string

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

boolean

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

boolean

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

Responses
200

Successfully added or updated

401

Unauthorized

403

Forbidden

429

Too Many Requests

Language
Credentials
OAuth2
Choose an example:
application/json

Copyright © 2025 Paylocity. All Rights Reserved. Privacy Center | Terms and Conditions | Accessibility