Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The accountsBalanceInquiry provides the available balance for a given chart of accounts and account number.


WSDL: DEV - https://kualinp.uconn.edu/kfs-dev/remoting/accountBalanceInquiry?wsdl
            UAT - https://kualinp.uconn.edu/kfs-uat/remoting/accountBalanceInquiry?wsdl
            PROD - https://kualinp.uconn.edu/kfs-prd/remoting/accountBalanceInquiry?wsdl

Anchor
_GoBack
_GoBack

Inquiries:
getAccountBalance will retrieve the available account balance for one account.
Optional – chartOfAccountsCode (Default 'UC')
Required – account number

Attributes returned:
Account Balance

Criteria Used for Balance Checking:

...


Calculation:
Available Balance = (BudgetAmount – ActualsAmount – EncumbranceAmount)

Sample code for retrieving a Single Account:
SOAP:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v5="http://kfs.kuali.org/core/v5_0">
<soapenv:Header/>
<soapenv:Body>
<v5:getAccountBalance>
<!-Optional:->
<arg0>
<chartOfAccountsCode></chartOfAccountsCode>
<accountNumber>5612710</accountNumber>
</arg0>
</v5:getAccountBalance>
</soapenv:Body>
</soapenv:Envelope>


Sample Good Result:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getAccountBalanceResponse xmlns:ns2="http://kfs.kuali.org/core/v5_0">
<return>
<accountBalance>10955.85</accountBalance>
</return>
</ns2:getAccountBalanceResponse>
</soap:Body>
</soap:Envelope>

Sample Bad Result:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Invalid/empty Account Parameter.</faultstring>
<detail>
<ns2:AccountInquiryFault xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns2="http://kfs.kuali.org/core/v5_0"/>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>