University of Illinois System

POST /foapalWS/services/validation/validateFoapalRules

Validates a FOAPAL Document against FOAPAL rules. A FOAPAL Document has one or more FOAPAL records and must include a document type code.

Valid document type codes

Code Description
CM Credit Memo
ENC Encumbrance
EOC Encumbrance Open/Close Document
FAA Fixed Assets Accounting Adjustments
INV Invoice
JV Journal Document
PO Purchase Order
REQ Requisition

Sample XML request

<?xml version="1.0" encoding="UTF-8"?>
<FoapalDocument>
  <documentTypeCode>JV</documentTypeCode>
  <FoapalRecord>
    <transDate>2016-06-20T12:00:00</transDate>
    <coasCode>1</coasCode>
    <fundCode>483259</fundCode>
    <orgnCode>992000</orgnCode>
    <acctCode>212210</acctCode>
    <progCode>191100</progCode>
    <bankCode>DB</bankCode>
    <ruleCode>210</ruleCode>
    <creditDebitInd>C</creditDebitInd>
  </FoapalRecord>
  <FoapalRecord>
    <transDate>2016-06-20T12:00:00</transDate>
    <coasCode>1</coasCode>
    <fundCode>200250</fundCode>
    <orgnCode>992000</orgnCode>
    <acctCode>212210</acctCode>
    <progCode>992011</progCode>
    <bankCode>DB</bankCode>
    <ruleCode>210</ruleCode>
    <creditDebitInd>D</creditDebitInd>
  </FoapalRecord>
</FoapalDocument>

Sample XML response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<FoapalResponse>
  <status>Valid</status>
</FoapalResponse>

Sample JSON request

{
   "documentTypeCode": "JV",
   "FoapalRecord": [
      {
         "transDate": "2016-05-19T12:00:00",
         "coasCode": "1",
         "fundCode": "800200",
         "orgnCode": "431000",
         "acctCode": "401000",
         "progCode": "191000",
         "bankCode": "DA",
         "ruleCode": "100",
         "creditDebitInd": "C"
      },
      {
         "transDate": "2016-05-19T12:00:00",
         "coasCode": "1",
         "fundCode": "900100",
         "orgnCode": "431000",
         "acctCode": "121700",
         "progCode": "191000",
         "bankCode": "DA",
         "ruleCode": "100",
         "creditDebitInd": "D"
      }
   ]
}

Sample JSON response

{
    "status": "Invalid"
    "msg": "Failed double FOAPAL rule #28"
}

HTTP Response Status Code

# Code Message
1 200 OK
2 500 Server error