Chart of Accounts Inquiry

Sample Response - Single Account

WSDL Definition

Operations

Response

Sample Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v5="http://kfs.kuali.org/core/v5_0">
   <soapenv:Header/>
   <soapenv:Body>
      <v5:getAccount>
         <!--Optional:-->
         <arg0>
            <accountNumber>7744640</accountNumber>
         </arg0>
      </v5:getAccount>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response XML (Good)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getAccountResponse xmlns:ns2="http://kfs.kuali.org/core/v5_0">
         <return>
            <id>21181adc-d953-4e0a-8ef3-3eb3ca7f3176</id>
            <accountName>902118</accountName>
            <accountNumber>7744640</accountNumber>
            <chartOfAccountsCode>UC</chartOfAccountsCode>
            <status>OPEN</status>
            <fiscalOfficerIdentifier>kar05009</fiscalOfficerIdentifier>
            <accountTypeCode>UI</accountTypeCode>
            <bankCode>17</bankCode>
            <consolidationChartOfAccountsCode/>
            <consolidationAccountNumber/>
            <reportsToAccountNumber/>
            <reportsToChartOfAccountsCode/>
            <FundSIDCode>3952010</FundSIDCode>
            <fundSIDDescription>Go Bond Uconn2000/21st Century</fundSIDDescription>
            <accountManagerSystemIdentifier>lac12009</accountManagerSystemIdentifier>
            <accountsSupervisorySystemsIdentifier>hls00005</accountsSupervisorySystemsIdentifier>
            <organizationCode>1832</organizationCode>
            <subFundGroupCode>PLBND</subFundGroupCode>
            <departmentAccountOwnercode>NGC</departmentAccountOwnercode>
            <departmentReference1>ACTIVE</departmentReference1>
            <cfdaNumber/>
            <projectName>East Central Campus Utility Upgrade</projectName>
            <plantFundsParentCode>1173</plantFundsParentCode>
            <plantFundsParentCodeDescription>Def Mtn/Code & ADA Cmp/Inf Imp & Reno Lump Sum/UA&S Fac</plantFundsParentCodeDescription>
            <accountExpenseGuidelineText>Utility upgrade. Will capitalize. A   Pavone 9/16/16.</accountExpenseGuidelineText>
            <accountIncomeGuidelineText>Conform to University/Sponsor policies.PER KS/SJ EMAIL, SH/N BE CHARGED PAYROLL - REMOVED PAYROLL INDICATOR 3/9/18.</accountIncomeGuidelineText>
            <accountPurposeText>Project will re-route, replace, upgrade or add utilities in    order to facilitate construction of South Campus Commons project planned for construction in 2018. Also consider & replace aged infrastructure in    general area of South Campus Commons & consider future projects will impact utility distribution.</accountPurposeText>
         </return>
      </ns2:getAccountResponse>
   </soap:Body>
</soap:Envelope>

Sample Response XML (Bad)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Server</faultcode>
         <faultstring>Account not found.</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>

Sample SQL example

select account_NBR, account_nm, Sub_fund_grp_cd, acct_closed_ind, acct_create_dt, acct_effect_dt, acct_expiration_dt
--select count(*)
from kfs_uat.CA_ACCOUNT_T
where sub_fund_grp_cd IN ('PLEQP', 'PLRES', 'PLBHC', 'PLRHC', 'OPOTF', 'PLBND', 'PLREV', 'PLUNR')
-- and acct_create_dt > TO_DATE('2016-08-25','YYYY-MM-DD')
-- and acct_create_dt < TO_DATE('2016-09-17','YYYY-MM-DD') 

--order by account_nbr
 ; 

Code Examples

