GUgusto
Garnishments

Get a garnishment

Changed on

Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments.

scope: garnishments:read

get/v1/garnishments/{garnishment_id}

Request

Path parameters

garnishment_idstring required

The UUID of the garnishment

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Example response

uuidstring required

The UUID of the garnishment in Gusto.

versionstring

The current version of the object. See the versioning guide for information on how to use this field.

employee_uuidstring

The UUID of the employee to which this garnishment belongs.

activeboolean

Whether or not this garnishment is currently active.

amountstring float

The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. "8.00". Child-support percentages cannot exceed 65; applicable federal or state rules may require a lower limit.

descriptionstring

The description of the garnishment.

court_orderedboolean

Whether the garnishment is court ordered. Must remain true for specific garnishment types other than other_garnishment.

timesinteger nullable

The number of times to apply the garnishment. Must be a positive integer when creating or changing a non-recurring count. Updates may echo an unchanged legacy zero. Ignored if recurring is true; use recurring rather than a negative count for indefinite deductions.

recurringboolean

Whether the garnishment should recur indefinitely.

annual_maximumstring float nullable

The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. "200.00".

total_amountstring float nullable

A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.

pay_period_maximumstring float nullable

The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. "16.00".

deduct_as_percentageboolean

Whether the amount should be treated as a percentage to be deducted per pay period.

garnishment_type'child_support' | 'federal_tax_lien' | 'state_tax_lien' | 'student_loan' | 'creditor_garnishment' | 'federal_loan' | 'other_garnishment' nullable

The specific type of garnishment for court ordered garnishments.

Changes

  • f98575fa2a5eRevision changes
    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status