Client Management Systems API

Request to retrieve cash data on a specific counterpart, such as total equity.


The following input parameters are available in the request.

Parameter

Mandatory

Description

SessionID

Y

SessionID returned by the Login Request

CounterpartId

Y

Counterpart Id of the counterpart to retrieve data from.

SOAP 1.2 Definition

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.saxobank.com/service/cms/2013/08">
   <soapenv:Header>
     <ns:SessionId>string</ns:SessionId>
   </soapenv:Header>
   <soapenv:Body>
     <ns:GetCounterpartDataRequest>
       <!-Optional:->
       <ns:CounterpartId>string</ns:CounterpartId>
     </ns:GetCounterpartDataRequest>
   </soapenv:Body>
 </soapenv:Envelope>


 Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="74710d61-42a4-4b3f-9d7e-2c5a257ed2a9" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">017bb543-bb81-4aa6-bfeb-b5ece63fc9b9</ActivityId>
   </s:Header>
   <s:Body>
     <GetCounterpartDataResponse xmlns="http://www.saxobank.com/service/cms/2013/08">
       <CounterpartData xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <CounterpartId>int</CounterpartId>
         <OwnerId>int</OwnerId>
         <BaseCurrency>string</BaseCurrency>
         <ClosingAmount>-decimal</ClosingAmount>
         <TotalEquity>decimal</TotalEquity>
         <Securities>decimal</Securities>
         <NetExposure>decimal</NetExposure>
         <MarginRequired>decimal</MarginRequired>
         <NetFreeBalance>decimal</NetFreeBalance>
         <RealMarginPct>decimal</RealMarginPct>
         <RealLinePct>decimal</RealLinePct>
         <CostToClosePositions>decimal</CostToClosePositions>
         <NetEquityForMargin>decimal</NetEquityForMargin>
         <MarginProductsPL>decimal</MarginProductsPL>
         <CurrentMarginCallLevel>decimal</CurrentMarginCallLevel>
         <Active>bool</Active>
         <CollateralMarketValue>decimal</CollateralMarketValue>
         <CollateralDeduction>decimal</CollateralDeduction>
         <TransactionsNotBooked>decimal</TransactionsNotBooked>
 <OptionPremiumMarket>decimal</OptionPremiumMarket>
       </CounterpartData>
     </GetCounterpartDataResponse>
   </s:Body>
 </s:Envelope>


 Code Examples

Code example 30: GetCounterpartData Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.saxobank.com/service/cms/2013/08">
   <soapenv:Header>
     <ns:SessionId>QAs01NW22ajBAsjFZTGM</ns:SessionId>
   </soapenv:Header>
   <soapenv:Body>
     <ns:GetCounterpartDataRequest>
       <ns:CounterpartId>3006888</ns:CounterpartId>
     </ns:GetCounterpartDataRequest>
   </soapenv:Body>
 </soapenv:Envelope>


 Code example 31: GetCounterpartData Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="74710d61-42a4-4b3f-9d7e-2c5a257ed2a9" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">017bb543-bb81-4aa6-bfeb-b5ece63fc9b9</ActivityId>
   </s:Header>
   <s:Body>
     <GetCounterpartDataResponse xmlns="http://www.saxobank.com/service/cms/2013/08">
       <CounterpartData xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <CounterpartId>3006888</CounterpartId>
         <OwnerId>961917</OwnerId>
         <BaseCurrency>USD</BaseCurrency>
         <ClosingAmount>-200.22</ClosingAmount>
         <TotalEquity>-165.08</TotalEquity>
         <Securities>0</Securities>
         <NetExposure>9668.03552</NetExposure>
         <MarginRequired>96.6803552</MarginRequired>
         <NetFreeBalance>-261.7603552</NetFreeBalance>
         <RealMarginPct>-1.70748234900982</RealMarginPct>
         <RealLinePct>9999</RealLinePct>
         <CostToClosePositions>-2.86</CostToClosePositions>
         <NetEquityForMargin>-165.08</NetEquityForMargin>
         <MarginProductsPL>-200.22</MarginProductsPL>
         <CurrentMarginCallLevel>200</CurrentMarginCallLevel>
         <Active>true</Active>
         <CollateralMarketValue>0</CollateralMarketValue>
         <CollateralDeduction>0</CollateralDeduction>
         <TransactionsNotBooked>21</TransactionsNotBooked>
       </CounterpartData>
     </GetCounterpartDataResponse>
   </s:Body>
 </s:Envelope>