HIhibob
Employee Tables

Creates a new variable payment for a given employee.

Changed on

Creates a new variable pay entry for the employee. On success, returns the new entry id. For multi-employee reads, use <a href="https://apidocs.hibob.com/reference/get_bulk-people-variable" target="_blank">List variable pay entries for a list of employees</a>.<br /><br /> Required permissions: People's Data > People's fields > Variable Pay (Table) > Edit.

post/people/{id}/variable

Request

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

Path parameters

idstring required

Employee ID.

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 created successfully.

entryIdinteger required

The id of the newly created variable pay table entry.

Changes

  • 9ac25373a355Revision changes
    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status