TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/hrms/garnishment-ordersPublished as /api/v1/garnishment-orders

Download specification (OpenAPI 3.1) Screen: Garnishment Orders

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.employee_deductions · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
employee_iduuidYesEmployee
deduction_code_iduuidYesGarnishment code — Its "max % of disposable earnings" is the CCPA limit applied.
amountnumericNoAmount a period
percentnumericNoOr percent
effective_fromdateNoFrom
effective_todateNoTo
goal_amountnumericNoStop after (arrears)
case_numbertextNoCase number
payeetextNoPay to — One remittance per payee after each run.
is_activebooleanNoActive
order_typetextNoKind of order
Allowed: child_support spousal_support federal_tax_levy state_tax_levy local_tax_levy bankruptcy student_loan creditor other
order_priorityintegerNoPriority — Lower is taken first. Empty: by kind -- support 10, federal levy 20, bankruptcy 25, state levy 30, student loan 40, creditor 50.
order_received_ondateNoReceived — Among equal priority, the order received first is taken first.
issuing_statetextNoIssuing state
issuing_authoritytextNoIssuing court or agency
remit_to_addresstextNoRemit to address
remit_fipstextNoSDU FIPS code
remit_methodtextNoSent by
Allowed: Check EFT EFT to a state disbursement unit (DED addenda)
medical_supportbooleanNoMedical support ordered
order_notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
employee_iduuidYesEmployee
deduction_code_iduuidYesGarnishment code — Its "max % of disposable earnings" is the CCPA limit applied.
amountnumericNoAmount a period
percentnumericNoOr percent
effective_fromdateNoFrom
effective_todateNoTo
goal_amountnumericNoStop after (arrears)
case_numbertextNoCase number
payeetextNoPay to — One remittance per payee after each run.
is_activebooleanNoActive
order_typetextNoKind of order
Allowed: child_support spousal_support federal_tax_levy state_tax_levy local_tax_levy bankruptcy student_loan creditor other
order_priorityintegerNoPriority — Lower is taken first. Empty: by kind -- support 10, federal levy 20, bankruptcy 25, state levy 30, student loan 40, creditor 50.
order_received_ondateNoReceived — Among equal priority, the order received first is taken first.
issuing_statetextNoIssuing state
issuing_authoritytextNoIssuing court or agency
remit_to_addresstextNoRemit to address
remit_fipstextNoSDU FIPS code
remit_methodtextNoSent by
Allowed: Check EFT EFT to a state disbursement unit (DED addenda)
medical_supportbooleanNoMedical support ordered
order_notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

Response

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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
employee_iduuidread, writeEmployee
deduction_code_iduuidread, writeGarnishment code — Its "max % of disposable earnings" is the CCPA limit applied.
amountnumericread, writeAmount a period
percentnumericread, writeOr percent
employer_amountnumericread onlyEmployer amount
effective_fromdateread, writeFrom
effective_todateread, writeTo
goal_amountnumericread, writeStop after (arrears)
taken_to_datenumericread onlyTaken to date
case_numbertextread, writeCase number
payeetextread, writePay to — One remittance per payee after each run.
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
order_typetextread, writeKind of order
Allowed: child_support spousal_support federal_tax_levy state_tax_levy local_tax_levy bankruptcy student_loan creditor other
order_priorityintegerread, writePriority — Lower is taken first. Empty: by kind -- support 10, federal levy 20, bankruptcy 25, state levy 30, student loan 40, creditor 50.
order_received_ondateread, writeReceived — Among equal priority, the order received first is taken first.
issuing_statetextread, writeIssuing state
issuing_authoritytextread, writeIssuing court or agency
remit_to_addresstextread, writeRemit to address
remit_fipstextread, writeSDU FIPS code
remit_methodtextread, writeSent by
Allowed: Check EFT EFT to a state disbursement unit (DED addenda)
medical_supportbooleanread, writeMedical support ordered
order_notestextread, writeNotes

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Garnishment Orders for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.