ACH Transactions1

Bank Accounts5

Companies18

Company Attachment4

Company Benefits13

Company Forms4

Contractor Documents4

Contractor Forms4

Contractor Payment Groups8

Contractor Payment Method4

Contractor Payments9

Contractors14

Departments7

Earning Types4

Employee Addresses10

Employee Benefits11

Employee Employments10

Employee Forms5

Employee Payment Method6

Employee Tax Setup4

Employees13

Events1

External Payrolls9

Federal Tax Details2

Flows1

Garnishments5

Generated Documents1

Holiday Pay Policies7

I-9 Verification7

Industry Selection2

Information Requests1

Introspection2

Invoices1

Jobs and Compensations10

Locations5

Member Portal Invitations6

Notifications2

Pay Schedules9

Payment Configs2

Payroll Cancellations2

Payroll Digests2

Payrolls20

People Batches2

Recovery Cases2

Reimbursements5

Reports7

Reverse Wire Transactions1

Salary Estimates5

Signatories5

Tax Payments2

Tax Requirements3

Time Off Policies9

Time Off Requests9

Webhooks8

Wire In Requests3

Garnishments

Update a garnishment

Changed on Nov 3, 2026

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

put/v1/garnishments/{garnishment_id}

Request

Base URL
https://api.gusto-demo.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/gusto/apis/gusto-api/docs/v1/garnishments/:garnishment_id/put.ts
A function with typed inputs. Its response is checked against the schema.

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.

Request body

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.

The specific type of garnishment for court ordered garnishments.

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

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.

total_amountstring float nullable

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

versionstring required

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

Example request

{
  "version": "56d00c178bc7393b2a206ed6a86afcb4"
}

Response

Example response

uuidstring required

The UUID of the garnishment in Gusto.

versionstring