Apply benefit deduction

post

https://api.everee.com/integration/v1/deductions/benefits

Start, change or end a worker's deduction for a benefit plan, like medical, dental or an HSA. Benefit deductions are fixed dollar amounts, with an optional employer contribution.

Send an effectiveDate to start or change the deduction, or only an effectiveEndDate to end it. The deduction is identified by workerId and payCode. See the Guide to the Deductions API for how changes are applied.

Body Params

workerId

string

required

The worker's ID (your external worker ID, or the Everee worker ID).

payCode

string

required

The benefit type, like MEDICAL_INSURANCE or HSA, or the apiKey of a custom pay code. See the Guide to the Deductions API for the supported values.

deductionAmount

object

A fixed dollar amount. Send either this or deductionPercentage, depending on what the payCode supports.

lifetimeLimit

object

A cap on the total amount deducted from the worker over the life of the deduction.

hsaLimitType

string

enum

Whether the HSA contribution limit is for an individual or a family. Only valid when payCode is HSA. If omitted for an HSA, the worker's existing limit type is kept.

Allowed:

effectiveDate

date

The date the deduction starts or changes. Send it to create or update the deduction. Omit it, and send only effectiveEndDate, to end an existing deduction. If the date is earlier than the worker's earliest editable date, it's moved forward, and the response shows the date that was used.

effectiveEndDate

date

The last day the deduction applies. Omit for a deduction that continues until you end it. Can't be before effectiveDate.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200The deduction after the change.

400effectiveEndDate is before effectiveDate.

404The payCode isn't a supported value for this endpoint, or you ended a deduction that doesn't exist or has already ended.

422The request was invalid. For example: neither date was sent; both or neither of deductionAmount and deductionPercentage were sent, or the one sent isn't supported by the payCode; or a required field is missing.