Difference between revisions of "API/Account/GetAccountBalance"
From Emersion
| Line 18: | Line 18: | ||
{noformat} | {noformat} | ||
| − | |||
<SOAP-ENV:Body> | <SOAP-ENV:Body> | ||
<ns1:GetAccountBalanceResponse> | <ns1:GetAccountBalanceResponse> | ||
| Line 31: | Line 30: | ||
</ns1:GetAccountBalanceResponse> | </ns1:GetAccountBalanceResponse> | ||
</SOAP-ENV:Body> | </SOAP-ENV:Body> | ||
| − | |||
{noformat} | {noformat} | ||
Revision as of 15:54, 15 July 2016
GetAccountBalance
Purpose: The purpose of this API is to fetch the account balance of an account along with a few additional columns.
Inputs
{noformat} <soapenv:Header/>
<soapenv:Body>
<acc:GetAccountBalance>
<acc:AccountID>9999999</acc:AccountID>
</acc:GetAccountBalance>
</soapenv:Body>
{noformat}
Outputs
{noformat}
<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>
{noformat}
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
