General Ledger Account Search
General Ledger Account Search is a jXchange service designed to allow consumers to inquire on a General Ledger account.
Message Flow
In jXchange, the General Ledger Account Search service uses a typical exchange of
MType
messages to provide a service that allows consumers to search on a
General Ledger account. This search returns an array of records with the data required for
the GL Account Inquiry service, which yields a single record with more fields.
Primary Request
The Third Party Consumer forwards the GLAcctSrchRq_MType
message to the
Service Provider. The message contains the following simple elements:
- AcctId
- AcctTitle
- BrCode
- GLCostCtr
- GLProdCode
Primary Response
The Service Provider returns the GLAcctSrchRs_MType
message to the Third
Party Consumer. The message contains an echo of the requested elements.
General Ledger Account Search Behavior
The objective of the General Ledger Account Search service is to provide the consumer with the General Ledger account identification to be used for a subsequent call of the General Ledger Account Inquiry service.
The GLAcctSrchRq_MType
request message contains a documented choice statement where the elements at the root are
optional, but at least one of the elements is required. The AcctId,
AcctTitle, BrCode,
GLCostCtr, and GLProdCode are available in the
GLAcctSrchRq_MType
request message.
The following canonical values for the AcctId SrchType attribute are supported ~Exact~, ~StartsWith~, and ~EndsWith~. The following canonical values for the AcctTitle SrchType attribute are supported: ~Exact~, ~StartsWith~, and ~Contains~.
The GLAcctSrchRs_MType
response message echoes the
requested elements. The GLAcctSrchRecArray_AType
array returns all of the
items related to the filter(s).
GLAcctSrchRq_MType
GLAcctSrchRq_MType
is a message
MType
element.
Contains:
Custom_CType
SrchMsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- AcctId
- The number or character that identifies an account record.
- 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.
- BrCode
- The branch code.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- 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.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType
is a complex
CType
element. This is a
standard request message 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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-Security
.
GLAcctSrchRs_MType
GLAcctSrchRs_MType
is a message
MType
element.
Contains:
Custom_CType
GLAcctSrchRecArray_AType
SrchMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- AcctId
- The number or character that identifies an account record.
- 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.
- BrCode
- The branch code.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- 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.
GLAcctSrchRecArray_AType
GLAcctSrchRecArray_AType
is an array
AType
element. This is an array of responses for the General Ledger Account
Search service.
Contains:
GLAcctSrchRec_CType
GLAcctSrchRec_CType
GLAcctSrchRec_CType
is a complex
CType
element.
Simple Elements
The simple elements contained within this complex are listed below.
- AcctId
- The number or character that identifies an account record.
- 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.
- BrDesc
- A description of the branch name. It includes the
Rstr
attribute. - CurBal
- The current balance.
- 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.
- GLCostCtrDesc
- The description of 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.
- GLProdDesc
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- GLTotalLvl
- The totaling level assigned to general ledger accounts.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType
is a complex
CType
element. It searches specific message response
headers.
Contains:
jXchangeHdr_CType
MsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned. Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be larger than
MaxRec.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-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.