treasury - pa - emarketplace web viewthe location code of the bank as assigned by the us treasury....

PTMS/IF APPR01 Agency Guide

APPR01 PAYMENT REQUEST INTERFACE

AGENCY GUIDEINT 055

PENNSYLVANIA TREASURYRM G-22 FINANCE BUILDING

HARRISBURG, PA 17120-0018

03/19/2014

1


Document Information and Revision History

2


Version Date Revision Notes1.0 1/15/2013 Initial Version1.1 1/24/2013 Added the DocumentType element to the Header node for the Request

message.1.2 3/27/2013 Updated guide to correctly reflect request schema field sizes and types.

Updated guide to include correct data type and size for the.

Updated data type for Item.SCDUNoncustodialParentSSN from String to Integer. Updated documentation for size for Advice.LineType from 2 to 10.

Added additional source system codes to the listing in Appendix A.

Updated Appendix G for IES Source System Document Types.

Added FiscalYear element to the Funding node. Change element names in the Funding node: FundType->Fund, BusinessArea->Department, Fund->Appropriation.

Removed the DiscountAmount and DiscountDate elements from the Header node.

Add CUS for Customer Id as a possible value on the RecipientType element.

Add payment class PYNZ for payroll net zero pays.

Removed example data values from the sample XML from the PaymentRequest and the DataModule nodes.

Changed length of the RecipientLocation element of the Header node from 10 to 14.

Changed length of the FieldValue element of the ValidationMessage node from 18 to 254.

Added Appendix I Country Codes1.3 05/16/13 Added new lookup value DL for AuditLookupType element.

Revised descriptions for the FormatCode values CCD, PPD, and CTX. Also revised Appendix F.

3


Added new Payment Class GRLF for payroll Group Life Insurance Payments. Removed Payment Class PRUD.

Clarified definition of ‘appropriation’

4


1.4 06/27/13 Clarified definition of ‘GrossPaymentAmount’Clarified definition of ‘Account’Clarified definition of ‘FiscalYear’

1.5 08/01/13 Added new element VendorTaxpayerId to the Item node. Expanded description for the PayeeNameOne and PayeeNameTwo elements on the Item node to include their usage by additional Item Types.

1.6 08/26/13 Appendix A – New source system ‘COS’ Commission On Sentencing

2.0 09/18/13 Appendix J – Payment Due Date Rules2.1 09/18/13 Expanded description for the VendorId and VendorLocation elements on the

Item node to include their usage by the AC (Advancement Account) ItemType.3.0 11/20/13 Parent Node: Acknowledgement-Min Occur Field should be 0.

Payment Node: Added New Handling Code, RADG – Return to Auditor General Comptroller. Deleted RTTC – Treasury Mails (UCP Checks)AddressTwo, City, State, Postal Code descriptions were updated to reflect foreign addresses.

Added Appendix K to list the interface validation edits.3.1 11/20/13 Appendix A – Removed Source System, ADG “Auditor General” and AGA

“Auditor General Allocation Payments.4.0 12/18/13 Batch ID description updated4.1 12/18/13 SCDUFIPS Code description updated4.2 12/18/13 Appendix D-Payment Terms Codes were added and revised5.0 01/15/14 Appendix A – New Source System “GWL” Great West Life

Appendix K – Added several new validation edits.6.0 02/26/14 Appendix G – New Document Types ‘AX’, ‘DK’

Item node ItemType element. Added new ItemType ‘AX’.

Added additional Due Date validation edits and edit on Funding.Account requiring the use of an expenditure account. Clarified validation edits related to Advancement Accounts. Added new edit to make a missing PaymentHandlingCode for a Check an error. Revised the withholding tax validation edits.

EFTBeneficiary.Country – Modified description to indicate that it is defaulted to USA if omitted or blank.

5


EFTBenficiary.TransactionHandling – Modified description to indicate that it is defaulted to X if blank.

Changed severity to Error from TBD for validation edits that prevent processing of monetary amounts in fractional amounts less than one cent.

6.1 03/11/2014 Corrected severity and text description for several validation edits in Appendix K.

Modified description for EFTBeneficiary.BankAccountNumber to indicate that it is mandatory for ACHs and Domestic and International wires.

6


Table of ContentsDOCUMENT INFORMATION AND REVISION HISTORY.......................................................................... IIINTERFACE OVERVIEW................................................................................................................... 5INTERFACE GUIDANCE................................................................................................................... 6

Interfacing using Files..............................................................................................................6Interfacing using Web Service.................................................................................................7Schema Locations...................................................................................................................7

REQUEST MESSAGE...................................................................................................................... 8Sample Request Document.....................................................................................................8Request Detail Node Information...........................................................................................12

ACKNOWLEDGEMENT MESSAGE...................................................................................................36Sample Acknowledgement Message.....................................................................................36Acknowledgement Detail Node Information...........................................................................38

APPENDICES............................................................................................................................... 44Appendix A: Source System Codes.......................................................................................44Appendix B: Payment Class Codes.......................................................................................45Appendix C: Payment Type Codes........................................................................................47Appendix D: Payment Terms Codes.....................................................................................49Appendix E: Tax Payment Addenda Requirements...............................................................50Appendix F: Format Code Guidance.....................................................................................58Appendix G: IES Source System Document Types...............................................................59Appendix H: Non-IES Source System Document Types.......................................................60Appendix I: Country Codes....................................................................................................61Appendix J: Payment Due Date Rules..................................................................................69Appendix K: Interface Validation Edits...................................................................................73

7


Interface Overview

The Payment Request Interface is used by State agencies to initiate disbursement of funds by the Pennsylvania Treasury. Each payment request generates a payment voucher representing a disbursement to a specific recipient. Treasury can automatically consolidate certain vouchers into a single payment. Multiple payment requests can be transmitted in a single payment request interface document.

The required information can be transmitted as either an XML file or via a SOAP formatted web service call. After the information is received and processed, an acknowledgement is sent back with information on transactions received, processed and rejected. The acknowledgement also includes error messages for rejected transactions that can be used to review and correct the data for resubmission.

8


Interface Guidance

Interfacing using Files

File Naming Conventions:

1. Each file name must be unique.

2. Name should be in XXXXXXSRC<FREEFORM>YYYYMMDDHHMMSSmmm.xml format XXXXXX – The first 6 characters represent the interface name i.e. APPR01 SRC – 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: APPR01IES20130101081235.xml – Minimum required in a file name. APPR01IES20130101081235123.xml – Includes millisecond. APPR01IESFFEX20130101081235123.xml – Includes freeform and milliseconds.

9


Interfacing using Web Service

Webservice Format:

SOAP XML

Webservice Limitations:

Additional documentation will be provided concerning the maximum number of payment requests to be included in 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 Locations

Request:

Schema xsd can be found in the collaboration SharePoint portal.

Response:

Schema xsd can be found in the collaboration SharePoint portal.

10

Request MessageThe Request Message is used to transmit requests for disbursements to Treasury. It is formatted as an XML

document and may be submitted via web service or file. All Request Documents consist of a single document header containing control information and one or more payment request data modules consisting of the data elements necessary for creating a disbursement. Each payment request data module must be identified by a trace id that is unique to the submitting source system.

Sample Request Document<?xml version="1.0"?><APPR01Request xmlns="http://schemas.patreasury.gov/interface/schema/APPR01Request.v1"> <DocumentHeader> <Control class="R"> <InterfaceIdentifier>APPR01</InterfaceIdentifier> <SourceSystemCode>IES</SourceSystemCode> <DocumentIdentifier>123456789</DocumentIdentifier> <DocumentDateTime>2013-12-31T15:35:38.687500-05:00</DocumentDateTime> <ControlCount>1</ControlCount> <ControlAmount>100.00</ControlAmount> </Control> </DocumentHeader>  <PaymentRequest> <Header class="R"> <TraceId></TraceId> <OriginalTraceId></OriginalTraceId> <PaymentClass></PaymentClass> <PriorityCode></PriorityCode> <RecipientType></RecipientType> <RecipientId></RecipientId> <RecipientLocation></RecipientLocation> <TaxpayerId></TaxpayerId> <PreConsolidationIndicator></PreConsolidationIndicator> <VendorInvoiceId></VendorInvoiceId> <VendorInvoiceDate></VendorInvoiceDate> <SourceSystemReference></SourceSystemReference> <DocumentType></DocumentType>

11

<GrossPaymentAmount></GrossPaymentAmount> <GrossEarningsAmount></GrossEarningsAmount> <DueDate></DueDate> <PaymentTerms></PaymentTerms> <PaymentTermsBasisDate></PaymentTermsBasisDate> <DocumentFormat></DocumentFormat> <DocumentVerificationValue></DocumentVerificationValue> <DocumentURL></DocumentURL> <BatchType></BatchType> <BatchId></BatchId> <BatchSequenceNumber></BatchSequenceNumber> <ForceBatchProcessing></ForceBatchProcessing> <Payment class="R"> <PaymentNumber></PaymentNumber> <PaymentType></PaymentType> <PaymentMethod></PaymentMethod> <SeparatePayment></SeparatePayment> <PaymentHandlingCode></PaymentHandlingCode> <PrintRemittance></PrintRemittance> <PaymentMessage></PaymentMessage> <PayrollDeliveryBusinessArea></PayrollDeliveryBusinessArea> <CheckMemoLine></CheckMemoLine>  <Advice class="R"> <LineType> </LineType> <LineTypeSequenceNumber></LineTypeSequenceNumber> <Text> </Text> </Advice>  <ACHAddenda class="R"> <SequenceNumber></SequenceNumber> <Text> </Text> </ACHAddenda> </Payment> <Recipient class="R"> <RecipientNumber></RecipientNumber> <NameOne></NameOne> <NameTwo></NameTwo> <Country></Country> <StreetAddressOne></StreetAddressOne> <StreetAddressTwo></StreetAddressTwo>

12

<City></City> <State></State> <PostalCode></PostalCode> </Recipient>  <EFTBeneficiary class="R"> <BeneficiaryNumber></BeneficiaryNumber> <TransactionHandling> </TransactionHandling> <FormatCode> </FormatCode> <WireType></WireType> <AgencyLocationCode></AgencyLocationCode> <DFIQualifier></DFIQualifier> <DFI></DFI> <BankAccountType></BankAccountType> <BankAccountNumber></BankAccountNumber> <IBAN></IBAN> <BankName></BankName> <Country></Country> <StreetAddressOne></StreetAddressOne> <StreetAddressTwo></StreetAddressTwo> <City></City> <State></State> <PostalCode></PostalCode> <PaymentDetailInformation></PaymentDetailInformation> <FurtherCreditToIndicator></FurtherCreditToIndicator> <BeneficiaryReference></BeneficiaryReference> </EFTBeneficiary>  <Item class="R"> <ItemNumber></ItemNumber> <Description></Description> <ItemAmount></ItemAmount> <ItemType> </ItemType> <ItemId></ItemId> <ItemLineNumber></ItemLineNumber> <ItemScheduleNumber></ItemScheduleNumber> <ItemDate></ItemDate> <ItemReference></ItemReference> <VendorId></VendorId> <VendorLocation></VendorLocation> <VendorTaxpayerId></VendorTaxpayerId>

13

<SCDUNoncustodialParentName></SCDUNoncustodialParentName> <SCDUNoncustodialParentSSN></SCDUNoncustodialParentSSN> <SCDUEmploymentTerminated></SCDUEmploymentTerminated> <SCDUMedicalSupportIndicator></SCDUMedicalSupportIndicator> <SCDUFIPSCode></SCDUFIPSCode> <Issuer></Issuer> <AdvancementAccountBusinessArea></AdvancementAccountBusinessArea> <AdvancementAccountCode></AdvancementAccountCode> <PayeeNameOne></PayeeNameOne> <PayeeNameTwo></PayeeNameTwo> <AuditLookupType></AuditLookupType> <AuditLookupId></AuditLookupId> <AccountingReference></AccountingReference>  <SupportingDocument class="R"> <DocumentNumber></DocumentNumber> <Description></Description> <Type></Type> <Format></Format> <VerificationValue></VerificationValue> <URL></URL> </SupportingDocument>  <Funding class="R"> <FundingLineNumber></FundingLineNumber> <Description></Description> <Amount></Amount> <Fund></Fund> <Department></Department> <Appropriation></Appropriation> <FiscalYear></FiscalYear> <Account></Account> </Funding> </Item> </Header> </PaymentRequest></APPR01Request>

14


Request Detail Node Information

Node Name APPR01Request Parent Node

Min Occur 1 Max Occurs 1

Description Root node of the XML document.

Element Name Data Type Size Format Required Description

DocumentHeader Element Y This is the standard inbound request header that must be present once on every inbound interface document.

PaymentRequest Element Y Inbound payment request information.

Node Name DocumentHeader Parent Node APPR01Request


Description The DocumentHeader module contains control and detail information for the interface document. There will be one DocumentHeader module per interface document.


Control Element Y The Control element holds control data for the document.

Node Name Control Parent Node DocumentHeader


Description Provides control information for the document, including: the source system transmitting the document, a unique identifier for the document in the source system, the number of payment requests in the document, and the total amount of requested payments.

Attribute Name Data Type Size Format Required Description

class String 1 Upper Y Value must always be “R”.


InterfaceIdentifier String 6 Upper Y Always APPR01.

SourceSystemCode String 3 Upper Y The three-character abbreviation of the transmitting source system.

15


Values will be provided by Treasury. See Appendix A for currently defined Source System Codes.

DocumentIdentifier String 36 Mixed N Unique identifier used by the source system to identify the interface document. This value will be echoed back in the Acknowledgement response.

DocumentDateTime String N Date and time when the request was transmitted. DocumentDateTime is a datetime. If this value is not populated then the system will default date and time to the time Treasury loads the data.

Format is 2008-10-31T15:07:38.687500-05:00ControlCount Integer 10 Y Total count of Payment Requests contained in the file or web

service request. ControlAmount Decimal 28 23.3 Y Total amount of all payments requested in the file or web service

request.

Node Name PaymentRequest Parent Node APPR01Request

Min Occur 1 Max Occurs Unbounded

Description The PayentRequest module contains the information to initiate a single disbursement to a recipient. There may be multiple PaymentRequests modules per interface document.


Header Element Y The Header record element for a Payment Request.

Node Name Header Parent Node PaymentRequest


Description The Header record element. Each Payment Request adheres to a header, line item and accounting distribution hierarchy. This describes information contained in the header. There can be only one header per Payment Request.




TraceId String 36 Mixed Y Source system assigned value that uniquely identifies eachPayment Request. This number serves as the unique identifier of

16


the Payment Request throughout its processing in the Treasury systems. It must be unique within a source system. A Trace Id cannot be reused in the Payment Request Interface once it has been loaded into the Treasury system.

If there are errors while processing the Payment Requests, the TraceId will enable the agency to identify the Payment Request on the response to be able to resolve the error and resubmit it for processing.

OriginalTraceId String 36 Mixed N Identifies the original Payment Request for a resubmission when the original was rejected by Treasury’s auditing review and is resubmitted as a new Payment Request.

