HIhibob
Employee Tables

Create an entitlement entry for an employee

Changed on

Creates a new entitlement table entry for the employee. On success, returns the new entry id. Creating or updating entries may also sync current entitlement amounts onto derived employee fields such as payroll.entitlement.<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 entitlement rows, use <a href="https://apidocs.hibob.com/reference/get_bulk-people-entitlement" target="_blank">List entitlement entries for a list of employees</a> (there is no per-employee GET).<br /><br /> Required permissions: People's Data > People's fields > Entitlement (Table) > Edit.

post/people/{id}/entitlement

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/people/{id}/entitlement
  • 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).

entitlementstring required

Entitlement type name from the company entitlement type list (for example Lunch vouchers or Company Car). 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 entitlementType.

endDatestring date

Optional explicit end date for this entitlement 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 entitlement table entry.

Changes