• Java

  JUnit

  package com.example.coa.service;
  
  import java.time.LocalDate;
  import java.util.ArrayList;
  import java.util.List;
  
  import javax.xml.bind.JAXBElement;
  
  import org.junit.Test;
  import org.kuali.kfs.core.v5_0.GetAccountsResponse;
  import org.springframework.oxm.jaxb.Jaxb2Marshaller;
  
  import junit.framework.TestCase;
  
  public class AccountInquiryServiceTest extends TestCase {
  
      @Test
      public void testGetAccounts() throws Exception {
  
          List<String> subFunds = new ArrayList<String>();
          subFunds.add("PLEQP");
          subFunds.add("PLRES");
          subFunds.add("PLBHC");
          subFunds.add("PLRHC");
          subFunds.add("OPOTF");
          subFunds.add("PLBND");
          subFunds.add("PLREV");
          subFunds.add("PLUNR");
  
          List<String> organizationcodes = new ArrayList<String>();
          organizationcodes.add("1832");
          organizationcodes.add("1731");
          organizationcodes.add("1863");
          
          LocalDate fromDate = LocalDate.parse("2016-08-26");
          LocalDate toDate = LocalDate.parse("2016-09-15");
                  
          ChartOfAccountsInquiryServiceClient client = new ChartOfAccountsInquiryServiceClient();
          
          Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
          marshaller.setContextPath("org.kuali.kfs.core.v5_0");
          client.setMarshaller(marshaller);
          client.setUnmarshaller(marshaller);
            
          JAXBElement<GetAccountsResponse> response = client.getAccounts(subFunds, organizationcodes, fromDate, toDate);
  
          assertNotNull(response);
      }
  
  }

  Client

  package com.example.coa.service;
  
  import java.time.LocalDate;
  import java.util.List;
  
  import javax.xml.bind.JAXBElement;
  import javax.xml.datatype.DatatypeFactory;
  
  import org.kuali.kfs.core.v5_0.AllAccountRequest;
  import org.kuali.kfs.core.v5_0.GetAccounts;
  import org.kuali.kfs.core.v5_0.GetAccountsResponse;
  import org.kuali.kfs.core.v5_0.ObjectFactory;
  import org.springframework.ws.client.core.support.WebServiceGatewaySupport;
  
  public class ChartOfAccountsInquiryServiceClient extends WebServiceGatewaySupport {
  
      public JAXBElement<GetAccountsResponse> getAccounts(List<String> subFunds, List<String> organizationcodes, LocalDate fromDate, LocalDate toDate) throws Exception {
      	
      	ObjectFactory factory = new ObjectFactory();
      	DatatypeFactory datatypeFactory = DatatypeFactory.newInstance();
  
          String uri = "https://kualinp.uconn.edu/kfs-dev/remoting/chartOfAccountsInquiry";
          GetAccounts request = new GetAccounts();
          AllAccountRequest allAccountRequest = new AllAccountRequest();
          allAccountRequest.getSubFund().addAll(subFunds);
          allAccountRequest.getOrganizationCode().addAll(organizationcodes);
          allAccountRequest.setFromDate(factory.createAllAccountRequestFromDate(datatypeFactory.newXMLGregorianCalendar(fromDate.toString())));
          allAccountRequest.setToDate(factory.createAllAccountRequestToDate(datatypeFactory.newXMLGregorianCalendar(toDate.toString())));
          request.setArg0(allAccountRequest);
          
          return (JAXBElement<GetAccountsResponse>) getWebServiceTemplate().marshalSendAndReceive(uri, request);
      }
  
  }

• Ruby 

  Client

  require 'savon'
  
  client = Savon.client(
    :wsdl => "https://kualinp.uconn.edu/kfs-uat/remoting/chartOfAccountsInquiry?wsdl",
    :ssl_verify_mode => :none,
    :namespace => "http://kfs.kuali.org/core/v5_0"
  )
  
  puts client.operations
  
  response = client.call(:get_accounts, soap_action: false,
  message: {
    arg0: {
      accountNumber:7744640
    }
  })
  
  puts response.to_xml

  Other Queries

• Multiple Account Queries:
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?fromDate=2021-04-25&toDate=2021-04-29&subfunds=PLRES,OPTUI,RSTSP&orgcodes=1832,1731,1863,1874,1300,1202
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=OPAUX,OPOTF,OPOTP,OPTUI,RFNDA,RFNDO,RSFAD,RSNSF,RSNSP,RSTSP,UNRSF,UNRSP
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=OPAUX
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=OPOTF
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=OPOTP
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=OPTUI
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=RFNDA
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=RFNDO
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=RSFAD
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=RSNSF
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=RSNSP
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=RSTSP
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=UNRSF
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=UNRSP
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=RSTSP&orgcodes=1833,1231
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?fromDate=2021-04-25&toDate=2021-04-29&subfunds=OPTUI
  Single Account Query:
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/account?accountNumber=2528000
  https://dev.api.finance.uconn.edu/webapi/accounts/cider/account?accountNumber=4343430