PaymentClass String 4 Upper Y Identifies the specific type of payment request. This See Appendix B for the list of valid values.

PriorityCode String 1 Upper N Used to indicate the payment requires expedited processing. Valid values are:

1 – Must be paid on the current or next business day.

2 – Must be paid within 5 business days.

R – Regular (default). Expedited processing not required.

Use when the DueDate is within 5 business days of the transmission date and the Payment Request is a high priority payment as classified by Treasury’s Fiscal Review bureau.

RecipientType String 3 Upper N Identifies the category of the recipient specified in the RecipientId element. Valid values are:

CUS – Customer Id – Use when the value in RecipientId is a Customer Identifier

EMP – Employee – Use when the value in RecipientId is a Commonwealth Personnel Number

PVD – Provider – Use when the value in RecipientId is a medical Provider Identifier.

RCP – Recipient – Use when the value in RecipientID is not one of the other listed categories.

VND – Vendor – Use when the value in RecipientId is a Vendor Identifier or Vendor Number

RecipientId String 25 Upper N The source system unique identifier for the disbursement recipient, (e.g. Vendor ID in IES).

17


RecipientLocation String 14 Upper N The source system location code for the recipient location, (e.g. Partner Code in IES).

TaxpayerId String 9 Upper N The recipient’s Social Security Number (SSN) orEmployer Identification Number (EIN). In order to utilize Treasury’s Check/ACH consolidation capability, this field must contain a value. Do not include spaces or dashes.

PreConsolidationIndicator String 1 Upper N Use to indicate that the payment request is the result of consolidation in the source system. Valid values are:

Y – Consolidated: source system has consolidated invoices for payment into a single Payment Request.

N – Unconsolidated (default)VendorInvoiceId String 30 Mixed N For unconsolidated payment requests populate with the Vendor’s

Invoice Number.

VendorInvoiceDate Date 10 XML Date N For unconsolidated payment requests populate with the Vendor’s invoice date stated on the vendor invoice.

SourceSystemReference String 30 Mixed N Populate with the invoice identifier in the source system. When present, the value must be unique within a source system. A Source System Reference value cannot be reused in the Payment Request Interface once it has been loaded into the Treasury system.

DocumentType String 2 Upper Y The document type identifies the business transaction to be posted. Payment Requests submitted by the IES (formerly SAP) source system must use one of the document types listed in Appendix G. All other source systems must use one of the document types listed in Appendix H.

GrossPaymentAmount Decimal 28 23.3 Y Amount of the Payment Request. All amounts are in US dollars. This amount must equal the sum of the Item ItemAmount values. Formatted as 9999.88. Include the decimal but do not include the dollar sign or commas.

ACH Prenotes (Payment.PaymentMethod of “ACH” and an ETFBeneficiary.TransactionHandling value of “P”) and payroll Net Zero Pays (Payment.PaymentMethod of “CHK” and a PaymentClass value of “PYNZ”) must have a GrossPaymentAmount of zero. A Gross Payment Amount defined as the amount of the payment made by Treasury must be zero for zero net pays.

GrossEarningsAmount Decimal 28 23.3 N Used only for payroll and annuitant Payment Requests. Populate with the employee’s gross earnings or gross annuitant amount. Required for payroll and annuitant Payment Requests, except ACH

18


Prenotes.

DueDate Date 10 XML Date N The date the disbursement needs to be in the recipient’s possession. Formatted as YYYY-MM-DD.

Treasury strongly recommends that the Due Date be populated by the submitting source system. Otherwise, Treasury will determine and assign the due date.

PaymentTerms String 5 Upper N Controls scheduling of discount payment date and calculated discount amount if a discount is available. See Appendix D for permitted values.

PaymentTermsBasisDate Date 10 XML Date N The date used in conjunction with Payment Terms to calculate the discount amount and discount due date. Must be provided for Payment Requests with discount payment terms.

DocumentFormat String 3 Upper N Identifies the format of the file referenced by the DocumentURL element. Supported values are:

XML – XML document.

IMG - Link to an agency-hosted page or image.

New formats may be added upon coordination with and approval from Treasury.

This element is use d for non-consolidated Payment Requests to access the supporting invoice documentation. For consolidated requests, supporting invoice documentation links are entered at the Item level.

DocumentVerificationValue String 40 Mixed N A 40-character value representing the “digest” result of encryptingthe entirety of the file residing at the location specified in the URLfield (below) using the SHA1 algorithm.

The SHA1 algorithm is described in IETF RFC 3174, “US SecureHash Algorithm 1”. This algorithm will be used to verify thecontents of the file whenever the file is accessed from a Treasuryapplication.

DocumentURL String 254 Mixed N URL referencing the file or page providing documentation that supports the validity of the disbursement. The URL passed to Treasury must include the full specification of the path as Treasury will use the URL directly with no customizations applied.

BatchType String 3 Upper N Code that identifies the type of value passed in the BatchId element.

19


Values are:

BPO – Treasury Batch Purchase Order Number

GRP – Agency Grouping IdentifierBatchId String 14 Upper N The 14 digit BatchID is mandatory for: 1) all payroll

payment requests from non-IES systems; 2) all journal entries with a Document Type PT (payroll transfer); and, 3) all payment requests from non-IES systems (i.e. Promise) for which Treasury receives detailed payment information and summary entries are posted in SAP. The BatchID will serve three purposes: 1) Enable Treasury to match payroll net pay payment requests to related payroll transfers to restricted receipt accounts; 2) Enable IES to post appropriate cash entries; 3) Assist in reconciling SAP to Treasury.

It should consist of a leading zero (0) + the two (2) digit ‘SAP’ business area + an eleven (11) digit unique number. These elements should be concatenated. The number should not be reused for payment requests with the exception of payroll. For payroll journal entries the BatchID should match the BatchID of the related payroll payments.

EX: 02100000001001 Department of Public Welfare

BatchSequenceNumber Integer 10 N Number assigned to the Payment Request to identify the Payment Request’s sequencing within the Agency batch when applicable

ForceBatchProcessing String 1 Upper N Indicator to direct Treasury to process all Payment Requests assigned to the Agency batch as a single unit of work. When set to Y Treasury will reject all Payment Requests assigned to the batch if one or more Payment Requests assigned to the batch encounter a validation error or audit rejection. If this is set to Y all payments in the same batch must come in the same file. Permitted values are:

Y – Force Batch Processing

N – Batch Processing Not Required (default)

20


Node Name Payment Parent Node Header


Description The Payment record is used in describes the disbursement generated to fulfill the Payment Request. It is also used in payment consolidation and in disbursement delivery.


Class String 1 Upper Y Value must always be “R”.


PaymentNumber String 10 Mixed Y Always 1.

PaymentType String 2 Upper N Identifies the category code of the ACH disbursement taking place. The value for regular vendor disbursements is ‘02’. Payroll disbursements must use ‘00’ or ‘01’. Required for ACH disbursements, leave blank for other payment methods. See Appendix C for a list of valid values.

Amount Decimal 28 23.3 N Reserved for future use. Omit.

ScheduledPayDate Date 10 XML Date N Reserved for future use. Omit .

PaymentMethod String 3 Upper Y Identifies the type of disbursement to generate. Permitted values are:ACH - Automated Clearing House

CHK - Check

WIR - Wire TransferSeparatePayment String 1 Upper N Controls consolidation of Payment Requests into a single

disbursement. Permitted values are:

Y – separate disbursement required, consolidation not permitted

N – separate disbursement not required, consolidation permitted (default)

If blank the system will default to ‘N”.

PaymentHandlingCode String 4 Upper N Specifies the Treasury disbursement distribution instructions. Permitted values are:

AGPY – Return to Attorney General (Payroll)

RTBC – Return to BCPO (Payroll)

RADG – Return to Auditor General Comptroller

21


RTCM – Return to Comptroller

RTPY – Return to Comptroller (Payroll)

RTTR – Return to Treasury Comptroller

TREM – Treasury Mails

Required for all Checks and for ACH disbursements that are to print a remittance advice.

PrintRemittance String 1 Upper N Controls whether or not to print a Remittance Advice Statement for an ACH disbursement. Permitted values are:

Y –print the Remittance Advice Statement (default)

N – suppress the printing of the Remittance Advice Statement

Applicable only to ACH disbursements.PaymentMessage String 79 Mixed N Free form text to be printed on the disbursement’s Payment Advice

Statement to provide the payee detailed information about the payment. If the disbursement does not print a Remittance Advice Statement, this field will be ignored.

PayrollDeliveryBusinessArea String 2 Upper N Business Area identifier of the intended delivery Business Area for employee payrolls. Normally, this is the same as the Business Area that is funding the disbursement, but there are certain cases where an employee is paid by one Business Area but is assigned to another. Use this field to control which Business Area delivers the Check or Remittance Advice Statement to the employee. Required only for payroll Payment Requests..

CheckMemoLine String 50 Mixed N Free form text to be printed on the disbursement’s memo line on the check face. Applicable only to Checks.

Node Name Advice Parent Node Payment


Description The Advice node is used to specify the disbursement remittance advice information.



22



LineType String 10 Mixed Y Specifies the type of line on the remittance advice. It must be one of the following values:

AG – Agency/Program Description: prints as the first line in the header section of all printed pages. Mandatory.

CH – Column Heading: up to 3 column heading lines are supported. They print beneath the AG record in the header section of all printed pages. Optional.

DL – Detail Line: values that correspond to their matching column headers. Presently, the number of detail lines is limited to a maximum of 275 which will fill the front and back of the check page and the front and back of two additional white sheets of paper.

Should the number of detail lines exceed 275, the detail lines will be replaced by a single text line on the check page with the caption “Remittance data provided by Agency was invalid. See Note for payment inquiry.” Mandatory.

TL – Total Line: values that correspond to their matching column details. The totals are at your discretion ex: Count, Qty, Amount. Optional.

NL – Note Line: ip to 4 note lines are supported. The note lines print adjacent to and beneath the “Note:” label in the footer section on the front side of the check page. Mandatory.

LineTypeSequenceNumber String 10 Mixed Y Specifies the order to print each record within the line type. Sequentially number each line starting at 1 for each line type. Note the following rules for assigning sequence numbers:

AG – Must always be 1. Only one AG line (Agency – program identifier) is permitted.

CH – If used, must be between 1 and 3. Zero to three column headers may be passed. No more than three CH lines are permitted.

DL – Consecutively numbered starting with 1 up to the number of detail lines present with a maximum value of 9999. Note that 275 is the maximum number of detail lines that will print.

TL – If used, must be 1.

NL – Must be between 1 and 4 since no more than four NL lines are permitted.

Text String 80 Mixed Y Free form text to be printed on the appropriate section of the page

23


as specified by the line type. Because the Advice record prints in columnar format, it is necessary for the column headings and detail lines to be aligned so the details line up beneath the appropriate column heading. A non-proportional font will be used when printing these lines. Use spaces to align the elements, do not use tabs or other unprintable characters. Additionally, there are limits on the number of characters that will print for some of the line types. These limits are:

AG – Use up to 80 character string.

CH – Use up to 80 character string.

DL – Use up to 80 character string.

TL – Use up to 80 character string.

NL – Use up to 40 character string.

Node Name ACHAddenda Parent Node Payment


Description The ACH Addenda node is used to construct NACHA formatted ACH Addenda when the disbursement is written to a NACHA payment file. This node should only be used when the Payment Method is ‘ACH’.




SequenceNumber String 10 Mixed Y Unique line number of the transaction for each group. Number sequentially starting with 1 up to a maximum value of 9999.

Text String 80 Mixed Y Addenda text to be attached to the disbursement’s ACH payment that provides the recipient detailed information about the payment. The text must follow the standard ACH specifications so asterisks are the field separators and the back slash (\) is the text terminator. The back slash must be the last character of the text. Prior to sending Addenda, please coordinate with the recipient to verify that their bank is configured to accept the Addenda in a specific format and that they are prepared to interpret it correctly.

24


Node Name Recipient Parent Node Header


Description Used to define the recipient information for the Payment Request.




RecipientNumber String 10 Mixed Y Always 1.

NameOne String 40 Upper Y Must contain the Payee Name of the recipient that is receiving the disbursement in UPPERCASE LETTERS. For check and ACH disbursements it prints on the face of the check or Remittance Advice Statement under “PAY TO THE ORDER OF.” For a check, the name should have at least three alphabetical characters although it is not a requirement. For wires, it must match the recipient’s name on the receiving bank account.

NameTwo String 40 Upper N Used for an additional Payee Name. If present, this field will print on the face of the check or Remittance Advice Statement on the line below the Name One (1) field. All alphabetical characters used in this field must be UPPERCASE.

Country String 3 Upper N Used for the three-character ISO 3166-1 alpha-3 standardabbreviation for the Country component of the recipient’s mailing address. This field is used to identify foreign addresses to the Treasury bulk mailing process. However, it does not print on the face of the check or Remittance Advice Statement. Use USA for domestic addresses. This field must be UPPERCASE.

Mandatory for International wires. Required for Domestic wires only when the recipient is located outside of the US.

If omitted or blank, it will default to USA.

See Appendix I for list of country codes.StreetAddressOne String 55 Mixed N Used for recipient’s mailing Street Address information. This field

will print on the face of the check or Remittance Advice Statement under the Name One (1) or Name Two (2) fields. All alphabetical characters used in this field must be UPPERCASE. (Due to current printing constraints only 40 characters can be used.)

Mandatory for International wires. Required for Domestic wires only

25


when the recipient is located outside of the US.StreetAddressTwo String 55 Mixed N Used for additional mailing Street Address information. If present,

this field will print on the face of the check or Remittance Advice Statement under the Street Address One (1) field. All alphabetical characters in this field must be UPPERCASE. (Due to current printing constraints only 40 characters can be used.)

For foreign address, this field should be provided already formatted for the CITY OR TOWN NAME, OTHER PRINCIPAL SUBDIVISION (such as PROVINCE, STATE, or COUNTY) AND POSTAL CODE (IF KNOWN) Note: In some countries, the postal code may precede the city or town name values.

City String 30 Mixed N Used for the city component of the recipient’s mailing address. If present, this field will print on the face of the check or Remittance Advice Statement under the Street Address One (1) or Street Address Two (2) fields. All alphabetical characters in this field must be UPPERCASE. (Due to current printing constraints only 26 characters can be used.)

Mandatory for International wires. Required for Domestic wires only when the recipient is located outside of the US.

This field will not be printed for foreign addresses.State String 6 Upper N Used for the abbreviation of the state or province component of the

recipient’s mailing address. For domestic addresses this field can also contain two character abbreviations for US possessions, territories or military “states”. For international addresses, up to six characters can be used for the foreign country’s state or province abbreviation.If present, this field will print on the face of the check or Remittance Advice Statement to the right of the city. This field must be UPPERCASE. (Due to current printing constraints only 2 characters can be used.)

This field will not be printed for foreign addresses.PostalCode String 12 Upper N Used for the postal code of the recipient’s mailing address and can

