ACCOUNT

Overview
Top level of the hierarchy. This entity can be analogous to a Company or a Customer. A billing profile should always be added to this root level element to ensure that charges are properly allocated and billed. This object has a recursive, parent relationship to itself to support account hierarchies such as departments, divisions, subsidiaries, etc..

System Entity Name
ACCOUNT


Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES YES YES 

 

Fields

Field Data Type Properties Description
Name  string  required This is the name of the account or customer.
AccountType  string  required Enter the type of account, depending of it's level within your defined hierarchy. Allowable values are:
  • ACCOUNT
  • PARENT ACCOUNT
Description  string    Enter a description for the account.
Status  string  required Enter a status for the account. Allowable values are:
  • ACTIVE
  • DEACTIVATED
  • DELETED


Sample Requests
Create

Request

 

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Header>
        <h:SessionHeader xmlns:h="urn:stronglytyped.soap.brmsystems.com" 
                         xmlns="urn:stronglytyped.soap.brmsystems.com" 
		         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
			 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <SessionID>LmqUukbKJSdftcFwHczQCuGqWfMLLLmyOKMMcjDo</SessionID>
        </h:SessionHeader>
    </s:Header>
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <create xmlns="urn:stronglytyped.soap.brmsystems.com">
            <brmObjects xsi:type="ACCOUNT"> 
              <AccountType>ACCOUNT</AccountType>
                <Name>Test Company 21</Name>
                <Status>ACTIVE</Status>    
            </brmObjects>
     <brmObjects xsi:type="ACCOUNT">
         <AccountType>ACCOUNT</AccountType>                
                <Name>Test Company 22</Name>
                <Status>ACTIVE</Status>    
            </brmObjects>
        </create>
    </s:Body>
</s:Envelope>

 

 

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:h="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <h:createResponse>
         <h:result>
            <h:ErrorCode>0</h:ErrorCode>
            <h:ErrorText></h:ErrorText>
            <h:ErrorElementField></h:ErrorElementField>
            <h:Id>10167</h:Id>
         </h:result>
      </h:createResponse>
      <h:createResponse>
         <h:result>
            <h:ErrorCode>0</h:ErrorCode>
            <h:ErrorText></h:ErrorText>
            <h:ErrorElementField></h:ErrorElementField>
            <h:Id>10168</h:Id>
         </h:result>
      </h:createResponse>
   </soapenv:Body>
</soapenv:Envelope>



Update

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>bnyaHxooYijvHwbgWwbtOaXTMMatDKvBVHCxjRFE</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"                
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:update xmlns="urn:stronglytyped.soap.brmsystems.com">
         <!--Optional:-->
         <urn:brmObjects xsi:type="ACCOUNT">
            <urn:Id>10155</urn:Id>
            <urn:Name>Test Company 12</urn:Name>
         </urn:brmObjects>
      </urn:update>
   </soapenv:Body>
</soapenv:Envelope>



Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:updateResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:ErrorElementField></urn:ErrorElementField>
            <urn:Id>10155</urn:Id>
         </urn:result>
      </urn:updateResponse>
   </soapenv:Body>
</soapenv:Envelope>




Retrieve

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>HvXndkGPeLhomkLQtNSbPbURyxwVrldQwwujbjwY</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:retrieve xmlns="urn:stronglytyped.soap.brmsystems.com">
         <urn:queryAnsiSql>Name='Test Company 12'</urn:queryAnsiSql>
         <urn:brmObjectType>ACCOUNT</urn:brmObjectType>
         <!--Zero or more repetitions:-->
         <urn:id>10155</urn:id>
      </urn:retrieve>
   </soapenv:Body>
