pyocf.objects.transactions.release.equitycompensationrelease

Object describing equity compensation security release transaction

pydantic model pyocf.objects.transactions.release.equitycompensationrelease.EquityCompensationRelease

Object describing equity compensation security release transaction

field comments: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Unstructured text comments related to and stored for the object')] | None = None
field consideration_text: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Unstructured text description of consideration provided in exchange for securityrelease')] | None = None
field date: Annotated[Date, FieldInfo(annotation=NoneType, required=True, description='Date on which the transaction occurred')] [Required]

Date on which the transaction occurred

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_RELEASE'], 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_RELEASE` will be deprecated inv2.0.0')] = 'TX_EQUITY_COMPENSATION_RELEASE'

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_RELEASE will be deprecated inv2.0.0

field quantity: Annotated[Numeric, FieldInfo(annotation=NoneType, required=True, description='Quantity of shares released')] [Required]

Quantity of shares released

field release_price: Annotated[Monetary, FieldInfo(annotation=NoneType, required=True, description='The release price used to determine the value of the security at the time ofrelease')] [Required]

The release price used to determine the value of the security at the time ofrelease

field resulting_security_ids: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Identifier of the new security (or securities) issuance resulting from a releasetransaction')] [Required]

Identifier of the new security (or securities) issuance resulting from a releasetransaction

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 settlement_date: Annotated[Date, FieldInfo(annotation=NoneType, required=True, description='The settlement date for the shares released, typically after the releasetransaction date')] [Required]

The settlement date for the shares released, typically after the releasetransaction date