Creates a new variable payment for a given employee.

post

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

Creates a new variable pay entry for the employee. On success, returns the new entry id. For multi-employee reads, use List variable pay entries for a list of employees.

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

Path Params

string

required

Employee ID.

Body Params

Variable payment to add.

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

effectiveDate

date

required

The date this entry becomes effective (ISO 8601 date).

amount

object

required

variableType

string

required

The type of variable pay. Default values include Bonus, ExecutiveBonus, and Commission. Companies may add custom list values.

paymentPeriod

string

required

The payment period for this variable entry. Possible values: Annual, Half-Yearly, Quarterly, Monthly.

companyPercent

number

The employee's company on-target weight, in percentage.

departmentPercent

number

The employee's department on-target weight, in percentage.

individualPercent

number

The employee's individual on-target weight, in percentage.

reason

string

The reason for this change.

Response

200Entry created successfully.