Introduction
This guide describes the OECN State Software USAS SOAP service. This guide is intended for software developers interested in using SOAP to integrate with or add alternative interfaces to USAS.
This guide assumes basic familiarity with USAS and the USAS account coding scheme. It also assumes the reader is familiar with SOAP, XML and other related technologies.
Glossary
- DAS or DA Site - Data Acquisition Sites. This term is obsolete. OECN sites are now refered to as ITC's
- ITC - Information Technology Centers are regional data processing centers that provide computer services to member school districts. Among the services ITC's provide is hosting of the USAS application for school districts.
- OECN -
Ohio Education Computer Network - SSDT - State Software Development Team develops USAS, and other software, for school district on behalf of the Ohio Department of Education.
- USAS - Uniform School Accounting system. USAS refers to both the USAS software developed by the SSDT on behalf of the Ohio Department of Education, and the USAS accounting structure defined by the Ohio Auditors of State and Ohio Department of Education.
Status of this Document
This document is updated routinely to reflect the current version of the USAS SOAP service. Links to the latest version of this document can be obtained from the SSDT Public Wiki at https://wiki.ssdt-ohio.org/display/CTD/USAS+SOAP+Developers+Guide
Resources
This document does not represent the complete documentation for the USAS SOAP service. The actual API documentation is contained in the WSDL, the USAS XML Schema and the OECN RPC XML schema.
The WSDL and Schemas are distributed by the SSDT as part of the SOAP service installation kit. Vendors should contact the school district's ITC or the SSDT for the WSDL for currently supported versions. The current development version of the USAS SOAP service is available at: http://devel.ssdt.nwoca.org/usassoap/. The latest WSDL and Schemas are available on that page. The latest WSDL and Schemas are available at /wiki/spaces/rtd/pages/2753089.
| Note |
|---|
| title | Schema clarification: Requisitions |
|---|
|
The deliver to address lines on the Requisition are limited to 24 characters, not 30 as stated by the schema. The datatype for the deliver to address on the Requisition and the delivery address on the Purchase Order are the same, so we are unable to change the schema. |
...
Developers who need background documentation on USAS may wish to refer to the USAS User and Reference Manuals or the USAS System Managers Guide. This . These documents are available on-line at httphttps://ssdtmcoecn.oecn.k12.oh.us/projects/usas .Developers who have questions or need technical advice on integrating with the USAS webservice are encouraged to join the ssdt-usas-dev-l list. This list is operated by the SSDT to assist developers with integration issues. For subscription options and to view the archives, visit http://listserv.nwoca.org/cgi/wa.exe?A0=ssdt-usas-dev-l.atlassian.net/wiki/x/6oA2 .
Status of the USAS SOAP Service
The USAS SOAP service provides a limited subset of USAS functionality via a standards based SOAP service. See the WSDL for business functions supported by the service.
Standards Compliance
The SSDT believes that USAS SOAP service complies with the WS-I Basic Profile 1.0a WS-I Basic Profile 1.0a . The artifacts (definitions and messages) of the service have passed all assertions tested by the “WS-I Testing Tools v 1.0.1” provided by WS-I.
The SSDT believes that the WS-I BP 1.0a is the best solution to ensuring interoperability between various SOAP implementations. Developers wishing to use the USAS SOAP service are encouraged to use client tools that can support WS-I compliant services. Any developer detecting a WS-I compliance issue in the service artifacts is encouraged to contact the SSDT.
Test Accounts
Developers intending to integrate with USAS may not have access to a USAS server for development and testing. The SSDT can provide access to a test server for development and testing. The test server will always have the most recent released version of the web service. A user account can be provided which has access to a sample district database with limited test data.
Developers interesting in a test account , should send mail to smith@nwoca becher@ssdt-ohio.org with their request. Please include contact information, company and a brief description of your application and intended use.
USAS Service Architecture Overview
The USAS system is hosted on servers operated by individual ITC's for their member school districts. Each server hosts a USAS database for one or more school districts.
District Database Identification
Each database is identified by a "district code" or IRN. Some ITC's also support the use of NCES codes to identify district databases. After a SOAP client authenticates with the SOAP service, it must declare the district database on which it intends to operate. Alternatively, the SOAP client may query the service for the databases the user has access to and allow the user to select the district code.
SOAP Service Endpoints
Each ITC that supports the USAS SOAP service will provide one or more “SOAP endpoint” URL's for accessing the service for their districts. In most cases, a single endpoint will be used for all districts hosted by a given DA Site. However, in some cases, an ITC may provide a different endpoint for specific districts.
Most ITC Separate endpoints are used for each district.
SOAP Service Endpoints
A separate endpoint will be provided for each school district.
ITC's will provide an HTTPS (SSL) end-point can be used to encrypt SOAP messages on the wire. Developers are encouraged to use HTTPS when available. Each ITC decides whether HTTPS is available or required and may have other local security policies regarding from what networks SOAP connections are availableare required to use HTTPS for production instances.
Authentication and Authorization
When a client connects to the service, it must provide username and password credentials for an account on the ITC server. Usernames and access rights are administered by the DA Site ITC on behalf of the member district. The access rights and functions the account can perform are limited by rights granted by the ITC and any USAS security profiles established by the district.
...
A given user account on a USAS server may be granted access to one or more school district databases. Therefore, the ITC might provide a single account to access multiple districts, or a separate account for each district. If when a single account is used, the users rights in each district may vary based on the USAS profile established by the district (see USAS User Profiles below).
USAS User Profiles
The USAS SOAP service applies all business rules and security implemented by the USAS system. This includes per-district user profiles. User profiles are a feature of USAS that permit fine grained control over what functions a user is able to perform and which USAS budget accounts they can see or use in transactions. A school district can establish profiles that control what any user (including users of the SOAP service) are able to perform.
A developer need not have any special understanding of how USAS security works or how it is applied. The security is applied automatically by the server based on the security settings and profiles established on the server. However, faults can be returned if an operation is performed that the user account is not authorized to perform.
Assuming Profile of Another User
A special feature of the service allows a sufficiently privileged account to assume (or impersonate) the profile of another USAS user. If a SOAP client impersonates another profile, any operations it performs will be limited by the impersonated user’s profile.
...
When posting requisitions, the username used in the impersonation call will also be used as the "requisitioner" in USAS. This is currently true only for requisitions and not for any other data types.
Mapping Foreign Users to USAS Profiles by Convention
When assuming the role of another user, USAS does not interpret the username in any special way against a particular authentication source. USAS simply uses the profile name “as is” and looks for a corresponding profile.
...
| Info |
|---|
USAS user profile names are currently limited to 20 characters. Therefore, the naming convention must be devised to fit within this constraint. |
USAS SOAP Service Details
This section contains details of using the USAS SOAP service operations and parameters. Items in italics refer to operations (methods), parameters or element names provided used the service. See the WSDL or generated WSDL documentation for details for each operation, parameters and data types.
SOAP Sessions
The USAS SOAP service is a “statefull” service. The login _operation, upon successful authentication, establishes a new session and returns a _sessionId. The session retains a connection to the USAS server and context for subsequent invocations of the service. The client application must retain this session id and pass it as a parameter to subsequent invocations of the service.
...
- Invoke _login _operation with credentials for an account on the USAS server
- Optional: Invoke _getDistrictList _to return a list of districts the user as access to
- Optional for Redesign: Invoke _setDistrictAccess _to bind the session to a given district database
- Optional: Invoke assumeUserProfile to assume the profile of another user
After these steps are completed, the client may invoke any other USAS operation. The client may perform as many operations as necessary to perform its work. When the client is finished using the service, it should invoke the _logout _operation to cleanly close down the session.
It is important that the client invoke setDistrictAccess code to establish the district database to which the session is bound. This must be done exactly once after login and prior to any other USAS operation.
...
...
work. When the client is finished using the service, it should invoke the _logout _operation to cleanly close down the session.
After the database context is established, the client application may optionally invoke assumeUserProfile to impersonate the profile of a different USAS user. This operation will only succeed if the authenticated user is authorized to impersonate other users and if a suitable profile exists on the USAS server. The _assumeUserProfile _operation may be used multiple times for a given session.
Session Timeout
Sessions consume resources on both the SOAP server and the back-end USAS server. Therefore, inactivity timeouts apply to the SOAP sessions. The timeout interval is configurable by each DA Site ITC and defaults to approximately 45 minutes. If there is no activity for a session in during the timeout interval, the session will be deleted from the SOAP service. Any subsequent invocations using an expired sessionId will result in a fault being returned. Client applications that attempt to maintain long running connections, must be prepared to handle such faults.
Threaded Clients
The USAS SOAP service will accept multiple simultaneous requests for a given session. However, no guarantees are given regarding the order that the requests will be processed. Threaded client applications must use care if using a shared session, especially when using multiple invocations of _assumeUserProfile _with other operations.
For this reason, the SSDT recommends that threaded clients synchronize access such that only one thread performs operations for a given session. If multiple threads need to access the service simultaneously, it is preferable to have a separate session per thread, perhaps by maintaining a pool of active sessions.
XML Namespaces
Three distinct namespaces are used to define the service operations and parameters used by the service. These are described briefly below. See the SSDT web site for links to the WSDL and associated XML Schemas.
| Panel |
|---|
** | No Format |
|---|
http://xml.ssdt.nwoca.org/usas/ws |
* defines the implementation and interface for the SOAP service itself. It defines parameters and operations of the SOAP service. The type definitions for this name space are contained wholly within the WSDL document.
** | No Format |
|---|
http://xml.ssdt.nwoca.org/USAS/61 |
* defines the USAS data model (Vendors, Requisitions, Budget Accounts, etc). An XML schema is provided that defines the complex types. For certain important USAS data types, user defined types are specified with restrictions that define the allowable content. However, the XML schema does not attempt to express all restrictions imposed by USAS. The service may reject or, in some cases, truncate values that are outside USAS’s normal limits.
** | No Format |
|---|
http://xml.ssdt.nwoca.org/OECN-RPC/10 |
* defines complex types used generically by several SSDT products as part of the RPC (Remote Procedure Call) infrastructure. Many of the elements in this namespace are not relevant for the USAS service. The only element of any relevance for USAS developers is the response-msgs, which is used in custom faults to return additional error and warning details (See SOAP Faults below). |
See #Resources for links to the schemas.
SOAP Faults
The WSDL defines custom SOAP faults for application specific errors. The faults are defined to clearly indicate the type of “normal” faults the client should be expected to handle. For example, getBudgetAccount can throw an AccountNotFoundFault.
However, not all possible faults are defined by the WSDL. All operations are capable of returning generic SOAP faults that indicate general failures. Examples of general failures include: “SessionId not found” (perhaps due to a timeout), connection failures, security violations (the user is not authorized for the operation). The client application should be written to expect and handle both application specific faults and general SOAP faults. The client must not assume that the only faults are those defined by the WSDL.
UsasGeneralFault
UsasGeneralFault is the base fault from which all other application faults are extended. The operations return either UsasGeneralfault directly or a fault message extended from it.
...
Two other elements of UsasGeneralFault are also for convenience of clients that don’t wish to interpret the entire response-msgs _element. _UsasErrorMessage contains the text of the first message of the highest severity. Clients should use UsasErrorMessage, if only one message is to be displayed or logged. The _Severity _element is an enumerated element that contains the highest severity (Fatal, Error or Warning) of any message in the _response-msgs _element. The _Severity _can be regarded as the overall severity of the fault.
Qualified Success (Warning) Faults
In certain circumstances, USAS business rules require reporting one or more warning conditions as the result of a posting or validation operation. From a SOAP point of view, these faults are unusual because the fault does not indicate failure of the operation. Rather, the operation was successful but was qualified with warnings according to USAS business rules.
...
All cases where warning fault can occur are explicitly defined in the WSDL. A client application need only be concerned about a warning fault, if explicitly declared in the binding for the operation.
Auto-Assignment of Transaction Numbers
As of version 2.0 of the USAS SOAP service, most of the "posting" operations now support automatic assignment of transaction numbers. In previous versions, the application was required to determine the transaction number (e.g. purchase order number) before posting a new transaction.
In version 2.0, the transaction numbers are optional elements (may be omitted or empty). When the transaction number is not provided, the SOAP service will automatically assign the next available number.
Response Document
Prior to version 2.0, posting operations, such as "postNewPurchaseOrder", returned an empty ("void") response. In version 2.0, it will return the actual <PurchaseOrder> element as posted with the assigned transaction number. Therefore, the client application will be able to determine the number that was assigned to the new transaction.
The use of this new feature is optional. The client application may continue to assign transaction numbers, if desired. In either case, an instance of the posted element will be returned on "post" operations.
"Split" Items on Requisitions or Purchase Orders
USAS requisitions and purchase orders support "splitting" an item into multiple accounts, allowing it to be printed as one line on the requisition or purchase order but stored as multiple lines each charged to a separate account code.
...
There are 2 ways of combining items, splitting the quantity and splitting the price.
Splitting the Quantity
This type of split involves splitting the quantity of a particular item among several different account codes. The unit price must be the same for each item. For example:
...
| HTML Table |
|---|
|
| Table Row (tr) |
|---|
| Table Head (th) |
|---|
| Qty !! Description !! Price !! Account Code |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
Reading Books | $15.00 | 05 001 1100 521 0000 000000 001 00 000 |
|---|
|
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| $15.00 | 05 001 1100 521 0000 000000 005 00 000 |
|---|
|
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
|
|---|
| $15.00 | 05 001 1100 520 0000 000000 006 00 000 |
|---|
|
|
|
Resulting printed PO item:
| HTML Table |
|---|
|
| Table Row (tr) |
|---|
| Table Head (th) |
|---|
| Qty !! Description !! Price !! Total |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
Reading Books | $15.00 | $3,750.00 |
|---|
|
|
|
Splitting the Price
This type of split involves splitting the price of a particular item among several different account codes. The quantity field must be 1 for the combined item and zero for the split items.
...
| HTML Table |
|---|
|
| Table Row (tr) |
|---|
| Table Head (th) |
|---|
| Qty !! Description !! Price !! Account Code |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
Color Printer | $250.00 | 05 001 2411 740 0000 000000 060 00 000 |
|---|
|
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
|
|---|
| $275.00 | 05 001 2421 640 0000 000000 010 00 000 |
|---|
|
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
|
|---|
| $300.00 | 05 001 2411 740 0000 000000 030 00 000 |
|---|
|
|
|
Resulting printed PO item:
| HTML Table |
|---|
|
| Table Row (tr) |
|---|
| Table Head (th) |
|---|
| Qty !! Description !! Price !! Total |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
Color Printer | $825.00 | $825.00 |
|---|
|
|
|
Usage of "<SplitTag>"
In the requisition or purchase order xml document, the tag <SplitFlag> is required to be included as a part of the <item> information for both the combined and split items. The following values are accepted:
| Panel |
|---|
<SplitFlag>Combined</SplitFlag>
<SplitFlag>Split_Price</SplitFlag>
<SplitFlag>Split_Quantity</SplitFlag> |
Restrictions
There must always be a "Combined" item first, immediately followed by one or more "Split_Price" or one or more "Split_Quantity" items. There cannot be both "Split_Price" and "Split_Quantity" items associated with the same "Combined" item.
...
The quantity field must be 1 for the "Combined" item and zero for all "Split_Price" items.
Appendixes
Fault Message Codes
The table below defines response message codes returned by the USAS SOAP service faults. The codes define the nature of the fault in greater detail.
...
| HTML Table |
|---|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | <u>Category</u> |
| Table Cell (td) |
|---|
| | <u>Code</u> |
| Table Cell (td) |
|---|
| | <u>Description</u> |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Common Messages |
| Table Cell (td) |
|---|
| | INVALIDXMLDATA |
| Table Cell (td) |
|---|
| | An incorrect tag was found, or XML document not in expected format. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | KEYNOTPROVIDED |
| Table Cell (td) |
|---|
| | The key field is blank or zero. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | ALREADYONFILE |
| Table Cell (td) |
|---|
| | The key is already on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDFUNCTION |
| Table Cell (td) |
|---|
| | An invalid 'function' tag value is present. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDOPERATION |
| Table Cell (td) |
|---|
| | An invalid 'operation' tag value is present |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | RECORDNOTFOUND |
| Table Cell (td) |
|---|
| | The record or records being read or searched for were not found. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDDATE |
| Table Cell (td) |
|---|
| | The date is invalid or not in the correct range. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | FILEOPENINPUTFAIL |
| Table Cell (td) |
|---|
| | A data file failed to open for input. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | FILEOPENIOFAIL |
| Table Cell (td) |
|---|
| | A data file failed to open for I/O. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | A protection violation occurred when trying to open a data file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Account Balances |
| Table Cell (td) |
|---|
| | CASHNEGFUND |
| Table Cell (td) |
|---|
| | Negative fund balance for cash account. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | CASHNEGREMAIN |
| Table Cell (td) |
|---|
| | Negative remaining balance for cash account. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | CASHNEGBALLESSPAY |
| Table Cell (td) |
|---|
| | Negative cash balance less payables for cash account. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | APPNEGREMAIN |
| Table Cell (td) |
|---|
| | Negative remaining balance for appropriation account. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | BUDNEGREMAIN |
| Table Cell (td) |
|---|
| | Negative remaining balance for budget account. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | APPNEGNEXTYEAR |
| Table Cell (td) |
|---|
| | Negative next year balance for appropriation account. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | BUDNEGNEXTYEAR |
| Table Cell (td) |
|---|
| | Negative next year balance for budget account. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Invalid Accounts |
| Table Cell (td) |
|---|
| | NOACCOUNTACCESS |
| Table Cell (td) |
|---|
| | Access to given Account is denied. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | ACCTNOTACTIVE |
| Table Cell (td) |
|---|
| | Account is not active. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | CASHACCTNOTFOUND |
| Table Cell (td) |
|---|
| | Cash Account was not found on file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | APPACCTNOTFOUND |
| Table Cell (td) |
|---|
| | Appropriation Account was not found on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | BUDACCTNOTFOUND |
| Table Cell (td) |
|---|
| | Budget Account was not found on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REVACCTNOTFOUND |
| Table Cell (td) |
|---|
| | Revenue Account was not found on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDTRANSIND |
| Table Cell (td) |
|---|
| | Invalid Transaction Indicator. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDFUNCTION |
| Table Cell (td) |
|---|
| | Invalid Function Code. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDRECEIPT |
| Table Cell (td) |
|---|
| | Invalid Receipt Code. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Account I/O |
| Table Cell (td) |
|---|
| | BUDACCTWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of Budget Account failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REVACCTWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of Revenue Account failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | CASHACCTREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of Cash Account failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | APPACCTREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of Appropriation Account failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | BUDACCTREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of Budget Account failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REVACCTREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of Revenue Account failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | VENDORNOTFOUND |
| Table Cell (td) |
|---|
| | Vendor number was not found or is invalid. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | VENDORNOTACTIVE |
| Table Cell (td) |
|---|
| | Vendor is not active. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | VENDORISMULTIVENDOR |
| Table Cell (td) |
|---|
| | Vendor is a Multi-Vendor. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | VENDORREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of Vendor record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | VENDORDIFFPO |
| Table Cell (td) |
|---|
| | Vendor number provided is different from Vendor on the Purchase Order. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | General Transaction |
| Table Cell (td) |
|---|
| | ITEMOVERFLOW |
| Table Cell (td) |
|---|
| | The maximum allowable number of items per transaction was exceeded. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Requisitions |
| Table Cell (td) |
|---|
| | INVALIDREQNUMBER |
| Table Cell (td) |
|---|
| | Requisition number supplied is not valid or is already on file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | REQNOTFOUND |
| Table Cell (td) |
|---|
| | Requisition was not found on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | NOASSOCIATEDITEMS |
| Table Cell (td) |
|---|
| | There were no item records posted for this Requisition. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REQWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of Requisition record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | REQDELONERECORD |
| Table Cell (td) |
|---|
| | Only one record is permitted when performing a delete operation. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REQACCESSDENIED |
| Table Cell (td) |
|---|
| | Access is denied to the Requisition. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REQALREADYPOSTED |
| Table Cell (td) |
|---|
| | Requisition already converted to a Purchase Order. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REQDELETEFAIL |
| Table Cell (td) |
|---|
| | Deletion of Requisition record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | GENERICBADLOCATION |
| Table Cell (td) |
|---|
| | The generic record type did not precede all other records in batch. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Purchase Orders |
| Table Cell (td) |
|---|
| | INVALIDPONUMBER |
| Table Cell (td) |
|---|
| | The Purchase Order number supplied is not valid or is already on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDDESCLINE |
| Table Cell (td) |
|---|
| | The Purchase Order Description line number is not valid or is already on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDDESCTYPE |
| Table Cell (td) |
|---|
| | The Purchase Order Description Type field is not valid. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | PONOTFOUND |
| Table Cell (td) |
|---|
| | Purchase Order was not found on file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | POITEMNOTFOUND |
| Table Cell (td) |
|---|
| | Purchase Order Item was not found on file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | POHISTWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of POHIST record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | POHISTREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of POHIST record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | POHISTDELETEFAIL |
| Table Cell (td) |
|---|
| | Deletion of POHIST record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | POITEMWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of POAMT record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | POITEMREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of POAMT record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | POITEMDELETEFAIL |
| Table Cell (td) |
|---|
| | Deletion of POAMT record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | PODESCWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of PODESC record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | PODESCDELETEFAIL |
| Table Cell (td) |
|---|
| | Deletion of PODESC record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | PODESCREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of PODESC record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | FUTPODELETEFAIL |
| Table Cell (td) |
|---|
| | Deletion of FUTPO record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | ZEROQUANTITY |
| Table Cell (td) |
|---|
| | Purchase Order item quantity must not equal zero. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOCHANGEKEY |
| Table Cell (td) |
|---|
| | The key cannot be changed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Combined Items |
| Table Cell (td) |
|---|
| | QUANTITYNONZERO |
| Table Cell (td) |
|---|
| | Quantity did not equal zero for split-price item. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | PRICENOTEQUAL |
| Table Cell (td) |
|---|
| | Price is not equal for all split-quantity items. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | COMBINEDPRECEDESPL<span >IT</span> |
| Table Cell (td) |
|---|
| | A combined item did not precede split item. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDSPLITFLAG |
| Table Cell (td) |
|---|
| | The Split Flag field is not valid. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | QUANTITYNOTONE |
| Table Cell (td) |
|---|
| | The quantity does not equal one for a split-price item. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | DESCEQUALDASH |
| Table Cell (td) |
|---|
| | The description field does not equal a dash for split items. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Change Orders |
| Table Cell (td) |
|---|
| | NOCHANGEDATEPRIORY<span >R</span> |
| Table Cell (td) |
|---|
| | The Purchase Order date may not be changed on a Purchase Order from a prior fiscal year. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Only new, partially filled or partially paid Purchase Orders may be amended. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOCHANGEDATEAMEND<span >ED</span> |
| Table Cell (td) |
|---|
| | The date cannot be changed on a Purchase Order that has already been amended. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOCHANGEVENDOR |
| Table Cell (td) |
|---|
| | The Vendor cannot be changed because there is an associated invoice or the PO status is not new. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | ISSUELESSTHANPODAT<span >E</span> |
| Table Cell (td) |
|---|
| | An item's Issue Date must not be before the Purchase Order date. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDACCTMOD |
| Table Cell (td) |
|---|
| | The account code may not be changed on an existing Purchase Order item. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDQUANTMOD |
| Table Cell (td) |
|---|
| | The quantity may not be changed on an existing Purchase Order item. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDPRICEMOD |
| Table Cell (td) |
|---|
| | The price may not be changed on an existing Purchase Order item. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | NOCANCELCOMBINED |
| Table Cell (td) |
|---|
| | You cannot cancel a combined item without canceling all of the associated split items. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDAMENDMENT |
| Table Cell (td) |
|---|
| | Invalid amendment record or original Purchase Order item was not found. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Purchase Order Del<span >ete</span> |
| Table Cell (td) |
|---|
| | PODELETEONERECORD |
| Table Cell (td) |
|---|
| | Only one record is permitted when deleting a Purchase Order. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | POSTATUSNOTNEW |
| Table Cell (td) |
|---|
| | Purchase Order status is not new, cannot be deleted. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | ASSOCINVCKNODELETE |
| Table Cell (td) |
|---|
| | There is an associated Invoice or Check, Purchase Order cannot be deleted. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | ASSOCCANINVEXIST |
| Table Cell (td) |
|---|
| | There is an associated 'cancel' Invoice. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDINVNUMBER |
| Table Cell (td) |
|---|
| | Invoice number supplied is not valid or is already on file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVOICENOTFOUND |
| Table Cell (td) |
|---|
| | Invoice number was not found on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVOICEWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of INAMT record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVOICEREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of INAMT record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVPAYNOTFOUND |
| Table Cell (td) |
|---|
| | INVPAY record was not found on file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVPAYWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of INVPAY record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVPAYDELETEFAIL |
| Table Cell (td) |
|---|
| | Deletion of INVPAY record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | AMOUNTSBOTHNEGORP<span >OS</span> |
| Table Cell (td) |
|---|
| | Remaining encumbered amount and invoice amount must be both negative or both positive. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDINVSTATUS |
| Table Cell (td) |
|---|
| | Invalid Invoice status. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | CANCELEXCEEDSENC |
| Table Cell (td) |
|---|
| | The canceled amount exceeds the remaining encumbrance amount. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | POITEMCOMPFILLED |
| Table Cell (td) |
|---|
| | Invoice cannot be posted because Purchase Order item is already completely filled. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDCHECKNUMBER |
| Table Cell (td) |
|---|
| | Check number supplied is not valid or is already on file. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | CHECKWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of Check record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | CHECKREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of Check record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | CHECKITEMWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of Check Item failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | NEGATIVECHECK |
| Table Cell (td) |
|---|
| | The check to be created will be a 'negative check'. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOUPDATEHIGHCHECK |
| Table Cell (td) |
|---|
| | The highest Check number on file was not updated. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOPOSTPAYWITHOUTPO |
| Table Cell (td) |
|---|
| | Cannot post a payroll check without posting Purchase Order. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOPOSTCHECKWOUTPO<span >INV</span> |
| Table Cell (td) |
|---|
| | Cannot post a check without posting Purchase Order and Invoice. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOPOSTCHECKINVC |
| Table Cell (td) |
|---|
| | Cannot post a check when the Invoice status is 'Canceled'. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | FINALMONTHCLOSE |
| Table Cell (td) |
|---|
| | Final month closed, but fiscal year is not. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOPENDINGINVOICE |
| Table Cell (td) |
|---|
| | No associated pending invoice was found for selection. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NOSELECTIONSMADE |
| Table Cell (td) |
|---|
| | No invoices were selected for processing. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | COLLAPSESETPROMPT |
| Table Cell (td) |
|---|
| | The collapse check items flag is set to 'prompt', instead of Y or N. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDRCPTNUMBER |
| Table Cell (td) |
|---|
| | Receipt number supplied is not valid or is already on file. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | RECEIPTWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of Receipt record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | RECEIPTREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of Receipt record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | RECEIPTDELETEFAIL |
| Table Cell (td) |
|---|
| | Deletion of Receipt record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | No items associated with Receipt record. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | USASDATREWRITEFAIL |
| Table Cell (td) |
|---|
| | Update of USASDAT record failed. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVENTWRITEFAIL |
| Table Cell (td) |
|---|
| | Creation of INVENT record failed. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Invalid Dates |
| Table Cell (td) |
|---|
| | INVALIDPODATE |
| Table Cell (td) |
|---|
| | Purchase Order date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDPAYDATE |
| Table Cell (td) |
|---|
| | Payroll date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDINVDATE |
| Table Cell (td) |
|---|
| | Invoice date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDPAYDUEDATE |
| Table Cell (td) |
|---|
| | Payment Due date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDCHECKDATE |
| Table Cell (td) |
|---|
| | Check date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INVALIDISSUEDATE |
| Table Cell (td) |
|---|
| | Issue Date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDRCVDDATE |
| Table Cell (td) |
|---|
| | Received date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDRCPTDATE |
| Table Cell (td) |
|---|
| | Receipt date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDREQDATE |
| Table Cell (td) |
|---|
| | Requisition date is invalid or not in proper processing period. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDDELDATE |
| Table Cell (td) |
|---|
| | Delivery date is invalid. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | AUTOPOST General |
| Table Cell (td) |
|---|
| | NOTALLFILESAVAIL |
| Table Cell (td) |
|---|
| | Not all USAS files were available for exclusive access. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | NORECORDSINBATCH |
| Table Cell (td) |
|---|
| | No batch records were found in the batch. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | RECNUMNOTNUMERIC |
| Table Cell (td) |
|---|
| | Record number is not numeric. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | REFNUMNOTNUMERIC |
| Table Cell (td) |
|---|
| | Reference number is not numeric. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Inconsistent Data |
| Table Cell (td) |
|---|
| | INCONSISTENTVENDOR |
| Table Cell (td) |
|---|
| | Vendor number field is not consistent. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INCONSISTENTPOFLAG |
| Table Cell (td) |
|---|
| | Purchase Order posting flag is not consistent. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INCONSISTENTCHECKFL<span >G</span> |
| Table Cell (td) |
|---|
| | Check posting flag is not consistent. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INCONSISTENTREFDATE |
| Table Cell (td) |
|---|
| | Refund date field is not consistent. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INCONSISTENTCREATE |
| Table Cell (td) |
|---|
| | Check create flag is not consistent. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INCONSISTENTCHECK |
| Table Cell (td) |
|---|
| | Check number is not consistent. |
|
| Table Row (tr) |
|---|
| | | Table Cell (td) |
|---|
| | INCONSISTENTCHECKDT |
| Table Cell (td) |
|---|
| | Check date is not consistent. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | Invalid Numerics |
| Table Cell (td) |
|---|
| | POITEMNOTNUMERIC |
| Table Cell (td) |
|---|
| | Purchase Order item number is not numeric. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | QUANTNOTNUMERIC |
| Table Cell (td) |
|---|
| | Quantity field is not numeric. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | PRICENOTNUMERIC |
| Table Cell (td) |
|---|
| | Price field is not numeric. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVAMTNOTNUMERIC |
| Table Cell (td) |
|---|
| | Invoice Amount field is not numeric. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | AMOUNTNOTNUMERIC |
| Table Cell (td) |
|---|
| | Amount is not numeric. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | INVALIDNUMERIC |
| Table Cell (td) |
|---|
| | Field is not numeric. |
|
| Table Row (tr) |
|---|
| Table Cell (td) |
|---|
| | <span ></span> |
| Table Cell (td) |
|---|
| | <span ></span> |
| Table Cell (td) |
|---|
| | <span ></span> |
|
|
...