Update a deduction entry for an employee

put

https://api.hibob.com/v1/people/{id}/deduction/{entry_id}

Updates an existing deduction entry for the given employee. Send the full row (not a partial patch). Returns no content on success.

Required permissions: People's Data > Payroll > Manage selected employees' Payroll sections (or Deduction table Manage when field-level permissions are enabled).

Path Params

string

required

Employee ID.

entry_id

int64

required

The entry ID to update.

Body Params

Values for the deduction entry you want to update.

Request body for creating or updating a deduction entry. Do not send id; the system assigns it on create. On update, identify the row with the path {entry_id}. The combination of effectiveDate and deduction must be unique per employee; duplicate pairs are rejected.

effectiveDate

date

required

Start of this timeline step (ISO 8601 date). Together with deduction, forms a unique key per employee for each row.

deduction

string

required

Deduction type name from the company deduction type list (for example Childcare vouchers or Health insurance). To list available values, call the Get company list by name endpoint with list name deductionType.

amount

object

required

endDate

date

Optional explicit end date for this deduction period (ISO 8601 date).

Responses

204

Entry updated successfully.

404

No deduction entry was found for the given employee and entry ID.