GET api/brand/{brandID}/holding-balances

Get all non-zero holding balances. Can be used to reconcile external systems.

Request Information

URI Parameters

Name	Description	Type	Additional information
brandID	Brand ID to filter on.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Contract notes.

Collection of HoldingBalance

Name	Description	Type	Additional information
ClientID	TPP client identifier.	integer	None.
ClientRef	Account reference from 3rd party front office systems.	string	None.
SecurityCode	Instrument code.	string	None.
HoldingQuantity	Quantity.	decimal number	None.
AverageCostBase	Average cost base on the transactions, if known and recorded.	decimal number	None.
Timestamp	UTC time holding was updated in TPP systems.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1234,
    "ClientRef": "abcd1234",
    "SecurityCode": "BHP",
    "HoldingQuantity": 1200.0,
    "AverageCostBase": 40.0,
    "Timestamp": "2019-10-17T00:00:00+11:00"
  },
  {
    "ClientID": 1234,
    "ClientRef": "abcd1234",
    "SecurityCode": "ABC",
    "HoldingQuantity": 800.0,
    "AverageCostBase": 15.0,
    "Timestamp": "2019-10-17T00:00:00+11:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfHoldingBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.DataAccess.LLB.Contracts.ExternalMessagingSender">
  <HoldingBalance>
    <AverageCostBase>40</AverageCostBase>
    <ClientID>1234</ClientID>
    <ClientRef>abcd1234</ClientRef>
    <HoldingQuantity>1200</HoldingQuantity>
    <SecurityCode>BHP</SecurityCode>
    <Timestamp>2019-10-17T00:00:00</Timestamp>
  </HoldingBalance>
  <HoldingBalance>
    <AverageCostBase>15</AverageCostBase>
    <ClientID>1234</ClientID>
    <ClientRef>abcd1234</ClientRef>
    <HoldingQuantity>800</HoldingQuantity>
    <SecurityCode>ABC</SecurityCode>
    <Timestamp>2019-10-17T00:00:00</Timestamp>
  </HoldingBalance>
</ArrayOfHoldingBalance>