include a zip code extension when available. If present, this field will print on the face of the check or Remittance Advice Statement to the right of STATE. This field will allow alphabetical characters to support foreign postal codes that use characters as well as digits. If alphabetical characters are used, they must be UPPERCASE. (Due to current printing constraints only 10 characters can be used.)

26


Hyphens may be used to separate the postal code extension from the postal code (eg. 17120-0001).

This field will not be printed for foreign addresses.EmailAddress String 70 Mixed N Reserved for future use. Omit.

27


Node Name EFTBeneficiary Parent Node Header


Description The EFT Beneficiary record is used to specify the receiving bank for electronic payments. If payment method is ACH or WIR this information is required.




BeneficiaryNumber String 10 Mixed Y Always 1.

TransactionHandling String 1 Upper Y Permitted values are:

D - Payment Only

P – Prenotification – Use for ACH prenotes.

X - Payment with Remittance Advice

If blank the system will default to ‘X’.FormatCode String 3 Upper Y Permitted values are:

CCD - Cash Concentration and Disbursement entries for corporate to corporate items

CTX - Corporate Trade Exchange entries for multiple corporate transactions to the same payee

PPD - Prearranged Payments and Deposit entries for consumer items

WRT - Wire Transfer

CCD, CTX, and PPD are applicable only to ACH disbursements (Payment Method is ‘ACH’). Always use WRT when the Payment Method is ‘WIR’.See Appendix G for guidance on how to populate this element.

WireType String 2 Upper N Identifies the type of wire transfer to execute.Valid values are:

DW - Domestic Wire

IW - International Wire

28


TW - US Treasury Wire

Required for wire disbursements, omit otherwise.AgencyLocationCode String 15 Mixed N The location code of the bank as assigned by the US Treasury.

Associated with FMS or ASAP in most cases. Mandatory for US Treasury wires. Omit for International and Domestic wires and ACH disbursements.

DFIQualifier String 2 Upper Y Depository Financial Institution Qualifier. The DFI qualifier indicates what format—how many characters and numerics—are in the receiving bank's DFI ID value. Note that each DFI ID type has a specific number of digits that can be entered. Permitted values are:

01 - Transit Routing Number: 9 numeric characters including the check digit. ACHs and Domestic and US Treasury wires must use 01.

02 - Swift ID/BIC: 8 or 11 characters. International wires must use 02.

DFI String 12 Upper Y Depository Financial Institution Identifier to identify the receiving financial institution.

When the DFI Qualifier is 01 the DFI must be 9 numeric characters. Zero fill if necessary.

When the DFI Qualifier is 02, the DFI must be 8 or 11 characters with positions 5 and 6 being a valid 2-characters country code. Zero fill if necessary.

BankAccountType String 2 Upper N Identifies the destination account type at the receiving financial institution. Valid values are:

03 - Checking Account

SV – Savings Account

Mandatory for ACHs.BankAccountNumber String 35 Upper Y Contains the recipient’s bank account number. It can contain

dashes, blanks, and numbers. ACH bank accounts are limited to 17 characters, wires may use all 35.

Mandatory for ACHs and Domestic and International wires.IBAN String 34 Upper N International Bank Account Number. Mandatory for international

wires to countries of the EU, optional for international wires to other

29


destinations. Leave blank for Domestic and US Treasury wires and ACHs.

BankName String 30 Mixed N The name of the receiving financial institution. Mandatory for all wires. Optional for ACHs.

Country String 3 Upper N Country code (ISO 3166-1 alpha-3) where the receiving financial institution is located. Mandatory for International wires. Otherwise, it is optional.

If omitted or blank, it will default to USA.StreetAddressOne String 55 Mixed N The receiving financial institution’s street address line 1. Mandatory

for International wires. Otherwise, it is optional.StreetAddressTwo String 55 Mixed N The receiving financial institution’s street address line 2. Optional..

City String 30 Mixed N City where the receiving financial institution is located. Mandatory for International and Domestic wires. Otherwise, it is optional.

State String 6 Upper N The state or province abbreviation where the receiving financial institution is located. Mandatory for Domestic wires. Otherwise, it is optional.

PostalCode String 12 Upper N The postal code where the receiving financial institution is located. Optional.

PaymentDetailInformation String 140 Mixed N Optional field for additional payment information for wires. To be used for "further credit" information such as sub-account or invoice number when applicable. Can be used by all wire types. Omit for ACHs.

FurtherCreditToIndicator String 1 Upper N Set to “Y” when a further “credit-to” account number is present in the Payment Detail Information field. Optional for Domestic wires. Omit for International and US Treasury wires and ACHs.

BeneficiaryReference String 16 Mixed N Optional field for additional beneficiary payment information. Applies only to Domestic wires. Omit for International and US Treasury wires and ACHs

Node Name Item Parent Node Header


Description Payment request detail lines.



30



ItemNumber String 10 Mixed Y Unique identifier for each item. Number sequentially starting with 1 up to a maximum value of 99999.

Description String 254 Mixed N Use to provide explanatory information or additional detail for the item.

ItemAmount Decimal 28 23.3 Y Amount of the Payment Request Gross Amount attributable to this item. All amounts are in US dollars. This amount must equal the sum of the associated Funding Amount values and the sum of the Item Amounts for the items associated with a Payment Request must equal the Gross Amount of the Payment Request.

ItemType String 4 Upper N Code identifying the type of value passed in the ItemId element. Valid ItemTypes are:

AC – Advancement Account Payment

AX – New Advancement Account and/or Increase to Existing

CM – Credit Memo

CN – Contract

DM – Debit Memo

IV – Invoice

PO – Purchase Order

SU – SCDU Payment

UP – Unclaimed PropertyItemId String 30 Mixed N ItemType usage:

AC - check number issued from the advancement account checking account being submitted for replenishment.

AX - Optional

CM – vendor credit memo identifier.

CN – contract number.

DM –debit memo identifier.

IV – vendor invoice number. Use when the Payment Request is constituted of pre-consolidated invoices.

PO – purchase order number. Note that Batch Purchase Order numbers are to be provided in the BatchId element with a

31


BatchType of “BPO”. Only actual Purchase Order numbers are to be placed in the ItemId element.

SU - IV-D case number or court order number.

UP – property identifier.ItemLineNumber Integer 10 N Used with the following ItemTypes:

CN – contract line number. Optional.

PO – purchase order line number. Optional.ItemScheduleNumber Integer 10 N Used with the following ItemTypes:

CN – contract schedule number. Optional.

PO – purchase order schedule number. Optional.ItemDate Date 10 XML Date N Used with the following ItemTypes:

AC - date the Advancement Account check was issued.

AX – Date of request

CM – date the credit memo was issued.

DM – date the debit memo was created.

IV – vendor invoice date.

SU - obligor’s (non-custodial parent) pay date or the date of the income withholding.

ItemReference String 30 Mixed N Source system reference for the payment item. Used with the following ItemTypes:

IV – source system invoice id.VendorId String 25 Upper N Used with the following ItemTypes:

AC – vendor to which the advancement account check was issued. Optional.

CN – vendor to which the contract was issued when different than the Remit-To RecipientId on the Header node. Optional.

IV – identifier for the vendor issuing the invoice when different than the Remit-To RecipientId on the Header node. Optional.

PO – vendor to which the purchase order was issued when different than the Remit-To RecipientId on the Header node. Optional

VendorLocation String 10 Upper N Used with the following ItemTypes:

AC – vendor location to which the advancement account check was

32


issued. Optional.

CN – vendor location to which the contract was issued when different than the Remit-To RecipientLocation on the Header node. Optional.

IV – location code for the vendor issuing the invoice when different than the Remit-To RecipientLocation on the Header node. Optional

PO – vendor location to which the purchase order was issued when different than the Remit-To RecipientLocation on the Header node. Optional.

VendorTaxpayerId String 9 Upper N Used with the following ItemTypes:

AC – taxpayer identifier (SSN/EIN) for vendor to which the advancement account check was issued. Optional.

CN –taxpayer identifier (SSN/EIN) for vendor to which the contract was issued when different than the Remit-To TaxpayerId on the Header node. Optional.

IV – taxpayer identifier (SSN/EIN) for the vendor issuing the invoice when different than the Remit-To TaxpayerId on the Header node. Optional.

PO – taxpayer identifier (SSN/EIN) for vendor to which the purchase order was issued when different than the Remit-To TaxpayerId on the Header node. Optional.

Do not include spaces or dashes. SCDUNoncustodialParentName String 10 Upper N Used with the following ItemTypes:

SU - First seven letters of the non-custodial parent’s last name, followed by the first three letters of the non-custodial parent’s first name. A comma must be used to separate the last name from the first name when the last name is less than seven characters. Mandatory when the ItemType is SU.

SCDUNoncustodialParentSSN Integer 9 Upper N Used with the following ItemTypes:

SU - Non-custodial parent’s Social Security Number. Mandatory when the ItemType is SU.

SCDUEmploymentTerminated String 1 Upper N Used with the following ItemTypes:

SU - The employment termination indicator is used to notify the child support enforcement agency that an individual’s employment has terminated. A Y is placed in this field if the employee has terminated; otherwise the field is not used and should be populated

33


with a blank space.SCDUMedicalSupportIndicator String 1 Upper N Used with the following ItemTypes:

SU - The medical support indicator indicates whether the employer offers family medical insurance coverage. If medical coverage is available, a Y is placed in the field. If there is no coverage available, an N is placed in the field. Required only for SCDU payment items Mandatory when the ItemType is SU..

SCDUFIPSCode String 7 Upper N Used with the following ItemTypes:

SU - Federal Information Process Standard Code referencing the child support entity receiving the transaction.

Agency’s submitting payment request with SU ItemType will be responsible for submitting the SCDU FIPS Code when required based on the National Institute of Standards and Technology (NIST)

Issuer String 30 Mixed N Used with the following ItemTypes:

AC - Agency assigned ID of person or organization that issued the Advancement Account payment.

AdvancementAccountBusinessArea String 4 Upper N Used with the following ItemTypes:

AC - Identifies the business area that issued the Advancement Account payment.

AX - Identifies the business area that issued the Advancement Account payment.

AdvancementAccountCode String 3 Upper N Used with the following ItemTypes:

AC – Code used to identify the Advancement Account to be replenished.

AX – Code used to identify the Advancement Account to be replenished.

PayeeNameOne String 40 Mixed N Used with the following ItemTypes:

AC - Contains the advancement account payment’s Payee Name. The Payee Name should have at least three alphabetical characters. Optional.

AX – Contains the advancement account payment’s Payee Name. The Payee Name should have at least three alphabetical characters. Optional.

CN –payee name for vendor to which the contract was issued when different than the Remit-To NameOne on the Recipient node. Optional.

34


IV – payee name for the vendor issuing the invoice when different than the Remit-To NameOne on the Recipient node. Optional.

PO – payee name for vendor to which the purchase order was issued when different than the Remit-To NameOne on the Recipient node. Optional.

PayeeNameTwo String 40 Mixed N Used with the following ItemTypes:

AC - Contains the second line of the advancement account payment’s Payee Name, if needed. Optional.

AX - Contains the second line of the advancement account payment’s Payee Name, if needed. Optional.

CN –second line of payee name for vendor to which the contract was issued when different than the Remit-To NameTwo on the Recipient node. Optional.

IV – second line of payee name for the vendor issuing the invoice when different than the Remit-To NameTwo on the Recipient node. Optional.

PO – second line of payee name for vendor to which the purchase order was issued when different than the Remit-To NameTwo on the Recipient node. Optional.

AuditLookupType String 2 Upper N Code identifying the type of value passed in the audit lookup identifier field. Required when the Audit Lookup Identifier field is valued. Otherwise, leave blank. Permitted values are:

05 – Audit Lookup Id

AN – Account Number

CL – Claim Id

CR – Payment Register Report

DL – Revenue Document Locator Number (DLN)

SA – Attachment Provided in SAP

VT – Agency Grouping IdentifierAuditLookupId String 50 Mixed N Audit Lookup identifier in the Agency source system. This value is

the identifier used by Treasury’s Fiscal Review auditors to match the payment to its auditing data in the Agency’s source system or to its paper-based supporting documentation. Typical audit lookup identifiers would be Invoice Number or Account Number. Note that

35


in some cases the audit lookup identifier value will be the same as another one of the identifier fields.

AccountingReference String 30 Mixed N This value represents an accounting document number which is directly related to the Payment Request. (eg., credit memo document number which reduces the amount to be paid)

Node Name SupportingDocument Parent Node Item


Description Documentation for Fiscal Review supporting the associated payment request item.




DocumentNumber String 10 Mixed Y Unique identifier for each detail record. Number sequentially starting with 1 up to a maximum value of 999.

Description String 254 Mixed N Use to provide explanatory information or additional detail for the specified document.

Type String 2 Upper Y Identifies the content type of the file referenced by the URL. Listof valid types:

PO - Purchase Order

CN – Contract

GR – Grant

IV – Invoice

New types may be added upon coordination with and approvalfrom Treasury.

Format String 3 Upper Y Identifies the format of the file referenced by the URL. Supportedvalues are:

XML – XML document

IMG - Scanned Image or link to agency-hosted document.

New formats may be added upon coordination with and approval from Treasury.

36


VerificationValue String 40 Mixed N A 40-character value representing the “digest” result of encryptingthe entirety of the file residing at the location specified in the URLfield (below) using the SHA1 algorithm.

The SHA1 algorithm is described in IETF RFC 3174, “US SecureHash Algorithm 1”. This algorithm will be used to verify thecontents of the file whenever the file is accessed from a Treasuryapplication.

URL String 254 Mixed Y URL referencing the file or page providing documentation that supports the validity of the disbursement. The URL passed to Treasury must include the full specification of the path as Treasury will use the URL directly with no customizations applied.

Name Funding Parent Node Item

Min Occur 1 Max Occurs 99999Description The Funding node provides funding detail information for a Payment Request item. Funding details are provided by specifying an

amount and a Chart Field. The Chart Field represents the appropriation defined by the Legislature and used for bookkeeping purposes. It consists of a Fund, Department, Appropriation, and Account. The Amount is the amount to be credited or debited to the Chart Field. The sign of the amount identifies the financial effect on the Chart Field; either debit or credit. Each Item must have at least one Funding record and may have two or more (up to 99999).




FundingLineNumber String 10 Mixed Y Unique identifier for each funding line. Number sequentially starting with 1 up to a maximum value of 99999.

Description String 254 Mixed N Use to provide explanatory information or additional detail for the funding line.

Amount Decimal 28 23.3 Y The amount to be credited or debited to the Chart Field. The sum of the Amounts for an Item’s Funding lines must equal the Item’s Item Amount.

Fund String 3 Upper Y Represents 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.

37


Example: 001Department String 3 Upper Y A Commonwealth agency or department. Pad with leading zero.

Example: 021

Appropriation String 7 Upper Y Represents 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 SAP Fund. 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.

FiscalYear String 4 Upper Y Fiscal year to which the transaction belongs. For ledgers 40,50, and 60, this field should be 0000.

Account String 7 Upper Y Classifies the nature of a transaction. This represents the SAP Commitment Item. For Non-SAP Agencies, map your GL Account to the SAP Commitment Item.

