Apply other deduction

post

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

Start, change or end a worker's other recurring deductions, like union dues, savings, or loan repayments. These are post-tax deductions that aren't tied to a benefit or retirement plan.

A worker can have several deductions of the same type, so each one is identified by workerId, payCode and an externalId you choose. Send an effectiveDate to start or change the deduction, or only an effectiveEndDate to end it. 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 deduction type, like DUES or LOAN_REPAYMENT, or the apiKey of a custom pay code. See the Guide to the Deductions API for the supported values.

externalId

string

required

Your identifier for this deduction. Required on every request. A worker can have several deductions with the same payCode, so a deduction is identified by workerId, payCode and externalId together.

deductionAmount

object

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

deductionPercentage

object

A percentage of pay. Send either this or deductionAmount, depending on what the payCode supports.

lifetimeLimit

object

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

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.