TRANXACT.AI Help

HRMS · Garnishments

Garnishment Remittances

What each payroll run withheld under each order, one remittance per payee, its file (with the child support DED addenda) and the payment reference once it is sent.

Type REST6 operationsBase path /api/hrms/garnishment-remittances

Download specification (OpenAPI 3.1) Screen: Garnishment Remittances

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 Remittances 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.
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-remittancesRead garnishment remittances

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/garnishment-remittances" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/garnishment-remittances/buildBuild

Request body

The keys this action reads (* = required; "one of" lists the only values):

runId*, rebuild

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-remittances/build" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"runId":"value","rebuild":"value"}'
GET/api/hrms/garnishment-remittances/{id}Read garnishment remittances

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/garnishment-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/garnishment-remittances/{id}/downloadDownload

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/garnishment-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/garnishment-remittances/{id}/remittedRemitted

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):

reference

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-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/remitted" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reference":"value"}'
POST/api/hrms/garnishment-remittances/{id}/voidVoid

Path parameters

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

No body is required.

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-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/void" \
  -H "Authorization: Bearer $TOKEN"

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 Remittances 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.