Update a variable payment for an employee

put

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

Updates an existing variable pay 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 Variable 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 variable pay entry you want to update.

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.

Responses

204

Entry updated successfully.

404

No variable pay entry was found for the given employee and entry ID.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here!