General Ledger Account Inquiry

General Ledger Account Inquiry is a jXchange service designed to allow consumers to inquire on a General Ledger Account.

Message Flow

In jXchange, the General Ledger Account Inquiry service uses a typical exchange of MType messages to inquire on General Ledger accounts that meet the criteria entered within the request.

Primary Request

The Third Party Consumer forwards the GLAcctInqRq_MType message to the Service Provider. The message contains the required AcctId element along with the BrCode, GlCostCtr, and GlProdCode elements as required by the Service Provider as they are part of the key for the General Ledger account identification.

Primary Response

The Service Provider returns the GLAcctInqRs_MType message to the Third Party Consumer. The message contains an echo of the elements contained in the request.

General Ledger Account Inquiry Behavior

The GLAcctInqRq_MType message request requires the AcctId element. The request also provides BrCode, GLCostCtr, and GLProdCode elements as required by the Service Provider because they are part of the key for the General Ledger account identification.

The response includes an echo of the AcctId, BrCode, GLCostCtr, and GLProdCode elements submitted in the request. These data values are represented of the same data values submitted by the consumer on the request.

The BrCode, GLCostCtr, and GLProdCode elements presented in the request are included in the GLAcctInfoRec_CType complex and are represented of the data values of the account identification.

The GLAcctInfoRec_CType complex includes the GLCombStmtInfoArray_AType, GLMonthAmtInfoArray_AType, GLQtrAmtInfoArray_AType, and the UserDefInfoArray_AType arrays.

The GLCombStmtInfoArray_AType array provides an array of General Ledger combined statement codes. The array is a matched pair array with the GLCombStmtText element, which serves as the defined service provider key for the array.

The GLMonthAmtInfoArray_AType array provides an array of monthly values as related to the General Ledger account identification. The array is a matched pair array with the CalMonth and CalYr elements, which serves as the calendar values represented by the preceding elements. These monthly amount elements include budget amounts, activity amounts, average balance amounts, and month-end total amounts. A Service Provider should deliver zero values for any supported elements included in this array, rather than requiring a consumer to implicitly determine that a non-delivered element represents a zero value. For example, a Service Provider supports the monthly budget amount MonthBdgAmt element, but not every month has a value. The provider would still deliver every month with the months with no value as a zero amount (<MonthBdgAmt>0.00</MonthBdgAmt>).

The GLQtrAmtInfoArray_AType array provides an array of quarterly values as related to the General Ledger account identification. The array is a matched pair array with the QtrBegDt and QtrEndDt elements, which serves as the quarterly periods represented by the preceding elements. These quarterly amount elements include average balance amounts and quarter end total amounts. A Service Provider should deliver zero values for any supported elements included in this array, rather than requiring a consumer to implicitly determine that a non-delivered element represents a zero value. For example, a Service Provider supports the quarterly average balance amount QtrAvgBalAmt element, but not every quarter has a value. The provider would still deliver four quarters with the quarters with no value as a zero amount (<QtrAvgBalAmt>0.00</QtrAvgBalAmt>).

The UserDefInfoArray_AType array provides an array of Service Provider defined values/codes as related to the General Ledger account identification. The array is a matched pair array with the UserDefTxt element, which serves as the defined Service Provider key for the array.

The XSD node design for the General Ledger Account Inquiry service was created in a way to leverage the addition and modification for future messages.

The following table is a list of elements with their canonical values and the default value.

ElementCanonical ValuesDefault
Print Summary Report <PrtSumRpt>true

false

false
Print Daily Report <PrtDlyRpt>true

false

false
Standard Balance Type <StdBalType>Dr

Cr

General Ledger Posting Frequency Units <GLPostFreqUnits>Dly

Month

Dly
Standard Transaction Type <StdTrnType>Dr

Cr

Both

Both
Officer Required Type <OffReqType>true

false

false
Excluded Consolidated Type <ExclCnsldtType>true

false

false
Description Required Type <DescReqType>true

false

false
POD Post Allowable Type <PODPostAllwType>true

false

false
General Ledger Subject Account Reconciliation <GLSubjAcctRecon>true

false

false

GLAcctInqRq_MType

GLAcctInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

AcctId
The number or character that identifies an account record.
BrCode
The branch code.
GLCnsldtAcctId
The number or character that identifies an account record.
GLCostCtr
The GL cost center provided for bank use in reporting the account to a specific GL cost center.
GLInqType
The type of general ledger inquiry being requested. Canonical values are:
  • Cnsldt
  • Cur
  • PriorEOM

The default is Cur.

GLProdCode
The GL product code provided for bank use in reporting the account to a specific GL product code.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

GLAcctInqRs_MType

GLAcctInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • GLAcctInqRec_CType
  • MsgRsHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

AcctId
The number or character that identifies an account record.
BrCode
The branch code.
GLCnsldtAcctId
The number or character that identifies an account record.
GLCostCtr
The GL cost center provided for bank use in reporting the account to a specific GL cost center.
GLInqType
The type of general ledger inquiry being requested. Canonical values are:
  • Cnsldt
  • Cur
  • PriorEOM

The default is Cur.

GLProdCode
The GL product code provided for bank use in reporting the account to a specific GL product code.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

GLAcctInqRec_CType

GLAcctInqRec_CType is a complex CType element.

Contains:

  • GLAcctInfoRec_CType

Simple Elements

The simple elements contained within this complex are listed below.

