Get garnishments for an employee
GET {{baseUrl}}/v1/employees/:employee_id/garnishments?page=<number>&per=<number>
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
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. | |
per | string | Number of objects per page. For majority of endpoints will default to 25 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
[{"uuid":"4c7841a2-1363-497e-bc0f-664703c7484f","version":"63152767c822d6b0385509b973c49dda","employee_uuid":"a6b53294-f871-4db2-bbd4-8c3d1fe56440","active":true,"amount":"100.00","description":"Child support","court_ordered":true,"times":null,"recurring":true,"annual_maximum":"400.00","pay_period_maximum":null,"deduct_as_percentage":false},{"uuid":"96334c6c-4e01-40ac-ac1c-d2fb02a7e371","version":"52b7c567242cb7452e89ba2bc02cb476","employee_uuid":"2d9c45f3-5ab9-4198-90a7-e8bea1ae3ce6","active":true,"amount":"8.00","description":"Company loan to employee","court_ordered":false,"times":5,"recurring":false,"annual_maximum":null,"pay_period_maximum":"100.00","deduct_as_percentage":true}]