Account Index

Service Information:

Version: 1.0

Availability: Conceptual

Release Date: October 2018

Framework: AITS RESTful Data API

Description: Retrieve details about an account index code.

Source System: Banner

Operations:

GET https://webservices.admin.uillinois.edu/financeWS/data/{senderAppId}/AccountIndex/1_0/{queryChartOfAccountsCode}/{queryAccountIndexCode}/{queryTransDate}?format={format}

A table detailing the parameter set for a Directory Data GET request.
Parameter	Description	Type	Required
senderAppId	Authorized sender application ID.	String	Yes
queryChartOfAccountsCode	Chart of Accounts code associated with the subject account index code.	String	Yes
queryAccountIndexCode	Account Index code to be returned.	String	Yes
queryTransDate	Transaction date to be utilized in determining the validity of the account index code. Format 'YYYY-MM-DD'. Defaults to system date in the source database.	String	No
format	Desired response format. Supports either "json" (default) or "xml".	String	No

Sample Request

GET /financeWS/data/mySenderAppId/AccountIndex/1_0/2/ABC123/2018-10-24 HTTP/1.1
Host: https://webservices-dev.admin.uillinois.edu

Sample Response (JSON)

{ "object": "AccountIndex", "version": "1_0", "list": [ { "queryChartOfAccountsCode": "1", "queryAccuntIndexCode": "ABC123", "queryTransDate": "10/22/2018", "accountIndexData": { "chartOfAccounts": { "code": "1", "description": "Urbana" }, "index": { "code": "ABC123", "description": "Index code description" }, "effectiveStatus": "I", "recordStatus": "A", "effectiveDate": "7/1/2010", "nextChangeDate": "12/31/2099", "terminationDate": "10/13/2016", "fund": { "code": "123456", "description": "FTVFUND title" }, "organization": { "code": "987654", "description": "FTVORTN title" }, "account": { "code": "XYZ", "description": "FTVACCT title" }, "program": { "code": "654987", "description": "FTVPROG title" }, "activity": { "code": "951753", "description": "FTVACTV title" }, "location": { "code": "L6548", "description": "FTVLOCN title" } } } ] }

Sample Response (JSON) - No Data (requested data does not exists or is inactive)

{ "object": "AccountIndex", "version": "1_0" }

Sample Response (XML)

<?xml version="1.0" encoding="UTF-8"?>
<AccountIndexList object="AccountIndex" version="1_0">
<accountIndexData>
<queryChartOfAccountsCode>1</queryChartOfAccountsCode>
<queryAccuntIndexCode>ABC123</queryAccuntIndexCode>
<queryTransactionDate>10/22/2018</queryTransactionDate>
<accountIndex>
<chartOfAccounts>
<code>1</code>
<description>Urbana</description>
</chartOfAccounts>
<accountIndex>
<code>ABC123</code>
<description>Index code description</description>
</accountIndex>
<effectiveStatus>I</effectiveStatus>
<recordStatus>A</recordStatus>
<effectiveDate>7/1/2010</effectiveDate>
<nextChangeDate>12/31/2099</nextChangeDate>
<terminationDate>10/13/2016</terminationDate>
<fund>
<code>123456</code>
<description>FTVFUND title</description>
</fund>
<organization>
<code>987654</code>
<description>FTVORTN title</description>
</organization>
<account>
<code>XYZ</code>
<description>FTVACCT title</description>
</account>
<program>
<code>654987</code>
<description>FTVPROG title</description>
</program>
<activity>
<code>951753</code>
<description>FTVACTV title</description>
</activity>
<location>
<code>L6548</code>
<description>FTVLOCN title</description>
</location>
</accountIndex>
</accountIndexData>
</AccountIndexList>

Data Object Detail:

Functional Area: Finance

Name: AccountIndex

Version:1.0

Element Map:

A table describing the object that relates a student with their designated advisor(s)/caption>
Path	Type	Name	Occurrence	Description
object	Element	object	Exactly One	Identifies the name of the object retrieved.
version	Element	version	Exactly One	Identifies the version of the object retrieved.
list	Object/Array	list	Zero or One	Parent object containing a listing of attributes about the business object
list.queryChartOfAccounts	Element	queryChartOfAccounts	Exactly One	The client-provided query parameter for chart of accounts code
list.queryAccountIndexCode	Element	queryAccountIndex	Exactly One	The client-provided query parameter for index code
list.queryTransDate	Element	queryTransDate	Zero or One	The client-provided query parameter for transaction date
list.accountIndexData	Object/Array	accountIndexData	Exactly One	Object containing details about an account index
list.accountIndexData.chartofAccounts	Object/Array	chartofAccounts	Exactly One	Object containing code and description for a chart of accounts
list.accountIndexData.chartOfAccounts.code	Element	code	Exactly One	Chart of accounts code
list.accountIndexData.chartOfAccounts.description	Element	description	Zero or One	Description of a chart of accounts code
list.accountIndexData.index	Object/Array	index	Exactly One	Objecting containing code and description for an index
list.accountIndexData.index.code	Element	code	Exactly One	Index code
list.accountIndexData.index.description	Element	description	Exactly One	Description of an index code
list.accountIndexData.effectiveStatus	Element	effectiveStatus	Exactly One	Accounting element status that considers effective dating. I.e. to be active, an element must have reached its effective/begin date, and not have surpassed it's terminated/end date. Valid values are "A" (active) and "I" (inactive).
list.accountIndexData.recordStatus	Element	recordStatus	Exactly One	Accounting element status as is reflected in the source database record. does not consider effective dating. Valid values are "A" (active) and "I" (inactive).
list.accountIndexData.effectiveDate	Element	effectiveDate	Exactly One	Date upon which an accounting element record becomes active/effective.
list.accountIndexData.nextChangeDate	Element	nextChangeDate	Exactly One	The change date for this particular record. I.E., if the record included a termination date, the next change date would reflect the date that the termination date was entered.
list.accountIndexData.terminationDate	Element	terminationDate	Exactly One	Date upon which an accounting element record becomes inactive/terminated.
list.accountIndexData.fund	Obejct/Array	fund	Zero or One	Objecting containing code and description for an fund
list.accountIndexData.fund.code	Element	code	Exactly One	Fund code
list.accountIndexData.fund.description	Element	description	Exactly One	Description of a fund code
list.accountIndexData.organization	Obejct/Array	fund	Zero or One	Objecting containing code and description for an organization
list.accountIndexData.organization.code	Element	code	Exactly One	Organization code
list.accountIndexData.organization.description	Element	description	Exactly One	Description of a organization code
list.accountIndexData.account	Obejct/Array	fund	Zero or One	Objecting containing code and description for an account
list.accountIndexData.account.code	Element	code	Exactly One	Account code
list.accountIndexData.account.description	Element	description	Exactly One	Description of a account code
list.accountIndexData.program	Obejct/Array	fund	Zero or One	Objecting containing code and description for an program
list.accountIndexData.program.code	Element	code	Exactly One	Program code
list.accountIndexData.program.description	Element	description	Exactly One	Description of a program code
list.accountIndexData.activity	Obejct/Array	fund	Zero or One	Objecting containing code and description for an activity
list.accountIndexData.activity.code	Element	code	Exactly One	Activity code
list.accountIndexData.activity.description	Element	description	Exactly One	Description of a activity code
list.accountIndexData.location	Obejct/Array	fund	Zero or One	Objecting containing code and description for an location
list.accountIndexData.location.code	Element	code	Exactly One	Location code
list.accountIndexData.location.description	Element	description	Exactly One	Description of a location code