Skip to content

List garnishment cases

GET/payroll/garnishments

Returns all active and historical wage garnishment cases for the tenant. Use to monitor court-ordered deductions and ensure compliance with priority ordering rules.

Request

Query parameters

NameTypeRequiredDescription
employee_idintegerNo

Filter garnishments to a specific employee.

statusstringNo

Filter by garnishment status.

One of: "active", "satisfied", "cancelled", "expired"

Responses

200 List of garnishment cases

Content type application/json, array of object · GarnishmentOrderV1.

FieldTypeRequiredDescription
idintegerNo

Auto-incremented primary key (present on responses, omit on create).

order_referencestringYes

Unique court order reference number (e.g. case number from the issuing court).

Max length: 120

employee_idintegerYes

ID of the employee subject to this garnishment.

jurisdictionstringYes

ISO 3166-1 alpha-2 country code of the issuing jurisdiction (e.g. "GH", "US").

Max length: 10

start_datestring (date)Yes

Date from which garnishment withholding begins.

end_datestring (date), nullableNo

Date on which garnishment ends. Null for open-ended orders satisfied when arrears reach zero.

priorityinteger, nullableNo

Priority ordering when multiple garnishments apply (lower number = higher priority).

max_withholding_typestringYes

Whether the maximum withholding limit is expressed as a percentage of disposable income ("percent") or a fixed monetary amount ("fixed").

One of: "percent", "fixed"

max_withholding_valuenumber (float)Yes

The maximum withholding amount or percentage per pay period.

arrearsnumber (float), nullableNo

Total outstanding balance owed. The garnishment is automatically closed when cumulative withholdings satisfy the arrears.

statusstringNo

Current status of the garnishment case (present on responses).

One of: "active", "satisfied", "cancelled", "expired"

Example

[
  {
    "id": 3,
    "order_reference": "COURT-ACC-2026-00141",
    "employee_id": 42,
    "jurisdiction": "GH",
    "start_date": "2026-03-01",
    "end_date": null,
    "priority": 1,
    "max_withholding_type": "percent",
    "max_withholding_value": 20.0,
    "arrears": 1500.0,
    "status": "active"
  }
]

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/payroll/garnishments" \
  -H "Accept: application/json"
Loading