HIhibob
Employee Tables

Update a variable payment for an employee

Changed on

Updates an existing variable pay entry for the given employee. Send the full row (not a partial patch). Returns no content on success.<br /><br /> Required permissions: People's Data > People's fields > Variable Pay (Table) > Edit.

put/people/{id}/variable/{entry_id}

Request

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

Path parameters

idstring required

Employee ID.

entry_idinteger required

The entry ID to update.

Request body

effectiveDatestring date required

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

variableTypestring required

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

paymentPeriodstring required

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

companyPercentnumber

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

departmentPercentnumber

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

individualPercentnumber

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

reasonstring

The reason for this change.

customColumnsobject

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

Response

Entry updated successfully.

Changes