create_instrument
Creates a new instrument (share class, option class, or other) for the company. Requires unlock_shareflo to have been called first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tax_scheme | No | Whether awards of this instrument benefits from tax benefits by default (can be overridden for individual awards) - defaults to None if no parameter provided | |
| cliff_period | No | Default cliff period in months. | |
| nominal_value | No | Nominal value per unit. Mandatory for Shares. | |
| exercise_price | No | Default exercise price. Mandatory for Options. | |
| vesting_period | No | Default vesting period in months. | |
| instrument_name | Yes | Instrument name without type suffix, e.g. "Ordinary" not "Ordinary Share". | |
| instrument_type | Yes | Type of instrument. | |
| nominal_currency | No | ISO 4217 currency code for nominal value. Mandatory for Shares. | |
| exercise_currency | No | ISO 4217 currency code for exercise price. Mandatory for Options. | |
| has_voting_rights | Yes | Whether the instrument has voting rights. | |
| underlying_share_class | No | Share class the options purchase. Mandatory for Options. Use exact case-sensitive name. |