AcctStatDesc
The account status description.
AcctTypeDesc
A description of the account type. It includes the Rstr attribute.
AvgYTDBal
The average year-to-date balance of an account.
BalYTDAmt
The year-to-date balance for an account.
BegLastYrBal
The account balance at the start of the last year.
BegPrevYrBal
The account balance at the start of the previous year.
BegYrBal
The account balance at the start of the year.
BrDesc
A description of the branch name. It includes the Rstr attribute.
CallRpt1Desc
The call report code description.
CallRpt2Desc
The call report code description.
CallRpt3Desc
The call report code description.
CallRpt4Desc
The call report code description.
CurBal
The current balance.
DlyBalChngAmt
The amount the account balance has changed from the last posted transaction.
GLProdDesc
The GL product code provided for bank use in reporting the account to a specific GL product code.
OffDesc
The officer short name.
YestBal
Yesterday's balance.

GLAcctInfoRec_CType

GLAcctInfoRec_CType is a complex CType element.

Contains:

  • GLCombStmtInfoArray_AType
  • GLMonthAmtInfoArray_AType
  • GLQtrAmtInfoArray_AType
  • UserDefInfoArray_AType
Simple Elements

The simple elements contained within this complex are listed below.

AcctStat
The account status.
AcctTitle
The account title including customer name and additional names.
Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
AcctType
The number or character that categorizes the AcctId.
BrCode
The branch code.
CallRpt1Code
The call report code.
CallRpt2Code
The call report code.
CallRpt3Code
The call report code.
CallRpt4Code
The call report code.
CapitalRiskPct
The percentage of the balance that is subject to capital risk.
DescReqType
Answers the question: Is this account subject to a mandatory description entry for transactions? Canonical values are:
  • false
  • true
ExclCnsldtType
Answers the question: Should this account be excluded from a consolidated report application? Canonical values are:
  • false
  • true
GLCnsldtAcctId
The number or character that identifies an account record.
GLCostCtr
The GL cost center provided for bank use in reporting the account to a specific GL cost center.
GLPostFreqUnits
The typical frequency of transactional posting. Canonical values are:
  • Dly
  • Month
GLProdCode
The GL product code provided for bank use in reporting the account to a specific GL product code.
GLSubjAcctRecon
Answers the question: Is this general ledger account subject to account recon process? Canonical values are:
  • false
  • true
GLTotalLvl
The totaling level assigned to general ledger accounts.
LastActDt
The date of last activity
LastMainDt
The last maintenance date.
OffCode
The code that designates the financial institution officer.
OffReqType
Answers the question: Is the account subjected to a mandatory officer for transactional entry? Canonical values are:
  • false
  • true
OpenDt
The date opened.
PODPostAllwType
Answers the question: Can the account accept transactions with a proof of deposit entry application? Canonical values are:
  • false
  • true
PrtDlyRpt
Answers the question: Should the account be included on daily reports? Canonical values are:
  • false
  • true
PrtSumRpt
Answers the question: Should the account be included on summary reports? Canonical values are:
  • false
  • true
StdBalType
The standard type of balance that is typically maintained for the account. Canonical values are:
  • Cr
  • Dr
StdTrnType
The standard type of transaction posted to the account. Canonical values are:
  • Both
  • Cr
  • Dr
GLCombStmtInfoArray_AType

GLCombStmtInfoArray_AType is an array AType element. This is an array of general ledger combined statement codes.

Contains:

  • GLCombStmtInfoRec_CType
GLCombStmtInfoRec_CType

GLCombStmtInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

GLCombStmtCode
The code used to control the behavior of combining general ledger accounts for reporting.
GLCombStmtDesc
The description of the code used to control the behavior of combining general ledger accounts for reporting.
GLCombStmtText
The textual data that describes the combined statement code in the array.
GLMonthAmtInfoArray_AType

GLMonthAmtInfoArray_AType is an array AType element. This is an array of monthly amounts as related to general ledger accounts.

Contains:

  • GLMonthAmtInfoRec_CType
GLMonthAmtInfoRec_CType

GLMonthAmtInfoRec_CType is a complex CType element.

Simple Elements

The simple elements contained within this complex are listed below.

CalMonth
The calendar month. Canonical values are:
  • Jan
  • Feb
  • Mar
  • Apr
  • May
  • June
  • July
  • Aug
  • Sep
  • Oct
  • Nov
  • Dec
CalYr
The year for the calendar period.
MonthActAmt
The monthly activity amount.
MonthAvgBalAmt
The monthly average balance amount.
MonthBalAmt
The monthly balance amount.
MonthBdgAmt
The monthly budget amount.
OrigBdgAmt
The original budget amount before any budget adjustments.
WorkBdgAmt
The working budget amount.
GLQtrAmtInfoArray_AType

GLQtrAmtInfoArray_AType is an array AType element. This is an array of calendar quarter amounts as related to general ledger accounts.

Contains:

  • GLQtrAmtInfoRec_CType
GLQtrAmtInfoRec_CType

GLQtrAmtInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

QtrAvgBalAmt
The quarterly average balance amount.
QtrBalAmt
The quarterly average balance amount.
QtrBegDt
The beginning date that equates to the start of the quarter.
QtrEndDt
The ending date that equates to the start of the quarter.
UserDefInfoArray_AType

UserDefInfoArray_AType is an array AType element. This is an array of UserDefInfo simple elements used to describe user defined information.

Contains:

  • UserDefInfo_CType
UserDefInfo_CType

UserDefInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

UserDefCode
The code that represents the answer to the UserDefTxt.
UserDefDesc
The description of what the UserDefCode represents.
UserDefDt
A date field that has a relationship with the UserDefTxt or UserDefCode.
UserDefInfo1
Additional information that may accompany any of the user supplied codes.
UserDefInfo2
Additional information that may accompany any of the user supplied codes.
UserDefInfo3
Additional information that may accompany any of the user supplied codes.
UserDefTxt
User Defined Text is part of a matched pair array that describes the proceeding elements.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The Soap Header Fault error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.