GET api/account/{clientId}/holdings/{securityCode}/transactions?includeHistoricalHoldings={includeHistoricalHoldings}&startDate={startDate}&endDate={endDate}

Get a list of holding transactions associated with a client account and security code.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Client account identifier.

integer

Required

securityCode

security code to filter on.

string

Required

includeHistoricalHoldings

include historical holdings to filter on.

boolean

Default value is True

startDate

start date to filter on.

date

None.

endDate

end date to filter on.

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of HoldingTransaction
NameDescriptionTypeAdditional information
TransactionID

Transaction ID.

integer

None.

Quantity

Transaction quantity.

decimal number

None.

CostValue

Transaction cost value.

decimal number

None.

EntryType

Transaction type.

enHoldingRegisterEntryType

None.

Description

Description.

string

None.

EntryTimestamp

Transaction date.

date

None.

TransactionRef

Transaction reference.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "TransactionID": 1000,
    "Quantity": 3344.0,
    "CostValue": 2.25,
    "EntryType": 9,
    "Description": "Transferred in",
    "EntryTimestamp": "2024-09-29T00:04:39.0091603+10:00",
    "TransactionRef": "123456789ABCD100"
  },
  {
    "TransactionID": 1000,
    "Quantity": 500.0,
    "CostValue": 6.55,
    "EntryType": 2,
    "Description": "Sell stock",
    "EntryTimestamp": "2024-09-29T00:04:39.0091603+10:00",
    "TransactionRef": ""
  }
]

application/xml, text/xml

Sample:
<ArrayOfHoldingTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Portfolio">
  <HoldingTransaction>
    <CostValue>2.25</CostValue>
    <Description>Transferred in</Description>
    <EntryTimestamp>2024-09-29T00:04:39.0091603+10:00</EntryTimestamp>
    <EntryType>SecurityChanged</EntryType>
    <Quantity>3344</Quantity>
    <TransactionID>1000</TransactionID>
    <TransactionRef>123456789ABCD100</TransactionRef>
  </HoldingTransaction>
  <HoldingTransaction>
    <CostValue>6.55</CostValue>
    <Description>Sell stock</Description>
    <EntryTimestamp>2024-09-29T00:04:39.0091603+10:00</EntryTimestamp>
    <EntryType>Sell</EntryType>
    <Quantity>500</Quantity>
    <TransactionID>1000</TransactionID>
    <TransactionRef></TransactionRef>
  </HoldingTransaction>
</ArrayOfHoldingTransaction>

Error Response Information

Resource Description

string

Error Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>