38


Acknowledgement Message

Payment Request messages are automatically responded to with an Acknowledgement message. The Acknowledgement is an XML document containing information on the loading status of payment requests in the initiating message. Detailed validation messages facilitate correcting invalid payment requests for resubmission. The Acknowledgement is returned as a synchronous response 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 Acknowledgement Message

<?xml version="1.0"?><Acknowledgement xmlns="http://schemas.patreasury.gov/interface/schema/Acknowledgement.v1"> <DocumentHeader> <Control class="R"> <InterfaceIdentifier></InterfaceIdentifier> <SourceSystemCode></SourceSystemCode> <DocumentIdentifier></DocumentIdentifier> <DocumentDateTime></DocumentDateTime> <ResponseCode></ResponseCode> <ReceiveCount></ReceiveCount> <ErrorCount></ErrorCount> <AcceptCount></AcceptCount> <RejectCount></RejectCount> <RequestDocumentIdentifier></RequestDocumentIdentifier> <RequestDateTime></RequestDateTime> <RequestSystemCode></RequestSystemCode> <RequestFilename></RequestFilename> <Message class="R"> <MessageNumber></MessageNumber> <MessageSet></MessageSet> <Severity></Severity> <Text></Text> </Message> </Control> </DocumentHeader> <DataModule>

39


<Reference class="R"> <TraceId></TraceId> <TraceIdTwo></TraceIdTwo> <ErrorFlag></ErrorFlag> <SystemReferenceOne></SystemReferenceOne> <SystemReferenceTwo></SystemReferenceTwo> <SystemReferenceThree></SystemReferenceThree> <SystemReferenceFour></SystemReferenceFour> <ValidationMessage class="R"> <MessageNumber></MessageNumber> <MessageSet></MessageSet> <Severity></Severity> <Text></Text> <RecordName></RecordName> <RecordReferenceOne></RecordReferenceOne> <RecordReferenceTwo></RecordReferenceTwo> <RecordReferenceThree></RecordReferenceThree> <FieldName></FieldName> <FieldValue></FieldValue> </ValidationMessage> </Reference> </DataModule></Acknowledgement>

40


Acknowledgement Detail Node Information

Node Name Acknowledgement Parent Node


Description Root node of the Acknowledgement XML document.



DocumentHeader Element The standard response header for inbound interfaces.

DataModule Element Detailed error messages on each Payment Request transaction.

Node Name DocumentHeader Parent Node Acknowledgement


Description Standard header response for inbound interfaces.



Control Element Includes counts of transactions received, processed and rejected.

41


Node Name Control Parent Node Acknowledgement


Description The Control node includes counts of transactions received, processed and rejected.


class String 1 Uppercase

Y Value must always be “R”.


InterfaceIdentifier String 6 Y Always APPR01.SourceSystemCode String 3 Y Always PAT.

DocumentIdentifier String 36 Y Identifier to uniquely identify the acknowledgement.DocumentDateTime String Y Date and time when the response is transmitted.

DocumentDateTime is a datetime.ResponseCode String 4 Y This returns a code that is an alphanumeric code that states

overall processing of request data..Valid Values :001A All Payment Requests Accepted001E Processing Error001R Some Payment Requests Rejected001X All Payment Requests Rejected

ReceiveCount Integer 10 Y Identifies number of Payment Requests received.ErrorCount Integer 10 Y Identifies number of Payment Requests that had errors.AcceptCount Integer 10 Y Identifies number of Payment Requests that were accepted

and processed.RejectCount Integer 10 Y Identifies number of Payment Requests that were rejected

due to data errors.RequestDocumentIdentifier String 36 N This is the original DocumentIdentifier that was sent on the

inbound interface request. Value will be included if it was sent on the inbound request.

RequestDateTime String N Date and time from the original request. The date time will be the same as the inbound DocumentHeader DocumentDateTime on the original request the response is for.

RequestSystemCode String 30 N The three-character abbreviation of the transmitting source system. Values will be provided by Treasury. See Appendix A

42


for currently defined source system codes.RequestFilename String 80 N Name of original file processed. It will be blank when the

interface is accessed via web service.Message Element N Standard response message with information about

processing results.

Node Name Message Parent Node Control


Description Standard response message for inbound interfaces. This will include messages related to processing the request.


class String 1 Upper Y Value must always be “R”


MessageNumber Integer 5 Y This will be PA Treasury generated error message sub - set number.

MessageSet Integer 5 Y This will be PA Treasury generated error message set number.

Severity String 1 Upper Y Severity of message. Values are:

E – Error: the issue identified in the document will prevent all payment requests from being processed.

M – Message: the message is informational only.

W – Warning: the issue with the document not prevent payment requests from being processed.

Text String 254 Mixed Y Text description of the message.

43


Node Name DataModule Parent Node Acknowledgement


Description DataModule includes messages related to transaction processing. In the standard acknowledgement each payment request is considered a “data module” and is identified by a unique trace identifier.



Reference Element Y References identifying data sent on the inbound request for each transaction that was processed and related messages.

Node Name Reference Parent Node DataModule


Description References identifying data sent on the inbound request for each Payment Request that was processed and related messages.




TraceId String 36 Y TraceId sent on the inbound request for each Payment Request that was processed.

TraceIdTwo String 36 N Not applicable for this interface, the field will be blank.ErrorFlag String 1 Y Shows if there was an error in the Payment Request. Valid

values are “Y” and “N”. If there are errors associated with the TraceId, the value will be passed as “Y”.

SystemReferenceOne String 20 N Not implemented on this interface.SystemReferenceTwo String 20 N Not implemented on this interface.SystemReferenceThree Integer 20 N Not implemented on this interface.SystemReferenceFour Integer 20 N Not implemented on this interface.ValidationMessage Element N Standard transactional data message response for inbound

44


Node Name Reference Parent Node DataModule


Description References identifying data sent on the inbound request for each Payment Request that was processed and related messages.


interfaces.

Node Name ValidationMessage Parent Node DataModule


Description Validation messages provide detailed feedback of issues identified with a payment request, facilitating correction before resubmission. Messages may be associated with the payment request header, child records, or specific record fields.


class String 1 Y Value must always be “R”


MessageNumber Integer 5 Y Treasury-generated message number.

MessageSet Integer 5 Y Treasury-generated message set number.

Severity String 1 Upper Y Severity of message on the Payment Request transaction. Values are:

E – Error: the issue identified in the referenced data element will prevent the payment request from being processed.

M – Message: the message is informational only.

W – Warning: the issue with the referenced data element will not prevent the payment request from being processed.

Text String 254 Mixed Y Text description of the warning/error/ message.

RecordName String 30 Mixed N Name of the node that contains the element for which the ValidationMessage was generated.

RecordReferenceOne String 10 Mixed N Valued if there is a child record key

RecordReferenceTwo String 10 Mixed N Valued if there is a grand child record key

45


Node Name ValidationMessage Parent Node DataModule


Description Validation messages provide detailed feedback of issues identified with a payment request, facilitating correction before resubmission. Messages may be associated with the payment request header, child records, or specific record fields.


class String 1 Y Value must always be “R”


RecordReferenceThree String 10 Mixed N Valued if there is a great grand child record key

FieldName String 30 Mixed N Name of the element for which the ValidationMessage was generated.

FieldValue String 254 Mixed N Input value received on the element.

46


Appendices

Appendix A: Source System Codes

Source SystemCode

Source System Description

ATP Automobile Theft Prevention AuthorityBDD Labor and Industry BDD Travel ReimbursementsBFR Liquid FuelsCOS Commission On SentencingEDU EducationGPF Treasury FinancialsGPP Treasury PayrollGWL Great West LifeHIP HIPP (DPW)ICF Intergovernmental Cooperative Authority (financials)ICP Intergovernmental Cooperative Authority (payroll)IES Integrated Enterprise Systems (formerly the SAP source system)IFP Insurance Fraud Prevention AuthorityLCB Liquor Control BoardLDF LDPC Financials LDP LDPC Payroll LIH LIHEAP (DPW)PHE Pennsylvania Higher Education AgencyPME PMERS AnnuitantsPRO PROMISe (DPW)PSE PSERS AnnuitantsREV RevenueSER SERS AnnuitantsSWI SWIFTAP Tuition Account ProgramTSC Thaddeus Steven College of TechnologyUCD Unemployment CompensationUCP Unclaimed PropertyUJS AOPC/UJS WCP Workers Compensation

47


Appendix B: Payment Class Codes

PaymentClass Code

Description

0000 Normal DisbursementADVA Advancement Account PaymentCSHA DPW Cash Assistance PaymentERCX Evaluated Receipt PaymentsGICX General Invoice cXML FormatGRLF Group Life Insurance PaymentHIPP DPW HIPP PaymentIPCX Invoice PlanningLIHP DPW LIHEAP PaymentLOAN Loan ManagementLSCX Lease Payments with cXML InvoiceMCAR MCARE PaymentPCRD Payment CardsPITP PIT PaymentPMER PMERS Annuitant PaymentPROM DPW Promise PaymentPSER PSERS Annuitant PaymentPTRR PTRR PaymentPYBP Payroll Benefit Payment to 3rd PartyPYNP Payroll Employee Net PayPYNZ Payroll Net Zero PayRPCX Recurring Payment Invoice cXML FormatSCDU SCDU PaymentSECA SECA PaymentSERS SRES Annuitant PaymentSPLQ Special Liquor Orders – No Invoice ScannedSPRT DPW Support Pass Through/EOURA PaymentTAPG TAP GSP PaymentTRVL Travel Reimbursement PaymentUTCX Utility Invoice cXML FormatWTFD Federal Tax PaymentWTIN Indiana Tax PaymentWTMD Maryland Tax PaymentWTNJ NJ Tax PaymentWTPA PA Tax PaymentWTPH Philadelphia Tax PaymentWTVA Virginia Tax PaymentWTWV West Virginia Tax Payment

48


WTDC Washington DC Tax PaymentXICX Vendor Invoice cXML Format

49


Appendix C: Payment Type Codes

PaymentType Code

Payment Type Descriptor Payment Type Description

00 PAYROLL (REGULAR PAYROLL)01 SUPPL-PAY (SUPPLEMENTAL PAY)02 COMM OF PA (COMMONWEALTH OF PA)07 HEALTH (HEALTH)08 PENNDOT (PENNDOT)10 AGING DEPT (AGING DEPT)11 ANNUITANT (ANNUITANT)12 DEPT L & I (LABOR & INDUSTRY)15 GENERAL (GENERAL SERVICES)16 EDUCATION (EDUCATION)18 REVENUE (REVENUE)19 PA REFUND (PA REFUND)20 SCHOOL SUB (SCHOOL SUBSIDY)21 WELFARE (WELFARE)22 LIHEAP (LIHEAP)23 PROMISE MA (PROMISE MEDICAL ASSIST.)24 CDBG PAYMT (CDBG PAYMENT)25 HIPP (HIPP)26 LIQUOR CON (LIQUOR CONTROL)29 COM AFFAIR (COMMUNITY AFFAIRS)30 HISTORICAL (HISTORICAL)32 CIVIL SERV (CIVIL SERVICE)35 ENV. RES (ENVIRONMENTAL RESOURCES)39 PHEAA (PHEAA)40 JTPA (JTPA)50 DPW VENDOR (DPW VENDOR)51 PRPTXRNTRB (PROP TAX RENT REBATE)53 EXPENSES (EXPENSES)54 TRAVEL (TRAVEL)55 DED ACCTG (DED ACCTG)60 INTAXPAYMT (IN TAX PAYMENT)61 VATAXPAYMT (VA TAX PAYMENT)62 WVTAXPAYMT (WV TAX PAYMENT)63 DCTAXPAYMT (DC TAX PAYMENT)81 EXECUTIVE (EXECUTIVE)82 C. OF ARTS (COUNCIL OF ARTS)83 CRIME+DELQ (DELINQUENCY)84 COURT(JUV) (JUVENILE COURT)

50


91 PATAXPAYMT (PA TAX PAYMENT)92 NJTAXPAYMT (NJ TAX PAYMENT)93 TAXEFTPS (FEDERAL TAX PAYMENT)94 PHILA TAX (PHILA TAX PAYMENT)95 CHILD PAY (CHILD SUPPORT PAYMENT)96 PRUDENTIAL (PRUDENTIAL INSURANCE)97 MDTAXPAYMT (MD TAX PAYMENT)98 PA VENDOR (PA VENDOR – GEN ADDENDA)

51


Appendix D: Payment Terms Codes

PaymentTerms Code

Description

P001 Net 30 DaysP002 Net 5 DaysP003 Net 35 DaysP004 Net 45 DaysP005 Net 60 DaysP006 Net 15 DaysP066 Due NowP067 2% 10 Days/ Net 30P068 2% 15 Days/ Net 30P069 2% 10 Days/ Net 35P070 2% 10 Days/ Net 45P071 1% 10 Days/ Net 30P072 1% 15 Days/ Net 30P073 1% 29 Days/ Net 30P074 1% 30 Days/ Net 31

52


Appendix E: Tax Payment Addenda Requirements

Maryland (MD) Tax Payments

The Addenda sent with a MD Tax Payment must include the following information in the Addenda Text field:

1. First field must be TXP.

2. Second field must contain the eight-digit Maryland Central Registration number.

3. Third field must contain the five-digit tax type code: 01100 = withholding payment for Form MW506 or MW506A; or 01101 = withholding payment for Form MW508 or MW508A.

4. Fourth field must contain the year, month, and day for the ending date of the tax period for the payment, formatted as YYMMDD.

5. Fifth field is always T.

6. Sixth and last field must contain the amount of withheld taxes to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

Each field, including blank fields, must be separated by an asterisk (*), and the entire record must be followed by a back slash (\). A sample value is:

TXP*01234567*01100*930731*T*2000000\

The MD Tax Payments should use Transit Route #052001633 and Bank Account #2001800598.

Indiana (IN) Tax Payments

The Addenda sent with an IN Tax Payment must include the following information in the Addenda Text field:


2. Second field must contain the thirteen-digit Indiana EFT ID.

3. Third field must contain the three-digit tax type code: 011 = withholding tax (WTH) payment.

4. Fourth field must contain the year, month, and day for the ending date of the tax period for the payment, formatted as YYYYMMDD.

53



6. Sixth field must contain the amount of withheld taxes to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

7. Seventh and last field must be space filled until the addenda text terminator (\) at the end of the text string.


TXP*1234567890123*011*20091231*T*2000099* \

The IN Tax Payments should use Transit Route #074000065 and Bank Account #501980988.

Virginia (VA) Tax Payments

The Addenda sent with a VA Tax Payment must include the following information in the Addenda Text field:


2. Second field must contain the fifteen-digit Virginia tax account number. Left justify. Do not zero fill. Do not use hyphens.

3. Third field must contain the five-digit tax type code: 00011 = employer withholding tax.




7. Seventh field is optional and must be P for Penalty or I for Interest if applicable.

8. Eighth field is to be omitted unless there is a P or I value in the seventh field. When the seventh field is P or I, then it is required. Contains the amount of penalty or interest to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

