.. _module-splice-api-token-holdingv1-43900: Splice.Api.Token.HoldingV1 ========================== Types and interfaces for retrieving an investor's holdings\. Interfaces ---------- .. _type-splice-api-token-holdingv1-holding-25898: **interface** `Holding `_ Holding interface\. **viewtype** `HoldingView `_ + **Choice** Archive Controller\: Signatories of implementing template Returns\: () (no fields) Data Types ---------- .. _type-splice-api-token-holdingv1-holdingview-83501: **data** `HoldingView `_ View for ``Holding``\. .. _constr-splice-api-token-holdingv1-holdingview-75848: `HoldingView `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - owner - `Party `_ - Owner of the holding\. * - instrumentId - `InstrumentId `_ - Instrument being held\. * - amount - `Decimal `_ - Size of the holding\. * - lock - `Optional `_ `Lock `_ - Lock on the holding\. Registries SHOULD allow holdings with expired locks as inputs to transfers to enable a combined unlocking \+ use choice\. * - meta - Metadata - Metadata\. **instance** `Eq `_ `HoldingView `_ **instance** `Show `_ `HoldingView `_ **instance** `HasFromAnyView `_ `Holding `_ `HoldingView `_ **instance** `HasInterfaceView `_ `Holding `_ `HoldingView `_ **instance** `GetField `_ \"amount\" `HoldingView `_ `Decimal `_ **instance** `GetField `_ \"instrumentId\" `HoldingView `_ `InstrumentId `_ **instance** `GetField `_ \"lock\" `HoldingView `_ (`Optional `_ `Lock `_) **instance** `GetField `_ \"meta\" `HoldingView `_ Metadata **instance** `GetField `_ \"owner\" `HoldingView `_ `Party `_ **instance** `SetField `_ \"amount\" `HoldingView `_ `Decimal `_ **instance** `SetField `_ \"instrumentId\" `HoldingView `_ `InstrumentId `_ **instance** `SetField `_ \"lock\" `HoldingView `_ (`Optional `_ `Lock `_) **instance** `SetField `_ \"meta\" `HoldingView `_ Metadata **instance** `SetField `_ \"owner\" `HoldingView `_ `Party `_ .. _type-splice-api-token-holdingv1-instrumentid-28218: **data** `InstrumentId `_ A globally unique identifier for instruments\. .. _constr-splice-api-token-holdingv1-instrumentid-17961: `InstrumentId `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - admin - `Party `_ - The party representing the registry app that administers the instrument\. * - id - `Text `_ - The identifier used for the instrument by the instrument admin\. This identifier MUST be unique and unambiguous per instrument admin\. **instance** `Eq `_ `InstrumentId `_ **instance** `Ord `_ `InstrumentId `_ **instance** `Show `_ `InstrumentId `_ **instance** `GetField `_ \"admin\" `InstrumentId `_ `Party `_ **instance** `GetField `_ \"id\" `InstrumentId `_ `Text `_ **instance** `GetField `_ \"instrumentId\" `HoldingView `_ `InstrumentId `_ **instance** `SetField `_ \"admin\" `InstrumentId `_ `Party `_ **instance** `SetField `_ \"id\" `InstrumentId `_ `Text `_ **instance** `SetField `_ \"instrumentId\" `HoldingView `_ `InstrumentId `_ .. _type-splice-api-token-holdingv1-lock-70295: **data** `Lock `_ Details of a lock\. .. _constr-splice-api-token-holdingv1-lock-56452: `Lock `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - holders - \[`Party `_\] - Unique list of parties which are locking the contract\. (Represented as a list, as that has the better JSON encoding\.) * - expiresAt - `Optional `_ `Time `_ - Absolute, inclusive deadline as of which the lock expires\. * - expiresAfter - `Optional `_ `RelTime `_ - Duration after which the created lock expires\. Measured relative to the ledger time that the locked holding contract was created\. If both ``expiresAt`` and ``expiresAfter`` are set, the lock expires at the earlier of the two times\. * - context - `Optional `_ `Text `_ - Short, human\-readable description of the context of the lock\. Used by wallets to enable users to understand the reason for the lock\. Note that the visibility of the content in this field might be wider than the visibility of the contracts in the context\. You should thus carefully decide what information is safe to put in the lock context\. **instance** `Eq `_ `Lock `_ **instance** `Ord `_ `Lock `_ **instance** `Show `_ `Lock `_ **instance** `GetField `_ \"context\" `Lock `_ (`Optional `_ `Text `_) **instance** `GetField `_ \"expiresAfter\" `Lock `_ (`Optional `_ `RelTime `_) **instance** `GetField `_ \"expiresAt\" `Lock `_ (`Optional `_ `Time `_) **instance** `GetField `_ \"holders\" `Lock `_ \[`Party `_\] **instance** `GetField `_ \"lock\" `HoldingView `_ (`Optional `_ `Lock `_) **instance** `SetField `_ \"context\" `Lock `_ (`Optional `_ `Text `_) **instance** `SetField `_ \"expiresAfter\" `Lock `_ (`Optional `_ `RelTime `_) **instance** `SetField `_ \"expiresAt\" `Lock `_ (`Optional `_ `Time `_) **instance** `SetField `_ \"holders\" `Lock `_ \[`Party `_\] **instance** `SetField `_ \"lock\" `HoldingView `_ (`Optional `_ `Lock `_)