stop_vesting
Proposes stopping vesting on one holding of shares or options, typically when an employee leaves. Shareflo calculates the number of vested shares/options from the schedule and shows it in the proposal. Normally you should not provide an overridden_vested_amount; only do so if the user specifically asks you to override the schedule calculation. 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 vesting stopped. If vesting_schedule_override = yes, this must explain why vesting was overridden. | |
| stop_date | Yes | Date vesting stops, usually the leaving date, in YYYY-MM-DD format. | |
| holding_uid | Yes | holding_uid from get_holdings for the holding whose vesting stops. | |
| replaces_proposal_uid | No | Optional UID of an Open stop-vesting proposal that this one corrects. The old proposal is superseded. | |
| overridden_vested_amount | No | The overridden number of vested shares/options. Normally omitted. Only provide this if the user specifically instructed you to override the vesting schedule, and then set vesting_schedule_override = yes. | |
| vesting_schedule_override | No | Only set this when the user specifically instructed you to override the vesting schedule and stated the intended number. With yes, you must include notes explaining why vesting is overridden. |