HRMS · Garnishments
Garnishment Orders
Child support, tax levies and creditor orders: the case, the payee and where the money goes, and the order of precedence. Payroll takes them in priority order within the CCPA limits of their deduction code.
/api/hrms/garnishment-ordersPublished as /api/v1/garnishment-ordersDownload specification (OpenAPI 3.1) Screen: Garnishment Orders
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Garnishment Orders on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.employee_deductions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/garnishment-ordersList garnishment orders
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deduction_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"amount": "1250.00",
"percent": "1250.00",
"employer_amount": "1250.00",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30",
"goal_amount": "1250.00",
"taken_to_date": "1250.00",
"case_number": "CAS-000001",
"payee": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/garnishment-orders?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/garnishment-orders/{id}Read one garnishment orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deduction_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"amount": "1250.00",
"percent": "1250.00",
"employer_amount": "1250.00",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30",
"goal_amount": "1250.00",
"taken_to_date": "1250.00",
"case_number": "CAS-000001",
"payee": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/garnishment-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/garnishment-ordersCreate a garnishment orders
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
deduction_code_id | uuid | Yes | Garnishment code — Its "max % of disposable earnings" is the CCPA limit applied. |
amount | numeric | No | Amount a period |
percent | numeric | No | Or percent |
effective_from | date | No | From |
effective_to | date | No | To |
goal_amount | numeric | No | Stop after (arrears) |
case_number | text | No | Case number |
payee | text | No | Pay to — One remittance per payee after each run. |
is_active | boolean | No | Active |
order_type | text | No | Kind of order Allowed: child_support spousal_support federal_tax_levy state_tax_levy local_tax_levy bankruptcy student_loan creditor other |
order_priority | integer | No | Priority — Lower is taken first. Empty: by kind -- support 10, federal levy 20, bankruptcy 25, state levy 30, student loan 40, creditor 50. |
order_received_on | date | No | Received — Among equal priority, the order received first is taken first. |
issuing_state | text | No | Issuing state |
issuing_authority | text | No | Issuing court or agency |
remit_to_address | text | No | Remit to address |
remit_fips | text | No | SDU FIPS code |
remit_method | text | No | Sent by Allowed: Check EFT EFT to a state disbursement unit (DED addenda) |
medical_support | boolean | No | Medical support ordered |
order_notes | text | No | Notes |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deduction_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"amount": "1250.00",
"percent": "1250.00",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deduction_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"amount": "1250.00",
"percent": "1250.00",
"employer_amount": "1250.00",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30",
"goal_amount": "1250.00",
"taken_to_date": "1250.00",
"case_number": "CAS-000001",
"payee": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/garnishment-orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","deduction_code_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","amount":"1250.00","percent":"1250.00","effective_from":"2026-10-30","effective_to":"2026-10-30"}'PUT/api/hrms/garnishment-orders/{id}Change a garnishment orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
deduction_code_id | uuid | Yes | Garnishment code — Its "max % of disposable earnings" is the CCPA limit applied. |
amount | numeric | No | Amount a period |
percent | numeric | No | Or percent |
effective_from | date | No | From |
effective_to | date | No | To |
goal_amount | numeric | No | Stop after (arrears) |
case_number | text | No | Case number |
payee | text | No | Pay to — One remittance per payee after each run. |
is_active | boolean | No | Active |
order_type | text | No | Kind of order Allowed: child_support spousal_support federal_tax_levy state_tax_levy local_tax_levy bankruptcy student_loan creditor other |
order_priority | integer | No | Priority — Lower is taken first. Empty: by kind -- support 10, federal levy 20, bankruptcy 25, state levy 30, student loan 40, creditor 50. |
order_received_on | date | No | Received — Among equal priority, the order received first is taken first. |
issuing_state | text | No | Issuing state |
issuing_authority | text | No | Issuing court or agency |
remit_to_address | text | No | Remit to address |
remit_fips | text | No | SDU FIPS code |
remit_method | text | No | Sent by Allowed: Check EFT EFT to a state disbursement unit (DED addenda) |
medical_support | boolean | No | Medical support ordered |
order_notes | text | No | Notes |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deduction_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"deduction_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"amount": "1250.00",
"percent": "1250.00",
"employer_amount": "1250.00",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30",
"goal_amount": "1250.00",
"taken_to_date": "1250.00",
"case_number": "CAS-000001",
"payee": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/garnishment-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","deduction_code_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/hrms/garnishment-orders/{id}Delete a garnishment orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/garnishment-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/garnishment-orders/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/garnishment-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a garnishment orders, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
employee_id | uuid | read, write | Employee |
deduction_code_id | uuid | read, write | Garnishment code — Its "max % of disposable earnings" is the CCPA limit applied. |
amount | numeric | read, write | Amount a period |
percent | numeric | read, write | Or percent |
employer_amount | numeric | read only | Employer amount |
effective_from | date | read, write | From |
effective_to | date | read, write | To |
goal_amount | numeric | read, write | Stop after (arrears) |
taken_to_date | numeric | read only | Taken to date |
case_number | text | read, write | Case number |
payee | text | read, write | Pay to — One remittance per payee after each run. |
is_active | boolean | read, write | Active |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
order_type | text | read, write | Kind of order Allowed: child_support spousal_support federal_tax_levy state_tax_levy local_tax_levy bankruptcy student_loan creditor other |
order_priority | integer | read, write | Priority — Lower is taken first. Empty: by kind -- support 10, federal levy 20, bankruptcy 25, state levy 30, student loan 40, creditor 50. |
order_received_on | date | read, write | Received — Among equal priority, the order received first is taken first. |
issuing_state | text | read, write | Issuing state |
issuing_authority | text | read, write | Issuing court or agency |
remit_to_address | text | read, write | Remit to address |
remit_fips | text | read, write | SDU FIPS code |
remit_method | text | read, write | Sent by Allowed: Check EFT EFT to a state disbursement unit (DED addenda) |
medical_support | boolean | read, write | Medical support ordered |
order_notes | text | read, write | Notes |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Garnishment Orders for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.