GET api/brand/{brandID}/contracts?date={date}

Get all contract notes generated on a specific day. Can be used to reconcile external systems.

Request Information

URI Parameters

Name	Description	Type	Additional information
brandID	Brand Identifier.	integer	Required
date	Date in format YYYY-MM-DD.	string	Required

Body Parameters

None.

Response Information

Resource Description

Contract notes.

Collection of Contract

Name	Description	Type	Additional information
ContractID	TPP contract identifier.	integer	None.
ClientID	TPP client identifier.	integer	None.
ClientRef	Account reference from 3rd party front office systems.	string	None.
OrderReferences	Order references given by 3rd party front office.	Collection of string	None.
NettingOrderID	Order netting reference.	integer	None.
SecurityCode	Instrument code.	string	None.
BuySell	Buy/Sell indicator.	enBuySell	None.
Quantity	Quantity.	integer	None.
ContractTimestamp	UTC time contract was created by TPP.	date	None.
AsAtDate	As-at-date of trades.	date	None.
SettlementDate	Settlement date.	date	None.
Brokerage	Value of brokerage to be charged is exclusive of GST.	decimal number	None.
CostBase	'NetValue' divided by 'Quantity'.	decimal number	None.
Fees	Value of fees to be charged is exclusive of GST.	Collection of Contract+FeeDetails	None.
GST	Value of GST included in brokerage and fees.	decimal number	None.
GrossValue	Traded value.	decimal number	None.
NetValue	Traded value plus the brokerage and fees.	decimal number	None.
Lines	Collection of trade lines.	Collection of Contract+Line	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ContractID": 12345,
    "ClientID": 1234,
    "ClientRef": "abcd1234",
    "OrderReferences": [
      "7700411 - ABC_IOSb"
    ],
    "NettingOrderID": 23456,
    "SecurityCode": "BHP",
    "BuySell": 1,
    "Quantity": 1240,
    "ContractTimestamp": "2024-09-29T00:04:40.1290263+10:00",
    "AsAtDate": "2024-09-29",
    "SettlementDate": "2024-09-29",
    "Brokerage": 15.0,
    "CostBase": 18.21,
    "Fees": [
      {
        "FeeScheduleType": 1,
        "Amount": 2.0
      }
    ],
    "GST": 1.55,
    "GrossValue": 22568.0,
    "NetValue": 22585.0,
    "Lines": [
      {
        "TradeRef": "1420765551",
        "Quantity": 1240,
        "Price": 18.2,
        "ConditionCodes": "CX,XT",
        "CorporateActions": "RE,XD",
        "CrossReference": "abcd"
      }
    ]
  },
  {
    "ContractID": 12356,
    "ClientID": 4321,
    "ClientRef": "dcba4321",
    "OrderReferences": [
      "7700412"
    ],
    "NettingOrderID": 23467,
    "SecurityCode": "RIO",
    "BuySell": 2,
    "Quantity": 1000,
    "ContractTimestamp": "2024-09-29T00:04:40.1290263+10:00",
    "AsAtDate": "2024-09-29",
    "SettlementDate": "2024-09-29",
    "Brokerage": 99.0,
    "CostBase": 1.01,
    "Fees": [],
    "GST": 9.0,
    "GrossValue": 1000.0,
    "NetValue": 1099.0,
    "Lines": [
      {
        "TradeRef": "1420765552",
        "Quantity": 1240,
        "Price": 1.0,
        "ConditionCodes": "",
        "CorporateActions": "",
        "CrossReference": ""
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.DataAccess.LLB.Contracts.ExternalMessagingSender">
  <Contract>
    <AsAtDate>2024-09-29T00:00:00+10:00</AsAtDate>
    <Brokerage>15</Brokerage>
    <BuySell>Buy</BuySell>
    <ClientID>1234</ClientID>
    <ClientRef>abcd1234</ClientRef>
    <ContractID>12345</ContractID>
    <ContractTimestamp>2024-09-29T00:04:40.1290263+10:00</ContractTimestamp>
    <CostBase>18.21</CostBase>
    <Fees>
      <Contract.FeeDetails>
        <Amount>2</Amount>
        <FeeScheduleType>ACHFee</FeeScheduleType>
      </Contract.FeeDetails>
    </Fees>
    <GST>1.55</GST>
    <GrossValue>22568</GrossValue>
    <Lines>
      <Contract.Line>
        <ConditionCodes>CX,XT</ConditionCodes>
        <CorporateActions>RE,XD</CorporateActions>
        <CrossReference>abcd</CrossReference>
        <Price>18.2</Price>
        <Quantity>1240</Quantity>
        <TradeRef>1420765551</TradeRef>
      </Contract.Line>
    </Lines>
    <NetValue>22585</NetValue>
    <NettingOrderID>23456</NettingOrderID>
    <OrderReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>7700411 - ABC_IOSb</d3p1:string>
    </OrderReferences>
    <Quantity>1240</Quantity>
    <SecurityCode>BHP</SecurityCode>
    <SettlementDate>2024-09-29T00:00:00+10:00</SettlementDate>
  </Contract>
  <Contract>
    <AsAtDate>2024-09-29T00:00:00+10:00</AsAtDate>
    <Brokerage>99</Brokerage>
    <BuySell>Sell</BuySell>
    <ClientID>4321</ClientID>
    <ClientRef>dcba4321</ClientRef>
    <ContractID>12356</ContractID>
    <ContractTimestamp>2024-09-29T00:04:40.1290263+10:00</ContractTimestamp>
    <CostBase>1.01</CostBase>
    <Fees />
    <GST>9.0</GST>
    <GrossValue>1000</GrossValue>
    <Lines>
      <Contract.Line>
        <ConditionCodes></ConditionCodes>
        <CorporateActions></CorporateActions>
        <CrossReference></CrossReference>
        <Price>1</Price>
        <Quantity>1240</Quantity>
        <TradeRef>1420765552</TradeRef>
      </Contract.Line>
    </Lines>
    <NetValue>1099</NetValue>
    <NettingOrderID>23467</NettingOrderID>
    <OrderReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>7700412</d3p1:string>
    </OrderReferences>
    <Quantity>1000</Quantity>
    <SecurityCode>RIO</SecurityCode>
    <SettlementDate>2024-09-29T00:00:00+10:00</SettlementDate>
  </Contract>
</ArrayOfContract>