HIhibob
Employee Tables

Create a deduction entry for an employee

Changed on

Creates a new deduction table entry for the employee. On success, returns the new entry id. The combination of effectiveDate and deduction must be unique per employee; duplicate pairs are rejected. Creating or updating entries may also sync current deduction amounts onto derived employee fields such as payroll.deduction.<Type>.amount (employee fields you can fetch with the <a href="https://apidocs.hibob.com/reference/post_people-search" target="_blank">People search</a> endpoint).<br /><br /> To read deduction rows, use <a href="https://apidocs.hibob.com/reference/get_bulk-people-deduction" target="_blank">List deduction entries for a list of employees</a> (there is no per-employee GET).<br /><br /> Required permissions: People's Data > People's fields > Deduction (Table) > Edit.

post/people/{id}/deduction

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/people/{id}/deduction
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

idstring required

Employee ID.

Request body

effectiveDatestring date required

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

deductionstring required

Deduction type name from the company deduction type list (for example Childcare vouchers or Health insurance). To list available values, call the <a href="https://apidocs.hibob.com/reference/get_company-named-lists-listname" target="_blank">Get company list by name</a> endpoint with list name deductionType.

endDatestring date

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

customColumnsobject

Custom column values for this entry, keyed by column id.

Response

Entry created successfully.

entryIdinteger required

The id of the newly created deduction table entry.

Changes