Open Cap Table Protocol Canton SDK - v0.2.84
    Preparing search index...

    Interface OcfObjectReference

    Type - Object Reference A type representing a reference to any kind of OCF object OCF: https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/types/ObjectReference.schema.json

    interface OcfObjectReference {
        object_id: string;
        object_type:
            | "ISSUER"
            | "STAKEHOLDER"
            | "STOCK_CLASS"
            | "STOCK_LEGEND_TEMPLATE"
            | "STOCK_PLAN"
            | "VALUATION"
            | "VESTING_TERMS"
            | "FINANCING"
            | "DOCUMENT"
            | "CE_STAKEHOLDER_RELATIONSHIP"
            | "CE_STAKEHOLDER_STATUS"
            | "TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT"
            | "TX_STOCK_CLASS_CONVERSION_RATIO_ADJUSTMENT"
            | "TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT"
            | "TX_STOCK_CLASS_SPLIT"
            | "TX_STOCK_PLAN_POOL_ADJUSTMENT"
            | "TX_STOCK_PLAN_RETURN_TO_POOL"
            | "TX_CONVERTIBLE_ACCEPTANCE"
            | "TX_CONVERTIBLE_CANCELLATION"
            | "TX_CONVERTIBLE_CONVERSION"
            | "TX_CONVERTIBLE_ISSUANCE"
            | "TX_CONVERTIBLE_RETRACTION"
            | "TX_CONVERTIBLE_TRANSFER"
            | "TX_EQUITY_COMPENSATION_ACCEPTANCE"
            | "TX_EQUITY_COMPENSATION_CANCELLATION"
            | "TX_EQUITY_COMPENSATION_EXERCISE"
            | "TX_EQUITY_COMPENSATION_ISSUANCE"
            | "TX_EQUITY_COMPENSATION_RELEASE"
            | "TX_EQUITY_COMPENSATION_RETRACTION"
            | "TX_EQUITY_COMPENSATION_TRANSFER"
            | "TX_EQUITY_COMPENSATION_REPRICING"
            | "TX_PLAN_SECURITY_ACCEPTANCE"
            | "TX_PLAN_SECURITY_CANCELLATION"
            | "TX_PLAN_SECURITY_EXERCISE"
            | "TX_PLAN_SECURITY_ISSUANCE"
            | "TX_PLAN_SECURITY_RELEASE"
            | "TX_PLAN_SECURITY_RETRACTION"
            | "TX_PLAN_SECURITY_TRANSFER"
            | "TX_STOCK_ACCEPTANCE"
            | "TX_STOCK_CANCELLATION"
            | "TX_STOCK_CONVERSION"
            | "TX_STOCK_ISSUANCE"
            | "TX_STOCK_REISSUANCE"
            | "TX_STOCK_CONSOLIDATION"
            | "TX_STOCK_REPURCHASE"
            | "TX_STOCK_RETRACTION"
            | "TX_STOCK_TRANSFER"
            | "TX_WARRANT_ACCEPTANCE"
            | "TX_WARRANT_CANCELLATION"
            | "TX_WARRANT_EXERCISE"
            | "TX_WARRANT_ISSUANCE"
            | "TX_WARRANT_RETRACTION"
            | "TX_WARRANT_TRANSFER"
            | "TX_VESTING_ACCELERATION"
            | "TX_VESTING_START"
            | "TX_VESTING_EVENT";
    }
    Index

    Properties

    object_id: string

    Identifier of the referenced object

    object_type:
        | "ISSUER"
        | "STAKEHOLDER"
        | "STOCK_CLASS"
        | "STOCK_LEGEND_TEMPLATE"
        | "STOCK_PLAN"
        | "VALUATION"
        | "VESTING_TERMS"
        | "FINANCING"
        | "DOCUMENT"
        | "CE_STAKEHOLDER_RELATIONSHIP"
        | "CE_STAKEHOLDER_STATUS"
        | "TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT"
        | "TX_STOCK_CLASS_CONVERSION_RATIO_ADJUSTMENT"
        | "TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT"
        | "TX_STOCK_CLASS_SPLIT"
        | "TX_STOCK_PLAN_POOL_ADJUSTMENT"
        | "TX_STOCK_PLAN_RETURN_TO_POOL"
        | "TX_CONVERTIBLE_ACCEPTANCE"
        | "TX_CONVERTIBLE_CANCELLATION"
        | "TX_CONVERTIBLE_CONVERSION"
        | "TX_CONVERTIBLE_ISSUANCE"
        | "TX_CONVERTIBLE_RETRACTION"
        | "TX_CONVERTIBLE_TRANSFER"
        | "TX_EQUITY_COMPENSATION_ACCEPTANCE"
        | "TX_EQUITY_COMPENSATION_CANCELLATION"
        | "TX_EQUITY_COMPENSATION_EXERCISE"
        | "TX_EQUITY_COMPENSATION_ISSUANCE"
        | "TX_EQUITY_COMPENSATION_RELEASE"
        | "TX_EQUITY_COMPENSATION_RETRACTION"
        | "TX_EQUITY_COMPENSATION_TRANSFER"
        | "TX_EQUITY_COMPENSATION_REPRICING"
        | "TX_PLAN_SECURITY_ACCEPTANCE"
        | "TX_PLAN_SECURITY_CANCELLATION"
        | "TX_PLAN_SECURITY_EXERCISE"
        | "TX_PLAN_SECURITY_ISSUANCE"
        | "TX_PLAN_SECURITY_RELEASE"
        | "TX_PLAN_SECURITY_RETRACTION"
        | "TX_PLAN_SECURITY_TRANSFER"
        | "TX_STOCK_ACCEPTANCE"
        | "TX_STOCK_CANCELLATION"
        | "TX_STOCK_CONVERSION"
        | "TX_STOCK_ISSUANCE"
        | "TX_STOCK_REISSUANCE"
        | "TX_STOCK_CONSOLIDATION"
        | "TX_STOCK_REPURCHASE"
        | "TX_STOCK_RETRACTION"
        | "TX_STOCK_TRANSFER"
        | "TX_WARRANT_ACCEPTANCE"
        | "TX_WARRANT_CANCELLATION"
        | "TX_WARRANT_EXERCISE"
        | "TX_WARRANT_ISSUANCE"
        | "TX_WARRANT_RETRACTION"
        | "TX_WARRANT_TRANSFER"
        | "TX_VESTING_ACCELERATION"
        | "TX_VESTING_START"
        | "TX_VESTING_EVENT"

    Type of the referenced object