cancel_shares_or_options
Proposes cancelling shares or options from one holding: for example options forfeited by a leaver, or shares cancelled by the company. Shareflo records a share cancellation or an option cancellation according to the instrument. Cancelling the whole holding is always possible. Cancelling only part of it is possible only once vesting on the holding has been stopped (use stop_vesting first) or if it has no vesting schedule; then, if the holding is partly vested, take_from says whether the cancelled units come from the vested or the unvested part. This tool only creates a proposal; nothing changes until confirm_action. Requires unlock_shareflo to have been called first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Optional notes, e.g. the reason for the cancellation. | |
| quantity | Yes | Number of shares or options to cancel; greater than zero and no more than the holding has. | |
| take_from | No | Only when vesting has stopped, the holding is partly vested and only part of it is cancelled: whether the cancelled units come from the vested or the unvested part. Omit otherwise. | |
| holding_uid | Yes | holding_uid from get_holdings for the holding being reduced. | |
| cancellation_date | Yes | Cancellation date in YYYY-MM-DD format. | |
| replaces_proposal_uid | No | Optional UID of an Open cancellation proposal that this one corrects. The old proposal is superseded. |