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
| Name | Type | Required | Description |
|---|---|---|---|
employee_id | integer | No | Filter garnishments to a specific employee. |
status | string | No | Filter by garnishment status. One of: |
Responses
200 List of garnishment cases
Content type application/json, array of object · GarnishmentOrderV1.
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | No | Auto-incremented primary key (present on responses, omit on create). |
order_reference | string | Yes | Unique court order reference number (e.g. case number from the issuing court). Max length: 120 |
employee_id | integer | Yes | ID of the employee subject to this garnishment. |
jurisdiction | string | Yes | ISO 3166-1 alpha-2 country code of the issuing jurisdiction (e.g. "GH", "US"). Max length: 10 |
start_date | string (date) | Yes | Date from which garnishment withholding begins. |
end_date | string (date), nullable | No | Date on which garnishment ends. Null for open-ended orders satisfied when arrears reach zero. |
priority | integer, nullable | No | Priority ordering when multiple garnishments apply (lower number = higher priority). |
max_withholding_type | string | Yes | Whether the maximum withholding limit is expressed as a percentage of disposable income ("percent") or a fixed monetary amount ("fixed"). One of: |
max_withholding_value | number (float) | Yes | The maximum withholding amount or percentage per pay period. |
arrears | number (float), nullable | No | Total outstanding balance owed. The garnishment is automatically closed when cumulative withholdings satisfy the arrears. |
status | string | No | Current status of the garnishment case (present on responses). One of: |
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"