GET api/brand/{brandID}/placementallocation-contractnotes?date={date}

Get all placement allocation contract notes by brand for a specific date so that placement allocation contract notes able to reconcile for client accounts.

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 PlacementAllocationContract

Name	Description	Type	Additional information
ContractID	TPP contract ID.	integer	None.
ClientID	TPP client identifier.	integer	None.
ClientRef	Account reference from 3rd party front office systems.	string	None.
PlacementAllocationID	Placement Allocation Reference	integer	None.
SecurityCode	Instrument code.	string	None.
Quantity	Quantity.	integer	None.
ContractTimestamp	UTC time contract was created by TPP.	date	None.
AsAtDate	As-at-date of trades in the format "YYYY-MM-DD".	date	None.
SettlementDate	Settlement date in format "YYYY-MM-DD.	date	None.
Brokerage	Value of brokerage to be charged.	decimal number	None.
CostBase	'NetValue' divided by 'Quantity'.	decimal number	None.
Fees	Value of Fees to be charged.	Collection of PlacementAllocationContract+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.

Response Formats

application/json, text/json

Sample:

[
  {
    "ContractID": 12345,
    "ClientID": 1234,
    "ClientRef": "abcd1234",
    "PlacementAllocationID": 123456,
    "SecurityCode": "BHP",
    "Quantity": 1240,
    "ContractTimestamp": "2024-09-29T00:04:40.1350258+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
  },
  {
    "ContractID": 12356,
    "ClientID": 4321,
    "ClientRef": "dcba4321",
    "PlacementAllocationID": 123456,
    "SecurityCode": "RIO",
    "Quantity": 1000,
    "ContractTimestamp": "2024-09-29T00:04:40.1350258+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
  }
]

application/xml, text/xml

Sample:

<ArrayOfPlacementAllocationContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.DataAccess.LLB.Contracts.ExternalMessagingSender">
  <PlacementAllocationContract>
    <AsAtDate>2024-09-29T00:00:00+10:00</AsAtDate>
    <Brokerage>15</Brokerage>
    <ClientID>1234</ClientID>
    <ClientRef>abcd1234</ClientRef>
    <ContractID>12345</ContractID>
    <ContractTimestamp>2024-09-29T00:04:40.1350258+10:00</ContractTimestamp>
    <CostBase>18.21</CostBase>
    <Fees>
      <PlacementAllocationContract.FeeDetails>
        <Amount>2</Amount>
        <FeeScheduleType>ACHFee</FeeScheduleType>
      </PlacementAllocationContract.FeeDetails>
    </Fees>
    <GST>1.55</GST>
    <GrossValue>22568</GrossValue>
    <NetValue>22585</NetValue>
    <PlacementAllocationID>123456</PlacementAllocationID>
    <Quantity>1240</Quantity>
    <SecurityCode>BHP</SecurityCode>
    <SettlementDate>2024-09-29T00:00:00+10:00</SettlementDate>
  </PlacementAllocationContract>
  <PlacementAllocationContract>
    <AsAtDate>2024-09-29T00:00:00+10:00</AsAtDate>
    <Brokerage>99</Brokerage>
    <ClientID>4321</ClientID>
    <ClientRef>dcba4321</ClientRef>
    <ContractID>12356</ContractID>
    <ContractTimestamp>2024-09-29T00:04:40.1350258+10:00</ContractTimestamp>
    <CostBase>1.01</CostBase>
    <Fees />
    <GST>9.0</GST>
    <GrossValue>1000</GrossValue>
    <NetValue>1099</NetValue>
    <PlacementAllocationID>123456</PlacementAllocationID>
    <Quantity>1000</Quantity>
    <SecurityCode>RIO</SecurityCode>
    <SettlementDate>2024-09-29T00:00:00+10:00</SettlementDate>
  </PlacementAllocationContract>
</ArrayOfPlacementAllocationContract>