9. Ninth field is optional and must be P for Penalty or I for Interest if applicable.

54


10. Tenth field is to be omitted unless there is a P or I value in the ninth field. When the ninth field is P or I, then it is required. Contains the amount of penalty or interest to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

11. Eleventh field is optional and when present is the taxpayer verification used by the receiver to verify the taxpayer’s transaction. It is a 1-6 character length alphanumeric.

Each field, including blank fields, must be separated by an asterisk (*), and the entire record must be followed by a back slash (\). Sample values are:

TXP*123456789012345*00011*091231*T*2000099\TXP*123456789012345*00011*091231*T*2000099*P*10000*I*20000*XXXXXX\TXP*123456789012345*00011*091231*T*2000099*****XXXXXX\

The VA Tax Payments receiving bank information is provided by VA when they receive your Agency’s completed EFT Agreement Form.

West Virginia (WV) Tax Payments

The Addenda sent with a WV Tax Payment must include the following information in the Addenda Text field:


2. Second field must contain the taxpayer identification number. This can be one of: a) 12 digit value made up of the Taxpayer ID number (FEIN or SSN) and the WV adjustment code, b) 9 digit Federal Employer Identification Number (FEIN), c) 9 digit SSN, or d) 8 digit WV Tax Account Number.

3. Third field must contain the five-digit tax type code: 01170 = employer withholding tax.




55



TXP*123456789001*01170*091231*T*2000000\

The WV Tax Payments receiving bank information must be provided by the WV State Tax Department.

District of Columbia (DC) Tax Payments

The Addenda sent with a DC Tax Payment must include the following information in the Addenda Text field:


2. Second field must contain the nine-digit Federal Employer ID Number (FEIN). Do not use a hyphen to separate digits.

3. Third field must contain the five-digit tax type code: 00300 = withholding tax.




7. Seventh field is optional and must be P for Penalty or I for Interest if applicable.

8. Eighth field is to be omitted unless there is a P or I value in the seventh field. When the seventh field is P or I, then it is required. Contains the amount of penalty or interest to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

9. Ninth field is optional and must be P for Penalty or I for Interest if applicable.

10. Tenth field is to be omitted unless there is a P or I value in the ninth field. When the ninth field is P or I, then it is required. Contains the amount of penalty or interest to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

11. Eleventh field is the taxpayer’s 12-digit account number assigned by OTR (DC Office of Tax and Revenue). The field is only required if you file multiple returns in a tax period under the same FEIN. For example, if your organization has multiple locations and files a separate Withholding tax return for each location the Account Number is required. However, if your organization files a consolidated return across all locations, the Account Number is not required. The Account number for Withholding is formatted as 30XXXXXXXXXX.

56



TXP*123456789*00300*091231*T*2000099\TXP*123456789*00300*091231*T*2000099*P*10000*I*20000*30XXXXXXXXXX\TXP*123456789*00300*091231*T*2000099*****30XXXXXXXXXX\

The DC Tax Payments receiving bank information must be provided by the DC OTR.

Pennsylvania (PA) Tax Payments

The Addenda sent with a PA Tax Payment must include the following information in the Addenda Text field:


2. Second field must contain the eight-digit Pennsylvania Account number for Employer Withholding Tax.

3. Third field must be EM340.



6. Sixth and last field must contain the amount of withheld taxes to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points since a two digit decimal position for the amount is implied. Field length must be ten digits so include leading zeroes.


TXP*12119848*EM340*071005*T*0000032195\New Jersey (NJ) Tax Payments

The Addenda sent with a NJ Tax Payment must include the following information in the Addenda Text field:


57


2. Second field must contain the thirteen-character New Jersey Division of Taxation Identification Number.

3. Third field must contain the tax type code. Valid entries are: 01110, 01120, 01130, 01140, 01150, 01160, and 01170.



6. Sixth field must contain the amount of withheld taxes to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points since a two digit decimal position for the amount is implied. Field length must be ten digits so include leading zeroes.

7. Seventh through tenth fields must be empty.

8. Eleventh field must be the four-character taxpayer verification code which is the first four characters of the taxpayer’s name as registered with the New Jersey Division of Taxation.


TXP*B232172299000*01170*060331*T*0000204539*****COMM\Philadelphia (PH) Tax Payments

The Addenda sent with a PH Tax Payment must include the following information in the Addenda Text field:


2. Second field must contain the seven-digit Philadelphia tax account number.

3. Third field must be 01.

4. Fourth field must contain the year, month, and day for the due date of the filing period for the payment, formatted as YYMMDD.


6. Sixth field must contain the amount of withheld taxes to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points since a two digit decimal position for the amount is implied. Field length must be ten digits so include leading zeroes.

7. Seventh field is always P.

58


8. Eighth field must contain the amount of the penalty and interest for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points since a two digit decimal position for the amount is implied. Field length must be eight digits if there is an amount being paid so include leading zeroes. If no interest and penalty is being paid, this field should be 0 (just a single digit).

9. Ninth field must contain the four digit period/year found on your tax coupon. The first two digits are the tax period and the last two are the last two digits of the tax year.


TXP*1234567*01*040430*T*0000000100*P*0*9204\Federal (FD) Tax Payments

The Addenda sent with a FD Tax Payment must include the following information in the Addenda Text field:


2. Second field must contain the nine-digit taxpayer Employer Identification Number.

3. Third field must contain the five-digit federal tax type code.

4. Fourth field must contain the year, month, and day for the ending date of the tax period for the payment, formatted as YYMMDD. Note that the DD must always be 01.

5. Fifth field contains the first IRS subcategory (=1) if applicable. If not, repeat the tax type code.

6. Sixth field must contain the amount of withheld taxes associated with the first IRS subcategory. Amounts are to be positive and entered without dollar signs, commas, or decimal points since a two digit decimal position for the amount is implied. Field length must be ten digits so include leading zeroes. If there is no first IRS subcategory, leave empty.

7. Seventh field contains the second IRS subcategory (=2) if applicable. If not, leave empty.

8. Eighth field must contain the amount of withheld taxes associated with the second IRS subcategory. Amounts are to be positive and entered without dollar signs, commas, or decimal points since a two digit decimal position for the amount is implied. Field length must be ten digits so include leading zeroes. If there is no second IRS subcategory, leave empty.

9. Ninth field contains the third IRS subcategory (=3) if applicable. If not, leave empty.

59


10. Tenth field must contain the amount of withheld taxes associated with the third IRS subcategory. Amounts are to be positive and entered without dollar signs, commas, or decimal points since a two digit decimal position for the amount is implied. Field length must be ten digits so include leading zeroes. If there is no third IRS subcategory, leave empty.

11. Eleventh field must be empty.

Note that the sum of the IRS subcategory amounts if present must equal the disbursement amount on the MA record.


TXP*236003133*94105*071201*1*0000173734*2*0000040632*3*0000198253*\TXP*231732438*09455*051201*09455******\

60


Appendix F: Format Code Guidance

Common standard NACHA entry class codes are:

1. PPD (Prearranged Payments and Deposit entries) for consumer items

2. CCD (Cash Concentration and Disbursement entries) for corporate to corporate items

3. CTX (Corporate Trade Exchange entries) for multiple corporate transactions to the same payee

61


Appendix G: IES Source System Document Types

The document types listed in the table below are to be used only by Payment Requests submitted by the IES (formerly SAP) source system.

SAP DOC TYPE DESCRIPTION PURPOSE OR TRIGGER

KD Vendor Invoice - Decentralized Non-PO invoice entered directly into SAP by the Agency

KR Vendor Invoice Non-PO invoice entered directly into SAP.

KU Utility Invoices Non-PO utility invoices entered via FB60, Web DynPro, and INTF_0492

ZA Advancement Account Invoice Non-PO Invoice for Advancement Accounts. For separating security by document types, reporting and auditing.

ZI Vendor Invoice Interface SAP invoice documents posted via an external interface. For auditing of payments in payment program the interface triggered invoices are required to be separated.

ZE Employee Travel Vendor Invoice HR / Travel Invoice postings to pay vendor.

ZW PR Posting 3rd Party 3rd Party Liability Payments.

ZF Non-SAP Advance Account Replenishment

Unique document type used to accumulate amounts to replenish non-SAP Advancement Accounts.

ZX Payroll Posting This entry is to record payroll expenses and payroll liabilities as a result of the payroll run. For example: Salaries, Medicare, Social Security, etc.

RN Invoice - Net Used to record invoices based on Purchase Orders. Also used to record Purchase Order refunds with and without remittance. RN documents with Bank Code 874 identified on them will be picked up by a collection program and SAP prints paper form to send to Treasury.

RE Invoice - Gross Used to record invoices based on Purchase orders. Invoicing Plan invoices.

AX Advancement Account Open Inc

Advancement Account – Open or Increase Authorized Balance. Open a new advancement account or increase the authorized balance of an existing account.

DK Loan Disbursement Loan Disbursement

62


Appendix H: Non-IES Source System Document Types

The document types listed in the table below are to be used only by Payment Requests submitted by all source systems other than IES (formerly SAP).

DOC TYPE DESCRIPTION PURPOSE OR TRIGGER

VT Vendor payment Payment to a vendor for goods or services. This is for initial recording of expenditures in the agency accounting system.

TE Travel related expenditure Travel related expenditure paid to an agency employee.This is for initial recording of expenditures in the agency accounting system.

PE Payroll related expenditure Payroll related expenditure paid to an agency employee or disbursement of employee payroll withholdings for taxes or benefits. This is for initial recording of expenditures in the agency accounting system.

AA Advancement Account replenishment.

Payment to replenish an Advancement Account. This is for initial recording of expenditures in the agency accounting system.

63


Appendix I: Country Codes

Country Code Short Descr Long DescriptionABW Aruba ArubaAFG Afghanistn AfghanistanAGO Angola AngolaAIA Anguilla AnguillaALB Albania AlbaniaAND Andorra AndorraANT Nth Antill Netherlands AntillesARE UEA United Arab EmiratesARG Argentina ArgentinaARM Armenia ArmeniaASM Am Samoa American SamoaATA Antarctica AntarcticaATF Fr S Terr French Southern TerritoriesATG Antigua Antigua and BarbudaAUS Australia AustraliaAUT Austria AustriaAZE Azerbaijan AzerbaijanBDI Burundi BurundiBEL Belgium BelgiumBEN Benin BeninBFA Burkina F Burkina FasoBGD Bangladesh BangladeshBGR Bulgaria BulgariaBHR Bahrain BahrainBHS Bahamas BahamasBIH Bosnia Her Bosnia and HerzegovinaBLR Belarus Belarus

64


BLZ Belize BelizeBMU Bermuda BermudaBOL Bolivia BoliviaBRA Brazil BrazilBRB Barbados BarbadosBRN Brunei Brunei DarussalamBTN Bhutan BhutanBVT Bouvet Is. Bouvet IslandBWA Botswana BotswanaCAF Central Af Central African RepublicCAN Canada CanadaCCK Cocos Is. Cocos (Keeling) IslandsCHE Switzerlan SwitzerlandCHL Chile ChileCHN China ChinaCIV Cote D'Ivo Cote D'IvoireCMR Cameroon CameroonCOD Congo, The Congo, The Democratic RepublicCOG Congo CongoCOK Cook Is. Cook IslandsCOL Colombia ColombiaCOM Comoros ComorosCPV Cape Verde Cape VerdeCRI Costa Rica Costa RicaCUB Cuba CubaCXR Christmas Christmas IslandCYM Cayman Is. Cayman IslandsCYP Cyprus CyprusCZE Czech Rep Czech RepublicDEU Germany GermanyDJI Djibouti Djibouti

65


DMA Dominica DominicaDNK Denmark DenmarkDOM Dominican Dominican RepublicDZA Algeria AlgeriaECU Ecuador EcuadorEGY Egypt EgyptERI Eritrea EritreaESH W Sahara Western SaharaESP Spain SpainEST Estonia EstoniaETH Ethiopia EthiopiaFIN Finland FinlandFJI Fiji FijiFLK Falkland I Falkland Islands (Malvinas)FRA France FranceFRO Faroe Is. Faroe IslandsFSM Micronesia Micronesia, Federated StatesGAB Gabon GabonGBR UK United KingdomGEO Georgia GeorgiaGHA Ghana GhanaGIB Gibraltar GibraltarGIN Guinea GuineaGLP Guadeloupe GuadeloupeGMB Gambia GambiaGNB Guinea-Bis Guinea-BissauGNQ Guinea Equatorial GuineaGRC Greece GreeceGRD Grenada GrenadaGRL Greenland GreenlandGTM Guatemala Guatemala

66


GUF Fr Guiana French GuianaGUM Guam GuamGUY Guyana GuyanaHKG Hong Kong Hong KongHMD Heard Is Heard and McDonald IslandsHND Honduras HondurasHRV Croatia CroatiaHTI Haiti HaitiHUN Hungary HungaryIDN Indonesia IndonesiaIND India IndiaIOT BritishIOT British Indian Ocean TerritoryIRL Ireland IrelandIRN Iran Iran (Islamic Republic Of)IRQ Iraq IraqISL Iceland IcelandISR Israel IsraelITA Italy ItalyJAM Jamaica JamaicaJOR Jordan JordanJPN Japan JapanKAZ Kazakhstan KazakhstanKEN Kenya KenyaKGZ Kyrgyzstan KyrgyzstanKHM Cambodia CambodiaKIR Kiribati KiribatiKNA St Kitts Saint Kitts and NevisKOR Sth Korea Korea, Republic ofKWT Kuwait KuwaitLAO Lao Lao People's Democratic RepLBN Lebanon Lebanon

67


LBR Liberia LiberiaLBY Libyan Ara Libyan Arab JamahiriyaLCA St Lucia Saint LuciaLIE Liechtenst LiechtensteinLKA Sri Lanka Sri LankaLSO Lesotho LesothoLTU Lithuania LithuaniaLUX Luxembourg LuxembourgLVA Latvia LatviaMAC Macau MacauMAR Morocco MoroccoMCO Monaco MonacoMDA Moldova Moldova, Republic ofMDG Madagascar MadagascarMDV Maldives MaldivesMEX Mexico MexicoMHL Marshall I Marshall IslandsMKD Macedonia Fmr Yugoslav Rep of MacedoniaMLI Mali MaliMLT Malta MaltaMMR Myanmar MyanmarMNE Montenegro MontenegroMNG Mongolia MongoliaMNP N Marina I Northern Mariana Islands

MOZMozambique Mozambique

MRT Mauritania MauritaniaMSR Montserrat MontserratMTQ Martinique MartiniqueMUS Mauritius MauritiusMWI Malawi Malawi

68


