HIhibob
Employee Tables

Updates an equity grant for an employee

Changed on

This endpoint updates an entry in the employee’s equity table.<br> <p>Note that the entire equities entry will be overwritten with the data provided in your payload. Any columns not included in the payload will be cleared (set to empty values).</p>

put/people/{id}/equities/{entry_id}

Request

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

Path parameters

idstring required

Employee ID

entry_idinteger required

The entry ID to update.

Request body

idinteger

The ID of the equity table entry.

quantitynumber double required

The number of equities granted.

equityTypestring required

The type of the grant.

vestingCommencementDatestring date nullable

Vesting commencement date.

consentNumberstring nullable

Consent number.

grantDatestring date nullable

Date the equity was granted.

optionExpirationstring date nullable

Date the options expire.

vestingTermstring nullable

Terms for exercising this grant.

taxPlanstring nullable

Tax plan associated with the grant.

specialTermsstring nullable

Special terms associated with the grant.

grantTypestring nullable

Grant type. One of: Initial Grant, Merit Grant

vestingScheduleinteger nullable

The vesting schedule ID assigned to this grant.

grantNumbernumber double nullable

The Grant number for employee.

grantStatusstring nullable

Grant status. one of: Granted, Pending Approval

customColumnsobject

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

Response

Entry updated successfully.

Changes

  • 9ac25373a355Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • warning

      removed subschema #2 from the request body allOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property