HoldingTransaction

This message is used to submit a Holding Transaction & adjust the corresponding Holding record.

Section: Transactions
Related Message: HoldingTransactionReply

Metadata

Message Type: TransactionMessage
Message Number: 1052

Inherited fields

Name	Type	Size (bytes)	Description
MessageType	Integer (unsigned)	2	The unique identifier of this message.
ClientId	Integer (unsigned)	4	The unique identifier of a session with the server, returned in a successful LoginReply message.
RequestId	Integer (unsigned)	4	Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session.

Fields

Name	Type	Size (bytes)	Description
RecordId	Integer (signed)	8
Account	Foreign key to Account	8	Account `Id` associated with the holding transaction.
Firm	Foreign key to Firm	8	Firm `Id` associated with the holding transaction.
AccountCode	String	40	The human readable identifier of the Account. It is a free text field, up to a maximum of 40 characters.
Instrument	Foreign key to Instrument	8	Instrument `Id` associated with the holding transaction. Required
Tag	String	50	For tagged Instruments, this is the identifier of the individual holding.
ExternalId	String	30	A place for writing the identifier of this HoldingTransaction at the external venue where it is managed.
ExternalTransactionId	String	20	This is the identifier of this transaction in the external system that initiated it
HoldingTransactionMetaData	String	2000
Quantity	Integer (signed)	8	Required Decimals: null
Reason	One of HoldingTransactionReason	1
Type	One of HoldingTransactionType	1	Required
VerifyExternal	Integer (unsigned)	1
Verified	Integer (unsigned)	1	If `true`, the HoldingTransaction will have HoldingTransactionStatus `Confirmed` when first entered (no extra confirmation step required).
NoParent	Integer (unsigned)	1
Force	Integer (unsigned)	1
Memo	String	100
SetMinimumBalance	Integer (unsigned)	1
Vintage	Integer (unsigned)	4	A year in YYYY format.
ProjectType	Foreign key to ProjectType	8
Region	Foreign key to Region	8
Country	Foreign key to Country	8
ConfirmationNumber	String	34
PaymentType	One of HoldingTransactionPaymentType	1
ValueDateTime	Integer (unsigned)	8
AccountDetails	String	1024
info	Struct (HoldingInfo)	90
TradeSettlementType	One of TradeSettlementType	1
IsForNetting	Integer (unsigned)	1
IsPayrollProceeds	Integer (unsigned)	1

Permissions

Unverified Holding Transaction

{
	instrument: "test-currency",
	quantity: 10,
	type: HoldingTransactionType.Deposit,
	firm: "test-firm",
	accountcode: "test-account",
	verified: false,
}

Permission Checks

PermissionAction	Table	Scope	Index
Deposit	Account	Instance	0
SetBalance	Account	Instance	0
ApproveDeny	Holding	Instance	-1

^{Test file: HoldingTransaction}

Deposit

{
	instrument: "test-currency",
	quantity: 10,
	type: HoldingTransactionType.Deposit,
	firm: "test-firm",
	accountcode: "test-account",
}

Permission Checks

PermissionAction	Table	Scope	Index
Deposit	Account	Instance	0
SetBalance	Account	Instance	0
ApproveDeny	Holding	Instance	-1

^{Test file: HoldingTransaction_Deposit}

Set Balance

{
	instrument: "test-currency",
	quantity: 10,
	type: HoldingTransactionType.Set,
	firm: "test-firm",
	accountcode: "test-account",
}

Permission Checks

PermissionAction	Table	Scope	Index
SetBalance	Account	Instance	0
SetBalance	Account	Instance	0
ApproveDeny	Holding	Instance	-1

^{Test file: HoldingTransaction_SetBalance}

Withdraw

{
	instrument: "test-currency",
	quantity: 10,
	type: HoldingTransactionType.Withdraw,
	firm: "test-firm",
	accountcode: "test-account",
}

Permission Checks

PermissionAction	Table	Scope	Index
Withdraw	Account	Instance	0
SetBalance	Account	Instance	0
ApproveDeny	Holding	Instance	-1

^{Test file: HoldingTransaction_Withdraw}