pyocf.objects.transactions.issuance.equitycompensationissuance
Object describing securities issuance transaction by the issuer and held by a stakeholder as a form of compensation (as noted elsewhere, RSAs are not included here intentionally and should be modelled using Stock Issuances).
- pydantic model pyocf.objects.transactions.issuance.equitycompensationissuance.EquityCompensationIssuance
Object describing securities issuance transaction by the issuer and held by a stakeholder as a form of compensation (as noted elsewhere, RSAs are not included here intentionally and should be modelled using Stock Issuances).
- field base_price: Annotated[Monetary, FieldInfo(annotation=NoneType, required=True, description='If this is a stock appreciation right, what is the base price used to calculatethe appreciation of the SAR?')] | None = None
- field board_approval_date: Annotated[Date, FieldInfo(annotation=NoneType, required=True, description='Date of board approval for the security')] | None = None
- field comments: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Unstructured text comments related to and stored for the object')] | None = None
- field compensation_type: Annotated[CompensationType, FieldInfo(annotation=NoneType, required=True, description='If the plan security is compensation, what kind?')] [Required]
If the plan security is compensation, what kind?
- field consideration_text: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Unstructured text description of consideration provided in exchange for securityissuance')] | None = None
- field custom_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='A custom ID for this security (e.g. CN-1.)')] [Required]
A custom ID for this security (e.g. CN-1.)
- field date: Annotated[Date, FieldInfo(annotation=NoneType, required=True, description='Date on which the transaction occurred')] [Required]
Date on which the transaction occurred
- field early_exercisable: Annotated[bool, FieldInfo(annotation=NoneType, required=True, description="Is this Equity Compensation exercisable prior to completion of vesting? If so,it's assumed the vesting schedule will remain in effect but, instead of vestinga right to exercise, it becomes the schedule determining when a right torepurchase the resulting stock lapses.")] | None = None
- field exercise_price: Annotated[Monetary, FieldInfo(annotation=NoneType, required=True, description='If this is an option, what is the exercise price of the option?')] | None = None
- field id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Identifier for the object')] [Required]
Identifier for the object
- field object_type: Annotated[Literal['TX_EQUITY_COMPENSATION_ISSUANCE'], FieldInfo(annotation=NoneType, required=True, description='This is done to avoid a breaking change as we work towards a bigger restructureof the equity types in v2.0.0. `TX_PLAN_SECURITY_ISSUANCE` will be deprecated inv2.0.0')] = 'TX_EQUITY_COMPENSATION_ISSUANCE'
This is done to avoid a breaking change as we work towards a bigger restructureof the equity types in v2.0.0. TX_PLAN_SECURITY_ISSUANCE will be deprecated inv2.0.0
- field option_grant_type: Annotated[OptionType, FieldInfo(annotation=NoneType, required=True, description='If the plan security is an option, what kind?')] | None = None
- field quantity: Annotated[Numeric, FieldInfo(annotation=NoneType, required=True, description='How many shares are subject to this plan security?')] [Required]
How many shares are subject to this plan security?
- field security_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description="Identifier for the security (stock, plan security, warrant, or convertible) bywhich it can be referenced by other transaction objects. Note that while thisidentifier is created with an issuance object, it should be different than theissuance object's `id` field which identifies the issuance transaction objectitself. All future transactions on the security (e.g. acceptance, transfer,cancel, etc.) must reference this `security_id` to qualify which security thetransaction applies to.")] [Required]
Identifier for the security (stock, plan security, warrant, or convertible) bywhich it can be referenced by other transaction objects. Note that while thisidentifier is created with an issuance object, it should be different than theissuance object’s id field which identifies the issuance transaction objectitself. All future transactions on the security (e.g. acceptance, transfer,cancel, etc.) must reference this security_id to qualify which security thetransaction applies to.
- field security_law_exemptions: Annotated[list[SecurityExemption], FieldInfo(annotation=NoneType, required=True, description='List of security law exemptions (and applicable jurisdictions) for this security')] [Required]
List of security law exemptions (and applicable jurisdictions) for this security
- field stakeholder_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Identifier for the stakeholder that holds legal title to this security')] [Required]
Identifier for the stakeholder that holds legal title to this security
- field stock_class_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='The stock class options will exercise into. Especially important for plan-lessoptions and any issuances from a plan that supports multiple share classes.')] | None = None
- field stock_plan_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description="If the equity compensation was issued from a plan (don't forget, plan-lessoptions are a thing), what is the plan id.")] | None = None
- field stockholder_approval_date: Annotated[Date, FieldInfo(annotation=NoneType, required=True, description='Date on which the stockholders approved the security')] | None = None
- field termination_exercise_windows: Annotated[list[TerminationWindow], FieldInfo(annotation=NoneType, required=True, description='Exercise periods applicable to plan security after a termination for a given,enumerated reason')] [Required]
Exercise periods applicable to plan security after a termination for a given,enumerated reason
- field vesting_terms_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Identifier of the VestingTerms to which this security is subject. If neither`vesting_terms_id` or `vestings` are present then the security is fully vestedon issuance.')] | None = None