Return Values

The U@CALCVTXTAX returns values in the E@VERRORSTSand E@VERRORMSG fields. For information on these fields see Vertex Quantum Global Variables

The U@CALCVTXTAX routine also returns values in the following fields in the E@VTXDSE structure.


Field	Description
E@VINVTOTTAX VTX-INV-TOTAL-TAX	The signed, 10-character numeric value (including 3 decimal spaces) that indicates the total tax, sum of return values from E@VSTLOC.
E@VTRNSTATCD	A one-character numeric code that determines hether taxes were collected for a jurisdiction other than the taxing jurisdiction.
E@VTOJURISRTC	A one-character numeric code that returns the level of the GeoCode (state, city, or none) for the ship-to location.
E@VFRJURISRTC	A one-character numeric code that returns the level of the GeoCode (state, city, or none) for the ship-from location.
E@VSTLOC	Occurs 4 times (state, county, city, district). State and Local Tax Variable Structure
E@VWKLOCADD	Occurs 3 times (county, city, district). Local Jurisdiction Tax Structure

State and Local Tax Variable Structure

The following table shows the fields returned in the E@VSTLOC structure.


Field	Description
E@VSTLOCTAXFL	The one-character, alphanumeric code that determines whether there is tax liability in the jurisdiction. Currently returns only 0, tax calculation process determines tax ability.
E@VSTLOCTAXTY	The one-character, alphanumeric code that indicates the type of tax collected for jurisdiction. Currently returns only 1, tax calculation process determines tax type.
E@VSTLOCTAXIN	The one-character, alphanumeric code that indicates whether the tax amount is included in the extended amount (used for Canadian GST transactions). Currently returns only 0, tax amount not included in extended amount.
E@VSTLOCEXREC	The one-character, alphanumeric code identifying the type of exemption. Currently returns only 0.
E@VSTLOCEXAMT	The signed, 12-character (with 2 decimal places) numeric value for the dollar amount exempt from state and local taxes.
E@VSTLOCNTREC	The one-character, alphanumeric code that identifies the type of nontaxable transaction. Currently returns only 0.
E@VSTLOCNTAMT	The signed, 12-character (with 2 decimal places) numeric value for the nontaxable dollar amount.
E@VSTLOCRATE	The signed, 7-character numeric value for the jurisdiction's tax rate or a user-supplied tax rate.
E@STLOCRATEDT	The signed, 8-character numeric value for the effective date of the jurisdiction tax rate in CCYYMMDD format.
E@VSTLOCTAXAM	The signed, 12-character (with 2 decimal places) numeric value for the amount subject to tax.
E@VSTLOCTAX	The signed, 12-character (with 2 decimal places) numeric value for the tax amount.
E@VSTKICDUSTF	The one-character, alphanumeric code that determines whether the district tax, if any, is for the city or the county. Currently returns only 0, no city or county level district tax.

Local Jurisdiction Tax Structure

The following table shows the fields returned in the E@VWKLOCADD structure.


Field	Definition
E@VLOCADTAXFL	The two-character, alphanumeric code that indicates whether there is tax liability in the jurisdiction. 00 = Tax calculation process determines tax ability 01 = Taxable 02 = Nontaxable 03 = Exempt 04 = Collect Tax In window-defined taxable situation 05 = Collect Tax In window-defined nontaxable situation 06 = Jurisdiction Exceptions window-defined taxable situation 07 = Jurisdiction Exceptions window-defined nontaxable situation 08 = GeoCode overrides used 09 = Product Exceptions window-defined taxable situation 10 = Product Exceptions window-defined nontaxable situation 11 = Product Exceptions window overrides used 12 = Customer Exceptions window-defined taxable situation 13 = Customer Exceptions window-defined nontaxable situation 14 = Customer Exceptions window overrides used 15 = Locations window-defined taxable situation 16 = Locations window-defined nontaxable situation 17 = Tax ability undefined
E@VLOCADTAXTY	The two-character, alphanumeric code that identifies type of tax for jurisdiction. 00 = No tax type 01 = Tax calculation process should determine tax type 02 = Sales tax type 03 = Use tax type 04 = Rental or lease tax type 05 = Service tax type 06 = Override sales tax type 07 = Override use tax type 08 = Override rental or lease tax type 09 = Override service tax type 10 = Exempt sales transaction 11 = Exempt use transaction 12 = Exempt rental or lease transaction 13 = Exempt service transaction 14 = Nontaxable sales transaction 15 = Nontaxable use transaction 16 = Nontaxable rental or lease transaction 17 = Nontaxable service transaction 18 = Jurisdiction imposes no sales tax 19 = Jurisdiction imposes no use tax 20 = Jurisdiction imposes no rental or lease tax 21 = Jurisdiction imposes no service tax 22 = Invalid jurisdiction
E@VLOCADTAXIN	The one-character, alphanumeric code that indicates whether tax amount is included in extended amount. (Used for Canadian GST transactions.) 0 = Tax amount not included in extended amount 1 = Tax amount included in extended amount
E@VLOCADEXREC	The one-character, alphanumeric code that identifies exemption type * (asterisk) = Transaction is exempt 9 = Transaction is exempt because the jurisdiction is an APO/FPO 0 = Nonexempt
E@VLOCADEXAMT	The signed, 12-character (with 2 decimal places) numeric value for the dollar amount exempt from taxes
E@VLOCADNTREC	The one-character, alphanumeric code that identifies the type of nontaxable transaction * (asterisk) = Transaction is nontaxable and a nontaxable reason code was not supplied 0 = Transaction is taxable or exempt
E@VLOCADNTAMT	The signed, 12-character (with 2 decimal places) numeric value for the nontaxable amount.
E@VLOCADRATE	The signed, 12-character (with 2 decimal places) numeric value for the jurisdiction tax rate.
E@VLOCADRATED	The signed, 8-character numeric value for the effective date of the jurisdiction tax rate in CCYYMMDD format
E@VLOCADTAXAM	The signed, 12-character (with 2 decimal places) numeric value for the amount subject to tax.
E@VLOCADTAX	The signed, 12-character (with 2 decimal places) numeric value for the tax amount.
E@VLOCADTAXGF	The one-character, alphanumeric code that identifies the taxing jurisdiction 0 = No taxing jurisdiction exists 1 = Tax calculation process should determine taxing jurisdiction 2 = Ship-to location 3 = Ship-from location 4 = Order-acceptance location
E@VLOCADDISTF	The one-character, alphanumeric code that indicates whether any district tax is collected and at what jurisdiction level 0 = No city- or county-level district task 1 = City-level district tax applies 2 = County level district tax applies