MYS Malaysia MalaysiaMYT Mayotte MayotteNAM Namibia NamibiaNCL New Caledo New CaledoniaNER Niger NigerNFK Norfolk Is Norfolk IslandNGA Nigeria NigeriaNIC Nicaragua NicaraguaNIU Niue NiueNLD Netherland NetherlandsNOR Norway NorwayNPL Nepal NepalNRU Nauru NauruNZL NZ New ZealandOMN Oman OmanPAK Pakistan PakistanPAN Panama PanamaPCN Pitcairn PitcairnPER Peru PeruPHL Philippine PhilippinesPLW Palau PalauPNG PNG Papua New GuineaPOL Poland PolandPRI Puerto Rco Puerto RicoPRK Nth Korea Korea, Democratic People's RepPRT Portugal PortugalPRY Paraguay ParaguayPYF Fr Polynes French PolynesiaQAT Qatar QatarREU Reunion ReunionROU Romania Romania

69


RUS Russian Fd Russian FederationRWA Rwanda RwandaSAU Saudi Arab Saudi ArabiaSDN Sudan SudanSEN Senegal SenegalSGP Singapore SingaporeSGS S Georgia Sth Georgia & Sth Sandwich IsSHN St Helena Saint HelenaSJM Svalbard Svalbard and Jan MayenSLB Solomon Is Solomon IslandsSLE Sierra Leo Sierra LeoneSLV ElSalvador El SalvadorSMR San Marino San MarinoSOM Somalia SomaliaSPM St Pierre Saint Pierre and MiquelonSRB Serbia Republic of SerbiaSTP Sao Tome Sao Tome and PrincipeSUR Suriname SurinameSVK Slovakia SlovakiaSVN Slovenia SloveniaSWE Sweden SwedenSWZ Swaziland SwazilandSYC Seychelles SeychellesSYR Syrian Ara Syrian Arab RepublicTCA Turks Is Turks and Caicos IslandsTCD Chad ChadTGO Togo TogoTHA Thailand ThailandTJK Tajikistan TajikistanTKL Tokelau TokelauTKM Turkmenstn Turkmenistan

70


TMP East Timor East TimorTON Tonga TongaTTO Trinidad Trinidad and TobagoTUN Tunisia TunisiaTUR Turkey TurkeyTUV Tuvalu TuvaluTWN Taiwan Taiwan, Province of ChinaTZA Tanzania, Tanzania, United Republic ofUGA Uganda UgandaUKR Ukraine UkraineUMI US Islands US Minor Outlying IslandsURY Uruguay UruguayUSA USA United StatesUZB Uzbekistan UzbekistanVAT Vatican Holy See (Vatican City State)VCT St Vincent St Vincent and the GrenadinesVEN Venezuela VenezuelaVGB BrVirginIs Virgin Islands (British)VIR VirginIsUS Virgin Islands (U.S.)VNM Viet Nam Viet NamVUT Vanuatu VanuatuWLF Wallis and Wallis and Futuna IslandsWSM Samoa SamoaYEM Yemen YemenYUG Yugoslavia YugoslaviaZAF Sth Africa South AfricaZMB Zambia ZambiaZWE Zimbabwe Zimbabwe

Appendix J: Payment Due Date Rules

71


Treasury plans to utilize PeopleSoft to manage cash flows and the scheduling of disbursements based on payment Due Dates. Providing a valid Due Date will allow Treasury to better manage cash flows and improve its ability to meet the Agencies’ goals for payment timing to recipients. The following rules provide the framework developed by Treasury to accomplish this goal. Treasury will make every effort to meet a requested Due Date, provided the request complies with Pre-Audit requirements and is consistent with cash availability, Budget availability, and Operational constraints.

Definitions:

Discount Date: The date by which payment must be made in order to take a discount in accordance with the Payment Terms.

Due Date: The date a payment is requested to be in the payee’s possession.

Expedited Payment: A payment for which the Due Date is five or fewer business days after the Treasury Received Date of the request. Expedited Payments comprise regularly recurring payments, irregular payments that can be foreseen but not loaded into PeopleSoft in advance, and unexpected payments that only allow a shortened review and processing period at Treasury.

Net Date: The date by which payment in full (i.e., without any discount) must be made in accordance with the Payment Terms. Payment Terms: Contractual or other provisions that establish, in instances where a payment may be eligible for a discount, the method calculating the Discount Date and the discount amount that may be applied to the face amount of an invoice if payment is made by the Discount Date.

Payment Terms Basis Date: The date designated by the Payment Terms for purposes of calculating the Discount Date and Net Date. Scheduled Payment Date: The payment date assigned based upon application of Treasury’s rules for scheduling payments as provided in this document.

Treasury Received Date: The date a payment request is loaded into the Treasury PeopleSoft system.

General Processing Rule

For requested Due Dates that are ten or more business days later than the Treasury Received Date, Treasury will assign the Due Date as the Scheduled Payment Date.

Special Processing Rule for Payroll Requests

72


Payroll requests that do not include a Due Date will be rejected. For Payroll Requests with a Due Date, Treasury will assign the Due Date as the Scheduled Payment Date.

Invalid Due Date Rules (non-payroll) :

When a payment request seeks a Due Date that is less than ten days from the Treasury Received Date (or is otherwise described in a scenario below), Treasury will calculate the Scheduled Payment Date based on the following rules:

Scenario 1: No Due Date is requested.

Rule: The Scheduled Payment Date is calculated by adding 15 business days to the Treasury Received Date. For example, a payment received on 4/4/13 will have a Scheduled Payment Date of 4/25/13. A warning message will be sent stating: ‘A minimum 15 day processing schedule is required for payments when no Due Date is submitted.’

Scenario 2: An already passed Due Date is requested.

Rule: The Scheduled Payment Date is calculated by adding 6 business days to the Treasury Received Date. For example, a payment received on 4/4/13, with a Due Date of 4/3/13, will have a Scheduled Payment Date of 4/12/13. A warning message will be sent stating: ‘A minimum 10 day processing schedule is required for payments when the Due Date submitted has passed.’

Scenario 3: A Due Date is requested that allows Treasury less than 5 days for processing. Note: This rule does not apply to Expedited Payments that include a priority code.

Rule: The Scheduled Payment Date is calculated by adding 6 business days to the Treasury Received Date. For example, a payment received on 4/4/13, with a Due Date of 4/7/13, will have a Scheduled Payment Date of 4/12/13. A warning message will be sent stating: ‘A minimum 10 day processing schedule is required for payment –pay Due Date will be changed.’

Scenario 4: A Due Date is requested that is greater than 90 days in advance.

Rule: Treasury will honor the Due Date unless it is modified by the Comptroller. A warning message is sent stating: ‘Payment request received with pay Due Date more than 90 days in advance of current date.’

Scenario 5: The Due Date requested is greater than 365 days from the Treasury Received Date.

73


Rule: If the Due Date is greater than 365 days from the Treasury Received Date, the payment will be rejected. An error message is sent stating: ‘Payment request received with pay Due Date more than 365 days in advance of current date cannot be scheduled.’

Expedited Payment Processing

Expedited Payments must be mutually agreed upon by Treasury, Comptroller, and Agency, either for a series of payment requests or for an individual request as the circumstances warrant. In order to be accepted by Treasury as an Expedited Payment, Comptroller must provide a compelling need for accelerated processing and payment such as legally mandated payment date, timing critical to health and safety, risk of significant economic harm to the payee, or exposure to significant penalty for delayed payment. Expedited Payment requests must provide an appropriate priority code of “1-must be paid on the current or next business day “or “2-must be paid within 5 business days.”

Expedited Payment Processing Rule: A payment will qualify for expedited processing by Treasury if: a) Comptroller and the responsible Agency secure advance approval from Treasury; b) The payment request includes an appropriate priority code; and c) The payment request seeks a Due Date not more than five days after the Treasury Received Date.

Discounted Invoices Payment Rules:

• If a payment request includes the Payment Terms and the Payment Terms Basis Date, Treasury will calculate the Discount Date. If the Discount Date allows five or more business days for processing, Treasury will calculate and apply the discount amount to the payment.

• If a payment request fails to include either the Payment Terms or Payment Terms Basis Date, the payment request will be rejected.

• If a payment request includes a Due Date in addition to the Payment Terms and the Payment Terms Basis Date, Treasury will disregard the Due Date and will calculate the Discount Date.

o If the Discount Date allows five or more business days for processing, Treasury will calculate and apply the discount amount to the payment.

o If the Discount Date allows less than five business days for processing, or if for any other reason Treasury cannot meet the Discount Date, it will assign payment for the net amount and Net Date provided for by the Payment Terms.

o If the Net Date provides less than five business days for processing, Treasury will utilize the Invalid Due Date Rules (non-payroll) to establish the Scheduled Payment Date.

74


The following are examples of how different Payment Term scenarios will be handled:

Scenario Due Date Payment Terms Payment Terms Basis Date

Discount and Net Date

Treasury Received Date

Scheduled Payment Date

Action

Payment Terms provided. Discount can be met but Due Date Less than 5 days from today's date

Not provided 2% 10 days Net 30 days

3/28/13 D: 4/8/13 N: 4/26/13

4/4/13 4/26/13 Use Net Date. No Invalid Due Date Rules Apply

Payment Terms provided. Discount can be met and Due Date 5 days or Greater from today's date


4/1/13 D: 4/11/13 N: 5/1/13

4/4/13 4/11/13 Use Discount Date. No Invalid Due Date Rules Apply

Payment Terms provided and the Discount Date is Past Due.


3/1/13 D: 3/11/13 N: 3/31/13

4/4/13 4/18/13 Use Invalid Due Date Rules, Add 10 Business Days to Treasury Received Date

Due Date and Payment Terms are provided and the Due Date is the same as the Discount Date

4/11/13 2% 10 days Net 30 days

4/1/13 D: 4/11/13 N: 5/1/13


Due Date and Payment Terms are provided, but the Due Date is prior to the Discount Date

4/9/13 2% 10 days Net 30 days

4/1/13 D: 4/11/13 N: 5/1/13


75


Appendix K: Interface Validation Edits

Severity Node Element Text ExplanationError Control ControlAmount Invalid ControlAmount - does not

equal the sum of PaymentRequest GrossPaymentAmounts

The ControlAmount must match the sum of the GrossPaymentAmounts in the file.

Error Control ControlCount Invalid ControlCount - does not equal the number of PaymentRequests

The ControlCount must match the actual number of number of Payment Requests (PRs) in the file.

Error Control SourceSystemCode Invalid SystemSourceCode Invalid SourceSystemCode value. It must be one of the values in the SourceSystem Code list provided in Appendix A of the Guide.

Error Header <internal use> Business Unit Assignment Failure: Please contact support.

All payments requests must be assigned an internal Treasury Business Unit to process through the Treasury system. The Business Unit is derived from the SourceSystem and potentially the Funding Department, Payment Class, and Funding Appropriation.

Error Header <internal use> Vendor Assignment Failure: Please contact support.

All payments requests must be assigned an internal Treasury Vendor Identifier to process through the Treasury system.

Error Header <node> ForceBatchProcessing enabled and related PR in same Batch has errors.

All PRs in a Batch are marked in Error if one or more PRs in the Batch enountered a validation error and ForceBatchProcessing is enabled.

Warning Header BatchId BatchType and BatchId must either both be present and populated or both be omitted.

BatchType and BatchId must either both be present and populated or both be omitted.

Error Header BatchId Missing BatchId Agencies under the Governor’s jurisdiction that submit payment requests to Treasury that do not flow through the Comptroller Operations IES system are required to provide a 14 digit BatchID.

Error Header BatchType Invalid Translate value. BatchType value must be BPO or GRP.Error Header DocumentFormat Invalid Translate value. DocumentFormat value must be IMG

76


or XML.Error Header DocumentFormat Missing DocumentFormat - required

when DocumentURL is specifiedThe DocumentFormat must be specified when a DocumentURL is provided.

Error Header DocumentType Missing Required value. DocumentType is required.Error Header DocumentType Invalid DocumentType - incompatible

with SourceSystemThe DocumentType must match a value that is eligible to be used for the submitting source system. IES and non-IES use differents sets of values.

Error Header DocumentURL Missing DocumentURL - required when DocumentFormat is specified

The DocumentURL must be provided when a DocumentFormat is present.

Error Header DueDate DueDate is required for payroll PRs Payroll (identified by having PaymentClass = PYNP) Payment Requests must have a DueDate.

Warning Header DueDate A minimum 15-day processing schedule is required for payments when no Due Date is submitted

Payment requests submitted without a DueDate have their DueDate assigned using the Treasury Due Date assignment rules specified in the Agency Guide.

Warning Header DueDate A minimum 10-day processing schedule is required for payments when the submitted DueDate has passed

Payment requests submitted with a past DueDate have their DueDate assigned using the Treasury Due Date assignment rules specified in the Agency Guide.

Warning Header DueDate A minimum 10 day processing schedule is required for payment – pay DueDate will be changed

Payment requests submitted with a DueDate that is less than 5 days in advance have their DueDate assigned using the Treasury Due Date assignment rules specified in the Agency Guide.

Warning Header DueDate Payment request received with pay DueDate more than 90 days in advance of current date

Payment requests submitted with a seemingly incorrect DueDate that is greater than 90 days in advance trigger a warning. The submitted DueDate will not be altered.

Error Header DueDate PR received with pay DueDate more than 365 days in advance of current date cannot be scheduled

Payment requests submitted with a seemingly incorrect DueDate that is greater than 365 days in advance will be rejected.

77


Error Header ForceBatchProcessing Invalid Yes/No value. ForceBatchProcessing value must be Y or N .

Error Header ForceBatchProcessing ForceBatchProcessing not consistent with value on other batch PRs.

All Payment Requests assigned to a BatchId must have the same value for the ForceBatchProcessing element. They must either all have the ForcebatchProcessing value set to Y or they all must have it set to N.

Warning Header GrossEarningsAmount Missing GrossEarningsAmount - required for Payroll and Annuitant Payment Requests

The GrossEarningsAmount is expected to be > $0 for all Payroll and Annuitant Payment Requests,except ACH Prenotes.

Error Header GrossEarningsAmount Schema Violation if more than 3 fractional digits and Invalid number of decimal positions for currency if equal to 3 digits.

Treasury does not support processing of monetary amounts in fractional amounts less than one cent.

Error Header GrossPaymentAmount Invalid GrossPaymentAmount - cannot be negative

The GrossPaymentAmount cannot be negative.

Error Header GrossPaymentAmount Invalid GrossPaymentAmount - cannot be > 99,999,999.99 for CHK

GrossPaymentAmount for a Check cannot be more than $99,999,999.99. This restriction is due to the micro line limit in the banking network.

Error Header GrossPaymentAmount Invalid GrossAmount - does not equal the sum of ItemAmounts

The sum of the ItemAmount values on the Item node must match the GrossPaymentAmount on the Header node.

Error Header GrossPaymentAmount Invalid GrossPaymentAmount - must be zero for ACH PreNotes and NetZeroPays

The GrossPaymentAmount must be zero for ACH PreNotes and Net Zero Pays.

Error Header GrossPaymentAmount GrossPaymentAmount cannot be > 99,999,999.99 for ACH

The GrossPaymentAmount for an ACH cannot be more than $99,999,999.99. This restriction is due to the ACH network limitation.

Error Header GrossPaymentAmount Schema Violation if more than 3 fractional digits and Invalid number of decimal positions for currency if equal to 3 digits.


