Client Management Systems API

Request to retrieve


The following input parameters are available in the request.

Parameter

Mandatory

Description

SessionID

Y

SessionID returned by the Login Request

Counterpart

Y

The Counterpart object.
See Section 4.4.3.2 for details.
On update, the CounterpartId must be specified. Otherwise, only the fields which should be updated is to be provided.

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:UpdateCounterpartRequest>
       <!-Optional:->
       <ns:Counterpart>
         <!-Optional:->
         <ns:OwnerId>int</ns:OwnerId>
         <!-Optional:->
         <ns:CounterpartId>int</ns:CounterpartId>
         <!-Optional:->
         <ns:Name>string</ns:Name>
         <!-Optional:->
         <ns:BaseCurrency>string</ns:BaseCurrency>
         <!-Optional:->
         <ns:IsProfessional>bool</ns:IsProfessional>
         <!-Optional:->
         <ns:Language>string</ns:Language>
         <!-Optional:->
         <ns:CountryOfResidence>string</ns:CountryOfResidence>
         <!-Optional:->
         <ns:TaxCountry>string</ns:TaxCountry>
         <!-Optional:->
         <ns:Email>string</ns:Email>
         <!-Optional:->
         <ns:CompanyRegistrationNumber>string</ns:CompanyRegistrationNumber>
         <!-Optional:->
         <ns:Active>bool</ns:Active>
         <!-Optional:->
         <ns:MarginProfileId>int</ns:MarginProfileId>
         <!-Optional:->
         <ns:MarginCallProfileId>int</ns:MarginCallProfileId>
         <!-Optional:->
         <ns:ProductClassifications>
           <!-Zero or more repetitions:->
           <ns:ProductAreaClassification>
             <ns:ProductAreaId>int</ns:ProductAreaId>
             <ns:ProductClassificationId>int</ns:ProductClassificationId>
             <!-Optional:->
             <ns:AppropriatenessTestPassedId>int</ns:AppropriatenessTestPassedId>
           </ns:ProductAreaClassification>
         </ns:ProductClassifications>
         <!-Optional:->
         <ns:ReliefAtSource>
           <ns:Enabled>bool</ns:Enabled>
           <ns:TypeId>int</ns:TypeId>
           <!-Optional:->
           <ns:ExpiryDate>dateTime</ns:ExpiryDate>
           <!-Optional:->
           <ns:NifId>string</ns:NifId>
         </ns:ReliefAtSource>
         <!-Optional:->
         <ns:Vat>
           <ns:Percentage>decimal</ns:Percentage>
           <ns:Forced>bool</ns:Forced>
         </ns:Vat>
         <!-Optional:->
         <ns:SwissTax>
           <!-Optional:->
           <ns:BrokerIntroduced>bool</ns:BrokerIntroduced>
           <!-Optional:->
           <ns:StampDutyExempt>bool</ns:StampDutyExempt>
           <!-Optional:->
           <ns:Residency>bool</ns:Residency>
         </ns:SwissTax>
         <!-Optional:->
         <ns:CounterpartType>string</ns:CounterpartType>
         <!-Optional:->
         <ns:WealthManagementProfileId>int</ns:WealthManagementProfileId>
 <!-Optional:->
<ns:FeeProfileIds>
 <!--Zero or more repetitions:-->
 <arr:int>int</arr:int>
 </ns:FeeProfileIds>
 <ns:CounterpartGroupIds>
 <!--Zero or more repetitions:-->
 <arr:int>int</arr:int>
 </ns:CounterpartGroupIds>
 <ns:WithholdingTaxProfileId>int</ns:WithholdingTaxProfileId>
 <ns:PositionNettingModeId>int</ns:PositionNettingModeId>
       </ns:Counterpart>
     </ns:UpdateCounterpartRequest>
   </soapenv:Body>
 </soapenv:Envelope> 



Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="71fee9c3-8bfd-4a28-a19e-141833f610c3" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">9c20d496-826a-42c5-9596-e03f5335338b</ActivityId>
   </s:Header>
   <s:Body/>
 </s:Envelope>

Code Examples

Code example 50: UpdateCounterpart Request
In this example, the Counterpart with id 6602910 under ownerid 300688 has the name updated to "NewlyUpdatedName".

<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:UpdateCounterpartRequest>
       <ns:Counterpart>
         <ns:OwnerId>3006888</ns:OwnerId>
         <ns:CounterpartId>6602910</ns:CounterpartId>
         <ns:Name>NewlyUpdatedName</ns:Name>
       </ns:Counterpart>
     </ns:UpdateCounterpartRequest>
   </soapenv:Body>
 </soapenv:Envelope>


Code example 51: UpdateCounterpart Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="71fee9c3-8bfd-4a28-a19e-141833f610c3" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">9c20d496-826a-42c5-9596-e03f5335338b</ActivityId>
   </s:Header>
   <s:Body/>
 </s:Envelope>