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
unitQuantityNumeric 6Locked quantity (ASX: Unit Quantity)
reasonAdminLockReason_V001.AdminLockReasonReason 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
operatorPartyThe operator
issuerOptional PartyThe issuer
accountIdAccount.Account_V001.KThe account ID of the holding
productIdSecurity.ProductId_V001.ProductIdThe product ID of the holding
totalNumeric 6The unit quantity of total balance
availableNumeric 6The 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
operatorPartyThe operator
actorPartyOptional PartyThe Party of the controlling actor
accountIdAccount.Account_V001.KThe account ID of the holding (ASX: Account Id)
securityIdSecurity.Security_V001.KThe security ID of the holding
futureBoolIdentifies if the lock if a future holding lock
validToDateOptional DateThe date the lock is due to be released
reasonAdminLockReason_V001.AdminLockReasonThe 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
lockTypeHoldingLockType_V001.HoldingLockTypeType of lock (ASX: Subposition Type)
unitQuantityNumeric 6Locked quantity (ASX: Unit Quantity)
transactionIdOptional TextLink to the Transaction Id of the request, if applicable (ASX: Related Transaction)
corporateActionEventIdOptional AssetServicing.CorporateActionEvent_V001.CorporateActionEventIdLink to the corporate action for a bid acceptance type (ASX: Corporate Action Event Id)
optionNumberOptional TextOption number value recorded against the corporate action event id (ASX: Option Number)
adminLockReasonOptional AdminLockReason_V001.AdminLockReasonReason for the lock for HADM locks

Module DA.ASX.API.Holding.Holding_V001

Templates

template Holding

FieldTypeDescription
operatorPartyThe operator
actorPartyOptional PartyThe Party of the controlling actor
accountIdAccount.Account_V001.KThe account ID of the holding (ASX: Account Id)
productIdSecurity.ProductId_V001.ProductIdThe product ID of the holding (ASX: Product Id)
availableNumeric 6The 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
operatorPartyThe system operator
submittingPartyOptional PartyThe party who requested the movement
transactionIdK(ASX: Transaction Id)
participantReferenceOptional Text(ASX: Participant Reference)
supplementaryReferenceOptional Text(ASX: Supplementary Reference)
underlyingReferenceOptional Text(ASX: Underlying Reference)
  • Choice Archive

template IssuerToParticipantMovementRequestStandardView

FieldTypeDescription
operatorPartyThe system operator
transactionIdK(ASX: Transaction Id)
movementTypeMovementType_V001.T(ASX: Movement Type)
deliveringActorIdActor.Actor_V001.KA reference to a ledger 'Actor', representing the deliverer (ASX: Deliverer Actor Id)
deliveringPartyOptional Party(ASX: Delivering Party)
receivingActorIdActor.Actor_V001.KA reference to a ledger 'Actor', representing the receiver (ASX: Receiver Actor Id)
receivingPartyOptional Party(ASX: Receiving Party)
securityIdSecurity.Security_V001.KUnique identifier of the traded security (ASX: Security Id)
deliveringAccountIdAccount.Account_V001.K(ASX: Delivering Account Identifier)
receivingAccountIdAccount.Account_V001.K(ASX: Receiving Account Identifier)
movementReasonMovementReason_V001.T(ASX: Movement Reason)
unitQuantityNumeric 6(ASX: Unit Quantity)
transactionBasisText(ASX: Transaction Basis)
registrationReferenceOptional Text(ASX: Registration Reference)
basisOfMovement[Text](ASX: Basis of Movement)
guaranteedForeignIndicatorOptional Text(ASX: Guaranteed Foreign Indicator)
accountAccountDataThe 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
accountIdAccount.Account_V001.KIdentifier of the account for the movement request
accountNameTextName of the registered holder of the account
accountTypeAccount.AccountType_V001.TThe type of account (Sponsored, Direct, AccumulationEntrepot, SettlementEntrepot, or RegistrationIdentifier)
ownershipTypeAccount.AccountOwnershipType_V001.TAccount ownership type (Single or Joint)
mailingAddresseeLineTextThe addressee line to be used for account statements
registeredAddressReference.Address_V001.TThe full address to be used for account statements
designationOptional TextAdditional account information over and above the name of the registered holder
residencyIndicatorAccount.ResidencyIndicator_V001.TThe residency of the account holder
accountStatusAccount.AccountHolderStatus_V001.TThe account status

