Difference between revisions of "API/Account/GetAccountBalance"
From Emersion
| Line 2: | Line 2: | ||
'''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. | ||
'''Inputs''' | '''Inputs''' | ||
| − | |||
<soapenv:Header/> | <soapenv:Header/> | ||
<soapenv:Body> | <soapenv:Body> | ||
| Line 13: | Line 13: | ||
</acc:GetAccountBalance> | </acc:GetAccountBalance> | ||
</soapenv:Body> | </soapenv:Body> | ||
| − | |||
'''Outputs''' | '''Outputs''' | ||
| − | |||
<SOAP-ENV:Body> | <SOAP-ENV:Body> | ||
<ns1:GetAccountBalanceResponse> | <ns1:GetAccountBalanceResponse> | ||
| Line 30: | Line 28: | ||
</ns1:GetAccountBalanceResponse> | </ns1:GetAccountBalanceResponse> | ||
</SOAP-ENV:Body> | </SOAP-ENV:Body> | ||
| − | |||
'''Error Strings:''' | '''Error Strings:''' | ||
Revision as of 14:56, 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
<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
