convert_share_class
Proposes converting shares from one holding into a different share class of the same company, for the same stakeholder, one for one. The stakeholder gets a new holding in the target class, with tax scheme None; the original holding is reduced. The target must be an existing share class: shares can't convert into options, and options can't be converted with this tool. Omitting the vesting schedule means the new holding has no vesting. Converting only part of a holding is possible only once its vesting has been stopped (use stop_vesting first) or if it has no vesting schedule. 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 |
|---|---|---|---|
| cliff | No | Cliff in months for the new holding. Omit for no cliff. | |
| notes | No | Optional notes, e.g. the resolution approving the conversion. | |
| quantity | Yes | Number of shares to convert; greater than zero and no more than the holding has. | |
| take_from | No | Only when vesting on the holding has stopped, it is partly vested and only part of it is converted: whether the shares come from the vested or the unvested part. Omit otherwise. | |
| holding_uid | Yes | holding_uid from get_holdings for the shares being converted. | |
| vesting_period | No | Vesting period in months for the new holding. Omit for no vesting. | |
| conversion_date | Yes | Conversion date in YYYY-MM-DD format. | |
| to_instrument_name | Yes | Exact name of the share class to convert into, as listed by get_instruments. | |
| vesting_start_date | No | Vesting start date in YYYY-MM-DD format. Required when vesting_period is given. | |
| replaces_proposal_uid | No | Optional UID of an Open conversion proposal that this one corrects. The old proposal is superseded. | |
| quantity_vested_at_start | No | Shares of the new holding vested at the vesting start. Omit if there is no vesting, or if none vest at the start. |