Page Comparison

...

Page Properties

Service Name

chartOfAccountsInquiry

Description

Provides basic information about the KFS chart of accounts based on a set of request parameters.

API Type

REST (changed from SOAP) - FinancialWebAPI (January, 2022)

Status


colour	Green
title	complete

Release Date

06 Feb 2018

Last Update

12 Feb 2019 KFS Version 3.32.0

Notes

Response

AttributeXPathNotesId

return/account/id

Unique IdentifierAccount name

return/account/accountName

description of accountAccount numberreturn/account/accountNumberChart of Accounts codereturn/account/chartOfAccountsCodeUCStatusreturn/account/statusenumeration values (NEW, OPEN, CLOSE, CHANGED)FiscalOfficerIdentifierreturn/account/fiscalOfficerIdentifiernetidAccount Type Codereturn/account/accountTypeCodeBank codereturn/account/bankCodeConsolidation

URL Samples	Note: SubFunds is a required field when checking for multiple accounts
All Parameters	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
Just FromDate and ToDate	https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?fromDate=2020-07-01&toDate=2021-06-30	Just SubFunds	https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?subfunds=OPAUX,OPOTF,OPOTP,OPTUI,RFNDA,RFNDO,RSFAD,RSNSF,RSNSP,RSTSP,UNRSF,UNRSP
Just SubFunds and OrgCode	https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?orgcodes=1832,1731,1863,1874,1300,1202	SubFund and OrgCode	https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?&&subfunds=OPTUI,RSTSP&orgcodes=1832,1731,1863
FromDate, ToDate, and SubFundSubFunds	https://dev.api.finance.uconn.edu/webapi/accounts/cider/accounts?fromDate=2021-04-25&toDate=2021-04-29&subfunds=PLRES,OPTUI,RSTSPFromDate, ToDate, and OrgCode
Single Account	https://dev.api.finance.uconn.edu/webapi/accounts/cider/accountsaccount?fromDate=2020-07-01&toDate=2021-06-30 &orgcodes=1832,1731,1863,1874,1300,1202

Sample Response

...

</accountBalance>

WSDL Definition

...

Definition URLs

...

UAT - https://kualinp.uconn.edu/kfs-uat/remoting/chartOfAccountsInquiry?wsdl
PROD - https://kuali.uconn.edu/kfs-prd/remoting/chartOfAccountsInquiry?wsdl

...

Binding

...

{http://kfs.kuali.org/kfs/v5_0}chartOfAccountsInquirySoapBinding

...

SOAP Version

...

SOAP 1.1

Operations

...

Will retrieve information one account

...

Will retrieve information on all accounts within a set of selection criteria

...

accountNumber=4343430
Other Queries	see bottom of page

Sample Response - Single Account

<accountName>2010 Pi Allotment</accountName>

<status>CLOSED</status>

<fundSIDDescription>Research Fund</fundSIDDescription>

<subFundGroupCode>UNRSP</subFundGroupCode>

<accountExpenseGuidelineText>Conform to University/Sponsor policies</accountExpenseGuidelineText>

<accountIncomeGuidelineText>Conform to University/Sponsor policies</accountIncomeGuidelineText>

To record transactions and balances for this account.

</accountPurposeText>

</Account>

WSDL Definition

Definition URLs	UAT - https://kualinp.uconn.edu/kfs-uat/remoting/chartOfAccountsInquiry?wsdl PROD - https://kuali.uconn.edu/kfs-prd/remoting/chartOfAccountsInquiry?wsdl
Binding	{http://kfs.kuali.org/kfs/v5_0}chartOfAccountsInquirySoapBinding
SOAP Version	SOAP 1.1

Operations

Name	Description	Input
getAccount	Will retrieve information one account	account number (Required)
getAccounts	Will retrieve information on all accounts within a set of selection criteria	subFund (Required) organization code (Optional) from Date [yyyy-mm-dd] (Optional) to Date [yyyy-mm-dd] (Optional)

Response

Attribute	XPath	Notes
Id	return/account/id	Unique Identifier
Account name	return/account/accountName	description of account
Account number	return/account/accountNumber
Chart of Accounts code	return/account/consolidationChartOfAccountsCodechartOfAccountsCode	Consolidation Account NumberUC
Status	return/account/consolidationAccountNumberReports to Account Numberstatus	enumeration values (NEW, OPEN, CLOSE, CHANGED)
FiscalOfficerIdentifier	return/account/reportsToAccountNumberReports to Chart of Accounts fiscalOfficerIdentifier	netid
Account Type Code	return/account/reportsToChartOfAccountsCodeaccountTypeCode
FundSid CodeBank code	return/account/FundSIDCodeFundSid descriptionbankCode
Consolidation Chart of Accounts code	return/account/fundSIDDescriptionconsolidationChartOfAccountsCode
Consolidation Account Manager System IdentifierNumber	return/account/accountManagerSystemIdentifierconsolidationAccountNumber	netid
Account Reports to Account Number	return/account/reportsToAccountNumber
Reports to Chart of Accounts Code	return/account/reportsToChartOfAccountsCode
FundSid Code	return/account/FundSIDCode
FundSid description	return/account/fundSIDDescription
Account Manager System Identifier	return/account/accountManagerSystemIdentifier	netid
Account supervisor Systems Identifier	return/account/accountsSupervisorySystemsIdentifier	netid
Organization Code	return/account/organizationCode
SubFund group code	return/account/subFundGroupCode
Department account owner code	return/account/departmentAccountOwnercode
Department reference 1	return/account/departmentReference1
Cfda number	return/account/cfdaNumber
Project name
Plant funds parent code
Plant funds parent code description
Account expense guideline text
Account income guideline text
Account purpose text

...

Code Block

language	xml
title	Sample Response (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>

Code Examples

Java

...

language	java
title	JUnit

...

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

Code Block

language	java
title	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);
    }

}

Code Block

language	java
title	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

Code Block

language	ruby
title	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_xmlObjectFactory();
    	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

Code Block

language	ruby
title	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

Versions Compared

Old Version 8

New Version Current

Key

Response

Sample Response

WSDL Definition

Operations

Sample Response - Single Account

WSDL Definition

Operations

Response

Code Examples

Sample SQL example

Code Examples

Other Queries