pyocf.objects.transactions.transfer.convertibletransfer

Object describing a transfer or secondary sale of a convertible security

pydantic model pyocf.objects.transactions.transfer.convertibletransfer.ConvertibleTransfer

Object describing a transfer or secondary sale of a convertible security

field amount: Annotated[Monetary, FieldInfo(annotation=NoneType, required=True, description='Amount of monetary value transferred')] [Required]

Amount of monetary value transferred

field balance_security_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Identifier for the security that holds the remainder balance (for partialtransfers)')] | 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 consideration_text: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Unstructured text description of consideration provided in exchange for securitytransfer')] | 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_CONVERTIBLE_TRANSFER'], FieldInfo(annotation=NoneType, required=True, description='')] = 'TX_CONVERTIBLE_TRANSFER'

field resulting_security_ids: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Array of identifiers for new security (or securities) created as a result of thetransaction')] [Required]

Array of identifiers for new security (or securities) created as a result of thetransaction

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.