HIhibob
Deductions

Update employee deduction

Beta. Updates an existing deduction by ID. Changes apply to the next pay cycle. Same body shape as create — pass the full deduction (PUT replaces all fields). If US Payroll rejects the update at downstream validation time, the API returns HTTP 400 with the standard error body (not HTTP 200 with a status: failed field).

Rate limit: 200 requests per minute per authenticated caller.

put/payroll/hub/us/employers/{employerId}/employees/{employeeId}/deductions/{deductionId}

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/payroll/hub/us/employers/{employerId}/employees/{employeeId}/deductions/{deductionId}
  • Auth
    HTTP bearer

Path parameters

employerIdstring required

Unique identifier of the employer.

employeeIdstring required

Unique Bob employee identifier.

deductionIdstring required

Unique identifier of the deduction to update.

Request body

vendorNamestring required

Vendor name to record as the source of this deduction in US payroll (e.g. "Fidelity", "Empower"). Required so the deduction can be reconciled back to the integrator.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.