Create a garnishment
POST {{baseUrl}}/v1/employees/:employee_id/garnishments
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
Request Body
{"amount"=>"<float>", "description"=>"<string>", "court_ordered"=>"<boolean>", "active"=>true, "times"=>nil, "recurring"=>false, "annual_maximum"=>nil, "pay_period_maximum"=>nil, "deduct_as_percentage"=>false}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"uuid":"96334c6c-4e01-40ac-ac1c-d2fb02a7e371","id":1363316538400333,"version":"52b7c567242cb7452e89ba2bc02cb476","employee_uuid":"2d9c45f3-5ab9-4198-90a7-e8bea1ae3ce6","employee_id":8964216891236743,"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}