Add or Update Employee Deduction.

This assigns a Section 125 or post tax deduction to an employee and manages deduction amounts across effective dated periods. It supports setting an initial amount with a start date, revising the deduction by creating a new effective period, updating an existing period, closing the current period, or beginning a new period with a different amount.

Notes:

  • Garnishments and 401k deductions are excluded.
  • If multiple periods need to be created for the same employee, each period must be submitted in a separate request
  • The system maintains a clean non overlapping timeline across all effective periods and automatically adjusts future periods when needed to preserve continuity
  • Effective period behavior:

    • When creating or updating a deduction period, the system ensures periods never overlap
    • When a new period falls between two existing periods, it fills the available gap.
    • When a new period overlaps a future period, the system automatically shifts the future period start date to the day after the new period ends.
    • When a new period has no end date and would overlap a future period, the system automatically sets the end date to the day before the next period begins.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

Override flag to use employee custom amount instead of synced/company amount.

double

Amount Per Pay (either fixed amount OR percent depending on company-level method).

string
required

Effective start date of this deduction record (MM/DD/YYYY)

string

Effective end date of this deduction record (MM/DD/YYYY). Null or blank means ongoing.

string
required

Employee UUID for whom deduction is assigned or updated.

string
required

Company-level deduction UUID.

string
ANNUALLY|LUMPSUM|NO_LIMIT

Deduction limit type. Allowed: ANNUALLY, LUMPSUM, NO_LIMIT

double

Annual allowed limit. Applicable when deductionLimitType is selected.

Headers
string
required

The company unique identifier

Responses

400

In case the request has some invalid parameter.

401

In case Security key is not provided or invalid.

500

In case system is unable to fulfil the request due to some internal error.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*