Difference between revisions of "API/Account/GetAccountBalance"

From Emersion
Jump to: navigation, search
(Created page with "'''GetAccountBalance''' '''Purpose''' The purpose of this API is to fetch the account balance of an account along with a few additional columns. '''Inputs''' {noformat} <so...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''GetAccountBalance'''
+
'''Purpose:'''
  
'''Purpose'''
 
 
The purpose of this API is to fetch the account balance of an account along with a few additional columns.
 
The purpose of this API is to fetch the account balance of an account along with a few additional columns.
 +
 +
'''WSDL: AccountAPI.wsdl'''
  
 
'''Inputs'''
 
'''Inputs'''
 
+
  <soapenv:Header/>
{noformat}
+
      <soapenv:Body>
<soapenv:Header/>
+
        <acc:GetAccountBalance>
  <soapenv:Body>
+
          <acc:AccountID>9999999</acc:AccountID>
      <acc:GetAccountBalance>
+
        </acc:GetAccountBalance>
        <acc:AccountID>9999999</acc:AccountID>
+
      </soapenv:Body>
      </acc:GetAccountBalance>
 
  </soapenv:Body>
 
{noformat}
 
  
 
'''Outputs'''
 
'''Outputs'''
  
{noformat}
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://external.fmahmood.dev.emersion.com.au/Account">
 
 
   <SOAP-ENV:Body>
 
   <SOAP-ENV:Body>
 
       <ns1:GetAccountBalanceResponse>
 
       <ns1:GetAccountBalanceResponse>
Line 31: Line 27:
 
       </ns1:GetAccountBalanceResponse>
 
       </ns1:GetAccountBalanceResponse>
 
   </SOAP-ENV:Body>
 
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
 
{noformat}
 
  
 
'''Error Strings:'''
 
'''Error Strings:'''

Latest revision as of 15:06, 15 July 2016

Purpose:

The purpose of this API is to fetch the account balance of an account along with a few additional columns.

WSDL: AccountAPI.wsdl

Inputs

  <soapenv:Header/>
     <soapenv:Body>
       <acc:GetAccountBalance>
          <acc:AccountID>9999999</acc:AccountID>
       </acc:GetAccountBalance>
     </soapenv:Body>

Outputs

  <SOAP-ENV:Body>
     <ns1:GetAccountBalanceResponse>
        <ns1:AccountBalancesList>
           <ns1:AccountBalance>0</ns1:AccountBalance>
           <ns1:TotalUnallocatedAmount>0</ns1:TotalUnallocatedAmount>
           <ns1:TotalPayable>0</ns1:TotalPayable>
           <ns1:TotalOverduePayable>0</ns1:TotalOverduePayable>
           <ns1:TotalDisputedAmount>0</ns1:TotalDisputedAmount>
           <ns1:TotalPaymentPlansAmount>0</ns1:TotalPaymentPlansAmount>
        </ns1:AccountBalancesList>
     </ns1:GetAccountBalanceResponse>
  </SOAP-ENV:Body>

Error Strings:

  • 'Missing mandatory Account ID' - Account ID is not provided
  • 'Undefined Account ID' - Account ID is provided but either it does not exist in the system or does not belong to the Caller Account