Get Employee Deductions

Returns the list of deduction periods assigned to an employee, including company-level deduction details and employee-level deduction period details such as deduction methods, amount, effective dates, limit details, and status. Includes all deduction types: Section 125, Post-tax (including Garnishments), and 401k/retirement. When EmployeeUUID is provided, returns deductions only for that employee and EmployeeStatus is ignored. When EmployeeUUID is not provided, returns deductions for employees within the company based on the EmployeeStatus filter.

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

Employee unique identifier (UUID). When provided, returns deductions only for this employee.

string
enum

Filter employees by employment status. Accepted values: Active, Terminated, All. Default: Active and Future (when employeeUUID is not provided). Ignored when employeeUUID is provided.

Allowed:
string
enum
Defaults to All

Filter by deduction period status. Accepted values: Active, Inactive, Future, All. Default: All

Allowed:
integer
≥ 1
Defaults to 1

Page number. Default: 1

integer
1 to 25
Defaults to 25

Number of records per page. Default: 25

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:
*/*