endpoints.VariablePayments.VariablePayments

VariablePayments methods

list

 | list(employee_id)

List employee's variable payments Returns a list of variable payments for a given employee.

Arguments:

• employee_id str - employee id

References:

• https://apidocs.hibob.com/reference#get_people-id-variable

---

create_entry

 | create_entry(employee_id, reason, effective_date, amount_value, amount_currency, pay_type, payment_period)

Creates a new variable payment for a given employee

Arguments:

• employee_id str - employee id
• reason str - reason for this change
• effective_date date - the date this entry becomes effective
• amount_value float -
• amount_currency str - 3 letter currency code
• pay_type str - The type of the variable pay
• payment_period str - represents the period for this variable entry. One of:
  • Annual
  • Half-Yearly
  • Quarterly
  • Monthly

References:

• https://apidocs.hibob.com/reference#post_people-id-variable

---

delete_entry

 | delete_entry(employee_id, entry_id)

Deletes a variable payment for an employee

Arguments:

• employee_id str - employee id
• entry_id int - the entry id to delete

References:

• https://apidocs.hibob.com/reference#delete_people-id-variable-entry-id