Error Header PaymentClass Invalid value. PaymentClass value must be a valid Payment Class.

Error Header PaymentClass Missing Required value. PaymentClass is required.Error Header PaymentClass Invalid PaymentClass/DocumentType The PaymentClass value must be

78


pairing - ADVA must be paired with DocumentTypes ZA, ZF, AA or AX.

ADVA when the DocumentType is AA, AX, ZA or ZF and the DocumentType must be AA, AX, ZA, or ZF when the PaymentClass is ADVA.

Error Header PaymentTerms Invalid value. PaymentTerms value must be a valid Payment Term.

Error Header PaymentTerms The PaymentTerms must be valued when there is a PaymentTermsBasisDate present.

The PaymentTerms must be valued when a PaymentTermsBasisDate is present.

Error Header PaymentTermsBasisDate Missing PaymentTermsBasisDate - required when PaymentTerms specified

The PaymentTermsBasisDate must be valued when there are PaymentTerms present.

Error Header PreConsolidationIndicator Invalid Translate value. PreConsolidationIndicator value must be Y or N .

Error Header PriorityCode Invalid Translate value. PriorityCode value must be 1, 2, or R.Warning Header RecipientId RecipientType and RecipientId must

either both be present and populated or both be omitted.

RecipientType and RecipientId must either both be present and populated or both be omitted.

Error Header RecipientType Invalid Translate value. RecipientType value must be CUS, EMP, PVD, RCP, or VND.

Error Header SourceSystemReference Invalid SourceSystemReference - cannot be a duplicate value for the SourceSystem

SourceSystemReference must be unique within Source System.

Error Header TraceId Missing TraceId TraceID must be present and valued.Error Header TraceId Invalid TraceId - cannot be a

duplicate value for the SourceSystemTraceID must be unique within a Source System.

Error Payment <internal use> Bank Acct Assignment Failure. Please contact support.

All payments requests must be assigned an internal Treasury Bank Account to process through the Treasury system. The Bank Account is derived from elements provided for the Payment Request.

Error Payment <node> Missing Payment node - required for single-pay payments

The Payment node must be present for payment requests since all payment requests are processed as single-pay payments in the Treasury system.

Error Payment PaymentHandlingCode Invalid value. PaymentHandlingCode value must be a valid Payment Handling Code.

Warning Payment PaymentHandlingCode Missing PaymentHandlingCode for Payment Handling Code cannot be 0

79


ACH/Wire requiring printed remittance advice.

or blank for ACH or Wire disbursements that are to print a remittance advice.

Error Payment PaymentHandlingCode Missing PaymentHandlingCode for Check.

Payment Handling Code cannot be 0 or blank for Checks.

Error Payment PaymentMethod Invalid Translate value. PaymentMethod value must be ACH, CHK, or WIR.

Error Payment PaymentMethod Missing Required value. PaymentMethod is required.Error Payment PaymentMethod A PR with PaymentClass SCDU must

be an ACH paymentPRs with PaymentClass SCDU must be an ACH.

Error Payment PaymentType Invalid value. PaymentType value must be a valid Payment Type.

Error Payment PaymentType PaymentType 95 can only be used with PaymentClass SCDU.

PaymentType 95 can only be used with PaymentClass SCDU.

Error Payment PaymentType PaymentType 95 must have one or more Item nodes with the SCDU related values populated.

PaymentType 95 must have one or more Item nodes with the SCDU related values populated.

Error Payment PaymentType Invalid PaymentType. PaymentType must be 95 when the PaymentClass is SCDU.

Invalid PaymentType. PaymentType must be 95 when the PaymentClass is SCDU.

Error Payment PaymentType Missing PaymentType - a value is required for ACH PaymentMethod

The PaymentType value cannot be omitted or blank for an ACH Payment Request.

Error Payment PaymentType Non-payroll (PaymentClass <> PYNP) ACH Payment Requests cannot use PaymentTypes 00 or 01.

Non-payroll (PaymentClass <> PYNP) ACH Payment Requests cannot use PaymentTypes 00 or 01.

Error Payment PaymentType Payroll (PaymentClass = PYNP) ACH Payment Requests must use PaymentTypes 00 or 01.

Payroll (PaymentClass = PYNP) ACH Payment Requests must use PaymentTypes 00 or 01.

Error Payment PaymentType Invalid PaymentType - not compatible with PaymentClass

PaymentType value does not match the PaymentClass assigned to the ACH Payment Request. These PaymentTypes must be paired with their matching PaymentClass: 60 - WTIN, 61 - WTVA, 62 - WTWV, 63 - WTDC, 91 - WTPA, 92 - WTNJ, 93 - WTFD, 94 - WTPH, 95 - SCDU, 97 -

80


WTMD.Error Payment PayrollDeliveryBusinessArea Missing PayrollDeliveryBusinessArea

- required for payroll PaymentClass (PYNP)

Payroll (identified by having PaymentClass = PYNP) Checks and ACHs must have a valid entry in their PayrollDeliveryBusinessArea.

Error Payment PayrollDeliveryBusinessArea PayrollDeliveryBusinessArea is Invalid.

The PayrollDeliveryBusinessArea is not a valid department.

Error Payment PrintRemittance Invalid Yes/No value. PrintRemittance value must be Y or N .

Error Payment SeparatePayment Invalid Yes/No value. SeparatePayment value must be Y or N .

Error Advice <node> Advice has an invalid number of nodes for the LineType.

LineType AG must have one and only one node, CH must have zero to three nodes, TL must have zero or one node, and NL must have one to four nodes.

Error Advice LineType Missing Required value. LineType is required.Error Advice LineType Invalid LineType - must be AG, CH,

DL, TL or NL.The LineType must be set to one of the defined values.

Error Advice LineTypeSequenceNumber Missing Required value. LineTypeSequenceNumber is required.

Error Advice LineTypeSequenceNumber Invalid Advice LineTypeSeqNum. Sequence numbers must start at 1.

The LineTypeSequenceNumber must begin with 1 for all LineTypes assigned to a Payment Request.

Error Advice LineTypeSequenceNumber Duplicate Advice LineTypeSequence number within the LineType.

The LineType/LineTypeSequenceNumber combinations must be unique within each Payment Request.

Error Advice Text Advice Text value has an invalid number of characters for the LineType.

The AG, CH, DL, and TL LineTypes cannot have Text values > 80 characters while the NL LineTpye cannot have Text values > 40.

Error ACHAddenda <node> Withholding Tax Payments must have one and only one ACHAddenda node.

Withholding Tax Payments (identified by PaymentClass beginnng with WT) must have one and only one ACHAddenda node.

Error ACHAddenda <node> ACHAddenda count must be 1 for PaymentTypes in (60-63, 91-94, 97)

PaymentTypes 60 through 63 and 91 through 97 will not print Remittance Advice Statements. These Pay Types represent withholding tax payments or child support payments made to

81


government organizations and use Addenda rather than printed statements.

Error ACHAddenda <node> ACHAddenda cannot be included for SCDU payments.

PaymentClass SCDU is not permitted to have Addenda records. Treasury will construct the SCDU addenda using the values passed in the SCDU elements on the Item node.

Error ACHAddenda SequenceNumber Missing Required value. SequenceNumber is required.Error ACHAddenda Text Missing Required value. Text is required.Error ACHAddenda Text Addenda text cannot be blank The Addenda Text value cannot be

omitted or blank.Error ACHAddenda Text Invalid ASCII charater in the Addenda

