Treasury .us



Outbound GL Posted Transactions InterfaceGLOT01INT 062User GuideTreasury ERP ProjectPennsylvania treasuryRM G-22 Finance BuildingHarrisburg, PA 17120-001809/18/2013Document Information and Revision HistoryVersionDateRevision Notes1.01/15/2013Initial Version1.1 1/23/2013Updated guide to add DocumentType element and moved TraceId to header level1.22/6/2013Added Appendix C which includes additional source system codes.1.302/13/2013Correction made: PostedTransactionDetail should be listed under PostedTransactionHeader not GLPostedTransaction. The Min Occur value for PostedTransactionDetail was updated from 0 to 2.2.003/27/2013Modified chartfield names in request/response message and included new chartfield – ‘FiscalYear’.Modified root element name.Added new elements - BatchId at the header level and BankCode at the line level.Modified FiscalYear element name at the header level to AccountingYear.2.105/16/2013Clarified definition of ‘appropriation’2.206/27/2013Clarified definition of ‘Account’2.306/27/2013Clarified definition of ‘FiscalYear’3.008/08/2013Added SourceSystem to the PostedTransactionHeader node of the Response message.3.108/21/2013Removed Appendix A and B from Outbound User Guides. Please refer to the Inbound User Guides for valid values.3.208/21/2013Appendix C – New source system ‘COS’ Commission On Sentencing4.009/18/2013AsOfDate – No longer AsOfDate – 1 logic4.109/18/2013Journal Source – New sources of ‘IP’ and ‘INV’Table of Contents TOC \o "1-3" Document Information and Revision History PAGEREF _Toc351998314 \h 2Interface Overview PAGEREF _Toc351998315 \h 4Interface Guidance PAGEREF _Toc351998316 \h 4Interfacing using Files PAGEREF _Toc351998317 \h 4Interface using Web Services PAGEREF _Toc351998318 \h 5Schema Locations PAGEREF _Toc351998319 \h 5Request Message PAGEREF _Toc351998320 \h 6Sample Request Message PAGEREF _Toc351998321 \h 6Request Detail Node Information PAGEREF _Toc351998322 \h 7Response Message PAGEREF _Toc351998323 \h 9Sample Response Message PAGEREF _Toc351998324 \h 9Response Detail Node Information PAGEREF _Toc351998325 \h 11Appendices PAGEREF _Toc351998326 \h 16Appendix A: IES Document Type codes PAGEREF _Toc351998327 \h 16Appendix B: Non IES Document Type codes16Appendix C: Source System Codes16Interface OverviewThis interface is used for sending posted transactions from the Department of Treasury PeopleSoft General Ledger. The Department of Treasury intends to facilitate agencies’ ability to keep their systems reconciled with Treasury. As part of this effort, an outbound interface XML file or message will be provided to agencies with detailed posted transactions on a daily basis. The transactional data will come from the General Ledger journal entries that have been posted. If the agencies intend to make use of webservices to receive this information the request message schema is used for making the web service call. For XML file based transmission this request is not required and a scheduled job will move the files to the correct source system.Interface GuidanceInterfacing using FilesFile naming conventions: Each file name needs to be unique. Name should be in XXXXXXSRC<FREEFORM>YYYYMMDDHHMMSSmmm.xml format XXXXXX – The first 6 characters represent the interface name i.e. GLOT01SRC – The next 3 characters represent the source system code i.e. IES.<FREEFORM> - Free form text, sender can add any value they wish.? Leave blank if not in use.? Length of field can be from 0-10 alphanumeric characters. YYYYMMDD - The date of the transmission in YYYYMMDD format i.e. 20120101.HHMMSS - The time of day when the transmission occurred; it’s a military time format i.e. 162412 for 4:24:12 PM.mmm -? This is the milliseconds of the time when the transmission occurred.? This is an optional field..xml – This is the file extension.?????? Example File Names: ??? GLOT01IES20130101081235.xml – Minimum required in a file name.GLOT01IES20130101081235123.xml – Includes millisecond.GLOT01IESFFEX20130101081235123.xml – Includes freeform and milliseconds. Interface using Web ServicesWebservice format: SOAP XMLWebservice limitations: Additional documentation will be provided concerning the maximum number of chartfield values that can be included on a web service message. Test WSDL:Treasury will provide this to agencies that need to develop against a test instance of this interface.Production WSDL:T.B.D.Schema LocationsRequest:Schema xsd can be found in the collaboration SharePoint portal.Response: Schema xsd can be found in the collaboration SharePoint portal.Request MessageThe GL Posted Transaction Request Message is used to transmit requests for posted transactions from Treasury. It is formatted as an XML document and may be submitted via web service.All GL Posted Transaction Request documents consist of a single document header containing control information and a posted transaction parameter data module consisting of the data elements necessary to target all revenue related transactions for the specified system and business area that have been posted.Sample Request Message <?xml version="1.0"?><GLOT01Request xmlns=""> <DocumentHeader> <Control class="R"> <InterfaceIdentifier>GLOT01</InterfaceIdentifier> <SourceSystemCode>IES</SourceSystemCode> <DocumentIdentifier>GLPOST01</DocumentIdentifier> <DocumentDateTime>2013-10-31T15:07:38.687500</DocumentDateTime> </Control> </DocumentHeader> <PostedTransactionRequest> <PostedTransactionParameter class="R"> <ProcessSourceSystem>IES</ProcessSourceSystem> <Department>023</Department> <AsOfDate>2012-12-01</AsOfDate> </PostedTransactionParameter> </PostedTransactionRequest></GLOT01Request>Request Detail Node Information Node NameGLOT01RequestParent NodeNAMin Occur1Max Occurs1DescriptionThis is the root node of the XML file / message.Element NameData TypeSizeFormatRequired?DescriptionDocumentHeaderElementYThis is PA Treasury’s standard request header that must be present once on every outbound interface document.PostedTransactionRequestElementYRequest parameters for GL Posted transactions interface.Node NameDocumentHeaderParent NodeGLOT01RequestMin Occur1Max Occurs1DescriptionThis is PA Treasury’s standard request header that must be present once on every outbound interface document. This contains interface identifier and requesting source system.Element NameData TypeSizeFormatRequired?DescriptionControlElementYThe Control element holds interface identifier and requesting source system for the request.Node NameControlParent NodeDocumentHeaderMin Occur1Max Occurs1DescriptionContains identifying information related to the source system that is sending the inbound request.Attribute NameData TypeSizeFormatRequired?DescriptionclassString1UppercaseYValue must always be “R” Element NameData TypeSizeFormatRequired?Description. Add valid values like translatesInterfaceIdentifierstring6UppercaseYUsed to identify the interface. Should always be GLOT01 for this message.SourceSystemCodestring3UppercaseYShould contain 3-character abbreviation of the requesting Source System. Values will be provided by Treasury. See Appendix C for currently defined Source System codes.DocumentIdentifierString36MixedNUnique identifier on the requesting source system to identify this request message. This is an optional field and can be left blank if not applicable.DocumentDateTimeString26NOptional field to populate the date and time the request was sent. Format: YYYY-MM-DDTHH:MM:SS.999999-0000. If left blank, the value will default to Treasury’s system date and time.Node NamePostedTransactionRequestParent NodeGLOT01RequestMin Occur1Max Occurs1DescriptionXML Wrapper for GL posted transaction request parameters.Element NameData TypeSizeFormatRequired?DescriptionPostedTransactionParameterElementY Contains the parameters used to specify the target source system for which posted transactions should be returned.Node NamePostedTransactionParameterParent NodePostedTransactionRequestMin Occur1Max Occurs1DescriptionContains the parameters used to specify the target source system for which posted transactions should be returned.Attribute NameData TypeSizeFormatRequired?DescriptionclassString1UppercaseYValue must always be “R” Element NameData TypeSizeFormatRequired?Description. Add valid values like translatesProcessSourceSystemString3UppercaseYSource system for which the outbound file needs to be generated. Values will be provided by Treasury. See Appendix C for currently defined Source System codes.To generate the posted transactions for all source systems accessible to the requesting source system, set this value to ‘%’.DepartmentString3UppercaseYA Commonwealth agency or department. Populate with department id (3 character length with business area and leading 0s) for which the response will be generated. To generate the response for all departments, set this value to ‘%’.AsOfDateDate10YYYY-MM-DDYDate for which file has to be run. Ideally this should be the current date. The data would then have journal entries with posted date of (AsOfDate).Response MessageThe outbound message is an XML document containing information on the posted GL transactions for the source system and business area specified in the initiating message. The outbound message is returned as a synchronous reponse when the interface is accessed via its web service integration point and as a file, email message, or both when accessed via its file integration point.Sample Response Message <?xml version="1.0"?><GLOT01Response xmlns=""> <DocumentHeader> <Control class="R"> <InterfaceIdentifier>GLOT01</InterfaceIdentifier> <SourceSystemCode>PAT</SourceSystemCode> <DocumentIdentifier>GLOT01IES20130101101201</DocumentIdentifier> <DocumentDateTime>2013-01-01T16:12:56.000000</DocumentDateTime> <ResponseCode>000S</ResponseCode> <ControlCount>1</ControlCount> <ControlAmount>1500</ControlAmount> <RequestDocumentIdentifier>GLPOST01</RequestDocumentIdentifier> <RequestDateTime>2013-10-31T15:07:38.687500</RequestDateTime> </Control> </DocumentHeader> <GLPostedTransaction> <PostedTransactionHeader class="R"> <JournalId>0000012345</JournalId> <JournalDate>2013-01-01</JournalDate> <SourceSystem>IES</SourceSystem> <TraceId>123456</TraceId><BatchId>BATCH0001</BatchId> <AccountingPeriod>1</AccountingPeriod> <AccountingYear>2013</AccountingYear> <JournalSource>AR</JournalSource> <DocumentType>EA</DocumentType> <PostedTransactionDetail class="R"> <JournalLine>1</JournalLine> <TransactionAmount>1500</TransactionAmount> <SymbolChangeIndicator>N</SymbolChangeIndicator> <Fund>001</Fund> <Department>011</Department> <Appropriation>10748</Appropriation> <FiscalYear>2013</FiscalYear> <Account>1300000</Account> </PostedTransactionDetail> <PostedTransactionDetail class="R"> <JournalLine>2</JournalLine> <TransactionAmount>-1500.00</TransactionAmount> <SymbolChangeIndicator>N</SymbolChangeIndicator> <Fund>002</Fund> <Department>099</Department> <Appropriation>10745</Appropriation> <FiscalYear>2013</FiscalYear> <Account>1500000</Account> </PostedTransactionDetail> </PostedTransactionHeader> </GLPostedTransaction></GLOT01Response>Response Detail Node InformationNode NameGLOT01ResponseParent NodeNAMin Occur1Max Occurs1DescriptionThis is the root node of the XML response message.Element NameData TypeSizeFormatRequired?DescriptionDocumentHeaderElementYDocument header information that contains control information related to the document. This will be present once on every outbound response.GLPostedTransactionElementNGL Posted transactions group data. Node NameDocumentHeaderParent NodeGLOT01ResponseMin Occur1Max Occurs1DescriptionTreasury’s standard response header to inbound requests. Contains control information related to the response.Element NameData TypeSizeFormatRequired?DescriptionControlElementYDocument header information containing control totals.Node NameControlParent NodeDocumentHeaderMin Occur1Max Occurs1DescriptionProvides control information for the document including the system transmitting the document, control counts and amounts for outbound response.Attribute NameData TypeSizeFormatRequired?DescriptionclassString1UppercaseYValue will always be “R” Element NameData TypeSizeFormatRequired?Description. Add valid values like translatesInterfaceIdentifierString6UppercaseYUsed to identify the interface, the value will always be “GLOT01”.SourceSystemCodeString30UppercaseYSource System Code is the three-character abbreviation of the transmitting organization and will always be ‘PAT’.DocumentIdentifierString36MixedYUnique identifier related to this response message. Format will be GLOT01XXXYYYYMMDDHHMMSS. ProcessSourceSystem determine what goes into XXXDocumentDateTimeString26YWill be populated with the date and time response was sent. Format: YYYY-MM-DDTHH:MM:SS.999999-0000.ResponseCodeString4UppercaseYWill be populated with the response code based on the request message. Valid Values are:000E – For Error on run control values000S – For Success on run control values.If there was an error in run control values, the error reason will be populated in the Message node of DocumentHeader.ControlCountInteger10NTotal number of GLPostedTransaction elements.ControlAmountDecimal2823.3NSum of all positive TransactionAmount values.RequestDocumentIdentifierString36MixedNIf the inbound request had a DocumentIdentifier provided on the DocumentHeader node, that value will be populated here. If not then the field will be blank.RequestDateTimeString26NIf the inbound request had a DocumentDateTime provided on the DocumentHeader node, that value will be populated here. If not then the field will be blank.MessageElementNStandard header message response containing information related to request message processing. Will occur only if there were any invalid values on the process parameters. Node NameMessageParent NodeControlMin Occur0Max OccursUnboundedDescriptionStandard header message response containing information related to request message processing. Will occur only if there were any invalid values on the process parameters.Attribute NameData TypeSizeFormatRequired?DescriptionclassString1UppercaseYValue will always be “R” Element NameData TypeSizeFormatRequired?Description. Add valid values like translatesMessageNumberInteger5NThis is a PA Treasury generated error message sub-set number.MessageSet Integer5NThis is a PA Treasury generated error message set number.SeverityString1UppercaseNSeverity of message. Values are:E – Error: the issue identified in the request will prevent the file from being processed.M – Message: the message is informational only.W – Warning: the issue with the request element will not prevent the file from being processed.TextString254MixedNText description of the message.Node NameGLPostedTransactionParent NodeGLOT01ResponseMin Occur0Max OccursUnboundedDescriptionThe GL Posted transactions group data contains header and detail information for the posted transactionsElement NameData TypeSizeFormatRequired?DescriptionPostedTransactionHeaderElementYHeader information related to GL posted transactions.Node NamePostedTransactionHeaderParent NodeGLPostedTransactionMin Occur1Max Occurs1DescriptionHeader information related to GL posted transactions.Attribute NameData TypeSizeFormatRequired?DescriptionclassString1UppercaseYValue must always be “R” Element NameData TypeSizeFormatRequired?Description. Add valid values like translatesJournalIdString10UppercaseYUnique Header ID from PA Treasury GL system that identifies the transaction.JournalDateDate10YYYY-MM-DDYDate on which Journal was posted in PeopleSoft. When run on a daily basis this field would contain prior date.SourceSystemString3UppercaseNThe source system that submitted the Journal Transaction to Treasury.TraceIdString36MixedNUnique identifier to identify the Journal ID in the source system. This value is same as – TraceId provided on the Inbound GL transactions interface.BatchIdString14MixedNBatchId will allow GL transactions to be linked to payment request transactions.AccountingPeriodInteger3YAccounting period to which the transactions were posted in the Treasury General Ledger.AccountingYearInteger4YAccounting year to which the transactions were posted in the Treasury General Ledger.JournalSourceString3UppercaseYIdentifies the application or Source system that generated the Journal entry. Valid values areTV - Transfer VouchersRT - Revenue TransmittalRE - Refund of ExpendituresEA - Expenditure AdjustmentDM - Debit MemosAM - Adjustment Memo'sONL - PAT - Online Journal EntryCM - Cash Management ModuleAR - Accounts ReceivableAP - Accounts PayableINV – Deal ManagementIP – Deal ManagementDocumentTypeString2UppercaseNThe document type identifies the business transaction to be posted. Refer to Appendix A and Appendix B for listing of values.PostedTransactionDetailElementNLine and Chart of Accounts information related to GL posted transactions.Node NamePostedTransactionDetailParent NodePostedTransactionHeaderMin Occur2Max OccursUnboundedDescriptionLine and Chart of Accounts detail information related to GL posted transactions.Attribute NameData TypeSizeFormatRequired?DescriptionclassString1UppercaseYValue will always be “R” Element NameData TypeSizeFormatRequired?Description. Add valid values like translatesJournalLineInteger9YUnique Line number for every Journal_ID.TransactionAmountDecimal2823.3YAmount on the line transaction. SymbolChangeIndicatorString1UppercaseYIndicates if the chart of accounts symbol was changed for a previously sent transaction.Valid values areY – Chart of account changed N – No changesFundString3UppercaseYRepresents a grouping of funds established in Funds Management, to enable accounting and reporting to be done by activity or objective in accordance with laws, special regulations, restrictions, or limitations.Example:?001DepartmentString3UppercaseNA Commonwealth agency or departmentAppropriationString7UppercaseNRepresents the lowest level source of funding required for budgeting and monitoring.? The appropriation values sent to Treasury should be the first 5 characters of the SAPFund.? Positions 6-7 of the SAP Fund, which represents the Fiscal Year, should be recorded in the Fiscal Year element.? Positions 8-10 are not used by Treasury.? The field length of the appropriation is 7 to support future growth if deemed necessary.FiscalYearString4UppercaseNFiscal year to which the transaction belongs. For ledgers 40,50, and 60, this field should be 0000.AccountString7UppercaseYClassifies the nature of a transaction. This represents the SAP Commitment Item. For Non-SAP Agencies, map your GL Account to the SAP Commitment Item.BankCodeString4UppercaseNRepresents bank code associated with the revenue transactions.AppendicesAppendix A: IES Document Type codesAppendix B: Non IES Document Type codesPlease refer to Appenidx A and Appendix B of INT054 Inbound GL Journal Entry User Guide for a list of valid values.Appendix C: Source System CodesSource SystemCodeSource System DescriptionADGAuditor GeneralAGAAuditor General Allocation PaymentsATPAutomobile Theft Prevention AuthorityBDDLabor and Industry BDD Travel ReimbursementsBFRLiquid FuelsCOS Commission On SentencingEDUEducationGPFTreasury FinancialsGPPTreasury PayrollHIPHIPP (DPW)ICFIntergovernmental Cooperative Authority (financials)ICPIntergovernmental Cooperative Authority (payroll)IESIntegrated Enterprise Systems (formerly the SAP source system)IFPInsurance Fraud Prevention AuthorityLCBLiquor Control BoardLDFLDPC Financials LDPLDPC Payroll LIHLIHEAP (DPW)PHEPennsylvania Higher Education AgencyPMEPMERS AnnuitantsPROPROMISe (DPW)PSEPSERS AnnuitantsREVRevenueSERSERS AnnuitantsSWISWIFTAPTuition Account ProgramTSCThaddeus Steven College of TechnologyUCDUnemployment CompensationUCPUnclaimed PropertyUJS AOPC/UJS WCPWorkers Compensation ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download