create_holding
The first step of allotting/awarding shares or options to a stakeholder. The tool creates an award proposal for the user, including filling in any default fields. You must then present the returned proposal to the user. Call confirm_action only after the user has actively approved that exact proposal. Or create a new one if they want further alterations. Requires unlock_shareflo to have been called first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cliff | No | Vesting cliff in months. Leave empty to accept the instrument default. With cliff_override=yes, use 0 for no cliff. | |
| notes | No | Optional notes for the award. | |
| quantity | Yes | Number of shares or options to award; must be greater than zero. | |
| tax_scheme | No | Tax scheme for this award. EMI and CSOP are Option-only; SEIS and EIS are Share-only. Omit to accept the instrument default. | |
| date_acquired | Yes | Award date in YYYY-MM-DD format. | |
| cliff_override | No | Include only when explicitly overriding the instrument's default cliff. With yes, cliff is required; use 0 for no cliff. | |
| exercise_price | No | Exercise price per option. Leave empty to accept the instrument default unless exercise_price_override is yes. | |
| purchase_price | No | Price paid for each unit. Leave empty to accept the instrument default unless purchase_price_override is yes. | |
| vesting_period | No | Vesting duration in months. Leave empty to accept the instrument default. With vesting_period_override=yes, use 0 for no vesting. | |
| instrument_name | Yes | Exact name of the instrument to award. | |
| instrument_type | Yes | Type of the named instrument. | |
| stakeholder_name | Yes | Stakeholder name in UPPER CASE; use FIRSTNAME LASTNAME for an individual. | |
| exercise_currency | No | ISO 4217 currency for exercise_price. Leave empty to accept the instrument default unless exercise_currency_override is yes. | |
| purchase_currency | No | ISO 4217 currency for purchase_price. Leave empty to accept the instrument default unless purchase_price_override is yes. | |
| vesting_start_date | No | Vesting start date in YYYY-MM-DD format. Required when the resolved vesting period is greater than zero; leave empty when it is zero. | |
| replaces_proposal_uid | No | Optional UID of an Open proposal being corrected. A successful new proposal supersedes it; it is not deleted. | |
| exercise_price_override | No | Include only when explicitly overriding the instrument's default exercise price. With yes, exercise_price is required; use 0 only for a zero-price exercise. | |
| purchase_price_override | No | Include only when explicitly overriding the instrument's default purchase price/currency. With yes, include purchase_price (use 0 for no purchase price) and purchase_currency when the price is greater than 0. | |
| vesting_period_override | No | Include only when explicitly overriding the instrument's default vesting period. With yes, vesting_period is required; use 0 for no vesting. | |
| quantity_vested_at_start | No | Units vested immediately at the vesting start. Omit for 0. | |
| exercise_currency_override | No | Include only when explicitly overriding the instrument's default exercise currency. With yes, exercise_currency is required. |