Text fieldThe Addenda Text value must contain only valid ASCII characters (a-z, A-Z, 0-9, blank, -,),(,*,\,&,^,%,$,#,@,!,).

Error ACHAddenda Text Addenda must end with a backslash (\)

The Addenda Text value must be terminated with a backslash.

Error ACHAddenda Text Field delimiter - Asterisk is missing in Addenda

The Addenda Text value must contain an asterisk.

Error ACHAddenda Text Addenda must have 6 fields for MD, PA, WV tax payments.

The number of Addenda fields must be 6 for MD, WV and PA tax payments (PaymentClasses WTMD, WTWV and WTPA).

Error ACHAddenda Text Field 1 must be TXP The first field in the the withholding tax payment addenda must be TXP

Error ACHAddenda Text Field 2 must be 8 characters for MD, PA

The second field in the MD and PA withholding tax payment addenda must be the eight-digit MD Central Registration number or the eight-digit PA account number for withholding tax.

Error ACHAddenda Text Field 3 must be 01100 or 01101 for MD

The third field in the MD withholding tax payment addenda must be a tax type code of 01100 or 01101.

Error ACHAddenda Text Field 4 must be a date in YYMMDD format

The tax period ending date field in the withholding tax payment addenda must be the tax period ending date formatted as YYMMDD.

Error ACHAddenda Text Field 4 must be a date in YYYYMMDD format

The tax period ending date field in the withholding tax payment addenda

82


must be the tax period ending date formatted as YYYYMMDD (for IN tax payment PaymentClass = WTIN

Error ACHAddenda Text Field 5 must be T The fifth field in the withholding tax payment addenda must be T for all state tax payments (exclude WTFD since it is a federal tax payment)

Error ACHAddenda Text Field 5 must be 1 or the tax type code (3rd field)

The fifth field must contain the first IRS subcategory (=1) if applicable. If not, repeat the tax type code (applicable to PaymentClass WTFD only).

Error ACHAddenda Text Field 6 must be a 10-digit integer for FD, NJ, PA, PH

The sixth field in the withholding tax payment addenda must be the 10 digit amount withheld (include leading zeroes when necessary).Enter without dollar signs, commas, or a decimal point.

Error ACHAddenda Text Field 8 must be a 10 digit integer for FD when there is a 2nd IRS subcategory

The 8th field must contain the amount of withheld taxes associated with the 2nd IRS subcategory. If there is no second IRS subcategory, leave empty. Enter without dollar signs, commas, or a decimal point.

Error ACHAddenda Text Field 10 must be a 10 digit integer for FD when there is a 3rd IRS subcategory

The 10th field must contain the amount of withheld taxes associated with the 3rd IRS subcategory. If there is no third IRS subcategory, leave empty. Enter without dollar signs, commas, or a decimal point.

Error ACHAddenda Text Field 6 must be an integer for DC, IN, MD, VA, WV

The sixth field in the withholding tax payment addenda must be the amount withheld. Enter without dollar signs, commas, or a decimal point.

Error ACHAddenda Text Addenda must have 11 fields for DC, FD, NJ, VA tax payments.

The number of Addenda fields must be 11 for NJ, DC, VA and FD tax payments (PaymentClasses WTNJ, WTDC, WTVA and WTFD).

Error ACHAddenda Text Field 2 must be 13 characters for IN, NJ

The second field in the NJ and IN withholding tax payment addenda must be the thirteen-character Tax

83


Identification number.Error ACHAddenda Text Field 3 must be 01110 - 01170 for NJ The third field in the NJ withholding

tax payment addenda must be a tax type code of 01110, 01120, 01130, 01140, 01150, 01160, or 01170.

Error ACHAddenda Text Field 7 must be empty for IN, NJ The seventh field in NJ and IN withholding tax payment addenda must be empty.

Error ACHAddenda Text Field 8 must be empty for NJ The eigth field in NJ withholding tax payment addenda must be empty.

Error ACHAddenda Text Field 9 must be empty for NJ The ninth field in NJ withholding tax payment addenda must be empty.

Error ACHAddenda Text Field 10 must be empty for NJ The tenth field in NJ withholding tax payment addenda must be empty.

Error ACHAddenda Text Field 11 must be empty for FD The 11th field in FD withholding tax payment addenda must be empty.

Error ACHAddenda Text Addenda must have 9 fields for PH tax payments.

The number of Addenda fields must be 9 for PH tax payments (PaymentClass WTPH).

Error ACHAddenda Text Field 2 must be 7 characters for PH The second field in the PH withholding tax payment addenda must be the seven-digit Philadelphia tax account number.

Error ACHAddenda Text Field 3 must be 01 for PH The third field in the PH withholding tax payment addenda must be 01.

Error ACHAddenda Text Field 7 must be P for PH The seventh field in the PH withholding tax payment addenda must be P.

Error ACHAddenda Text Field 8 must be numeric for PH and must consist of 1 or 8 digits

The eighth field in the PH withholding tax payment addenda must be the amount of penalty and interest for the period. Field length must be 8 digits if there is an amount being paid so include leading zeroes. If no interest or penalty is being paid, this field should be 0 (just a single digit).

84


Error ACHAddenda Text Field 9 must be 4-digit period/year for PH

The ninth field in the PH withholding tax payment addenda must be the four digit period/year on the tax coupon. The first two digits are the tax period and the last two are the last two digits of the tax year.

Error ACHAddenda Text Field 3 must be EM340 for PA The third field in the PA withholding tax payment addenda must be EM340.

Error ACHAddenda Text Field 2 must be 9 digits for DC, FD The second field in the FD and DC withholding tax payment addenda must be the nine-digit Employer Identification number.

Error ACHAddenda Text Field 3 must be 5 characters for FD The third field in the FD withholding tax payment addenda must be the five-digit federal tax type code.

Error ACHAddenda Text Addenda must have 7 fields for IN tax payments.

ACHAddenda.Text with Class = WTIN: IN state tax witholding payments allow only 7 fields in the addenda with the last one being space filled.

Error ACHAddenda Text Field 2 must be 15 alphanumeric characters for VA

ACHAddenda.Text with PaymentClass = WTVA: VA taxpayer id value in second field of State tax payment addenda must be 15 alphanumeric characters.

Error ACHAddenda Text Field 3 must be 011 for IN ACHAddenda.Text with PaymentClass = WTIN: IN tax type code in 3rd field of State tax payment addenda must be 011.

Error ACHAddenda Text Field 3 must be 00011 for VA ACHAddenda.Text with PaymentClass = WTVA: VA tax type code in 3rd field of State tax payment addenda must be 00011.

Error ACHAddenda Text Field 3 must be 00300 for DC ACHAddenda.Text with PaymentClass = WTDC: DC tax type code in 3rd field of State tax payment addenda must be 00300.

Error ACHAddenda Text Field 7 must be empty, I or P for DC, VA

Value in 7th field of the DC and VA State tax payment addenda must be P or I or left empty.

Error ACHAddenda Text Field 7 must be empty or 2 for FD The seventh field contains the second

85


IRS subcategory (=2) if applicable. If not, leave empty (applicable to PaymentClass WTFD only).

Error ACHAddenda Text Field 8 must be populated for DC, VA when 7th field is I or P

The eigth field is to be omitted unless there is a P or I value in the seventh field. When the seventh field is I or P, it is required and contains the amount of interest or penalty to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

Error ACHAddenda Text Field 9 must be empty, I or P for DC, VA

Value in 7th field of the DC and VA State tax payment addenda must be P or I or left empty.

Error ACHAddenda Text Field 9 must be empty or 3 for FD The ninth field contains the third IRS subcategory (=3 if applicable. If not, leave empty (applicable to PaymentClass WTFD only).

Error ACHAddenda Text Field 10 must be populated for DC, VA when 8th field is I or P

The tenth field is to be omitted unless there is a P or I value in the eighth field. When the eighth field is I or P, it is required and contains the amount of interest or penalty to be reported for this period. Amounts are to be positive and entered without dollar signs, commas, or decimal points.

Error ACHAddenda Text Field 11 must be empty or a 1-6 character alphanumeric for VA

Eleventh field is optional for VA and when present is the taxpayer verification used by the receiver to verify the taxpayer’s transaction. It is a 1-6 character length alphanumeric.

Error ACHAddenda Text Field 11 must be empty or a 12-digit account number for DC beginning with "30".

Eleventh field is the taxpayer’s 12-digit account number assigned by OTR (DC Office of Tax and Revenue) which must begin with “30” when present. The field is only required if you file multiple returns in a tax period under the same FEIN. For example, if your organization has multiple locations and files a separate Withholding tax return for each

86


location the Account Number is required. However, if your organization files a consolidated return across all locations, the Account Number is not required.

Error ACHAddenda Text Field 2 must be 8, 9 or 12 characters for WV

ACHAddenda.Text with PaymentClass = WTWV: WV taxpayer id value in second field of State tax payment addenda must be 8, 9, or 12 digits (including leading zeroes).

Error ACHAddenda Text Field 3 must be 01170 for WV ACHAddenda.Text with PaymentClass = WTWV: WV tax type code in 3rd field of State tax payment addenda must be 01170.

Error Recipient <node> Missing Recipient node - required for single-pay payments

The Recipient node must be present for payment requests since all payment requests are processed as single-pay payments in the Treasury system.

Error Recipient City The Recipient.City must be valued for International wires.

The Recipient.City must be valued for International wires.

Error Recipient Country Invalid value. Country value must be a valid Country Code.

Error Recipient Country Missing Required value. Country is required.Warning Recipient Country The Recipient.Country must be

valued for International wires.The Recipient.Country must be valued for International wires.

Warning Recipient Country The Recipient.Country must match the EFTBeneficiary.Country for International wires.

The Recipient.Country must match the EFTBeneficiary.Country for International wires.

Error Recipient NameOne Missing Required value. NameOne is required.Warning Recipient NameOne Payee Name too short Payee name has less than 3

alphabetic charactersWarning Recipient NameOne The Recipient.NameOne must be

valued for International and Domestic wires.

The Recipient.NameOne must be valued for International and Domestic wires.

TBD Recipient NameOne Under development Invalid charater in the Recipient NameOne value.

TBD Recipient NameTwo Under development Invalid charater in the Recipient NameTwo value.

87


Error Recipient State Invalid value. State value must be a valid State Code for the Country Code.

Warning Recipient StreetAddressOne The Recipient.StreetAddressOne and Recipient.City must be valued for Dom wires to non-US recipients.

The Recipient.StreetAddressOne and Recipient.City must be valued for Domestic wires when the Recipient.Country is <> USA.

Warning Recipient StreetAddressOne The Recipient.StreetAddressOne must be valued for International wires.

The Recipient.StreetAddressOne must be valued for International wires.

TBD Recipient StreetAddressOne Under development Checks that are to be mailed by Treasury must have a mailing address provided on the Recipient node.

TBD Recipient StreetAddressOne Under development Mailing Address must be present for ACHS that are to be mailed by Treasury with a remittance advice.

Error EFTBeneficiary <node> Missing EFTBeneficiary node - required for single-pay EFT payments

The EFTBeneficiary node must be present for ACH and Wire payment requests since all EFT payment requests are processed as single-pay payments in the Treasury system.

Message EFTBeneficiary AgencyLocationCode The EFTBeneficiary.AgencyLocationCode must be valued for US Treasury wires.

The AgencyLocationCode must be specified for US Treasury Wire Payment Requests.

Error EFTBeneficiary BankAccountNumber Bank Account Num cannot be blank for an ACH or a Domestic/International Wire

The BankAccountNumer must be specified for ACH and Domestic and International Wire Payment Requests.

Error EFTBeneficiary BankAccountType Invalid Translate value. BankAccountType value must be 03 or SV.

Warning EFTBeneficiary BankAccountType The BankAccountType value cannot be blank for ACH Payment Requests.

The BankAccountType must be specified for ACH Payment Requests.

Warning EFTBeneficiary BankName All wires must provide an EFTBeneficiary.BankName value.

The BankName must be specified for Wire Payment Requests.

Warning EFTBeneficiary City The EFTBeneficiary.City must be valued for Domestic and International wires.

The City must be specified for Domestic and International Wire Payment Requests.

Error EFTBeneficiary Country Invalid value. Country value must be a valid Country Code.

Message EFTBeneficiary Country The EFTBeneficiary.Country must be valued for International wires.

The Country must be specified for International Wire Payment Requests.

88


Message EFTBeneficiary DFI The DFI value cannot be 0 or blank for ACH Payment Requests.

The DFI must be specified for ACH Payment Requests and cannot have a value of 0.

Message EFTBeneficiary DFI The DFI value must be populated for Domestic and US Treasury wires.

The DFI must be specified for Domestic and International Wire Payment Requests and cannot have a value of 0.

Error EFTBeneficiary DFI The DFI Value must be numeric and exactly 9 digits for DFI Qual = 01

The DFI Value must be numeric and contain exactly 9 digits when the DFI Qualifier is 01 (Transit Route Number). Leading zeroes are acceptable.

Error EFTBeneficiary DFIQualifier Invalid Translate value. DFIQualifier value must be 01 or 02.Warning EFTBeneficiary DFIQualifier The DFIQualifier must be 01 for

Domestic and US Treasury wires.The DFIQualifier must be 01 (Transit Routing Number) for Domestic and US Treasury wires.

Error EFTBeneficiary DFIQualifier The DFIQualifier value must be 01 for ACH Payment Requests.

The DFIQualifier value must be 01 (Transit Routing Number) for ACH Payment Requests.

Warning EFTBeneficiary DFIQualifier DFI Qualifier must be 02 for Intl Wires.

The DFIQualifier value must be 02 (SWIFT ID/BIC) for International Wire Payment Requests.

Error EFTBeneficiary FormatCode Invalid Translate value. FormatCode value must be CCD, CTX, PPD, or WRT.

Error EFTBeneficiary FormatCode ACH Payment Requests must have a FormatCode value of CCD, CTX, or PPD.

ACH Payment Requests must have a FormatCode value of CCD, CTX, or PPD.

Message EFTBeneficiary FormatCode Wire Payment Requests must have a FormatCode value of WRT.

All Wire Payment Requests must have a FormatCode value of WRT.

Error EFTBeneficiary FormatCode ACH Payment Requests having a FormatCode value of CCD or PPD can have no more than 1 ACHAddenda node

ACH Payment Requests having a FormatCode value of CCD or PPD are limited to a single Addenda if an Addenda is present.

Warning EFTBeneficiary IBAN Intl Wires destined to EU member country must have IBAN value

An IBAN value must be specified for International Wire Payment Requests destined to a Country that is a member of the EU.

Error EFTBeneficiary State Invalid value. State value must be a valid State Code for the Country Code.

89


Warning EFTBeneficiary State The EFTBeneficiary.State must be valued for Domestic wires.

The State must be specified for Domestic Wire Payment Requests.

Warning EFTBeneficiary StreetAddressOne The EFTBeneficiary.StreetAddressOne must be valued for International wires.

The StreetAddressOne must be specified for International Wire Payment Requests.

Error EFTBeneficiary TransactionHandling Invalid Translate value. TransactionHandling value must be D, P or X.

Error EFTBeneficiary TransactionHandling The TransactionHandling value cannot be blank for ACH Payment Requests.

The TransactionHandling must be specified for ACH Payment Requests.

Error EFTBeneficiary WireType Invalid Translate value. WireType value must be DW, IW, or TW.

Message EFTBeneficiary WireType Wire Payment Requests must populate the WireType element with one of the permitted values.

Wire Payment Requests must have a WireType value of DW, IW, or TW.

Error Item AdvancementAccountBusinessArea The AdvancementAccountBusinessArea must be populated when the ItemType is AC or AX.

The AdvancementAccountBusinessArea must be populated when the ItemType is AC or AX.

Warning Item AdvancementAccountBusinessArea The AdvancementAccountBusinessArea element should be omitted or blank if the PaymentClass <> ADVA.

The AdvancementAccountBusinessArea element should be omitted or blank if the PaymentClass <> ADVA.

Error Item AdvancementAccountCode The AdvancementAccountCode value cannot be blank or 0 for PaymentClass ADVA.

The AdvancementAccountCode value cannot be blank or 0 for PaymentClass ADVA.

Error Item AdvancementAccountCode The AdvancementAccountCode must be populated when the ItemType is AC or AX.

The AdvancementAccountCode must be populated when the ItemType is AC or AX.

Warning Item AdvancementAccountCode The AdvancementAccountCode element should be omitted or blank if the PaymentClass <> ADVA.

The AdvancementAccountCode element should be omitted or blank if the PaymentClass <> ADVA.

Warning Item AuditLookupId AuditLookupType and AuditLookupId must either both be present and populated or both be omitted.

AuditLookupType and AuditLookupId must either both be present and populated or both be omitted.

Error Item AuditLookupType Invalid Translate value. AuditLookupType value must be 05, AN, CL, CR, DL, IV, SA, or VT.

90


Error Item Issuer Issuer must be populated for Advancement Payments when the DocumentType is not ZF or AX.

Issuer must be populated for Advancement Payments when the DocumentType is not ZF or AX.

Error Item ItemAmount ItemAmount not equal to sum of Funding Amounts.

The sum of the Amount values on the Funding node must match the ItemAmount on the Item node.

Error Item ItemAmount Schema Violation if more than 3 fractional digits and Invalid number of decimal positions for currency if equal to 3 digits.


Error Item ItemDate Missing ItemDate - required when the ItemType is AC, AX, CM, DM, IV, or SU.

The ItemDate is required when the ItemType is AC, AX, CM, DM, IV, or SU.

Message Item ItemId ItemType and ItemId must either both be present and populated or both be omitted.

ItemType and ItemId must either both be present and populated or both be omitted.

Error Item ItemNumber Invalid Value - ItemNumber must be an integer between 1 and 99999

Invalid Value - ItemNumber must be an integer between 1 and 99999

Error Item ItemNumber Duplicate ItemNumber. Each ItemNumber within a Payment Request must be unique and sequentially numbered starting with 1.

Error Item ItemReference Missing ItemReference - required when the ItemType is IV

The ItemReference cannot be blank when the ItemType is IV.

Error Item ItemType Invalid Translate value. ItemType value must be AC, AX, CM, CN, DM, IV, PO, SU, or UP.

Error Item ItemType Invalid ItemType - must be AC for DocumentTypes AA, ZA, ZF and AX for DocumentType AX.

Invalid ItemType - must be AC for DocumentTypes AA, ZA, ZF and AX for DocumentType AX.

Error Item ItemType Invalid ItemType - must be SU for PaymentClass SCDU

The ItemType must be SU when the payment request's Payment Class is SCDU (SCDU Payment).

Error Item ItemType ItemType cannot be "SU" when PaymentClass is not "SCDU"

ItemType "SU" can only be used when the PaymentClass is "SCDU".

Error Item ItemType ItemType cannot be "AC" or "AX" when PaymentClass is not "ADVA"

ItemTypes "AC" and "AX" can only be used when the PaymentClass is "ADVA".

Error Item ItemType No more than one PO can be assigned to a PR when ItemType is PO.

A Payment Request can have no more than one PO number assigned to it.

91


Warning Item PayeeNameOne Missing PayeeNameOne - required when the PaymentClass = ADVA

The PayeeNameOne cannot be blank when the PaymentClass = ADVA.

Error Item SCDUEmploymentTerminated Invalid Yes/No value. SCDUEmploymentTerminated value must be Y or N .

Error Item SCDUFIPSCode Missing or invalid FIPSCode for SCDU payment to FL, MI, or NY

For SCDU PRs (PaymentClass = ‘SCDU’):1. If FIPS Code present, the value must be 5 or 7 alphanumeric characters.2. If Recipient.State is provided for the SCDU payment and is FL, MI, or NY, the FIPS Code must be present.

Error Item SCDUMedicalSupportIndicator Invalid Yes/No value. SCDUMedicalSupportIndicator value must be Y or N .

Error Item SCDUMedicalSupportIndicator Missing SCDUMedicalSupportIndicator - required when the ItemType is SU

The SCDUMedicalSupportIndicator cannot be blank when the ItemType is SU.

Error Item SCDUNoncustodialParentName Missing SCDUNoncustodialParentName - required when the ItemType is SU

The SCDUNoncustodialParentName cannot be blank when the ItemType is SU.

Error Item SCDUNoncustodialParentSSN Missing SCDUNoncustodialParentSSN - required when the ItemType is SU

The SCDUNoncustodialParentSSN cannot be blank or 0 when the ItemType is SU.

Warning SupportingDocument DocumentNumber The DocumentNumber value in SupportingDocument nodes must be sequenced starting with 1

The DocumentNumber on the SupportingDocument node is expected to begin with 1 for each Item node.

Error SupportingDocument Format Invalid Translate value. Format value must be XML or IMG.Error SupportingDocument Format Missing Required value. Format is required.Error SupportingDocument Type Invalid Translate value. Type value must be CN, GR, IV, or PO.Error SupportingDocument Type Missing Required value. Type is required.Error SupportingDocument URL Missing Required value. URL is required.TBD Funding <multiple> Under development The funding symbol must reference a

valid Chartfield combination. The symbol includes the Fund, Department, Appropriation, and Fiscal Year. Note that this is a composite validation performed on multiple elements.

Error Funding Account Accounts used by Payment Requests must be an expenditure account.

Accounts must begin with a "6" and must map to a valid Account.

92


Error Funding Account Invalid value. Account value must be a valid Account.

Error Funding Account Missing Required value. Account is required.Error Funding Amount Schema Violation if more than 3

fractional digits and Invalid number of decimal positions for currency if equal to 3 digits.


Error Funding Appropriation Invalid value. Appropriation value must be a valid Appropriation.

Error Funding Appropriation Missing Required value. Appropriation is required.Error Funding Department Invalid value. Department value must be a valid

Department.Error Funding Department Missing Required value. Department is required.Error Funding Department Multiple Funding Departments not

permitted.Payments requests must be funded by a single department.

Error Funding Department Department not valid for SourceSystemCode.

The Funding Department specified cannot be used by the submitting Source System.

Error Funding FiscalYear Missing Required value. FiscalYear is required.Error Funding Fund Invalid value. Fund value must be a valid Fund.Error Funding Fund Missing Required value. Fund is required.Error Funding FundingLineNumber Invalid Value - FundingLineNumber

must be an integer between 1 and 99999

Invalid Value - FundingLineNumber must be an integer between 1 and 99999

Error Funding FundingLineNumber Duplicate FundingLineNumber Each FundingLineNumber within an Item must be unique and sequentially numbered starting with 1.

Warning Funding FundingLineNumber Funding Line Number does not begin with 1

The FundingLineNumber on the Funding node is expected to begin with 1 for each Item node.

93