Vertex Quantum Global Variables
The variables described in this section are used by a number of Vertex APIs. Additional fields may also be used by each routine. For information on the additional fields used by a Vertex Quantum routine, see the section on that routine.
The following table describes the fields returned by Vertex Quantum routines.
VTXWS
Field Descriptions
| Field | Description |
|---|---|
VTX-ERROR-STATUS
|
Returned by all Vertex APIs. One-character, either: N = Call successful Y = Call failed E = End of File |
VTX-ERROR-MSG
|
Returned by all Vertex APIs. Error message of up to 60 alphanumeric characters. |
VTX-GEOCODE
|
The GeoCode value found, up to 10 digits. |
VTX-GEO-STATE
|
The state associated with the GeoCode, up to 25 characters. |
VTX-GEO-COUNTY
|
The county associated with the GeoCode, up to 20 characters. |
VTX-GEO-CITY
|
The city associated with the GeoCode, up to 25 characters. |
VTX-GEO-ZIP-START
|
The beginning zip code associated with the GeoCode, up to 6 characters. |
VTX-GEO-ZIP-END
|
The ending zip code associated with the GeoCode, up to 6 characters. |
VTX-ACCESS-MODE
|
One alphanumeric character that indicates whether access is read-only or update. The default is R, for read-only. |
Vertex Working Storage Examples
**************************************************************
* WORKING STORAGE FOR VERTEX APIs
***************************************************************
01 VTXWS.
02 VTX-ERROR-STATUS PIC X(01) VALUE ZEROES.
02 VTX-ERROR-MSG PIC X(60) VALUE SPACES.
02 VTX-GEOCODE PIC 9(10) VALUE ZEROES.
02 VTX-GEO-STATE PIC X(25) VALUE SPACES.
02 VTX-GEO-COUNTY PIC X(20) VALUE SPACES.
02 VTX-GEO-CITY PIC X(25) VALUE SPACES.
02 VTX-GEO-ZIP-START PIC X(06) VALUE SPACES.
02 VTX-GEO-ZIP-END PIC X(06) VALUE SPACES.
02 VTX-ACCESS-MODE PIC X(01) VALUE "R".
02 VTX-NAME-CRITERIA.
03 VTX-NAMECRTA-LEVEL PIC X(01) VALUE ZEROES.
88 NAMECRTA-LEVEL-STATE VALUE ZEROES.
88 NAMECRTA-LEVEL-COUNTY VALUE "1".
88 NAMECRTA-LEVEL-CITY VALUE "2".
03 VTX-NAMECRTA-STATE PIC X(25) VALUE SPACES.
03 VTX-NAMECRTA-COUNTY PIC X(20) VALUE SPACES.
03 VTX-NAMECRTA-CITY PIC X(25) VALUE SPACES.
03 VTX-NAMECRTA-ZIP PIC X(06) VALUE SPACES.
02 VTX-GEOCODE-CRITERIA.
03 VTX-GEOCRTA-LEVEL PIC X(01) VALUE SPACES.
88 GEOCRTA-LEVEL-STATE VALUE ZEROES.
88 GEOCRTA-LEVEL-COUNTY VALUE "1".
88 GEOCRTA-LEVEL-CITY VALUE "2".
03 VTX-GEOCRTA-GEOCODE PIC 9(10) VALUE ZEROES.
03 VTX-GEOCRTA-STATE PIC 9(02) VALUE ZEROES.
03 VTX-GEOCRTA-COUNTY PIC 9(03) VALUE ZEROES.
03 VTX-GEOCRTA-CITY PIC 9(04) VALUE ZEROES.*************************************************************
* WORKING STORAGE FOR VERTEX APIs ()
*************************************************************
02 VTX-TAX-REQ.
03 VTX-COMPANY PIC 9(04) VALUE ZEROES.
03 VTX-COMPANY.
04 VTX-TAX-CD PIC X(09) VALUE SPACES.
04 VTX-JURIS-IN-OUT PIC X(01) VALUE SPACES.
03 VTX-TAXABLE-AMT PIC S9(13)V99
SIGN IS TRAILING SEPARATE
VALUE ZEROES.
03 VTX-TAX-AMOUNT PIC S9(13)V99
SIGN IS TRAILING SEPARATE
VALUE ZEROES.
03 VTX-PROD-TAX-CAT PIC X(15) VALUE SPACES.
03 VTX-PROC-LEVEL PIC X(05) VALUE SPACES.
03 VTX-LOCATION PIC X(05) VALUE SPACES.
03 VTX-CUSTOMER-CODE.
04 VTX-CUSTOMER PIC X(09) VALUE SPACES.
04 VTX-CUST-XTRA PIC X(01) VALUE SPACES.
03 VTX-CUST-CLASS PIC X(04) VALUE SPACES.
03 VTX-CUST-EXEMPT PIC X(01) VALUE SPACES.
03 VTX-CITY PIC X(18) VALUE SPACES.
03 VTX-STATE PIC X(02) VALUE SPACES.
03 VTX-ZIP.
04 VTX-ZIP-FIRST-5 PIC X(05) VALUE SPACES.
04 VTX-ZIP-LAST-5 PIC X(05) VALUE SPACES.
03 VTX-FROM-CITY PIC X(18) VALUE SPACES.
03 VTX-FROM-STATE PIC X(02) VALUE SPACES.
03 VTX-FROM-ZIP.
04 VTX-FR-ZIP-FIRST-5 PIC X(05) VALUE SPACES.
04 VTX-FR-ZIP-LAST-5 PIC X(05) VALUE SPACES.
03 VTX-FROM-TAX-CODE.
04 VTX-FR-TAX-CD PIC X(09) VALUE SPACES.
04 VTX-FR-JURIS-IN-OUT PIC X(01) VALUE SPACES.
03 VTX-INVOICE PIC X(22) VALUE SPACES.
03 VTX-LINE-NUMBER PIC 9(06) VALUE ZEROES.
03 VTX-QUANTITY PIC S9(11)V9(4)
SIGN IS TRAILING SEPARATE VALUE ZEROES.
03 VTX-PROD-EXEMPT PIC X(01) VALUE SPACES.
03 VTX-THIRD-PARTY-FUNC PIC X(01) VALUE SPACES.
03 VTX-TRANS-TYPE PIC X(01) VALUE SPACES.
03 VTX-TRANS-SUB-TYPE PIC X(03) VALUE SPACES.
03 VTX-SAVE-EFFECT-DATE PIC 9(08) VALUE ZEROES.
03 VTX-SYSTEM-DATE PIC 9(08) VALUE ZEROES.
03 VTX-VERTEX-FLAG PIC X(01) VALUE SPACES.**************************************************************
* WORKING STORAGE FOR VERTEX APIs
***************************************************************
02 VTX-TAX-RESULT.
03 VTX-INV-TOTAL-TAX PIC S9(10)V999
SIGN IS TRAILING SEPARATE VALUE ZEROES.
03 VTX-TRANS-STATUS-CD PIC 9(01) VALUE ZEROES.
03 VTX-TO-JURIS-RETURN-CD PIC 9(01) VALUE ZEROES.
03 VTX-FROM-JURIS-RETURN-CD PIC 9(01) VALUE ZEROES.
03 VTX-STATE-LOCAL OCCURS 4 TIMES.
04 VTX-STLOC-TAXBLTY-FLAG PIC X(01).
04 VTX-STLOC-TAX-TYPE PIC X(01).
04 VTX-STLOC-TAX-INCLUDED-FLAG PIC X(01).
04 VTX-STLOC-EXEMPT-REASON-CD PIC X(01).
04 VTX-STLOC-EXEMPT-AMOUNT PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-STLOC-NON-TAX-REASON-CD PIC X(01).
04 VTX-STLOC-NON-TAX-AMOUNT PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-STLOC-RATE PIC SV9(7)
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-STLOC-RATE-DATE PIC 9(08).
04 VTX-STLOC-TAX-AMOUNT PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-STLOC-TAX PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-STLOC-DISTRICT-FLAG PIC X(01).
03 VTX-LOCAL-ADDITION OCCURS 3 TIMES.
04 VTX-LOCADD-TAXBLTY-FLAG PIC X(02).
04 VTX-LOCADD-TAX-TYPE PIC X(02).
04 VTX-LOCADD-TAX-INCLUDED-FLAG PIC X(01).
04 VTX-LOCADD-EXEMPT-REASON-CD PIC X(01).
04 VTX-LOCADD-EXEMPT-AMOUNT PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-LOCADD-NON-TAX-REASON-CD PIC X(01).
04 VTX-LOCADD-NON-TAX-AMOUNT PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-LOCADD-RATE PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-LOCADD-RATE-DATE PIC 9(08).
04 VTX-LOCADD-TAX-AMOUNT PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-LOCADD-TAX PIC S9(13)V99
SIGN IS TRAILING SEPARATE VALUE ZEROES.
04 VTX-LOCADD-TAXED-GEO-FLAG PIC X(01).
04 VTX-LOCADD-DISTRICT-FLAG PIC X(01).