GET api/brand/{brandID}/holding-transactions?date={date}
Get all holding transactions generated on a specific day. Can be used to reconcile external systems
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| brandID |
Brand ID to filter on. |
integer |
Required |
| date |
"date in format YYYY-MM-DD" |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Contract notes.
Collection of HoldingTransaction| Name | Description | Type | Additional information |
|---|---|---|---|
| TransactionID |
TPP transaction identifier. |
integer |
None. |
| ClientID |
TPP client identifier. |
integer |
None. |
| ClientRef |
Account reference from 3rd party front office systems. |
string |
None. |
| SecurityCode |
Instrument code. |
string |
None. |
| Quantity |
Quantity. |
decimal number |
None. |
| CostValue |
The cost base on the transactions, if known and recorded. |
decimal number |
None. |
| EntryType |
Transaction type. |
enHoldingRegisterEntryType |
None. |
| Description |
Description. |
string |
None. |
| ReasonCode |
Reason code from initiating CHESS transaction. |
string |
None. |
| TransactionRef |
Reference to detect messages with the same transaction (e.g. 'Security change' entries) |
string |
None. |
| EntryTimestamp |
UTC time holding was updated in TPP systems. |
date |
None. |
Response Formats
application/json, text/json
[
{
"TransactionID": 1829930,
"ClientID": 1234,
"ClientRef": "abcd1234",
"SecurityCode": "BHP",
"Quantity": 150.0,
"CostValue": 10.0,
"EntryType": 1,
"Description": "",
"ReasonCode": "",
"TransactionRef": "",
"EntryTimestamp": "2019-10-17T00:00:00+11:00"
},
{
"TransactionID": 1829931,
"ClientID": 1234,
"ClientRef": "abcd1234",
"SecurityCode": "ABC",
"Quantity": 500.0,
"CostValue": 5.0,
"EntryType": 2,
"Description": "",
"ReasonCode": "",
"TransactionRef": "",
"EntryTimestamp": "2019-10-17T00:00:00+11:00"
}
]
application/xml, text/xml
<ArrayOfHoldingTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.DataAccess.LLB.Contracts.ExternalMessagingSender">
<HoldingTransaction>
<ClientID>1234</ClientID>
<ClientRef>abcd1234</ClientRef>
<CostValue>10</CostValue>
<Description></Description>
<EntryTimestamp>2019-10-17T00:00:00</EntryTimestamp>
<EntryType>Buy</EntryType>
<Quantity>150</Quantity>
<ReasonCode></ReasonCode>
<SecurityCode>BHP</SecurityCode>
<TransactionID>1829930</TransactionID>
<TransactionRef></TransactionRef>
</HoldingTransaction>
<HoldingTransaction>
<ClientID>1234</ClientID>
<ClientRef>abcd1234</ClientRef>
<CostValue>5</CostValue>
<Description></Description>
<EntryTimestamp>2019-10-17T00:00:00</EntryTimestamp>
<EntryType>Sell</EntryType>
<Quantity>500</Quantity>
<ReasonCode></ReasonCode>
<SecurityCode>ABC</SecurityCode>
<TransactionID>1829931</TransactionID>
<TransactionRef></TransactionRef>
</HoldingTransaction>
</ArrayOfHoldingTransaction>