pyocf.objects.transactions.return_to_pool.stockplanreturntopool

Object describing which stock plan pool a particular security’s shares were returned to upon cancellation.

pydantic model pyocf.objects.transactions.return_to_pool.stockplanreturntopool.StockPlanReturnToPool

Object describing which stock plan pool a particular security’s shares were returned to upon cancellation.

field comments: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Unstructured text comments related to and stored for the object')] | 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_STOCK_PLAN_RETURN_TO_POOL'], FieldInfo(annotation=NoneType, required=True, description='')] = 'TX_STOCK_PLAN_RETURN_TO_POOL'

field quantity: Annotated[Numeric, FieldInfo(annotation=NoneType, required=True, description='How many shares were returned to the pool?')] [Required]

How many shares were returned to the pool?

field reason_text: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Reason for the return to the pool')] [Required]

Reason for the return to the pool

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 stock_plan_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Identifier of the Stock Plan object, a subject of this transaction')] [Required]

Identifier of the Stock Plan object, a subject of this transaction