Garnishment (GARN)

The Garnishment (GARN) transaction allows you calculate, compare and deduct the employee's pay garnishment. An employee’s creditor can petition the court to recover monies owed. In turn, the court notifies your organization to deduct a specified percentage of the employee’s pay each pay period until the creditor is repaid. The court also determines the goal amount to be collected. The deductions are sent to the court for disbursement to the creditor.

Garnishments are processed based on the deduction processing order set on the Deduction Type (DEDT) page. If two garnishments have the same processing order, then the effective dates are used to determine the order in which they are taken up for processing.

Field InformationField Information

In this transaction you can capture the deduction type and deduction plan information. You can also capture the recipient information, such as the docket, case number and any override information.

The User Defined Fields can be enabled via DESIGNER and can be used by sites as per their specific requirements. These fields consist of User Defined Text, Date, and Amount Fields and can also be used for any extra information that sites need to track.

Note: The Garnishment transaction is enabled with Inbound and Outbound API to facilitate seamless integration with any third-party system/application.

This GARN API provides following endpoints and methods:

POST IMPORT - allows users to import a GARN transaction via inbound integration.
PATCH UPDATE - allows users to update an existing GARN transaction.
PATCH SUBMIT - allows users to submit an GARN transaction in draft status.
PATCH CANCEL - allows users to cancel/delete an existing GARN transaction in draft status.
GET EXPORT - allows users to fetch the field-based details via outbound integration.

The following points must be determined while using the GARN API:

The API key/token needs to be generated before the use of API.
Make sure that the following mandatory fields are entered/inserted in the API body.

Deduction Type
Deduction Plan
Employee ID
From Date
Line Number
Valid DEDT and DPLN should be selected.
Employee ID must be valid.
Employee Department must be active.
Employee Status must be active.
From Date must be within time slice.
For Update, Submit, and Cancel make sure the existing transaction is in Draft status.
Reference data export through API from Deduction Type, Deduction Plan and Employee has also been enabled to facilitate the GARN transaction integration.

The Garnishment transaction can be created in the following ways:

Select the Create action on the Transaction Catalog.
Select the Create Garnishment row-level action on the Garnishment tab of the Deduction Management (DEDM) activity folder.
Select the Modify Garnishment row-level action on the Garnishment tab of the Deduction Management (DEDM) activity folder.