HIhibob
Deductions

Create employee deduction

Beta. Creates a new deduction for an employee under an employer. Changes apply to the next pay cycle. Do not include a deductionId in the request body — the server assigns one and returns it in the response.

If US Payroll rejects the deduction 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.

post/payroll/hub/us/employers/{employerId}/employees/{employeeId}/deductions

Request

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

Path parameters

employerIdstring required

Unique identifier of the employer.

employeeIdstring required

Unique Bob employee identifier.

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.