Holdings API Contracts
Table of Contents
Access API
Module DA.ASX.API.Holding.AdminLock2Issuer_V001
Data Types
data AdminLock2Issuer
Admin holding locks disclosed to issuers
AdminLock2Issuer
FieldTypeDescription
unitQuantity Numeric 6 Locked quantity (ASX: Unit Quantity) reason AdminLockReason_V001.AdminLockReason Reason for the lock (ASX: Holding Lock Reason)
Module DA.ASX.API.Holding.AdminLockReason_V001
Data Types
data AdminLockReason
Account level reasons for administration locks
NonSpecific
NOSL (ASX: Non-specific)
SubjectToCourtOrder
SCOL (ASX: Subject to Court Order)
ActionByAsxOperations
ASXL (ASX: Action by ASX Operations)
Module DA.ASX.API.Holding.CollateralType_V001
Data Types
data CollateralType
ExchangeTradedOptionCover
CashMarketMarginCover
Module DA.ASX.API.Holding.Holding2Issuer_V001
Templates
template Holding
FieldTypeDescription
operator Party The operator issuer Optional Party The issuer accountId Account.Account_V001.K The account ID of the holding productId Security.ProductId_V001.ProductId The product ID of the holding total Numeric 6 The unit quantity of total balance available Numeric 6 The unit quantity of available balance adminLocked [AdminLock2Issuer_V001.AdminLock2Issuer] The locked subpositions only under admin lock
- Choice Archive
Module DA.ASX.API.Holding.HoldingAdminLock_V001
Templates
template HoldingAdminLockStandardView
FieldTypeDescription
operator Party The operator actorParty Optional Party The Party of the controlling actor accountId Account.Account_V001.K The account ID of the holding (ASX: Account Id) securityId Security.Security_V001.K The security ID of the holding future Bool Identifies if the lock if a future holding lock validToDate Optional Date The date the lock is due to be released reason AdminLockReason_V001.AdminLockReason The reason the holding admin lock was created
- Choice Archive
Data Types
Module DA.ASX.API.Holding.HoldingLockType_V001
Data Types
data HoldingLockType
SettlementLock
SETL (ASX: Settlement Lock)
ExchangeTradedOptionCover
ETOC (ASX: Exchange Traded Option Cover)
CashMarketMarginCover
CMMC (ASX: Cash Market Margin Cover)
BidAcceptance
BIDA (ASX: Bid Acceptance)
Admin
HADM (ASX: Holding Administration Lock)
Module DA.ASX.API.Holding.HoldingLock_V001
Data Types
data HoldingLock
HoldingLock
FieldTypeDescription
lockType HoldingLockType_V001.HoldingLockType Type of lock (ASX: Subposition Type) unitQuantity Numeric 6 Locked quantity (ASX: Unit Quantity) transactionId Optional Text Link to the Transaction Id of the request, if applicable (ASX: Related Transaction) corporateActionEventId Optional AssetServicing.CorporateActionEvent_V001.CorporateActionEventId Link to the corporate action for a bid acceptance type (ASX: Corporate Action Event Id) optionNumber Optional Text Option number value recorded against the corporate action event id (ASX: Option Number) adminLockReason Optional AdminLockReason_V001.AdminLockReason Reason for the lock for HADM locks
Module DA.ASX.API.Holding.Holding_V001
Templates
template Holding
FieldTypeDescription
operator Party The operator actorParty Optional Party The Party of the controlling actor accountId Account.Account_V001.K The account ID of the holding (ASX: Account Id) productId Security.ProductId_V001.ProductId The product ID of the holding (ASX: Product Id) available Numeric 6 The unit quantity of the available balance (ASX: Available Balance) locked [HoldingLock_V001.HoldingLock] The locked subpositions
- Choice Archive
Module DA.ASX.API.Holding.IssuerToParticipantMovementRequest_V001
Templates
template IssuerToParticipantMovementRequestFullView
FieldTypeDescription
operator Party The system operator submittingParty Optional Party The party who requested the movement transactionId K (ASX: Transaction Id) participantReference Optional Text (ASX: Participant Reference) supplementaryReference Optional Text (ASX: Supplementary Reference) underlyingReference Optional Text (ASX: Underlying Reference)
- Choice Archive
template IssuerToParticipantMovementRequestStandardView
FieldTypeDescription
operator Party The system operator transactionId K (ASX: Transaction Id) movementType MovementType_V001.T (ASX: Movement Type) deliveringActorId Actor.Actor_V001.K A reference to a ledger 'Actor', representing the deliverer (ASX: Deliverer Actor Id) deliveringParty Optional Party (ASX: Delivering Party) receivingActorId Actor.Actor_V001.K A reference to a ledger 'Actor', representing the receiver (ASX: Receiver Actor Id) receivingParty Optional Party (ASX: Receiving Party) securityId Security.Security_V001.K Unique identifier of the traded security (ASX: Security Id) deliveringAccountId Account.Account_V001.K (ASX: Delivering Account Identifier) receivingAccountId Account.Account_V001.K (ASX: Receiving Account Identifier) movementReason MovementReason_V001.T (ASX: Movement Reason) unitQuantity Numeric 6 (ASX: Unit Quantity) transactionBasis Text (ASX: Transaction Basis) registrationReference Optional Text (ASX: Registration Reference) basisOfMovement [Text] (ASX: Basis of Movement) guaranteedForeignIndicator Optional Text (ASX: Guaranteed Foreign Indicator) account AccountData The relevant details of the account used within the movement request holders [HolderData] The relevant details of the holder(s) of the account used within the movement request
- Choice Archive
Data Types
data AccountData
AccountData
FieldTypeDescription
accountId Account.Account_V001.K Identifier of the account for the movement request accountName Text Name of the registered holder of the account accountType Account.AccountType_V001.T The type of account (Sponsored, Direct, AccumulationEntrepot, SettlementEntrepot, or RegistrationIdentifier) ownershipType Account.AccountOwnershipType_V001.T Account ownership type (Single or Joint) mailingAddresseeLine Text The addressee line to be used for account statements registeredAddress Reference.Address_V001.T The full address to be used for account statements designation Optional Text Additional account information over and above the name of the registered holder residencyIndicator Account.ResidencyIndicator_V001.T The residency of the account holder accountStatus Account.AccountHolderStatus_V001.T The account status
data HolderData
HolderData
FieldTypeDescription
holderId Text Identifier of the holder for the movement request holderName Text Legal name of the holder holderType Account.HolderType_V001.T Type of holder holderStatus Account.AccountHolderStatus_V001.T The holder status
type K= Text
Module DA.ASX.API.Holding.MovementReason_V001
Data Types
data MovementReason
HolderInLiquidation
(ASX: HLLQ)
BalanceTransfer
(ASX: BLTR)
HolderRequest
(ASX: HLRQ)
DeceasedEstate
(ASX: DEST)
HolderBankrupt
(ASX: HLBK)
SecurityClosed
(ASX: SCCL)
WithdrawalOfParticipant
(ASX: WDPT)
IPOTransaction
(ASX: IPOO)
ActionByASXOperation
(ASX: ASXO)
type T= MovementReason
Module DA.ASX.API.Holding.MovementType_V001
Data Types
data MovementType
Conversion
(ASX: ICVP)
Transfer
(ASX: ITRP)
type T= MovementType
Module DA.ASX.API.Holding.ParticipantToIssuerAccountLockedReason_V001
Data Types
data ParticipantToIssuerAccountLockedReason
SubjectToCourtOrder
(ASX: SCOL)
NonSpecific
(ASX: NOSL)
ActionByAsxOperations
(ASX: ASXL)
Module DA.ASX.API.Holding.ParticipantToIssuerMovementReason_V001
Data Types
data ParticipantToIssuerMovementReason
SecurityClosed
(ASX: SCCL)
WithdrawalOfParticipant
(ASX: WDPT)
ActionByAsxOperations
(ASX: ASXO)
Module DA.ASX.API.Holding.ParticipantToIssuerMovementRequest_V001
Templates
template ParticipantToIssuerMovementRequest
FieldTypeDescription
operator Party The operator transactionId Text Transaction identifier of the movement request (ASX: Transcation Id) securityIds [Security.Security_V001.K] Security identifiers of the specific holdings requested to be converted / transferred (ASX: Security Id) deliveringActorId Optional Actor.Actor_V001.K Actor identifier of the participant that delivers the units (ASX: Delivering Actor Id) deliveringAccountId Optional Account.Account_V001.K Account identifier that delivers the units (Delivering Account Id) movementType ParticipantToIssuerMovementType_V001.ParticipantToIssuerMovementType Type of movement (ASX: Movement Type) movementReason ParticipantToIssuerMovementReason_V001.ParticipantToIssuerMovementReason Reason for the movement (ASX: Movement Reason) unitQuantity Optional (Numeric 6) Number of units requested to be converted (ASX: Unit Quantity) lockedReason Optional ParticipantToIssuerAccountLockedReason_V001.ParticipantToIssuerAccountLockedReason Lock reason of the holding at the time of the request (ASX: Locked Reason) effectiveDate Date Date the movement becomes effective (ASX: Effective Date) timeOfExecution ParticipantToIssuerTimeOfExecution_V001.ParticipantToIssuerTimeOfExecution Time of day the movement becomes effective (ASX: Time of Execution)
- Choice Archive
Module DA.ASX.API.Holding.ParticipantToIssuerMovementType_V001
Data Types
data ParticipantToIssuerMovementType
SecurityHoldingsConversion
(ASX: SHCV)
AccountHoldingsConversion
(ASX: AHCV)
ParticipantHoldingsConversion
(ASX: PHCV)
Module DA.ASX.API.Holding.ParticipantToIssuerTimeOfExecution_V001
Data Types
data ParticipantToIssuerTimeOfExecution
StartOfDay
(ASX: STDY)
EndOfDay
(ASX: ENDY)
Module DA.ASX.API.Holding.SrnEnquiry_V001
Templates
template PendingSrnEnquiry
FieldTypeDescription
operator Party The system operator transactionId K Transaction identifier of the enquiry (ASX: Transaction Id) securityId Security.Security_V001.K Unique identifier of the traded security (ASX: Security Id) requestingActorId Actor.Actor_V001.K A reference to a ledger 'Actor', representing the requestor (ASX: Requesting Actor Id) requestingParty Optional Party Party who initiated the request (ASX: Requesting Party) issuerParty Optional Party Party to respond to the request registrationReference Text Reference of the registration identifier (ASX: Registration Reference) securityholderReferenceNumber Optional Text SRN, if provided (ASX: Securityholder Reference Number) account AccountData Account associated with the request holders [HolderData] Holders associated with the account
- Choice Archive
Data Types
data AccountData
AccountData
FieldTypeDescription
accountId Account.Account_V001.K The unique identifier of the account (ASX: Account Identifier) accountType Account.AccountType_V001.T The type of account (ASX: Account Type) ownershipType Account.AccountOwnershipType_V001.T Account ownership type (ASX: Ownership Type) name Text Name of the registered holder of the account (ASX: Account Name) designation Optional Text Additional account information over and above the name of the registered holder, if available (ASX: Designation) mailingAddresseeLine Text The addressee line to be used for account statements (ASX: Mailing Addressee Line) registeredAddress Reference.Address_V001.T Address of registered holder of the account (ASX: Registered Address) residencyIndicator Account.ResidencyIndicator_V001.T The residency of the account holder (ASX: Residency Indicator) accountStatus Account.AccountHolderStatus_V001.T The account status (ASX: Account Status)
type C= ContractId T
data HolderData
HolderData
FieldTypeDescription
holderId Account.Holder_V001.K The unique identifier of the holder (ASX: Holder Identifier) holderType Account.HolderType_V001.T Type of holder (Individual or Organisation) (ASX: Holder Type) name Text Name of the holder (ASX: Holder Name) holderStatus Account.AccountHolderStatus_V001.T The holder status (ASX: Holder Status)
type K= Text
type T= PendingSrnEnquiry
Related Pages:
Browse Popular Pages:
No labels match these criteria.
This document provides general information only. ASX Limited (ABN 98 008 624 691) and its related bodies corporate (“ASX”) makes no representation or warranty with respect to the accuracy, reliability or completeness of the information. To the extent permitted by law, ASX and its employees, officers and contractors shall not be liable for any loss or damage arising in any way (including by way of negligence) from or in connection with any information provided or omitted or from anyone acting or refraining to act in reliance on this information.
© 2022 ASX Limited ABN 98 008 624 691