</soapenv:Envelope>



Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:retrieveResponse>
         <urn:result xsi:type="urn:ACCOUNT">
            <urn:Id>10155</urn:Id>
            <urn:AccountType>ACCOUNT</urn:AccountType>
            <urn:Created>2014-02-24T21:28:01.000Z</urn:Created>
            <urn:CreatedUserId>6</urn:CreatedUserId>
            <urn:Description xsi:nil="true"/>
            <urn:EBNumber xsi:nil="true"/>
            <urn:ExternalKey xsi:nil="true"/>
            <urn:ExternalName xsi:nil="true"/>
            <urn:FederalEin xsi:nil="true"/>
            <urn:Name>Test Company 12</urn:Name>
            <urn:NetsuiteId xsi:nil="true"/>
            <urn:Status>ACTIVE</urn:Status>
            <urn:Updated>2014-02-24T21:29:28.000Z</urn:Updated>
            <urn:UpdatedUserId>6</urn:UpdatedUserId>
         </urn:result>
      </urn:retrieveResponse>
   </soapenv:Body>
</soapenv:Envelope>



Delete

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>ticEQPIPGTzsIMqbGBGiDXeoGoxmSpnkNZqfIkqW</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:delete>
      <brmObjects xsi:type="ACCOUNT">
         <Id>10151</Id>
      </brmObjects>
      </urn:delete>
   </soapenv:Body>
</soapenv:Envelope>



Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:deleteResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:Id>10151</urn:Id>
            <urn:Success>true</urn:Success>
         </urn:result>
      </urn:deleteResponse>
   </soapenv:Body>
</soapenv:Envelope>



Undelete

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Header>
      <urn:SessionHeader>
         <urn:SessionID>ticEQPIPGTzsIMqbGBGiDXeoGoxmSpnkNZqfIkqW</urn:SessionID>
      </urn:SessionHeader>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	         xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn:undelete>
      <brmObjects xsi:type="ACCOUNT">
         <!--1 or more repetitions:-->
         <urn:Id>10151</urn:Id>
         </brmObjects>
      </urn:undelete>
   </soapenv:Body>
</soapenv:Envelope>



Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:urn="urn:stronglytyped.soap.brmsystems.com">
   <soapenv:Body>
      <urn:undeleteResponse>
         <urn:result>
            <urn:ErrorCode>0</urn:ErrorCode>
            <urn:ErrorText></urn:ErrorText>
            <urn:Id>10151</urn:Id>
            <urn:Success>true</urn:Success>
         </urn:result>
      </urn:undeleteResponse>
   </soapenv:Body>
</soapenv:Envelope>



Upsert

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Header>
        <h:SessionHeader xmlns:h="urn:stronglytyped.soap.brmsystems.com" 
		         xmlns="urn:stronglytyped.soap.brmsystems.com" 
			 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
			 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <SessionID>bnyaHxooYijvHwbgWwbtOaXTMMatDKvBVHCxjRFE</SessionID>
        </h:SessionHeader>
    </s:Header>
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <upsert xmlns="urn:stronglytyped.soap.brmsystems.com">
            <externalIDFieldName>Name</externalIDFieldName>
            <brmObjects xsi:type="ACCOUNT">                	
                <Name>Test Web Service 1</Name>
                <Status>ACTIVE</Status>					
            </brmObjects>
	    <brmObjects xsi:type="ACCOUNT">                	
                <Name>Test Web Service 2</Name>
                <Status>ACTIVE</Status>					
            </brmObjects>
        </upsert>
    </s:Body>
</s:Envelope>



Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:h="urn:stronglytyped.soap.brmsystems.com">
    <soapenv:Body>
        <h:upsertResponse xmlns="urn:stronglytyped.soap.brmsystems.com">
            <h:result>
                <h:created>true</h:created>
                <h:ErrorCode>0</h:ErrorCode>
                <h:ErrorText>
                </h:ErrorText>
                <h:ErrorElementField>
                </h:ErrorElementField>
                <h:Id>12027</h:Id>
            </h:result>
        </h:upsertResponse>
        <h:upsertResponse xmlns="urn:stronglytyped.soap.brmsystems.com">
            <h:result>
                <h:created>true</h:created>
                <h:ErrorCode>0</h:ErrorCode>
                <h:ErrorText>
                </h:ErrorText>
                <h:ErrorElementField>
                </h:ErrorElementField>
                <h:Id>12028</h:Id>
            </h:result>
        </h:upsertResponse>
    </soapenv:Body>
</soapenv:Envelope>

 

Have more questions? Submit a request

Comments

Powered by Zendesk