General Ledger History Search
General Ledger History Search
General Ledger History Search is a jXchange service designed to provide a consumer with the ability to search for General Ledger History or Memo Post transactions.
Message Flow
In jXchange, the General Ledger History Search service uses a typical exchange of
MType messages to search for General Ledger History or Memo Post
transactions.
Primary Request
The third-party consumer forwards the GLHistSrchRq_MType message to the
service provider.
The message contains the following simple elements:
- AcctId
- BatchNum
- BrCode
- EndDt
- GLCostCtr
- GLProdCode
- HighAmt
- LowAmt
- MemoPostInc
- SrtMthd
- StartDt
The message contains the following complex elements:
Custom_CTypeSrchMsgRqHdr_CType
The message contains the following array:
IncXtendElem_AType
Primary Response
The service provider returns the GLHistSrchRs_MType message to the
third-party consumer.
The message contains the following simple elements:
- AcctId
- BatchNum
- BrCode
- EndDt
- GLCostCtr
- GLProdCode
- HighAmt
- LowAmt
- MemoPostInc
- SrtMthd
- StartDt
The message contains the following complex elements:
Custom_CTypeSrchMsgRsHdr_CType
The message contains the following array:
GLHistSrchRecArray_AType
General Ledger History Search Behavior
The GLHistSrchRq_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 and
BatchNum are available at the root request. The request provides
additional documented choices that contains the optional elements
BrCode, GLCostCtr, and
GLProdCode.
However, if the consumer submits all of the required keys in the AcctId element, the service provider should attempt to parse those values to their perspective elements much like their application does for proof of deposit (POD) captured GL items.
The GLHistSrchRq_MType request contains a documented filter statement that
contains the following optional elements:
- BatchNum
- EndDt
- HighAmt
- LowAmt
- MemoPostInc
- SrtMthd
- StartDt
The GLHistSrchRq_MType request includes the
IncXtendElemArray_AType array, which requires submission for the consumer
to be returned the x_ACHHistSrchRec_AType record array that corresponds with
the GL History item.
The SrtMthd element's canonical value ~ChkNum~ is not supported for General Ledger History Search.
The General Ledger History Date search filters comparison is dependent upon the canonical value for the SrtMthd element value. The canonical value ~PostDt~ should compare the PostDt element in the response. The canonical value ~EffDt~ should compare the EffDt element in the response. The absence of the SrtMthd element should compare the PostDt element in the response.
A consumer request with a StartDt and without an EndDt returns all of the qualified General Ledger History records with a date equal to and greater than the StartDt. A consumer request with an EndDt and without a StartDt returns all of the qualified General Ledger History records with a date equal to and less than the EndDt. A consumer request with a StartDt and an EndDt returns all of the qualified General Ledger History records with a date equal to and greater than the StartDt and a date equal to and less than the EndDt.
The General Ledger History amount search filters compare the Amt element in the response. A consumer request with a LowAmt and without a HighAmt returns all of the qualified General Ledger History records with an amount equal to and greater than the LowAmt. A consumer request with a HighAmt and without a LowAmt returns all of the qualified General Ledger History records with an amount equal to and less than the HighAmt. A consumer request with a LowAmt and a HighAmt returns all of the qualified General Ledger History records with an amount equal to and greater than the LowAmt and an amount equal to and less than the HighAmt.
The GLHistSrchRs_MType response message echoes back the requested elements.
The response should be returned in last in, first out order.
The GLHistSrchRecArray_AType array should return all of the items related to
the General Ledger requested documented choices and documented filters. The
GLHistSrchRec_CType complex encapsulates an array of remarks related to the
General Ledger History item, TrnDescArray_AType array.
GLHistSrchRq_MType
GLHistSrchRq_MType is a message
MType element.
Contains:
Custom_CTypeIncXtendElem_ATypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- AcctId
- The number or character that identifies an account record.
- BatchNum
- The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
- BrCode
- The branch code.
- EndDt
- The date that designates the ending point for date selections.
- 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.
- HighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- LowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- MemoPostInc
- Determines the behavior searching history search for memo-posted
items. Canonical values are:
- Excl
- Only
- True
- SrtMthd
- The order that transactions are returned in a response.
Canonical values are:
- Amt
- ChkNum
- EffDt
- PostDt
- StartDt
- The date that designates the starting point for date selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType is an array AType element. This is an array that
lists x_ elements by name, which are to be included in the response.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 canonical value is JHA.
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
- 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
GLHistSrchRs_MType
GLHistSrchRs_MType is a message
MType element.
Contains:
Custom_CTypeGLHistSrchRecArray_ATypeSrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- AcctId
- The number or character that identifies an account record.
- BatchNum
- The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
- BrCode
- The branch code.
- EndDt
- The date that designates the ending point for date selections.
- 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.
- HighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- LowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- MemoPostInc
- Determines the behavior searching history search for memo-posted
items. Canonical values are:
- Excl
- Only
- True
- SrtMthd
- The order that transactions are returned in a response.
Canonical values are:
- Amt
- ChkNum
- EffDt
- PostDt
- StartDt
- The date that designates the starting point for date selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
GLHistSrchRecArray_AType
GLHistSrchRecArray_AType is an array AType element. This is an array of responses for the
General Ledger History Search service.
Contains:
GLHistSrchRec_CType
GLHistSrchRec_CType
GLHistSrchRec_CType is a complex
CType element.
Contains:
Custom_CTypeTrnDescArrayreferencesRmk_ATypex_ACHHistSrchRec_CType
Simple Elements
The following simple elements are contained within this complex.
- 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.
- AffCode
- The code that designates how the behavior influenced values of an account.
- Amt
- The amount or quantity.
- BatchNum
- The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
- BrCode
- The branch code.
- BrDesc
- A description of the branch name. It includes the
Rstrattribute. - EffDt
- The date assigned to transactions when it is different from the posting date.
- EFTTrnId
- A document reference assigned to an EFT transaction by the originating entity.
- GLCostCtrDesc
- The description of the GL Cost Center provided for bank use in reporting the account to a specific GL Cost Center.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLInterfaceCode
- A code that describes the GL account number that this transaction's interface applies.
- 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.
- GroupCode
- Used to group loans of different types for general ledger reporting purposes. It may also be used to group customer accounts together.
- GroupDesc
- The code that is used to group loans of different types for general ledger reporting purposes. It may also be used to group customer accounts together.
- ImgNum
- The numbers or characters that identify the key of the transaction's stored image.
- MemoPost
- A reference that indicates if the transaction is a memo-posted item.
- OffCode
- The code that designates the financial institution officer.
- OffDesc
- The officer short name.
- PostDt
- The date a transaction has posted or is scheduled to be posted to an account.
- RefDescCode
- A code that references a longer description. Used mostly in GL applications where a standard description is used so often that a code replacement is preferable.
- SeqNum
- The integer assigned to a specific transaction.
- SrcCodeDesc
- The description of the code that designates the original entry of a transaction.
- TrnApprvUsrId
- The user identification that initiated a transaction.
- TrnCodeCode
- The code that identifies the behavior of a monetary transaction.
- TrnCodeDesc
- The description of the code that identifies the behavior of a monetary transaction.
- TrnEntryTime
- The time a transaction was accepted.
- TrnType
- The grouping of monetary transactions by a specific code.
- TrnUsrId
- The user identification that initiated a transaction.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TrnDescArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
TrnDescArray references Rmk_AType.
Contains:
RmkInfo_CType
RmkInfo_CType
RmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Rmk
- Application or user remarks free-form text.
x_ACHHistSrchRec_CType
x_ACHHistSrchRec_CType is a complex
CType element.
Contains:
ACHHistSrchRec_CTypeCustom_CType
ACHHistSrchRec_CType
ACHHistSrchRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ACHCompName
- The ACH company name, as governed by NACHA rules.
- ACHCompDiscrData
- The ACH company discretionary data, as governed by NACHA rules.
- ACHCompDtDesc
- A date created by the ACH originator for descriptive purposes and never used for any timing controls.
- ACHCompEntryDesc
- The ACH company entry description, as governed by NACHA rules.
- ACHCompId
- The ACH company ID.
- ACHDtSttl
- The date on which the ACH participating financial institution is scheduled to be debited or credited FRB. This is not of type date due to the format of the date governed by Fed.
- ACHEffDt
- The date assigned to transactions when it is different from the posting date.
- ACHIndvDiscrData
- The ACH individual discretionary data as governed by NACHA rules.
- ACHIndvId
- The ID entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
- ACHIndvName
- The name entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
- ACHRetRsnCode
- The NACHA governed standard return reason codes to describe the reason for returning an ACH entry.
- ACHRetRsnDesc
- The NACHA governed standard return reason codes to describe the reason for returning an ACH entry.
- ACHStdEntryClass
- The ACH standard entry class.
- ACHSvcClass
- The general classification of dollar entries for ACH exchange as governed by NACHA.
- ACHTraceId
- The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.
- ACHTraceNum
- The ACH trace number that uniquely identifies each entry detail
record within a batch in an ACH file.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2018–01–01.
- ACHTrnCode
- The transaction code to be used for the ACH item, as governed by NACHA rules.
- ACHTrnDesc
- The description of the transaction code to be used for the ACH item, as governed by NACHA rules.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex
CType element. It searches
specific message response headers.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 canonical value is JHA.
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
- 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 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.