Update Special Forms Definition - ARSPSF
The Accounts Receivable (AR) module contains a Special Forms (ARSPSF) page that allows for custom development for invoices, billing statements, late notices, and cash receipt formats. The same page is used to define each of these types of formats, using a unique Report ID to identify each specific definition.
The Report ID is the common element that ties all three tabs of this page together. Along with the report Description, the Report ID is displayed at the top of the page, sub-dividing the various elements of the definition into three components: Global Information, Page Layout, and Overflow Action.
Header
Report ID: Enter up to eight-characters that will uniquely identify the form. Generally, there are requirements to the naming convention of the Report ID depending on the nature of the form, which are as follows:
Billing Statements: SPFMxxBL, where xx is the two-character billing stock ID (i.e., SPFMARBL).
Invoices: SPFMARxx, where xx is the two-character invoice stock ID (i.e., SPFMARIN).
Cash Receipts: SPFMCRxx, where xx is the two-character cash receipt format (i.e., SPFMCR01). These Cash Receipt formats are not used in the AR Interactive Cash Receipts (ARBTCRIC) page.
Description: Enter a special form description.
Global Information Tab
Each special form has a single record of Global Information. This tab contains information related to the special form definition as a whole, as well as definition elements that may be used in the Page Layout section.
Forms Message: A one-line message that displays on the page.
Mount Message: The message that can be presented at the system console when mounting forms on a line printer.
Control Number: Reserved for future use.
Row: Reserved for future use.
Col: Reserved for future use.
Void Starters: The number of void starters to print before printing actual data on the forms. This is used to help with alignment issues when using a line printer.
Page Length: A vertical measurement that indicates the number of rows from the top to the bottom of the page.
Page Width: A horizontal measurement that indicates the number of columns that span the width of the page.
Region: A Region is a user-defined range of rows or lines that will be dedicated to a "Type" of data. There can be up to four regions defined in the special form. Each region indicates an area of the form where data will be repeated, for example, detailed transactional activity or text. An alphabetic character that will describe this particular region (i.e., A, B, T, etc.).
Row Range: The starting and ending rows (vertically) on the page where the specified region will display information.
Column: The column on the page where the region information will begin to print.
Type: The region type. There are two primary region types, "TR" (for Transaction) and "TX" (for Text information).
Space: A numerical value to indicate the spacing between detail lines within the region. For example, the value "1" will insert a single blank line between the detail lines. The default (blank) is zero.
Open: Reserved for future use.
Page Layout Tab
The Page Layout information defines the actual body of the special form being created.
Sequence Number: This value is used to sort and order the various elements that are part of the Page Layout. In most cases, the sequence does not matter, but there are situations where this can be valuable.
Item Name: Enter a specific attribute that denotes an element of a database record or a reserved word. A complete list of these attributes and reserved words is listed at the end of this document.
Constant: Use this field to print literal text on the special form in a particular location. Each Page Layout record must have either an Item Name or Constant. The tilde (~) character in this field is interpreted as an Escape character (ASCII 027), which is useful with specific printer directives, such as initiating an ELF form. Additionally, unprintable HEX characters can also be entered in this field by using the format nnn, where nnn is the HEX value.
Page: The value in this field indicates the page on which this row of information is to be printed. Along with entering any specific page number, the following values are available: F – First page only, L – Last page only, and E – Every page. If left blank, the default is "E".
Row: Enter the specific Row number to print the Item or Constant, or specify a Region, as defined in the Global Info tab.
Column: Enter the Column to begin printing the Item or Constant.
Length: Enter the desired Length for the printed data.
Just: Used to specify the data justification: R – Right, L – Left, C – Center, A - All.
Sign: Specifies if the amount sign should be flipped. Code values are restricted to static system codes: N – Do not flip sign, D – Flip sign on transactions, T – Flip sign on totals, B – Flip sign on both.
Round: For item amounts, enter the number of decimals (1-5) for rounding.
Zero: If checked, item amounts with the value of zero will print a zero; otherwise, a blank will be displayed.
Total: Designate the amount tied to this item to be added into a specific accumulated total (1-9).
IF Code: This value sets conditions for when/if the data will print. Valid options are AR, CR, POS, NEG, ARSUM, ARPOS, ARNEG, CRSUM, CRSUMINV, CRPOS, CRNET, GZERO, NZERO, ZERO, and PPINDX1.
Clear: When processing this item, the specified Total will be cleared (reset).
Overflow Action Tab
The purpose of the Overflow Action information is to allocate both an area and the actual text that will print whenever multiple pages are necessary to print a particular Invoice, Statement, or Receipt.
Sequence Number: This value is used to sort and order the various elements that are part of the Overflow Action.
Text: Enter up to 40 characters defining the explicit text to print should an overflow occur. Separate text can be set up for the three different overflow conditions: First page overflow, Middle page overflow, and Last page overflow, as denoted in the check box fields.
Row Start: Used to specify the page Row in which to start printing the overflow text.
Row End: Used to specify the page Row in which to stop printing the overflow text. Typically, there is just a single row of overflow text, in which case the Row Start and Row End values are identical.
Column: Enter the column in which to begin printing the overflow text.
First: If checked, the associated text on the First page of the Invoice, Statement, or Receipt.
Middle: If checked, the associated text will print on all Middle pages. This, of course, only applies to Invoices, Statements, or Receipts where more than two pages per customer are printed.
Last: If checked, the associated text will print on the Last page of the Invoice, Statement, or Receipt.
Item Attributes and Reserved Words
The following is a list of Attributes and Reserved Words that can be used when entering an ITEM in the Page Layout tab. These attributes map to specific database elements that are part of either the Accounts Receivable or Person/Entity information database.
Account Information |
|
ID | Account ID |
NAME | Account Name |
ACATG# | Account Category (1-6) |
ABAL | Account Balance |
AADJBAL | Account Adjusted Balance |
ASTAT | Account Status |
ANUM# | Account Category Numeric (1-6) |
AFULL | Account Full Time Flag |
AGRAD | Account Grad Flag |
AEXTID | Account External ID |
Primary Information |
|
PNAME | Primary Name (Last, First) |
PNAMER | Primary Name Reversed (First Last) |
PCAREOF | Primary Care Of (same as PADDR1) |
PSTREET | Primary Street (same as PADDR2) |
PADDR# | Primary Address (Lines 1-4) |
PCITY | Primary City |
PSTATE | Primary State |
PZIP | Primary Zip |
PCSZ | Primary City, State Zip |
PCOUNTRY | Primary Country |
PCONTACT | Primary Contact |
PSSN | Primary Social Security Number |
PTIN | Primary Tax ID Number |
PNICKNM | Primary Nickname |
Third Party Billing Info |
|
ANAME | Third-Party Name (Last, First) |
ANAMER | Third-Party (First Last) |
AADDR# | Third-Party Address (Lines 1-4) |
ACITY | Third-Party City |
ASTATE | Third-Party State |
AZIP | Third-Party Zip |
ACSZ | Third-Party City, State Zip |
ACOUNTRY | Third-Party Country |
ACONTACT | Third-Party Contact |
ASSN | Third-Party Social Security Number |
ATIN | Third-Party Tax ID Number |
ANICKNM | Third-Party Nickname |
Transaction Information |
|
TERM | Term |
PROJ | GL Account Key |
ACCT | GL Account Key |
GLKEY | GL Account Key |
OBJ | GL Object Code |
GLOBJ | GL Object Code |
JOB | Job Key |
JLKEY | Job Key |
FAREA | Job Object |
JLOBJ | Job Object |
DIV | Division |
POSTCD | Posting Code |
ARREF | Invoice Number |
CRREF | Cash Receipt Number |
WO | Work Order Number |
DESC | Description |
FINCD | Finance Code |
MISC | Miscellaneous Code |
BTCH | Batch ID |
PREP | Prep ID |
JOBNO | Job Number |
TRTYPE | Transaction Type |
PPNDX | Payment Plan Index |
PYTYPE | Payment Type |
PYREF | Payment Reference |
BANKID | Bank ID |
BANKSL | Bank Deposit Slip |
BANKDT | Bank Deposit Date |
BILLDT | Bill Date |
DUEDT | Due Date |
UNITS | Units |
QTY | Quantity |
PRODID | Product ID |
REFDT | Reference Date |
DISCAMT | Discount Amount |
AMT | Transaction Amount |
FCAMT | Foreign Currency Amount |
CURRCD | Currency Code |
MSUR | Unit of Measure |
ITEMNO | Count of Transactions |
UNITAMT | Unit Price |
CCEXP | Credit Card Expiration |
CCAUTH | Credit Card Authorization |
POREF | PO Reference |
SRCID | Source ID or Item Number |
TAXAMT | Tax Amount |
TAXAMT2 | Tax Two Amount |
TAXCD | Tax Code |
TAXCD2 | Tax Two Code |
DUTYAMT | Duty Amount |
DUTYCD | Duty Code |
DISCTERM | Discount Terms |
RELONE | Relate Code One |
RELTWO | Relate Code Two |
CHARGEAM | Charge Amount |
CHARGECD | Charge Code |
RETAILAM | Retail Amount |
ADDRCD | Address Code |
SEPFLAG | Separate Billing Flag |
POSTDT | Post Date |
Text Information |
|
LITEXT | Line Item Text |
RFTEXT | Reference Text |
TEXT | Generic Text (Selection Class) |
GL/JL Additional Info |
|
FKEY | Fund Key |
FUNDDESC | Fund Description |
PROJDESC | Org Key Description |
OBJDESC | Object Code Description |
JOBDESC | Job Key Description |
FAREADSC | Job Object Description |
GLKP# | GL Key Part (1-8) |
GLKP#DES | GL Key Part Description (1-8) |
FYEAR | Fiscal Year |
FYMONTH | Fiscal Month |
FYPERIOD | Fiscal Period |
AR Codes Additional Info |
|
TERMDSC | Term Description |
TERMDSCL | Long Term Description |
DIVDSC | Division Description |
DIVDSCL | Long Division Description |
FINDSC | Finance Code Description |
FINDSCL | Long Finance Code Description |
MISCDSC | Miscellaneous Code Description |
MISCDSCL | Long Misc Code Description |
PAYTDSC | Payment Type Description |
PAYTDSCL | Long Payment Type Description |
Organization / User Info |
|
CLNAME | Organization Name |
USERID | IFAS User ID |
USERNM | User Name |
USERDS | User Description |
USERLC | User Location Code |
USERMC | User Manager Code |
USERMCDS | Manager Code Short Description |
USERMCDM | Manager Code Medium Description |
USERMCDL | Manager Code Long Description |
USERMCNM | Manager Code Formal Name |
USERMCPH | Manager Code Phone Number |
USERMCA# | Manager Code Address Line (1-3) |
TIMEIN | Logon Time |
LDEV | Terminal Device Number |
Miscellaneous Information |
|
BILLDUE | Due Date given at Billing Time |
STATEDT | Billing Date given at Statement Time |
BLFWDDT | Balance Forward Date |
BLFWDAR | Balance Forward Charges |
BLFWDCR | Balance Forward Payments |
BLFWDNET | Balance Forward Net |
DETAILAR | Total Detail Charges |
DETAILCR | Total Detail Payments |
DETAILDB | Total Detail Debits |
DETAILCC | Total Detail Credits |
ACCTDB | Total Account Debits |
ACCTCR | Total Account Credits |
ACCTNET | Total Account Net |
DUEPREV | Total Due Prior to Billing Date |
DUECURR | Total Due on Billing Date |
DUELATER | Total Due after Billing Date |
DUENOW | Total Due as of the Billing Date |
TTLAR | Total Charges for Type |
TTLCR | Total Payments for Type |
FUTURED | Future Due |
FUTURET | Future Total |
ACCTNETD | Account Net Due |
TTL# | Special Forms Acct Totals (0-9) |
PAGENO | Page Number |
INVPGNO | Invoice Page Number |
DATE | Current Date |
TIME | Current Time |
AGE# | Aging Bucket (10-1) |
INV | Invoice Number |
INVAMT | Invoice Total |
INVDT | Invoice Date |
INVPAMT | Invoice Total Payments |
INVPDT | Invoice Date of Last Payment |
INVNET | Net of INVAMT and INVPAMT |
INVDUE | Invoice Due Date |
INVBILL | Invoice Billing Date |
CATG# | Category Value (1-6) |
CATG#D | Category Short Description (1-6) |
CATG#DL | Category Long Description (1-6) |
=TOTAL | Name Totals |
Primary Reference Info |
|
RFARRREF | REF: Primary Reference |
RFNOTDT# | REF: Late Notice Date (1-6) |
RFUSRAMT | REF: User Reference Amount |
RFBLFLG | REF: Bill Flag |
RFCRAMT | REF: Invoice total CR Amount |
RFDSPFLG | REF: Dispute Flag |
RFRFAAMT | REF: System Total AR Amount |
RFRFCAMT | REF: System Total CR Amount |
RFREFDT | REF: Reference Date |
Secondary Reference Info |
|
R2REF2 | REF2: Secondary Reference |
R2APRID | REF2: Reversal Approval |
R2CORRCR | REF2: Corrective CR Number |
R2CRE8DT | REF2: Create Date |
R2CRE8ID | REF2: Creator ID |
R2ORIGCR | REF2: Original CR Number |
R2PAYID | REF2: Payer ID |
R2PAYNM | REF2: Payer Name |
R2PEDB | REF2: Payer PEDB Code |
R2REGID | REF2: Receipt Register |
R2REVCD | REF2: Reversal Reason Code |
R2REVDT | REF2: Reversal Date |
R2REVID | REF2: Reversal User ID |
Late Notice Information |
|
LNINV | LN: Invoice Number |
LNINVAMT | LN: Invoice Change Amount |
LNINVDT | LN: Invoice Date |
LNPAMT | LN: Invoice Total Payments |
LNINVPDT | LN: Date of Last Payment |
LNINVNET | LN: Net of LNINVAMT and LNPAMT |
LNINVDUE | LN: Invoice Due Date |
LNBILL | LN: Invoice Billing Date |
LNDIV | LN: Division |
LNDAYNTC | LN: Day Mark for Specific Notice |
LNDAYSLT | LN: Number of Days Late |
CALLNO | Call Number |
COURSE | Course Number |
SECTION | Course Section Number |
COURSET | Course Title |
SCHOOL | School |
CREDIT | Course Credits |
CREDIT9 | Course Credits (alternate format) |
PROFID | Professor ID |
PROFNM | Professor Name |
MEETTIME | Course Meeting Time |
LOCATION | Course Location |
LOCTCAMP | Campus Location |
LOCTBULD | Building Location |
LOCTROOM | Room Location |
BEGINDT | Course Begin Date |
ENDDT | Course End Date |
CSCOMMT | Course Comments |
DEGSCHL | Student School |
DEGCOLL | Student College |
DEGCODE | Degree Code |
DEGINTER | Degree Interest |
MAJOR# | Major Code (1-4) |
MAJOR#LT | Major Description (1-4) |
FAYEAR | FA: Year |
FACODE | FA: Code |
FACODELT | FA: Description |
FATYPE | FA: Type |
FATYPELT | FA: Type Description |
FASTAT | FA: Status |
FATOTAMT | FA: Total Amount |
FATRMAMT | FA: Transaction Amount |
FATOTCR | FA: Total Transaction Credits |
FATRMCR | FA: Total Term Credits |
FATOTPCT | FA: Transaction Percentage |
FATRMPCT | FA: Term Percentage |
FATRMDT | FA: Transaction Date |
DACODE | Award Fund |
DATYPE | Institutional or External |
DAYEAR | Award Year |
DATERM | Registration Term |
DAAWARD | Amount Awarded |
DASCHED | Amount to be Transferred to AR |
DACREDIT | Amount Transferred to AR |
DABAL | Transfer Amount Remaining |
DABDATE | Date that Bal Amt should be Zero |
DACOUNT | Number of Disbursements |
DACODEL | Award Long Description |
DACODES | Award Short Description |
DAFLG200 | AR Transmittal Flag |
DAATYPE | Award Type |
DAATYPEL | Award Type Description |
DASTATUS | Award Status |
DAFLG218 | Allow Transfer to AR Flag |
DAACCEPT | Award Accepted |
DAHOLD | Hold Code |
DACODELT |
|
DDFYEAR |
|
DDFAWARD |
|
DDATYPE |
|
DDTERM |
|
DDPENTOT |
|
DDCODEL |
|
DDTYPEL |
|