Create an entitlement entry for an employee

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 People search endpoint).

To read entitlement rows, use List entitlement entries for a list of employees (there is no per-employee GET).

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

Path Params
string
required

Employee ID.

Body Params

Values for the entitlement entry you want to add.

Request body for creating or updating an entitlement entry. Do not send id; the system assigns it on create. On update, identify the row with the path {entry_id}.

date
required

Start of this timeline step (ISO 8601 date).

string
required

Entitlement type name from the company entitlement type list (for example Lunch vouchers or Company Car). To list available values, call the Get company list by name endpoint with the entitlement type list name.

amount
object
required
date

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

Response

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json