data HolderData

HolderData

FieldTypeDescription
holderIdTextIdentifier of the holder for the movement request
holderNameTextLegal name of the holder
holderTypeAccount.HolderType_V001.TType of holder
holderStatusAccount.AccountHolderStatus_V001.TThe 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
operatorPartyThe operator
transactionIdTextTransaction 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)
deliveringActorIdOptional Actor.Actor_V001.KActor identifier of the participant that delivers the units (ASX: Delivering Actor Id)
deliveringAccountIdOptional Account.Account_V001.KAccount identifier that delivers the units (Delivering Account Id)
movementTypeParticipantToIssuerMovementType_V001.ParticipantToIssuerMovementTypeType of movement (ASX: Movement Type)
movementReasonParticipantToIssuerMovementReason_V001.ParticipantToIssuerMovementReasonReason for the movement (ASX: Movement Reason)
unitQuantityOptional (Numeric 6)Number of units requested to be converted (ASX: Unit Quantity)
lockedReasonOptional ParticipantToIssuerAccountLockedReason_V001.ParticipantToIssuerAccountLockedReasonLock reason of the holding at the time of the request (ASX: Locked Reason)
effectiveDateDateDate the movement becomes effective (ASX: Effective Date)
timeOfExecutionParticipantToIssuerTimeOfExecution_V001.ParticipantToIssuerTimeOfExecutionTime 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
operatorPartyThe system operator
transactionIdKTransaction identifier of the enquiry (ASX: Transaction Id)
securityIdSecurity.Security_V001.KUnique identifier of the traded security (ASX: Security Id)
requestingActorIdActor.Actor_V001.KA reference to a ledger 'Actor', representing the requestor (ASX: Requesting Actor Id)
requestingPartyOptional PartyParty who initiated the request (ASX: Requesting Party)
issuerPartyOptional PartyParty to respond to the request
registrationReferenceTextReference of the registration identifier (ASX: Registration Reference)
securityholderReferenceNumberOptional TextSRN, if provided (ASX: Securityholder Reference Number)
accountAccountDataAccount associated with the request
holders[HolderData]Holders associated with the account
  • Choice Archive

Data Types

data AccountData

AccountData

FieldTypeDescription
accountIdAccount.Account_V001.KThe unique identifier of the account (ASX: Account Identifier)
accountTypeAccount.AccountType_V001.TThe type of account (ASX: Account Type)
ownershipTypeAccount.AccountOwnershipType_V001.TAccount ownership type (ASX: Ownership Type)
nameTextName of the registered holder of the account (ASX: Account Name)
designationOptional TextAdditional account information over and above the name of the registered holder, if available (ASX: Designation)
mailingAddresseeLineTextThe addressee line to be used for account statements (ASX: Mailing Addressee Line)
registeredAddressReference.Address_V001.TAddress of registered holder of the account (ASX: Registered Address)
residencyIndicatorAccount.ResidencyIndicator_V001.TThe residency of the account holder (ASX: Residency Indicator)
accountStatusAccount.AccountHolderStatus_V001.TThe account status (ASX: Account Status)

type C= ContractId T

data HolderData

HolderData

FieldTypeDescription
holderIdAccount.Holder_V001.KThe unique identifier of the holder (ASX: Holder Identifier)
holderTypeAccount.HolderType_V001.TType of holder (Individual or Organisation) (ASX: Holder Type)
nameTextName of the holder (ASX: Holder Name)
holderStatusAccount.AccountHolderStatus_V001.TThe holder status (ASX: Holder Status)

type K= Text

type T= PendingSrnEnquiry




Related Pages:

There are no related labels.

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