Account Balance Inquiry

URL

Sample Response

Criteria Used for Balance Checking:

1. University Fiscal Year defaults to the current fiscal year.
2. Chart of Accounts defaults to "UC", if not entered.
3. Use the Available Balances Lookup logic in KFS, using the following selection criteria.
   1. Consolidation Option = Consolidation
   2. Include Pending Ledger Entry = All
   3. Transfers = Include
   4. Balance Sheet = Include
   5. Indirect Cost = Exclude
   6. Object Code Grouping = Exclude
4. For Agency Accounts, no matter what fundsid, we will use the cash balance:
   1. Subfund group EQUALS "AGEN",
   2. Only include the balance of Object Code = 1100Lori – is this correct or is it the balance of the beginning balance and fiscal YTD balance? This is what I would define as the "available cash balance".If we are looking at it from the Available Balance screen, the available cash is simply the Actual Amount. If we are looking at it from the General Ledger Balance screen it would be the Beginning Balance plus the Annual Balance (current FY activity). I assume we are pulling from Available Balance. Is this correct, Bruce?
      .
5. For non-sponsored fiscal accounts in the 1171 fundsid (which are not specifically budgeted during the annual budget process), we will use the available cash balance:
   1. Subfund group NOT EQUAL to "RSTSP",
   2. Fund Sid EQUALS 1171
   3. Only include the balance of Object Code = 1100See comment above regarding definition of "available cash balance.".
6. For project accounts (as defined by subfund group code RSTSP), across all fundsids, we will include available budget balances from object codes 6000 – 6999. For these, the budget available is based on project-to-date and not fiscal-year-to-date $$.
   1. Subfund group EQUALS "RSTSP",
   2. All fundsids,
   3. Include (sum) the balances of Object Codes 6000 – 6999"Budget available" defined as budget amount less project-to-date actual expenses.
      If we are looking at the Available Balance screen, both Budget and Actuals are cumulative project to date. We should also decut the Encumbrances. So, in my opinion, it is really the sum of the Variance column for object codes 6000-6999..
7. For all other non-sponsored accounts (subfund NOT RSTSP), across all other fundsids (NOT 1171), we will use the sum of all BUDGET AVAILABLE BALANCES IN(as defined in 3 above) object code in the 6000 – 6999 range:
   1. All other Subfund groups NOT EQUAL to "AGEN" and "RSTSP",
   2. Fund sid NOT EQUAL to 1171,
   3. Include (sum) the balances of Object Codes 6000 – 6999.

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

WSDL Definition

Operations

Response

Sample Request XML (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 Response XML - SOAP (Good)

<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 Response XML - SOAP (Bad)

<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>

Code Examples

• Java

  JUnit

  package com.example.coa.service;
  
  import javax.xml.bind.JAXBElement;
  
  import org.junit.Test;
  import org.kuali.kfs.core.v5_0.GetAccountBalanceResponse;
  import org.springframework.oxm.jaxb.Jaxb2Marshaller;
  
  import junit.framework.TestCase;
  
  public class AccountBalanceInquiryServiceTest extends TestCase {
  
      @Test
      public void testGetAccounts() throws Exception {
  
      	String chartOfAccountsCode = "UC";
          String accountNumber = "5612710";
                  
          AccountBalanceInquiryServiceClient client = new AccountBalanceInquiryServiceClient();
          
          Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
          marshaller.setContextPath("org.kuali.kfs.core.v5_0");
          client.setMarshaller(marshaller);
          client.setUnmarshaller(marshaller);
            
          JAXBElement<GetAccountBalanceResponse> response = client.getAccountBalance(chartOfAccountsCode, accountNumber);
  
          assertNotNull(response);
      }
  
  }

  Client

  package com.example.coa.service;
  
  import java.io.StringWriter;
  
  import javax.xml.bind.JAXBContext;
  import javax.xml.bind.JAXBElement;
  import javax.xml.transform.Result;
  import javax.xml.transform.stream.StreamResult;
  
  import org.kuali.kfs.core.v5_0.AccountBalanceInquiryRequest;
  import org.kuali.kfs.core.v5_0.GetAccountBalance;
  import org.kuali.kfs.core.v5_0.GetAccountBalanceResponse;
  import org.springframework.oxm.Marshaller;
  import org.springframework.ws.client.core.support.WebServiceGatewaySupport;
  
  public class AccountBalanceInquiryServiceClient extends WebServiceGatewaySupport {
  
      public JAXBElement<GetAccountBalanceResponse> getAccountBalance(String chartOfAccountsCode, String accountNumber) throws Exception {
      	
          String uri = "https://kualinp.uconn.edu/kfs-dev/remoting/accountBalanceInquiry";
          GetAccountBalance request = new GetAccountBalance();
          AccountBalanceInquiryRequest accountBalanceInquiryRequest = new AccountBalanceInquiryRequest();
          accountBalanceInquiryRequest.setChartOfAccountsCode(chartOfAccountsCode);
          accountBalanceInquiryRequest.setAccountNumber(accountNumber);
          request.setArg0(accountBalanceInquiryRequest);
          
          logXml(request);
          
          Object object =  getWebServiceTemplate().marshalSendAndReceive(uri, request);
          
          logXml(object);
          
          return (JAXBElement<GetAccountBalanceResponse>) object;
      }
  
      public void logXml(Object element) {
  
          try {
              JAXBContext jc = JAXBContext.newInstance(element.getClass());
              Marshaller marshaller = getMarshaller();
              StreamResult result = new StreamResult(new StringWriter());
              marshaller.marshal(element, result);
              System.out.println("XML : " + result.getWriter().toString());
          } catch (Exception e) {
              e.printStackTrace();
          }
      }
  }