You are on page 1of 232

Tax Data File Formats Handbook

Vertex® Indirect Tax O Series® 7.0

June 2014
Copyright and legal notices
Copyright © 2014 Vertex Global Tax Solutions Ireland Holdings. All rights reserved.
This documentation may not be reproduced, displayed, distributed, modified, posted, republished, or transmitted
in any form or by any means, without the prior written consent of Vertex Global Tax Solutions Ireland Holdings or
its affiliates (collectively, “Vertex”), except as otherwise specified in a valid, current Vertex license agreement or
allowed by law.
Disclaimers
The information contained in this documentation is designed to help users in regard to the subject matter covered.
Some of it may be based upon interpretations of federal, state, foreign and other tax laws and regulations. Each
entity is responsible for making its own determination of how such laws and regulations apply to its own
circumstances and for evaluating the capabilities of, and all data and results generated by, any product that is
described in this documentation. Vertex is not engaged in providing legal, tax or accounting advice or services and
the information contained in this documentation or in any product cannot replace the advice of competent legal
counsel. Further, the information in this documentation is subject to change without notice and is not warranted to
be error-free. If you find any errors, please report them to us in writing.
Trademarks and Service Marks
The trademarks, logos and service marks ("marks") displayed in this documentation are the property of Vertex or
other third parties. Users are not permitted to use these marks without the prior written consent of Vertex or the
third party that may own the mark.
Third Party Products
Copies of the licenses for some third-party products included with a Vertex product may be found in or with the
installation materials for that product.
Contents
Preface............................................................................................................. 7
Contacting Vertex.................................................................................................................... 7
Vertex corporate offices.....................................................................................................7
Vertex services and products.............................................................................................8
About Vertex O Series..............................................................................................................9
Vertex Indirect Tax O Series...............................................................................................9
Finding the information you need in Vertex Indirect Tax O Series.........................................10
About this handbook..............................................................................................................13
Scope................................................................................................................................13
What's new in this handbook for 7.0 (June 2014)............................................................14

Chapter 1 Vertex Tax Data File Formats............................................................15


Reviewing the tax data hierarchy and requirements.............................................................16
Tax data fields hierarchy and requirements.....................................................................17
Special considerations for historical relationship data.....................................................18
Tips for creating an import/export file...................................................................................19
Ensuring partition access for tax data..............................................................................19
Specifying the partition for an import or export file........................................................20
Matching version of Vertex O Series software, service release,
and monthly update data.........................................................................................20
Reviewing the most up-to-date enumerated types.........................................................20
Reviewing date format.....................................................................................................21
Matching date dependencies...........................................................................................22
Importing a tax rule..........................................................................................................23
Working with Taxability Categories..................................................................................23
Changing the data delimiter for the import/export file...................................................24

Chapter 2 File Layouts...................................................................................... 26


Hierarchy of entity records.................................................................................................... 27
Version format....................................................................................................................... 31
Imposition formats.................................................................................................................32
Tax Imposition Inclusion fields.........................................................................................33
Tax Imposition fields........................................................................................................ 34

Taxpayer formats................................................................................................................... 36

June 2014  Page 3


Taxpayer Reason Code fields............................................................................................37
Taxpayer Contact fields....................................................................................................39
Taxpayer fields................................................................................................................. 40
Taxpayer Business Location fields....................................................................................43
Taxpayer Tax Registration Imposition Jurisdiction fields..................................................45
Taxpayer Tax Registration Imposition fields.....................................................................46
Taxpayer Tax Registration Jurisdiction fields....................................................................47
Taxpayer Tax Registration fields.......................................................................................48
Taxpayer Discount Type fields..........................................................................................51
Taxpayer Currency Rounding Rule fields..........................................................................52
Taxpayer Recoverable Percentage for VAT fields.............................................................54
Taxability Category format.....................................................................................................55
Flexible Field Definition format..............................................................................................57
Taxability Driver format......................................................................................................... 60
Customer formats.................................................................................................................. 63
Customer Reason Code fields...........................................................................................64
Customer Contact fields...................................................................................................65
Customer fields................................................................................................................ 67
Customer Business Location fields...................................................................................69
Customer Tax Registration Imposition Jurisdiction fields.................................................71
Customer Tax Registration Imposition fields....................................................................72
Customer Tax Registration Jurisdiction fields...................................................................73
Customer Tax Registration fields......................................................................................74
Vendor formats......................................................................................................................77
Vendor Reason Code fields..............................................................................................78
Vendor fields.................................................................................................................... 79
Vendor Business Location fields.......................................................................................82
Vendor Tax Registration Imposition Jurisdiction fields....................................................84
Vendor Tax Registration Imposition fields.......................................................................85
Vendor Tax Registration Jurisdiction fields......................................................................86
Vendor Tax Registration fields......................................................................................... 87
Vendor Recoverable Percentage for VAT fields................................................................90
Taxability Category Mapping formats....................................................................................91
Taxability Category Mapping Drivers fields......................................................................92
Taxability Category Mapping fields..................................................................................94
Form formats......................................................................................................................... 96
Form Jurisdiction fields.................................................................................................... 97
Form fields....................................................................................................................... 98

Certificate formats................................................................................................................. 99

June 2014  Page 4


Certificate Taxability Driver fields..................................................................................100
Certificate Transaction Type fields.................................................................................103
Certificate Imposition Jurisdiction fields........................................................................104
Certificate Imposition fields...........................................................................................105
Certificate Jurisdiction fields..........................................................................................106
Certificate Coverage fields............................................................................................. 107
Certificate Image fields...................................................................................................111
Certificate fields............................................................................................................. 112
Batch Certificate formats..................................................................................................... 115
Batch Certificate Jurisdiction fields................................................................................116
Batch Certificate fields................................................................................................... 119
Letter formats...................................................................................................................... 123
Letter Template fields.................................................................................................... 123
Letter Batch Taxpayer fields...........................................................................................124
Letter Batch Customer fields..........................................................................................126
Letter Batch Jurisdiction fields.......................................................................................128
Letter Batch fields.......................................................................................................... 129
Tax Rule formats.................................................................................................................. 131
Tax Rule Transaction Type fields....................................................................................132
Tax Rule Tax Type fields.................................................................................................133
Tax Rule Tax Imposition fields........................................................................................134
Tax Rule Qualifying Conditions fields.............................................................................135
Tax Rule Conditional Jurisdiction fields..........................................................................140
Child Single Rate Tax Structure fields.............................................................................141
Single Rate Tax Structure fields......................................................................................142
Child Quantity Tax Structure fields.................................................................................143
Quantity Tax Structure fields..........................................................................................144
Child Tier fields...............................................................................................................145
Tier fields........................................................................................................................147
Child Tiered Tax Structure fields....................................................................................149
Tiered Tax Structure fields.............................................................................................150
Flat Tax Tax Structure fields...........................................................................................151
Tax Rule Conditional Tax Expression Tax Factor fields...................................................152
Tax Rule Tax Basis Conclusion Tax Factor fields.............................................................154
Tax Rule Conditional Tax Expression fields.....................................................................157
Tax Basis Rule Tax Basis Conclusion fields......................................................................158
Taxability Rule fields.......................................................................................................159
Max Tax Rule fields........................................................................................................ 165
Tax Basis Rule fields....................................................................................................... 169

June 2014  Page 5


Recoverability Rule fields...............................................................................................174
Taxability Mapping formats................................................................................................. 178
Taxability Mapping Rule Transaction Type fields...........................................................179
Taxability Mapping Rule Tax Type fields........................................................................180
Taxability Mapping Rule Tax Imposition fields...............................................................181
Taxability Mapping Rule Qualifying Conditions fields....................................................182
Taxability Mapping Rule Conditional Jurisdiction fields.................................................187
Taxability Mapping Rule fields.......................................................................................188
Taxability Mapping Category Mapping Drivers fields.....................................................194
Taxability Mapping Category Mapping fields.................................................................196
Taxability Mapping fields............................................................................................... 198
Situs Treatment Rule formats..............................................................................................199
Situs Treatment Rule Transaction Event fields...............................................................199
Situs Treatment Rule fields............................................................................................ 200
Tax Assist formats................................................................................................................ 202
Tax Assist Lookup Table fields........................................................................................203
Tax Assist Lookup Record fields.....................................................................................205
Tax Assist Allocation Table fields....................................................................................206
Tax Assist Allocation Column fields................................................................................207
Tax Assist Allocation Column Value fields......................................................................208
Tax Assist Rule fields...................................................................................................... 210
Data Extract fields................................................................................................................ 211

Chapter 3 Enumerated Types and Values........................................................212

Appendix A Batch Certificate Import...............................................................218


Overview of batch certificate import...................................................................................218
Before you import a batch of certificates............................................................................219
Batch certificate import: File names and locations..............................................................219
Batch certificate import: File layouts...................................................................................220
Batch certificate import: Header fields................................................................................221
Batch Certificate fields......................................................................................................... 223
Batch Certificate Jurisdiction fields......................................................................................227
Guidelines for jurisdiction names...................................................................................229

Index............................................................................................................ 230

June 2014  Page 6


Preface
This preface contains the following information:
 Contacting Vertex®, which includes how to contact us about services
and products
 About Vertex® Indirect Tax O Series® products, which includes the list of
guides that Vertex provides
 About this guide, which includes its purpose and scope

Contacting Vertex
Founded in 1978, Vertex is the trusted leader in corporate tax technology
excellence. Contact Vertex for help streamlining your tax processes.

Vertex corporate offices


Vertex is a privately held company with offices in these locations:
Global headquarters European headquarters

1041 Old Cassatt Road Vertex Global Tax Solutions, LTD


Berwyn, PA 19312 1 Furzeground Way, Stockley Park
USA Uxbridge, UB11 1EZ
Phone: 610.640.4200 United Kingdom
Toll-free (United States only): Phone: +44 (0)20 8622 3053
800.355.3500 Fax: +44 (0)20 8622 3200
Fax: 610.640.2761
www.vertexinc.com/

Sarasota office Tax Returns processing center

101 Paramount Drive 40 Shuman Blvd.


Suite 340 Suite 160
Sarasota, FL 34232 Naperville, IL 60563
USA USA
Phone: 866.829.8324 Phone: 630.328.2600

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Prefa  Contacting

Vertex services and products


The following table provides contact information for Vertex services and
products:
For assistance with... Contact...
Technical questions about Vertex Product Support
products you have licensed Phone: 800.281.1900 (Monday through Friday, 8:15 A.M. to 8:00
P.M. United States Eastern Time)
Fax: 610.640.1207
Web: https://my.vertexinc.com/
Up-to-the-minute information Vertex Critical Changes page
about tax rate, tax rule, and Web:
jurisdiction changes in Vertex data https://my.vertexinc.com/category/type/immediate-attention

Questions about your licensing Vertex Account Services


agreement, license renewal, Phone: 800.355.3500 or 610.640.4200
invoicing arrangements, or
Fax: 610.640.5892
obtaining a license file for a
product you have purchased Email: accountservices@vertexinc.com
Web: www.vertexinc.com/ContactUs/web-inquiry-form.asp
Purchasing Vertex services and Vertex Global Headquarters
products Phone: 800.355.3500 or 610.640.4200
Fax: 610.640.5892
Web: www.vertexinc.com/ContactUs/web-inquiry-form.asp

Vertex European Headquarters


Vertex Global Tax Solutions Ltd.
Phone: +44 (0) 20 8622 3053
Fax: +44 (0) 20 8622 3200
Regional training classes, Vertex Training
Web-based training classes, or Phone: 800.281.1900 (Monday through Friday, 8:15 A.M. to 8:00
on-site training at your facility P.M. United States Eastern Time) option #2
Fax: 610.640.5892
Email: training.registration@vertexinc.com
Web: www.vertexinc.com/ContactUs/web-inquiry-form.asp
Questions or feedback about this Vertex Information Development
documentation Email: documentation@vertexinc.com

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Preface  About Vertex O Series

About Vertex O Series


The Vertex O Series platform provides an advanced architecture for integrating a
broad range of tax compliance features into a single, seamless application suite.
By using object-oriented techniques and Web technologies, such as XML, HTML,
SOAP, and Java, Vertex O Series efficiently combines functionality for data
maintenance, tax calculation, system administration, and external interface to a
financial host system that can be shared by multiple applications. Vertex O Series
also provides easy, flexible deployment in a variety of operating environments.
This section describes products and features that can be licensed and deployed
on the O Series platform, plus additional Vertex products that can be used with
Vertex O Series.

Vertex Indirect Tax O Series


Vertex® Indirect Tax O Series® (Vertex O Series) integrates with your enterprise
financial, accounting, ERP, or CRM host system to calculate tax automatically on
individual business transactions.
Using Vertex O Series can significantly reduce the complexities and expense of
tax compliance processes for your enterprise. To help you achieve and maintain
compliance, Vertex O Series calculates tax based on Vertex-supplied research and
your customizations of jurisdiction rates, exceptions, and exemptions. Vertex O
Series also supports precise taxing jurisdiction identification and special
situations that include tiered tax, maximum basis tax, maximum tax amount tax,
complex rounding rules, and VAT import reverse charge.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Prefa  Finding the information you need in Vertex Indirect Tax O

Finding the information you need in Vertex Indirect Tax


O Series
Vertex provides documentation for the tasks that you must complete to use O
Series successfully. All documentation is available on the myVertex customer
portal (https://my.vertexinc.com/).
Note: You can also use myVertex to access the online Knowledge Center, submit
a Service Request, or visit the Forums where you can communicate with
other Vertex users about tips, tricks, and best practices.
Preparing your O Series instance
For this task Use this documentation
Planning your implementation for Planning Guide
technology and tax compliance.

Installing and deploying the O Installation Guide


Series platform and loading O
Series.
Configuring O Series using the Configuration File Parameters Reference Guide
Vertex configuration file.
Performing administrative tasks, Administration Guide
such as defining user access and
roles, applying data updates,
moving data, and monitoring
performance.

Integrating O Series with your host system


For this task Use this documentation
Using XML messages to integrate O XML Integration Guide
Series and your host system.

Using the Java interface to Java Integration Guide


integrate O Series and your host
system.
Managing O Series tax data that is Vertex Central Web Services Integration Guide
used in a calling application.
Using the Batch Client Interface to Batch Client Interface Integration Guide
process groups of transactions
without writing an interface
between O Series and your host
system.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Prefa  Finding the information you need in Vertex Indirect Tax O

Maintaining O Series
For this task Use this documentation
Managing O Series data and Administration Guide
managing customized data and Tax Vertex Central Help
Journal data.
User's Guide
Performing monthly updates. Administration Guide
Upgrading to the latest major Upgrade Guide
version of O Series.

Using O Series for Indirect Tax


For this task Use this documentation
Setting up taxability information Vertex Central Help
and your structure, such as the User's Guide
following:
 Taxability categories
 Taxability drivers
 Tax rules
 Taxpayers, customers, and
vendors
 Certificates

Generating standard reports and Vertex Central Help


Data Extract reports. User's Guide
Using the command line or Web O Series Client Utilities User's Guide
services to perform activities for
Data Management, Data Extract,
and file transfer.
Using required data file formats to Tax Data File Formats Handbook
move data between O Series and
your host system.
Reviewing formats in which you can Reporting Database Views Tipsheet
view the Reporting database data.

Using O Series with Vertex Returns


For this task Use this documentation
Using the required header layouts Returns Data File Format Handbook
and export file layouts to move
data between O Series and Vertex
Returns.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Prefa  Finding the information you need in Vertex Indirect Tax O

For this task Use this documentation


Exporting data for returns. Vertex Central Help
User's Guide
Setting up data transfers and Returns Reconciliation Guide
understanding data discrepancies
between O Series and Vertex
Returns.

Using O Series with Vertex Reporting & Analysis


For this task Use this documentation
Accessing Vertex Reporting & O Series Administration Guide
Analysis directly from Vertex Vertex Reporting & Analysis Administration Guide
Central.
Generating reports and adhoc Vertex Reporting & Analysis User’s Guide
queries.
Installing and deploying Cognos IBM Cognos Business Intelligence Installation and
software. Configuration Guide
IBM Cognos Business Intelligence Administration and Security
Guide

Learning more about Cognos. IBM Cognos Business Intelligence Installation and
Configuration Guide
IBM Cognos Query Studio User Guide
IBM Cognos Connection User Guide
Creating reports and ad hoc queries Vertex Reporting & Analysis Value Added Tax Return Reports
for Value Added Tax returns. User’s Guide
Setting up Tax Assist rules and Vertex Reporting & Analysis Tax Assist Setup Guide
lookup tables for tax codes.

Using O Series On-Demand


For this task Use this documentation

Understanding your responsibilities On-Demand Getting Started Guide


for setting up and for administering
your hosted O Series environment.
Reviewing special consideration On-Demand Configuration Guide
parameters for your hosted
environment.
Using O Series in your hosted Vertex Central Help
environment.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Prefa  About this

Using O Series with industry-specific data


For this task Use this documentation
Exemption Certificate Manager Vertex Central Help
ECM Administration Guide
ECM Configuration Guide
Exemption Certificate Portal Exemption Certificate Portal User’s Guide
Vertex Indirect Tax for Retail Retail Getting Started Guide
Retail Installation and Administration Guide
Retail Tax Extract Integration Guide
Vertex Indirect Tax for Leasing Lease Tax O Series Planning Guide
Administration Guide
Vertex Central Help
Vertex Indirect Tax for Telecom Telecom Planning Guide
Vertex Central Help
Vertex Indirect Tax for Hospitality Hospitality Planning Guide
Vertex Central Help

About this handbook


This guide applies to the Vertex® Indirect Tax O Series® products. This guide
contains information for anyone who is importing data into or exporting data
from a Vertex® Indirect Tax O Series® version 7.0 database.

Scope
This guide describes what you need to know to:
 Plan the content of your tax data import/export file
 Understand how to manually create tax data import/export files successfully
 Identify the correct tax data import/export file format for each taxability
entity

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Prefa  About this

What's new in this handbook for 7.0 (June 2014)


This handbook includes the following additions and changes:
The tax data fields hierarchy and requirements and the hierarchy of
entity records were updated — The Data Extract Format fields were added
to the Tax data fields hierarchy and requirements (see page 17) and the
Hierarchy of entity records (see page 27).
Designating the target partition name for a Tax Data Import or a Tax
Data Export — Use the Import Into Current Partition check box to designate
the target partition for a Tax Data Import. Use the Target Partition Name field to
designate the destination partition for a Tax Data Export. For details, refer to
Specifying the target partition for an import or export file (see page 20).
New Recoverability Rule fields were added to Tax Rule fields — You
can now import or export user-defined recoverability rules by using the
Recoverability Rule fields (see page 174).
Renaming Validation Type and Validation Date — For clarity, Validation
Type was renamed VIES Validation Status and Validation Date was renamed VIES
Validation Date in the Customer Tax Registration fields (see page 74) and Vendor
Tax Registration fields (see page 87).
New custClassInd field — The value of custClassInd was added to Certificate
fields (see page 112) and Batch Certificate fields (see page 119).
New Certificate Reason Code template in Data Extract — A new Data
Extract template, Certificate Reason Code template, enables you to generate a
current list of Reason Code IDs. Refer to Certificate Reason Codes and Certificate
Coverage fields (see page 107).
Data Extract definitions can now be imported and exported. — You
can now import and export Data Extract definitions between different instances
of O Series. For details, refer to Data Extract fields (see page 211).
New Exemption Certificate Portal (ECP) enumerated types —
The following new enumerated types were added for the Exemption
Certificate Portal:
 Certificate Status (Approved, Denied, and Not_Processed)
 Creation Source (Valid values: OSeries, ECMWizard)
For details, refer to Enumerated Types and Values. (see page 212)

June  Page
Chapter 1

Vertex Tax Data File Formats


This chapter describes the taxability data file formats used for importing or
exporting Vertex O Series user-defined data.
In addition to manually setting up records using the Vertex Central GUI, you can
import and export records using Data Management features in the Vertex Central
GUI or the Command Line interface. This feature enables you to automate the
process of setting up Vertex O Series instances without re-keying data.
Data that can be imported and exported
The data that can be imported and exported includes:
 My Enterprise records such as Taxpayers, Customers, Vendors, Certificates,
and Certificate Management.
 Tax Setup records such as Tax Rules, Taxability Categories, and Tax Assist
rules, lookup tables, and allocations.
When to review these tax data formats
Review these formats if you want to move data between:
 Two Vertex O Series instances
 A non-Vertex system and Vertex O Series
Typically, you can use this importing and exporting function to move data
between Vertex O Series systems from:
 An approved test environment to a live environment
 A centrally maintained location to one or more geographically diverse site
locations

In this chapter
Reviewing the tax data hierarchy and requirements....................16
Tips for creating an import/export file..........................................19

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Reviewing the tax data hierarchy and

Reviewing the tax data hierarchy and requirements


This section provides a snapshot of the tax data import and export format
entities, along with requirement information and how to use them.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Reviewing the tax data hierarchy and

Tax data fields hierarchy and requirements


Records being imported to Vertex Central must follow a specific sequence in the
import file. If you split up your imports into multiple import files, you must
perform the imports in the sequence defined by the hierarchy.
For example:
If the import data comprises Taxpayer and Customer records, all
Taxpayer-level records must precede Customer-level records.
The following table shows this sequence:
Order Entity
1 Version formats
2 Imposition formats
3 Taxpayer formats
4 Taxability Category formats
5 Flexible Field Definition formats
6 Taxability Driver formats
7 Customer formats
8 Vendor formats
9 Taxability Category Mapping formats
10 Form formats
11 Certificate formats
12 Batch Certificate formats
13 Letter formats
14 Tax Rule formats
15 Taxability Mapping formats
16 Situs Treatment Rule formats
17 Tax Assist formats
18 Data Extract formats

For a detailed hierarchical breakout of both entity and sub-entity records, refer
to Hierarchy of entity records (see page 27).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File Formats  Reviewing the tax data hierarchy and requirements

Special considerations for historical relationship data


The purpose of the historical relationship data is to capture the effective date
interval history of the relationship between the taxability entity data. Generally,
historical relationship data is not required when you are importing new taxability
entity data. However, it may be required when you are importing taxability data
to perform an update.
When an import updates an existing entity, Vertex recommends that you
complete the following steps to create history relationship data:
1. Run the export for the entity to be updated.
2. Make the changes on the exported file.
Caution:Do not change history relationship data unless the relationship must be changed due to

When you change history relationship data, it is important to ensure that all the
data is correct. This is because the import overwrites the destination database
history relationship data, and it may damage the history information if you
provide incorrect data.
Caution:Vertex strongly recommends NOT changing the history relationship with non-Vertex i

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Tips for creating an import/export

Tips for creating an import/export file


Vertex recommends that you create one export record and export it. Print the
exported record format and use it as a guide to create additional export records.
To ensure the success of your import/export, review the following data issues.
The more proactive you are in complying with these items, the greater your
likelihood of success:
 Ensuring partition access for tax data
 Matching version of Vertex O Series software, service release, and monthly
update data
 Reviewing the most up-to-date enumerated types
 Reviewing date format
 Matching date dependencies
 Changing the data delimiter for the import/export file
 Importing a tax rule
 Working with Taxability Categories

Ensuring partition access for tax data


The level of partition data access depends on the Security role of the User ID
being used to perform the import/export:
 UserIDs with a Master Administrator role perform import/export for all
partitions.
 UserIDs with a Partition System Administrator role perform import/export
within their assigned partition only.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Tips for creating an import/export

Specifying the partition for an import or export file


You can specify the destination partition for an import or export file. Currently,
Vertex O Series imports or exports the tax data file into the partition that is
identified in the import or export file.
When you create a filter to perform a Tax Data Import through Vertex Central,
you can overwrite the identified partition by selecting the Import Into Current
Partition check box. Selecting this check box enables data in the import file to be
imported into the current partition.
When you create a filter to perform a Tax Data Export through Vertex Central,
you can specify the name of the Target Partition. Enter the name of the partition
into which all data will be written in the Target Partition Name field. By
identifying the target partition name, you avoid the errors that can happen when
directly editing partition names in the export file.

Matching version of Vertex O Series software, service release, and


monthly update data
Before you import data into one Vertex O Series database from another, check
that both systems use the same software version, Service Release (patch)
number, and Vertex data update. Also, check that data update history for each
environment is identical. You should apply the same initial data version and
subsequent data updates to each environment.
Caution:You cannot manually update tax data in different environments and then perform a tax

Reviewing the most up-to-date enumerated types


The valid enumerated type values for each field are updated occasionally. When
you are building your own tax data import/export file, see the “Enumerated
Types and Values” chapter in this handbook for a complete list of enumerated
types. Use these values in your file.
Match the spacing and capitalization when you use these values. Otherwise, you
encounter errors.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Tips for creating an import/export

Reviewing date format


Check that the date format in all your records is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Tips for creating an import/export

Matching date dependencies


If you create an import/export file using Data Management
If you create an import/export file using the Data Management Tax Data Import
or Tax Data Export features, O Series structures the date dependencies properly.
If you create an import/export file manually
If you create an import/export file manually, you may have an issue with dates in
your import/export file matching the dates in the destination database.
The date fields in Vertex Central have a hierarchy that corresponds to the
hierarchies for entities and sub-entities. For details on the hierarchies, refer to
Reviewing the tax data hierarchy and requirements (see page 16).
The relationships between date fields in the import/export file and their
corresponding date fields in the destination database determine the success of
the import/export. Also, date fields in the import/export file for entities higher in
the hierarchy need to be established before date fields for entities lower in the
hierarchy.
You must meet two key considerations to ensure the effectivity of dates:
 Do the sub-entities within each entity exist in the import/export file and
destination database?
 Are these existing entities effective in both the import/export file and
destination database?
Review the following scenario for an import/export file created on 06/01/2014.
Compare each date field in both the import/export file and the destination
database and see how they impact the success of the import/export.

Date Field Import/Export Destination How This Date Impacts Success of


File Database Date Import/Export
Date Example Example
Import Date 06/01/2014 06/01/2014 N/A
Taxability 05/01/2014 06/01/2014 If this date in the import file is earlier than the
Category Taxability Category Start Effective Date in the
Start destination database, the import program
Effective cannot find Taxability Category.
Date

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Tips for creating an import/export

Date Field Import/Export Destination How This Date Impacts Success of


File Database Date Import/Export
Date Example Example
Taxability 05/01/2014 06/01/2014 Since the Taxability Category Start Effective
Category Date cannot be found in the destination
Mapping database, the Taxability Category Mapping
Start Start Effective Date cannot be imported due to
Effective an invalid Taxability Category date.
Date

Importing a tax rule


You must always provide both the Where and Transaction Type information
when you are importing a tax rule. In addition, you must provide one of the
following types of information: Taxpayer, Customer, or Qualifying Condition.
If this information is available, the tax rule is validated and imported successfully.
If this information is not available during the import process, an error occurs and
the tax rule is not imported.

Working with Taxability Categories


Taxability Categories are used in several different record formats. Check that you
use the Taxability Category Code, not the Taxability Category Name, in the record
format. Vertex provides a report to list all Taxability Category Codes.
Note: When you are using a Taxability Category in an import record, check that
the Taxability Category start effective date is in sync with the entity start
date.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Tips for creating an import/export

Changing the data delimiter for the import/export file


Import and export files are tilde-delimited files. Generally, most fields are
separated by a tilde. The exception is the last field in each format. The last field in
each format does not need to end in a tilde.
Through two parameters (tps.importexport.export.delimiter and
tps.importexport.import.delimiter) in the configuration file (vertex.cfg) or
through Vertex Central, you can change the delimiters for both export and
import files. For details, refer to the Configuration File Parameters Reference
Guide.
You may want to change the data delimiter for several reasons. For example, if
you are using Excel to build your import/export file, you may want to create
comma-delimited data files. Also, another system that interacts with Vertex O
Series might determine your selection for the data delimiter symbol.
Valid delimiter values include:
 Tilde (~)
 Comma (,)
 Semicolon (;)
 Forward slash (/)
 Caret (^)
 Asterisk (*)
 Single pipe (|)
If you attempt to define a data delimiter through Vertex Central with a character
that is not a valid value, the system generates a warning message. Enter a valid
data delimiter before you continue your import/export activities.
When your data includes some of the valid data delimiters, you need to indicate
to the system that you want to continue processing a line of data. You can escape
data delimiters within your data using \d. When your selected delimiter character
displays within your data, the Vertex export process automatically replaces it
with \d. If your selected delimiter displays in an import file you created manually,
you must escape the delimiter character. Otherwise, errors will occur during the
import process. During the import process, the Vertex system recognizes the
escape character \d and replaces it with your selected delimiter.
Example: If your data delimiter is a comma and your manually created
import file contains the data value Jones,Inc, you must escape this data
as Jones\dInc.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 1. Vertex Tax Data File  Tips for creating an import/export

Note: Vertex recommends that you select a data delimiter as a standard for your
imports and exports and make that your default value in the
tps.importexport.export.delimiter and
tps.importexport.import.delimiter parameters in the vertex.cfg file.
Keep the selected delimiter the same for both the import file and export
file.

June  Page
Chapter 2

File Layouts
This chapter provides detailed file layout information for formats in the Vertex O
Series Tax Data File. It is organized according to the sequence of entity records
required in import files. Within each entity section, sub-entities are presented in
the order they must appear in import files.

In this chapter
Hierarchy of entity records...........................................................27
Version format..............................................................................31
Imposition formats.......................................................................32
Taxpayer formats..........................................................................36
Taxability Category format...........................................................55
Flexible Field Definition format.....................................................57
Taxability Driver format................................................................60
Customer formats.........................................................................63
Vendor formats.............................................................................77
Taxability Category Mapping formats...........................................91
Form formats................................................................................96
Certificate formats........................................................................99
Batch Certificate formats............................................................115
Letter formats.............................................................................123
Tax Rule formats.........................................................................131
Taxability Mapping formats........................................................178
Situs Treatment Rule formats.....................................................199
Tax Assist formats.......................................................................202
Data Extract fields.......................................................................211

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Hierarchy of entity

Hierarchy of entity records


The hierarchy and sequence for importing and exporting records to and from
Vertex Central is shown in the following table.
Example: If the import data comprises Taxpayer and Customer records, all
Taxpayer-level records must precede Customer-level records. For the
Customer records, Customer Reason Code record values must precede
Customer Contact record values.
If you split up your imports into multiple import files, you must perform the
imports in the sequence defined by the hierarchy in the following table.
Order Entity Sub-entity
1 Version formats None
2 Imposition formats Tax Imposition Inclusion fields
Tax Imposition fields
3 Taxpayer formats Taxpayer Reason Code fields
Taxpayer Contact fields
Taxpayer fields
Taxpayer Business Location fields
Taxpayer Tax Registration Imposition Jurisdiction fields
Taxpayer Tax Registration Imposition fields
Taxpayer Tax Registration Jurisdiction fields
Taxpayer Tax Registration fields
Taxpayer Discount Type fields
Taxpayer Currency Rounding Rule fields
Taxpayer Recoverable Percentage for VAT fields
4 Taxability Category formats None
5 Flexible Field Definition formats None
6 Taxability Driver formats None
7 Customer formats Customer Reason Code fields
Customer Contact fields
Customer fields
Customer Business Location fields
Customer Tax Registration Imposition Jurisdiction fields
Customer Tax Registration Imposition fields
Customer Tax Registration Jurisdiction fields
Customer Tax Registration fields

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Hierarchy of entity

Order Entity Sub-entity


8 Vendor formats Vendor Reason Code fields
Vendor fields
Vendor Business Location fields
Vendor Tax Registration Imposition Jurisdiction fields
Vendor Tax Registration Imposition fields
Vendor Tax Registration Jurisdiction fields
Vendor Tax Registration fields
Vendor Recoverable Percentage for VAT fields
9 Taxability Category Mapping formats Taxability Category Mapping Drivers fields
Taxability Category Mapping fields
10 Form formats Form Jurisdiction fields
Form fields
11 Certificate formats Certificate Taxability Driver fields
Certificate Transaction Type fields
Certificate Imposition Jurisdiction fields
Certificate Imposition fields
Certificate Jurisdiction fields
Certificate Coverage fields
Certificate Image fields
Certificate fields
12 Batch Certificate formats Batch Certificate Jurisdiction fields
Batch Certificate fields
13 Letter formats Letter Template fields
Letter Batch Taxpayer fields
Letter Batch Customer fields
Letter Batch Jurisdiction fields
Letter Batch fields

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Hierarchy of entity

Order Entity Sub-entity


14 Tax Rule formats Tax Rule Transaction Type fields
Tax Rule Tax Type fields
Tax Rule Tax Imposition fields
Tax Rule Qualifying Conditions fields
Tax Rule Conditional Jurisdiction fields
Child Single Rate Tax Structure fields
Single Rate Tax Structure fields
Child Quantity Tax Structure fields
Quantity Tax Structure fields
Child Tier fields
Tier fields
Child Tiered Tax Structure fields
Tiered Tax Structure fields
Flat Tax Tax Structure fields
Tax Rule Conditional Tax Expression Tax Factor fields
Tax Rule Tax Basis Conclusion Tax Factor fields
Tax Rule Conditional Tax Expression fields
Tax Basis Rule Tax Basis Conclusion fields
Taxability Rule fields
Max Tax Rule fields
Tax Basis Rule fields
Recoverability Rule fields
15 Taxability Mapping formats Taxability Mapping Rule Transaction Type fields
Taxability Mapping Rule Tax Type fields
Taxability Mapping Rule Tax Imposition fields
Taxability Mapping Rule Qualifying Conditions fields
Taxability Mapping Rule Conditional Jurisdiction fields
Taxability Mapping Rule fields
Taxability Mapping Category Mapping Drivers fields
Taxability Mapping Category Mapping fields
Taxability Mapping fields
16 Situs Treatment Rule formats Situs Treatment Rule Transaction Event fields
Situs Treatment Rule fields

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Hierarchy of entity

Order Entity Sub-entity


17 Tax Assist formats Tax Assist Lookup Table fields
Tax Assist Lookup Record fields
Tax Assist Allocation Table fields
Tax Assist Allocation Column fields
Tax Assist Allocation Column Value fields
Tax Assist Rule fields
18 Data Extract format Data Extract Report fields
Data Extract Report Field fields
Data Extract Report Filter fields
Data Extract Report Property fields

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Version format

Version format
This section describes the format pertaining to Version, which appears first in the
import and export files.
Version fields indicate the O Series software version and data update versions
used to create an export file. This data is used only for troubleshooting purposes.
Note: Use version numbers only when moving data between Vertex systems. If
there is a difference in version data, a warning displays in the Import
Report. If you are creating an export file between a non-Vertex system and
O Series, you do not need to create version records.
The following table describes VERSION fields for a flat tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes VERSION
to text in
description field.
2 internalBuild No STRING 60 No An internal build version number
Version that is meaningful to Vertex product
developers.
Version number format is
Major.Minor.Interim.
3 tpsDataRelease No STRING 60 No The data release number for the O
Version Series data.
4 taxgisData No STRING 60 No The data release number for the
ReleaseVersion TaxGIS data.
5 utilDataRelease No STRING 60 No The data release number for the Util
Version data.
6 fileCreationDate No LONG 8 No The system date on which the file
was created.
Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Imposition

Imposition formats
This section describes the formats pertaining to Impositions and presents them in
the order they must appear in the import file. User-defined impositions must be
imported prior to tax rules.
Imposition formats and the corresponding record indicators are listed in the
following table.
Format Record Indicator
Tax Imposition Inclusion fields (see page 33) TAX_IMPOSITION_INCLUSION
Tax Imposition fields (see page 34) TAX_IMPOSITION

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Imposition

Tax Imposition Inclusion fields


The following table describes TAX_IMPOSITION_INCLUSION fields for a flat
tilde-delimited import file.
User-defined tax impositions must be imported prior to tax rules.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_IMPOSITION_INCLUSION
text in description
field.
2 included Yes LONG 18 Yes The jurisdiction ID associated with the
JurisdictionId Tax Imposition that is included to
another Tax Imposition for Tax Basis.
3 includedImp Yes STRING 128 Yes Name related to the Source ID for Tax
SourceName Imposition that is included to another
Tax Imposition for Tax Basis.
4 includedImpType Yes STRING 60 Yes Tax Imposition Type Name for Tax
Name Imposition that is included to another
Tax Imposition for Tax Basis.
5 includedImpStart Yes LONG 8 Yes Date format is YYYYMMDD.
Date
6 includedImpTypeS Yes STRING 128 Yes Name related to the Source ID for Tax
ourceName Imposition Type for Tax Imposition
that is included to another Tax
Imposition for Tax Basis.
7 basisStartDate Yes LONG 8 Yes Date format is YYYYMMDD.
8 basisEndDate Yes LONG 8 Yes Date format is YYYYMMDD.
9 temporaryTax No STRING 155 Yes A temporary key to facilitate the
ImpositionKey association of this Tax Basis Inclusion
to a Tax Imposition.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Imposition

Tax Imposition fields


The following table describes TAX_IMPOSITION fields for a flat tilde-delimited
import file.
User-defined impositions must be imported prior to tax rules.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_IMPOSITION
to text in
description field.
2 jurisdictionId Yes LONG 18 Yes The jurisdiction ID associated with
the Tax Imposition.
3 impSourceName Yes STRING 128 Yes Name related to Source ID for Tax
Imposition.
4 impTypeName Yes STRING 60 Yes Tax Imposition Type Name.
5 impStartDate Yes LONG 8 Yes Date format is YYYYMMDD.
6 impEndDate Yes LONG 8 Yes Date format is YYYYMMDD.
7 impTypeSource Yes STRING 128 Yes Name related to Source ID for Tax
Name Imposition Type.
8 taxImposition No STRING 60 Yes Tax Imposition Name
Name
9 taxImpositionDesc No STRING 100 No Tax Imposition Description
10 temporaryTax No STRING 155 No A temporary key to facilitate the
ImpositionKey association of a Tax Imposition with
other Tax Impositions that have the
same Tax Imposition detail ID. For a
Vertex export file, the tax imposition
ID, tax imposition source ID,
jurisdiction ID, tax imposition type
ID, and tax imposition type source ID
are used to populate the field.
User-created import files (for
example, files not created via the
Vertex export) may use any unique
identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Imposition

Field Field Natural Type Max. Size Req. Description


Count Key
11 temporaryTax No STRING 155 No A temporary key to facilitate the
ImpositionSame association of a Tax Imposition with
IdKey other Tax Impositions that have the
same Tax Imposition detail ID. For a
Vertex export file, the tax imposition
ID, tax imposition source ID,
jurisdiction ID, tax imposition type ID
and tax imposition type source ID
are used to populate the field.
User-created import files (for
example, files not created via the
Vertex export) may use any unique
identifier.
12 impTaxTypeName No STRING 12 No A temporary key to facilitate the
association of a Tax Imposition with
other Tax Impositions that have
same ID. For a Vertex export file, the
tax imposition ID, tax imposition
source ID and jurisdiction ID are used
to populate the field. User-created
import files (for example, files not
created via the Vertex export) may
use any unique identifier.
This field must not have the same
value of the field 11,
temporaryTaxImpositionSameID
Key.
13 taxResponsibility No STRING 20 No Name of Tax Type of Imposition.
RoleTypeName This is to support Hybrid Countries in
VAT Supplies and Purchases.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Tax
Responsibility Role Type.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Taxpayer formats

Taxpayer formats
This section describes the formats pertaining to Taxpayers and presents them in
the order they must appear in the import file. Taxpayer formats and the
corresponding record indicators are listed in the following table.
Format Record Indicator
Taxpayer Reason Code fields (see page 37) TAXPAYER_REASON_CODE
Taxpayer Contact fields (see page 39) TAXPAYER_CONTACT
Taxpayer fields (see page 40) TAXPAYER
Taxpayer Business Location fields (see page 43) BUSINESS_LOCATION_TAXPAYER
Taxpayer Tax Registration Imposition Jurisdiction fields TAX_REGISTRATION_IMPOSITION_JURISDICTION_ TAXPAYER
(see page 45)
Taxpayer Tax Registration Imposition fields (see page TAX_REGISTRATION_IMPOSITION_TAXPAYER
46)
Taxpayer Tax Registration Jurisdiction fields (see page TAX_REGISTRATION_JURISDICTION_TAXPAYER
47)
Taxpayer Tax Registration fields (see page 48) TAX_REGISTRATION_TAXPAYER
Taxpayer Discount Type fields (see page 51) TAXPAYER_DISCOUNT_TYPE
Taxpayer Currency Rounding Rule fields (see page 52) TAXPAYER_CURRENCY_ROUNDING_RULE
Taxpayer Recoverable Percentage for VAT fields (see TAXPAYER_VAT_RECOVERABLE_PERCENTAGE
page 54)

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Reason Code fields


The following table describes TAXPAYER_REASON_CODE fields for a flat
tilde-delimited import file.
Required fields apply if the taxpayer is identified as Exempt or Generally
Nontaxable.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXPAYER_REASON_CODE
to text in
description field.
2 taxpayer Yes STRING 80 Yes The user-defined code that identifies
Company the company.
Code
3 taxpayer Yes STRING 80 No The user-defined code that identifies
Division the division.
Code Defaults to NULL, if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined code that identifies
Department the department.
Code Defaults to NULL, if not supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 partyRoleType Yes STRING 60 Yes The party role type name represents
Name roles that parties can play in
transactions.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
8 reasonCode Yes STRING 60 Yes The reason code that applies when
Name the taxpayer is playing this party role
in a transaction.
9 general Yes LONG 1 Yes Flag to indicate that the taxpayer is
NontaxableInd generally nontaxable when playing
this party role in a transaction.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Field Field Natural Type Max. Size Req. Description


Count Key
10 exemptInd Yes LONG 1 Yes Flag to indicate the taxpayer is
exempt when playing this party role
in a transaction.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Contact fields


The following table describes TAXPAYER_CONTACT fields for a flat tilde-delimited
import file. Required fields apply if contacts are set up for the taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXPAYER_CONTACT
to text in
description
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
Company code.
Code
3 taxpayer Yes STRING 80 No The user-defined code that identifies
DivisionCode the Division. Defaults to NULL, if not
supplied. Division Code is required if
a non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined code that identifies
Department the Department. Defaults to NULL if
Code not supplied.
5 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 streetAddress No STRING 100 No The contact street address.
8 contactCity No STRING 60 No The contact city.
9 contactMain No STRING 60 No The contact main division
Division (state/province/territory).
10 contactPostal No STRING 9 No The contact postal code.
Code
11 contactCountry No STRING 60 No The contact country.
12 email No STRING 100 No The contact email.
13 phone No STRING 20 No The contact phone number
14 phoneExtension No STRING 20 No The contact phone extension.
15 fax No STRING 20 No The contact fax number.
16 departmentCode No STRING 20 Yes The contact department code.
17 firstName No STRING 60 No The contact person’s name.
18 lastName No STRING 60 No The contact person’s last name.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer fields
The following table describes TAXPAYER fields for a flat tilde-delimited import
file. Required fields apply for each taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXPAYER
to text in
description field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
Company code.
Code
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
Division code.
Code Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
Department department code.
Code Defaults to NULL, if not supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 startEffDate Yes LONG 8 Yes Date format is YYYYMMDD.
7 taxpayerName No STRING 60 Yes The user-defined taxpayer name.
8 endEffDate No LONG 8 No Date format is YYYYMMDD;
defaults to 99991231 if not
provided.
9 taxpayerFiling No LONG 1 No Indicates whether this taxpayer is a
EntityInd filing entity.
1 = true, 0 = false.
Defaults to 1, is filing entity, if not
supplied.
10 note No STRING 1000 No The taxpayer note.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Field Field Natural Type Max. Size Req. Description


Count Key
11 shippingTerms No STRING 60 No For VAT only, this field represents
the shipping terms for the transfer
of goods.
Defaults to NULL, if not supplied.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
12 overTaxThreshold No DOUBLE 18 No The flat amount over charge
Amount threshold. This numeric field allows
up to 18 digits total, with up to
three digits after the decimal.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).
13 overTaxThreshold No DOUBLE 18 No The percentage-based over charge
Percent threshold. This numeric field allows
up to 10 digits total, with up to six
digits after the decimal. The
percentage should be represented
in decimal format. For example,
2.3% should be represented as
0.023.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).
14 underTax No DOUBLE 18 No The flat amount under charge
ThresholdAmount threshold. This numeric field allows
up to 18 digits total, with up to
three digits after the decimal.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Field Field Natural Type Max. Size Req. Description


Count Key
15 underTax No DOUBLE 18 No The percentage-based under charge
ThresholdPercent threshold. This numeric field allows
up to 10 digits total, with up to six
digits after the decimal. The
percentage should be represented
in decimal format. For example,
2.3% should be represented as
0.023.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).
16 parentParty No LONG 1 No Indicates whether this taxpayer
InheritenceInd inherits attributes from its parent
taxpayer.
1 = true, 0 = false.
Defaults to 0 if not supplied.
17 taxpayerType No STRING 60 No Taxpayer type.
A free-form string identifying the
type of Taxpayer.
18 companyStartEffD Yes LONG 8 No The company-level taxpayer start
ate effective date.
19 divisionStartEff Yes LONG 8 No The division-level taxpayer start
Date effective date.
20 discountCategory Yes STRING 60 Yes The discount category name with
Name which this taxpayer is associated.
21 discountCategory No LONG 8 No The discount category start
StartDate effective date.
Date format is YYYYMMDD.
22 temporary No STRING 155 No A temporary key to facilitate the
TaxpayerKey association of a Taxpayer with
other Taxpayers that have the same
taxpayer id. For a Vertex export file,
the Taxpayer ID and Source ID are
used to populate the field.
User-created import files, for
example, files not created via the
Vertex export, may use any unique
identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Business Location fields


The following table describes BUSINESS_LOCATION_TAXPAYER fields for a flat
tilde-delimited import file. Required fields apply if a business location is set up for
the taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes BUSINESS_LOCATION_
to text in TAXPAYER
description field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
Company code.
Code
3 taxpayer Yes STRING 80 No The user-defined code that identifies
Division the Division.
Code Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined code that identifies
Department the Department.
Code Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Related to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 locationCode Yes STRING 20 Yes The user-defined location code.
8 registrationCode No STRING 20 Yes A code assigned by the taxing
jurisdiction to the physical location.
9 locationStartEff No LONG 8 No The effective start date for the
Date location.
Date format is YYYYMMDD.
10 locationEndEff No LONG 8 No The effective end date for the
Date location.
Date format is YYYYMMDD. Defaults
to 99991231 if not provided.
11 locationName No STRING 60 Yes The name of the location.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Field Field Natural Type Max. Size Req. Description


Count Key
12 partyRoleType Yes STRING 60 Yes The party role type associated with
Name the location. This implies the domain
(Supplies or Procurement) to which
the location is relevant.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
13 streetAddress No STRING 100 No The street address of the location.
Defaults to NULL if not provided.
14 locationCity No STRING 60 Yes The location city.
15 locationSub No STRING 60 No The location subdivision
Division (county/parish). Defaults to NULL if
not provided. It is recommended that
the SubDivison Name be supplied to
accurately determine the location via
TaxGIS.
16 locationMain No STRING 60 Yes The location main division
Division (state/province/territory).
17 locationPostal No STRING 9 Yes The location postal code.
Code
18 locationCountry No STRING 60 Yes The location country.
19 taxAreaId No LONG 18 No The identification of a tax area that
the business location is in.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Tax Registration Imposition Jurisdiction fields


The following table describes TAX_REGISTRATION_IMPOSITION_
JURISDICTION_TAXPAYER fields for a flat tilde-delimited import file. Required
fields apply if a tax registration and its impositions are set up for the taxpayer and
if a lower-level jurisdiction override is set up within the tax registration
imposition.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_REGISTRATION_
text in description IMPOSITION_JURISDICTION_
field. TAXPAYER
2 actionType Yes STRING 60 Yes Action types for inheriting
coverage behavior from
higher-level jurisdictions.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Coverage Action Type.
3 registrationId Yes STRING 60 No The ID that the jurisdiction
Code assigns to the registration.
4 registration Yes STRING 60 No The tax registration type.
Type For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Tax Registration Type.
5 jurisdictionId Yes LONG 18 Yes The jurisdiction that overrides
the tax registration imposition
setting.
6 reverseCharge No LONG 1 No Indicates whether the taxpayer is
Indicator eligible for the Import Reverse
Charge for the specified
jurisdiction.
7 temporaryTax No STRING 155 Yes A temporary key to facilitate the
Registration association of a Tax Registration
ImpKey Imposition with related
overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Tax Registration Imposition fields


The following table describes TAX_REGISTRATION_IMPOSITION_ TAXPAYER fields
for a flat tilde-delimited import file. Required fields apply if a tax registration and
its impositions are set up for the taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_REGISTRATION_
to text in IMPOSITION_TAXPAYER
description field.
2 impositionType Yes STRING 60 Yes Tax Imposition Type for the tax
registration.
3 impositionType Yes STRING 128 Yes Name related to Source ID for
SourceName Tax Imposition Type.
4 activeIndicator No LONG 1 No A flag to indicate the entity is
registered in this imposition.
1 = true, 0 = false.
Defaults to 0, if not supplied.
5 jurisdictionType Yes STRING 60 Yes The Jurisdiction Type Set name.
Set For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
6 registrationId Yes STRING 60 No The ID that the jurisdiction
Code assigns to the registration.
7 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Tax Registration Type.
8 reverseCharge No LONG 1 No Indicates whether the
Indicator registration is a reverse charge.
9 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationKey association of a Tax Registration
with related Tax Registration
Imposition.
10 temporaryTax No STRING 155 Yes A temporary key to facilitate the
Registration association of a Tax Registration
ImpKey Imposition with related
overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Tax Registration Jurisdiction fields


The following table describes TAX_REGISTRATION_JURISDICTION_ TAXPAYER
fields for a flat tilde-delimited import file. Required fields apply if a tax
registration is set up for the taxpayer and if a lower-level jurisdiction override is
set up within the tax registration.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_REGISTRATION_
text in description JURISDICTION_TAXPAYER
field.
2 actionType Yes STRING 60 Yes Action types for inheriting
coverage behavior from
higher-level jurisdictions.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Coverage Action Type.
3 jurisdictionId Yes LONG 18 Yes The lower-level jurisdiction that
override the tax registration
setting.
4 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationKey association of a Tax Registration
with related overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Tax Registration fields


The following table describes TAX_REGISTRATION_TAXPAYER fields for a flat
tilde-delimited import file. Required fields apply if a tax registration is set up for
the taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_REGISTRATION_
text in description TAXPAYER
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer
Company company code.
Code
3 taxpayer Yes STRING 80 No The user-defined code that
Division identifies the Division.
Code Defaults to NULL, if not
supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined code that
Department identifies the Department.
Code Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name corresponding to Source
ID.
6 taxpayerStart Yes LONG 8 Yes Date format is YYYYMMDD.
EffDate
7 allCities No LONG 1 No A flag to indicate that the entity
Registered registered in all cities of
high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
8 allCounties No LONG 1 No A flag to indicate that the entity
Registered registered in all subdivisions of
high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Field Field Natural Type Max. Size Req. Description


Count Key
9 allStates No LONG 1 No A flag to indicate that the entity
Registered registered in all main divisions
of high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
10 allOthers No LONG 1 No A flag to indicate that the entity
Registered registered in all district-level
jurisdictions of high-level
jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
11 activeIndicator No LONG 1 No A flag to indicate the entity is
registered in this jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
12 physical No LONG 1 No Indicator for existence of a
Presence physical presence in the
Indicator jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
13 jurisdictionId Yes LONG 18 Yes The jurisdiction in which the
entity is registered.
14 registrationId Yes STRING 60 No The ID that the jurisdiction
Code assigns to the registration.
15 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Tax Registration Type.
16 validationDate No LONG 8 No The date when validation is
performed.
17 validationType Yes STRING 60 No The types of validation results.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Field Field Natural Type Max. Size Req. Description


Count Key
18 startEffDate No LONG 8 No The start date on which the
registration is effective.
The format is YYYYMMDD.
Defaults to the current date if
not provided.
19 endEffDate No LONG 8 No The date on which the
registration expires and is no
longer effective.
Defaults to 99991231 if not
supplied.
20 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationKey association of a Tax Registration
with related Jurisdiction Type
Sets and values. For a Vertex
export file, the
Tax_Registration_Id is used to
populate this field. However,
user-created import files (for
example, files not created via
the Vertex export) may use any
unique identifier.
21 filingCurrency No STRING 3 No The three-letter ISO code for the
Unit filing currency unit.
22 allImpositions No LONG 1 No 1 = true, 0 = false. Indicates if all
Ind impositions are considered
registered by the registration
unless overridden.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Discount Type fields


The following table describes TAXPAYER_DISCOUNT_TYPE fields for a flat
tilde-delimited import file. Required fields apply if a discount type is set up for
the taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXPAYER_DISCOUNT_TYPE
text in description
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
Company code.
Code
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
Division code.
Code Defaults to NULL, if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
Department department code.
Code Defaults to NULL, if not supplied.
5 taxpayerSource Yes STRING 128 Yes The user-defined source name for
Name the taxpayer.
6 taxpayerStart Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 discountType Yes STRING 20 Yes The user-defined discount type.
Code
8 discountType Yes LONG 8 Yes Date format is YYYYMMDD.
StartDate
9 sourceName Yes STRING 128 Yes Name related to Source ID.
10 discountCategory Yes STRING 8 Yes The discount category with which
Name this discount type is associated.
11 discountCategory Yes LONG 8 Yes Discount Category Start Effective
StartDate Date.
12 discountTypeEnd No LONG 8 No Date format is YYYYMMDD. Defaults
Date to 99991231 if not provided.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Currency Rounding Rule fields


The following table describes TAXPAYER_CURRENCY_ROUNDING_RULE fields for
a flat tilde-delimited import file. These fields apply only to VAT Supplies and VAT
Purchases product domains. Required fields apply if special rounding rules are set
up for the taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXPAYER_CURRENCY_
text in description ROUNDING_RULE
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer
Company company code. User-defined
Code currency rounding rules are
required to be associated with a
taxpayer.
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
Division code.
Code Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
Department department code.
Code Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 taxpayerStart Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 jurisdictionId Yes LONG 18 Yes The jurisdiction in which the
Currency Rounding Rule applies.
8 jurisReference Yes LONG 8 Yes A reference date for the
Date jurisdiction’s effectivity.
Date format is YYYYMMDD.
9 currencyUnit Yes STRING 3 Yes The three-letter ISO code for the
currency unit to which the
Currency Rounding Rule applies.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Field Field Natural Type Max. Size Req. Description


Count Key
10 roundingType No STRING 10 Yes The Vertex identifier for the
Rounding Type used when
applying the Currency Conversion
Rounding Rule.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
11 currency Yes LONG 8 Yes The start date of the Currency
RoundingRule Rounding Rule.
StartDate Date format is YYYYMMDD.
12 currency No LONG 8 No Date format is YYYYMMDD;
RoundingRule defaults to 99991231 if not
EndDate provided.
13 taxType No STRING 60 No For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
This field is not currently used; it
has been added to support future
functionality.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxpayer

Taxpayer Recoverable Percentage for VAT fields


The following table describes TAXPAYER_VAT_RECOVERABLE_ PERCENTAGE
fields for a flat tilde-delimited import file. Required fields apply if Recoverable
Percentage is set up for the taxpayer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXPAYER_VAT_
text in description RECOVERABLE_
field. PERCENTAGE
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
Company code.
Code
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
Division code.
Code Defaults to NULL, if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
Department department code. Defaults to NULL,
Code if not supplied.
5 sourceName Yes STRING 128 Yes The user-defined source name for
the taxpayer.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 costCenter No STRING 40 No Cost Center Name.
8 jurisdictionId Yes LONG 18 Yes The jurisdiction in which the entity
is registered.
9 percent No DOUBLE 10 Yes Recoverable percentage.
10 effDate Yes LONG 8 Yes Recoverable Percentage Start
Effective Date.
11 endDate Yes LONG 8 Yes Recoverable Percentage End
Effective Date.
Defaults to 99991231 if not
supplied.
12 accrualReliefInd No LONG 1 Yes Self Accrual Relief Indicator.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Category

Taxability Category format


This section describes the format pertaining to Taxability Categories. Taxability
Categories are used in several different record formats. Check that you use the
Taxability Category Code, not the Taxability Category Name, in the record format.
Vertex provides a report to list all Taxability Category Codes.
When you are using a Taxability Category in an import record, check that the
Taxability Category start effective date is in sync with the entity start date.
The following table describes TAXABILITY_CATEGORY fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXABILITY_CATEGORY
to text in
description field.
2 taxability Yes STRING 60 Yes The user-defined taxability category
CategoryCode code. All category codes are
required to be unique.
3 taxability Yes LONG 8 Yes Date format is YYYYMMDD.
CategoryStart
Date
4 taxability Yes STRING 128 Yes Name related to Source ID.
CategorySource
Name
5 taxability Yes STRING 60 No Taxability Category Data Type
CategoryData Name.
TypeName
6 parentTaxability No STRING 60 Yes The code for the parent taxability
CategoryCode category.
This field is required because
user-defined categories cannot be
root categories; therefore, a
user-defined category must have a
parent.
7 parentTaxability No LONG 8 Yes The start date of the parent
CategoryStart category.
Date Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Category

Field Field Natural Type Max. Size Req. Description


Count Key
8 parentTaxability No STRING 128 Yes The source name of the parent
CategorySource category.
Name This will either be Vertex or the
same source name as the taxability
category itself.
9 parentTaxability Yes STRING 60 No Parent Category Data Type Name.
CategoryData
TypeName
10 taxability No STRING 60 Yes The taxability category name.
CategoryName
11 taxability No STRING 1000 Yes A description for the taxability
Category category.
Description
12 taxability No LONG 1 Yes Indicator of whether or not this
CategoryDefault category is a default or freight
Id default.
Default = 1, Freight Default = 2, No
Default = 0.
13 taxability No LONG 8 No Date format is YYYYMMDD.
CategoryEnd Defaults to 99991231 if not
Date provided.
14 temporary No STRING 155 No A temporary key to facilitate the
Taxability association of a Taxability Category
CategoryKey with other Taxability Categories
that have the same taxability id. For
a Vertex export file, the Taxability
Category ID and Source ID are used
to populate the field. User-created
import files (for example, files not
created via the Vertex export) may
use any unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Flexible Field Definition

Flexible Field Definition format


This section describes the format pertaining to Flexible Field Definitions.
The following table describes FLEX_FIELD_DEFINITION fields for a flat
tilde-delimited import file.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for further detail.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes FLEX_FIELD_DEFINITION
to text in
description
field.
2 flexFieldData Yes STRING 60 Yes Flex Field Definition data type name.
TypeName
3 flexFieldField Yes LONG 2 Yes Flex Field Definition number.
Number
4 flexFieldSource Yes STRING 128 Yes Flex Field Definition source name.
Name
5 flexFieldStartDate Yes LONG 8 Yes Flex Field Definition start effective
date.
Date format is YYYYMMDD.
6 flexField No STRING 1000 No Description for Flex Field Definition.
Description
7 flexFieldEndDate No LONG 8 No Date format is YYYYMMDD. Defaults to
99991231 if not supplied.
8 longName No STRING 60 No A long name describing the meaning of
the flexible field.
9 flexField Yes LONG 8 Yes A number which determines the order
Sequence in which this flexible field is considered
Number (relative to other flexible fields) for
taxability determination.
10 shortName No STRING 10 Yes A short name for the meaning of the
flexible field.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Flexible Field Definition

Field Field Natural Type Max. Size Req. Description


Count Key
11 temporaryFlex No STRING 155 Yes A temporary key to facilitate the
FieldDefinition association of a Flex Field Definition
Key with other Flex Field Definitions that
have the same flex field definition ID.
For a Vertex export file, the Flex Field
Definition ID and Source ID are used to
populate the field. User-created import
files (for example, files that are not
created via the Vertex export) may
use any unique identifier.
12 taxability No STRING 60 No* Taxability Category Code
CategoryCode *This field is required if the Flex Field
Definition has an associated Taxability
Category.
13 taxability No LONG 8 No* Date format is YYYYMMDD.
CategoryStart *This field is required if the Flex Field
Date Definition has an associated Taxability
Category.
14 taxability No STRING 128 No* Name related to Source ID.
CategorySource *This field is required if the Flex Field
Name Definition has an associated Taxability
Category.
15 taxability No STRING 60 No* The data type of the taxability
CategoryData category.
TypeName *This field is required if the Flex Field
Definition has an associated Taxability
Category.
See the “Enumerated Types and
Values” chapter for a list of valid values
for this field.
16 suppliesProduct No LONG 1 Yes* This field indicates whether this
DomainIndicator taxability category should be displayed
in the Supplies Financial Event
Perspective.
1 = true, 0 = false.
* At least one of these two Financial
Event Perspectives must be set to true.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Flexible Field Definition

Field Field Natural Type Max. Size Req. Description


Count Key
17 procurement No LONG 1 Yes* This field indicates whether this
ProductDomain taxability category should be displayed
Indicator in the Procurement Financial Event
Perspective.
1 = true, 0 = false
* At least one of these two Financial
Event Perspectives must be set to true.
18 calcOutputInd No LONG 1 Yes Indicates whether the flex field type is
input (0) or output (1).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Driver

Taxability Driver format


This section describes the format pertaining to Taxability Drivers.
The following table describes TAXABILITY_DRIVER fields for a flat tilde-delimited
import file.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for further detail.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXABILITY_DRIVER
to text in
description field.
2 taxpayerCompanyC Yes STRING 80 Yes The user-defined taxpayer company
ode code.
3 taxpayerDivision Yes STRING 80 No The user-defined taxpayer division
Code code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
5 taxpayerStartDate Yes LONG 8 Yes Date format is YYYYMMDD.
6 taxabilityDriver Yes STRING 40 Yes The user-defined product, purchase,
Code or usage code.
7 taxabilityDriver Yes LONG 8 Yes Date format is YYYYMMDD.
StartDate
8 sourceName Yes STRING 128 Yes Name related to Source ID.
9 taxabilityDriver No STRING 60 Yes The user-defined taxability driver
Name name.
10 taxabilityDriver No LONG 8 No Date format is YYYYMMDD; it
EndDate defaults to 99991231 if not
provided.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Driver

Field Field Natural Type Max. Size Req. Description


Count Key
11 exemptIndicator No LONG 1 No Indicates whether this taxability
driver is exempt.
1 = is exempt, 0 = not exempt.
Defaults to 0 if not supplied.
12 exemptReason No STRING 60 No This exempt reason code for the
Code taxability driver.
Defaults to NULL, if not supplied.
Valid values for this field may be
selected from a list of single
characters to which end users may
assign their own meaning. The list of
valid single characters includes the
letters A-Z, digits 0-9, and the
symbols +, -, and *. The Reason Code
should only be set if the Exempt
Indicator is true.
13 note No STRING 1000 No The note associated with the
taxability driver.
Defaults to NULL if not supplied.
14 taxabilityDriver No LONG 1 Yes This field indicates whether this
SuppliesProduct taxability driver should be displayed
DomainIndicator in the Supplies Financial Event
Perspective.
1 = true, 0 = false.
* At least one of these two Financial
Event Perspectives must be set to
true.
15 taxabilityDriver No LONG 1 Yes This field indicates whether this
Procurement taxability driver should be displayed
ProductDomain in the Procurement Financial Event
Indicator Perspective.
1 = true, 0 = false.
* At least one of these two Financial
Event Perspectives must be set to
true.
16 discountCategory No STRING 60 No The discount category name.
Name
17 discountCategory No LONG 8 No The discount category start effective
StartDate date. Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Driver

Field Field Natural Type Max. Size Req. Description


Count Key
18 flexFieldDataTypeN Yes STRING 60 No* Flex Field Definition data type name
ame of taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
19 flexFieldField Yes LONG 5 No* Flex Field Definition number of
Number taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
20 flexFieldSource Yes STRING 128 No* Flex Field Definition source name of
Name taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
21 flexFieldStartDate Yes LONG 8 No* Flex Field Definition start effective
date of taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
22 flexfieldSupplies No LONG 1 Yes This field indicates whether the
ProductDomain associated flexible field should be
Indicator displayed in the Supplies Financial
Event Perspective.
1 = true, 0 = false.
* At least one of these two Financial
Event Perspectives must be set to
true.
23 flexfield No LONG 1 Yes This field indicates whether the
Procurement associated flexible field should be
ProductDomain displayed in the Procurement
Indicator Financial Event Perspective.
1 = true, 0 = false
* At least one of these two Financial
Event Perspectives must be set to
true.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Field Field Natural Type Max. Size Req. Description


Count Key
24 taxabilityDriver Yes STRING 60 Yes This field indicates the type of Input
TaxabilityInput Parameter of the taxability driver.
ParameterType For a list of valid values for this field,
Name refer to the “Enumerated Types and
Values” chapter.
25 temporary No STRING 155 Yes A temporary key to facilitate the
TaxabilityDriver association of a Taxability Diver with
Key other Taxability Drivers that have the
same taxability driver id. For a
Vertex export file, the Taxability
Driver ID and Source ID are used to
populate the field. User-created
import files. For example, files not
created via the Vertex export, may
use any unique identifier.

Customer formats
This section describes the formats pertaining to Customers and presents them in
the order they must appear in the import file. Customer formats and the
corresponding record indicators are listed in the following table.
Format Record Indicator
Customer Reason Code fields (see page 64) CUSTOMER_REASON_CODE
Customer Contact fields (see page 65) CUSTOMER_CONTACT
Customer fields (see page 67) CUSTOMER
Customer Business Location fields (see page 69) BUSINESS_LOCATION_CUSTOMER
Customer Tax Registration Imposition Jurisdiction fields TAX_REGISTRATION_IMPOSITION_JURISDICTION_
(see page 71) CUSTOMER
Customer Tax Registration Imposition fields (see page TAX_REGISTRATION_IMPOSITION_CUSTOMER
72)
Customer Tax Registration Jurisdiction fields (see page TAX_REGISTRATION_JURISDICTION_CUSTOMER
73)
Customer Tax Registration fields (see page 74) TAX_REGISTRATION_CUSTOMER

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer Reason Code fields


The following table describes CUSTOMER_REASON_CODE fields for a flat
tilde-delimited import file. Required fields apply if the customer has been
identified as Exempt or Generally Nontaxable.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is Yes CUSTOMER_REASON_CODE
identical to
text in
description
field.
2 taxpayerCompanyC Yes STRING 80 Yes The user-defined code that identifies
ode the Company.
3 taxpayerDivision Yes STRING 80 Yes The user-defined taxpayer division code.
Code Division Code is required if a non-NULL
Department Code is supplied.
4 taxpayer Yes STRING 80 Yes The user-defined code that identifies
DepartmentCode the Department.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 txpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 customerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
8 customerCode Yes STRING 80 Yes The user-defined code that identifies
the Customer.
9 partyRoleType Yes STRING 60 Yes The party role type name represents
Name roles that parties can play in
transactions.
For a list of valid values for this field,
refer to Enumerated Types and Values
(see page 212).
10 reasonCodeName Yes STRING 60 Yes The reason code that applies for the
customer.
11 exemptInd Yes LONG 1 Yes Flag to indicate the party role is exempt.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer Contact fields


The following table describes CUSTOMER_CONTACT fields for a flat
tilde-delimited import file. Required fields apply if contacts are set up for the
customer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CUSTOMER_CONTACT
to text in
description field.
2 taxpayerCompany Yes STRING 80 Yes The user-defined taxpayer company
Code code.
3 taxpayerDivision Yes STRING 80 No The user-defined code that identifies
Code the Division.
Defaults to NULL, if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined code that identifies
DepartmentCode the Department.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 streetAddress No STRING 100 No The contact street address.
8 contactCity No STRING 60 No The contact city.
9 contactMain No STRING 60 No The contact main division
Division (state/province/territory).
10 contactPostalCode No STRING 9 No The contact postal code.
11 contactCountry No STRING 60 No The contact country.
12 email No STRING 100 No The contact email.
13 phone No STRING 20 No The contact phone number
14 phoneExtension No STRING 20 No The contact phone extension.
15 fax No STRING 20 No The contact fax number.
16 departmentCode No STRING 20 Yes The contact department code.
17 firstName No STRING 60 No The contact person’s name.
18 lastName No STRING 60 No The contact person’s last name.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Field Field Natural Type Max. Size Req. Description


Count Key
19 contactRoleType No STRING 60 Yes The name of the contact role type.
Name For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Contact
Role Type.
20 customerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
21 customerCode Yes STRING 80 Yes The user-defined customer code.
22 custClassInd No LONG 1 No Indicates whether this is a customer
or a customer class.
1 = is class, 0 = not a class. Defaults
to 0, if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer fields
The following table describes CUSTOMER fields for a flat tilde-delimited import
file. Required fields apply for each customer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CUSTOMER
to text in
description field.
2 taxpayerCompany Yes STRING 80 Yes The user-defined taxpayer
Code company code.
3 taxpayerDivision Yes STRING 80 No The user-defined taxpayer
Code division code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 customerCode Yes STRING 80 Yes The user-defined customer
code.
8 customerName No STRING 60 Yes The customer name.
9 customerStart Yes LONG 8 Yes Date format is YYYYMMDD.
Date
10 customerEndDate No LONG 8 No Date format is YYYYMMDD.
Defaults to 99991231 if not
provided.
11 note No STRING 1000 No The note associated with the
customer.
Defaults to NULL if not supplied.
12 custClassInd No LONG 1 No Indicates whether this is a
customer or a customer class.
1 = is class, 0 = not a class.
Defaults to 0 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Field Field Natural Type Max. Size Req. Description


Count Key
13 shippingTerms No STRING 60 No For VAT only, this field
represents the shipping terms
for the transfer of goods.
Defaults to NULL if not supplied.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
14 discountCategory No STRING 60 No The name of the discount
Name category with which this
customer is associated.
15 discountCategory No LONG 8 No This field indicates the start date
StartDate for a discount category.
16 temporary No STRING 155 No A temporary key to facilitate the
CustomerKey association of a Customer with
other Customers that have the
same Customer ID. For a Vertex
export file, the Customer ID and
Source ID are used to populate
the field. User-created import
files (for example, files that are
not created via the Vertex
export) may use any unique
identifier.
17 customField1Value Yes STRING 60 Yes Custom field for storing extra
customer information.
18 customField2Value Yes STRING 60 Yes Custom field for storing extra
customer information.
19 customField3Value Yes STRING 60 Yes Custom field for storing extra
customer information.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer Business Location fields


The following table describes BUSINESS_LOCATION_CUSTOMER fields for a flat
tilde-delimited import file. Required fields apply if a business location is set up for
the customer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes BUSINESS_LOCATION_
to text in CUSTOMER
description
field.
2 taxpayer Yes STRING 80 Yes A user-defined code that identifies the
CompanyCode Company code.
3 taxpayerDivision Yes STRING 80 No A user-defined code that identifies the
Code Division.
Defaults to NULL if not supplied.
Division Code is required if a non-NULL
Department Code is supplied.
4 taxpayer Yes STRING 80 No A user-defined code that identifies the
DepartmentCode Department.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 locationCode Yes STRING 20 Yes A user-defined location code.
8 registrationCode No STRING 20 Yes A code assigned by the taxing
jurisdiction to the physical location.
9 locationStartEff No LONG 8 Yes The effective start date.
Date Date format is YYYYMMDD. Defaults to
today’s date if not provided.
10 locationEndEff No LONG 8 No The effective end date of the record.
Date Date format is YYYYMMDD. Defaults to
99991231 if not provided.
11 locationName No STRING 60 Yes The name of the location.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Field Field Natural Type Max. Size Req. Description


Count Key
12 partyRoleType No STRING 60 Yes The party role type associated with the
Name location. This implies the domain
(Supplies or Procurement) to which the
location is relevant.
For a list of valid values for this field,
refer to Enumerated Types and Values
(see page 212).
13 streetAddress No STRING 100 No The street address of the location.
Defaults to NULL if not provided.
14 locationCity No STRING 60 Yes The location city.
15 locationSub No STRING 60 No The location subdivision
Division (county/parish). Defaults to NULL if not
provided. Vertex recommends that the
name be supplied in order to
accurately determine the location via
TaxGIS.
16 locationMain No STRING 60 Yes The location main division.
Division
17 locationPostal No STRING 9 Yes The location postal code.
Code
18 locationCountry No STRING 60 Yes The location country.
19 taxAreaId No LONG 18 No The identification of a tax area where
the business location is.
20 customerCode Yes STRING 80 Yes The user-defined customer code.
21 custClassInd No LONG 1 No Indicates whether this is a customer or
a customer class.
1=class; 0=not a class.
Defaults to 0, if not supplied.
22 customerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer Tax Registration Imposition Jurisdiction fields


The following table describes TAX_REGISTRATION_IMPOSITION_
JURISDICTION_CUSTOMER fields for a flat tilde-delimited import file. Required
fields apply if a tax registration and its impositions are set up for the customer
and if a lower-level jurisdiction override is set up within the tax registration
imposition.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_REGISTRATION_
text in description IMPOSITION_JURISDICTION_
field. CUSTOMER
2 actionType Yes STRING 60 Yes Action types for inheriting coverage
behavior from higher-level
jurisdictions.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Coverage
Action Type.
3 registrationId Yes STRING 60 No The ID that the jurisdiction assigns to
Code the registration.
4 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Tax
Registration Type.
5 jurisdictionId Yes LONG 18 Yes The jurisdiction that overrides the tax
registration imposition setting.
6 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationImp association of a Tax Registration
Key Imposition with related overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer Tax Registration Imposition fields


The following table describes TAX_REGISTRATION_IMPOSITION_ CUSTOMER
fields for a flat tilde-delimited import file. Required fields apply if a tax
registration and its impositions are set up for the customer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_REGISTRATION_
to text in IMPOSITION_CUSTOMER
description field.
2 impositionType Yes STRING 60 Yes Tax Imposition Type for the tax
registration.
3 impositionType Yes STRING 128 Yes Name related to Source ID for Tax
SourceName Imposition Type.
4 activeIndicator No LONG 1 No A flag to indicate the entity is
registered in this imposition.
1 = true, 0 = false.
Defaults to 0, if not supplied.
5 jurisdictionTypeSet Yes STRING 60 Yes The Jurisdiction Type Set name.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
6 registrationIdCode Yes STRING 60 No The ID that the jurisdiction assigns
to the registration.
7 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the Tax
Registration Type.
8 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationKey association of a Tax Registration
with related Tax Registration
Imposition.
9 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationImp association of a Tax Registration
Key Imposition with related overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer Tax Registration Jurisdiction fields


The following table describes TAX_REGISTRATION_JURISDICTION_CUSTOMER
fields for a flat tilde-delimited import file. Required fields apply if a tax
registration is set up for the customer and if a lower-level jurisdiction override is
set up within the tax registration.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_REGISTRATION_
text in description JURISDICTION_
field. CUSTOMER
2 actionType Yes STRING 60 Yes Action types for inheriting
coverage behavior from
higher-level jurisdictions.
For a list of valid values for
this field, refer to
Enumerated Types and
Values (see page 212), the
Coverage Action Type.
3 jurisdictionId Yes LONG 18 Yes The jurisdiction that
overrides the tax registration
imposition setting.
4 temporaryTax No STRING 155 Yes A temporary key to facilitate
RegistrationKey the association of a Tax
Registration with related
overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Customer Tax Registration fields


The following table describes TAX_REGISTRATION_CUSTOMER fields for a flat
tilde-delimited import file. These fields are only applicable to VAT Supplies and
VAT Purchases product domains. Required fields apply if a tax registration has
been set up for the customer.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_REGISTRATION_
to text in CUSTOMER
description field.
2 taxpayerCompany Yes STRING 80 Yes The user-defined taxpayer
Code company code.
3 taxpayerDivision Yes STRING 80 No The user-defined code that
Code identifies the Division.
Defaults to NULL, if not
supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined code that
DepartmentCode identifies the Department.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name corresponding to Source
ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 allCitiesRegistered No LONG 1 No Indicates if the entity is
registered in all cities of the
high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
8 allCounties No LONG 1 No Indicates if the entity is
Registered registered in all subdivisions of
the high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Field Field Natural Type Max. Size Req. Description


Count Key
9 allStatesRegistered No LONG 1 No Indicates if the entity is
registered in all main divisions
of the high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
10 allOthersRegistered No LONG 1 No Indicates if the entity is
registered in all district-level
jurisdictions of the high-level
jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
11 activeIndicator No LONG 1 No A flag to indicate the entity is
registered in this jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
12 physicalPresence No LONG 1 No Indicator for existence of a
Indicator physical presence in the
jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
13 jurisdictionId Yes LONG 18 Yes The jurisdiction in which the
entity is registered.
14 registrationIdCode Yes STRING 60 No The ID that the jurisdiction
assigns to the registration.
15 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Tax Registration Type.
16 VIESvalidationDate No LONG 8 No The date when validation is
performed.
17 VIESvalidationType Yes STRING 60 No The types of validation results.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Customer

Field Field Natural Type Max. Size Req. Description


Count Key
18 startEffDate No LONG 8 No The start date on which the
registration is effective.
The format is YYYYMMDD and
defaults to the current date if
not provided.
19 endEffDate No LONG 8 No The date on which the
registration expires and is no
longer effective.
Defaults to 99991231 if not
supplied.
20 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationKey association of a Tax Registration
with related Jurisdiction Type
Sets and values. For a Vertex
export file, the
Tax_Registration_Id is used to
populate this field. However,
user-created import files (for
example, files not created via
the Vertex export) may use
any unique identifier.
21 customerCode Yes STRING 80 Yes The user-defined customer
code.
22 customerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
23 custClassInd No LONG 1 No Indicates whether this is a
customer or a customer class.
1 = is class, 0 = not a class.
Defaults to 0, if not supplied.
24 allImpositionsInd No LONG 1 No Indicates if all impositions are
considered registered by the
registration unless overridden.
1 = true, 0 = false.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Vendor formats

Vendor formats
This section describes the formats pertaining to Vendors and presents them in
the order they must appear in the import file. Vendor formats and the
corresponding record indicators are listed in the following table.
Format Record Indicator
Vendor Reason Code fields (see page 78) VENDOR_REASON_CODE
Vendor fields (see page 79) VENDOR
Vendor Business Location fields (see page 82) BUSINESS_LOCATION_VENDOR
Vendor Tax Registration Imposition Jurisdiction fields TAX_REGISTRATION_IMPOSITION_JURISDICTION_ VENDOR
(see page 84)
Vendor Tax Registration Imposition fields (see page 85) TAX_REGISTRATION_IMPOSITION_VENDOR
Vendor Tax Registration Jurisdiction fields (see page TAX_REGISTRATION_JURISDICTION_VENDOR
86)
Vendor Tax Registration fields (see page 87) TAX_REGISTRATION_VENDOR
Vendor Recoverable Percentage for VAT fields (see VENDOR_VAT_RECOVERABLE_PERCENTAGE
page 90)

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor Reason Code fields


The following table describes VENDOR_REASON_CODE fields for a flat
tilde-delimited import file. Required fields apply if the vendor is identified as
Exempt or Generally Nontaxable.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes VENDOR_REASON_CODE
to text in
description field.
2 taxpayer Yes STRING 80 Yes The user-defined code that
CompanyCode identifies the Company.
3 taxpayerDivision Yes STRING 80 Yes The user-defined code that
Code identifies the Division.
Defaults to NULL if not
supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 Yes The user-defined code that
DepartmentCode identifies the Department.
Defaults to NULL if not
supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 vendorStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
8 vendorCode Yes STRING 80 Yes The user-defined vendor code.
9 partyRoleType Yes STRING 60 Yes The party role type name
Name represents roles that parties
can play in transactions.
For a list of valid values for this
field, refer to Enumerated
Types and Values (see page
212).
10 reasonCode Yes STRING 60 Yes The reason code that applies
Name for the vendor.
11 exemptInd Yes LONG 1 Yes Flag to indicate the party role is
exempt.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor fields
The following table describes VENDOR fields for a flat tilde-delimited import file.
Required fields apply for each vendor.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes VENDOR
to text in
description field.
2 taxpayerCompany Yes STRING 80 Yes The user-defined taxpayer
Code company code.
3 taxpayerDivision Yes STRING 80 No The user-defined taxpayer
Code division code.
Defaults to NULL if not
supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not
supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 vendorCode Yes STRING 80 Yes The user-defined vendor code.
8 vendorName No STRING 60 Yes The vendor name.
9 vendorStartDate Yes LONG 8 Yes Date format is YYYYMMDD.
10 vendorEndDate No LONG 8 No Date format is YYYYMMDD.
Defaults to 99991231 if not
provided.
11 note No STRING 1000 No The note associated with the
vendor.
Defaults to NULL if not
supplied.
12 vendClassInd No LONG 1 No Indicates whether this is a
vendor or a vendor class.
1 = is class, 0 = not a class.
Defaults to 0 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Field Field Natural Type Max. Size Req. Description


Count Key
13 shippingTerms No STRING 60 No For VAT only, this field
represents the shipping terms
for the transfer of goods.
Defaults to NULL if not
supplied.
For a list of valid values for this
field, refer to Enumerated
Types and Values (see page
212).
14 ersInd No LONG 1 No Indicates whether this vendor
participates in ERS
transactions.
1 = true, 0 = false.
Defaults to 0 if not supplied.
15 discountCategory No STRING 60 No The discount category
Name associated with this vendor.
16 discountCategory No LONG 8 No The start effective date of the
StartDate associated discount category.
Date format is YYYYMMDD.
17 overTaxThresholdA No DOUBLE 18 No The flat amount over charge
mount threshold.
This numeric field allows up to
18 digits total, with up to three
digits after the decimal.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).
18 overTaxThresholdP No DOUBLE 18 No The percentage-based over
ercent charge threshold.
This numeric field allows up to
10 digits total, with up to six
digits after the decimal. The
percentage should be
represented in decimal format,
for example, 2.3% should be
represented as 0.023.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Field Field Natural Type Max. Size Req. Description


Count Key
19 underTax No DOUBLE 18 No The flat amount under charge
ThresholdAmount threshold.
This numeric field allows up to
18 digits total, with up to three
digits after the decimal.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).
20 underTax No DOUBLE 18 No The percentage-based under
ThresholdPercent charge threshold.
This numeric field allows up to
10 digits total, with up to six
digits after the decimal. The
percentage should be
represented in decimal format,
for example, 2.3% should be
represented as 0.023.
Defaults to NULL if not supplied
(not to 0, because 0 can have
meaning in this context).
21 temporaryVendor No STRING 155 No A temporary key to facilitate
Key the association of a Vendor
with other Vendors that have
the same vendor id. For a
Vertex export file, the Vendor
ID and Source ID are used to
populate the field.
User-created import files, for
example, files not created via
the Vertex export may use any
unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor Business Location fields


The following table describes BUSINESS_LOCATION_VENDOR fields for a flat
tilde-delimited import file. Required fields apply if a business location is set up for
the vendor.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes BUSINESS_LOCATION_VENDOR
to text in
description
field.
2 taxpayer Yes STRING 80 Yes A user-defined code that identifies the
CompanyCode Company code.
3 taxpayerDivision Yes STRING 80 No A user-defined code that identifies the
Code Division.
Defaults to NULL if not supplied.
Division Code is required if a non-NULL
Department Code is supplied.
4 taxpayer Yes STRING 80 No A user-defined code that identifies the
DepartmentCode Department.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name related to Source ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 locationCode Yes STRING 20 Yes A user-defined location code.
8 registrationCode No STRING 20 Yes A code assigned by the taxing
jurisdiction to the physical location.
9 locationStartEff No LONG 8 Yes The effective start date.
Date Date format is YYYYMMDD. Defaults to
today’s date if not provided.
10 locationEndEff No LONG 8 No The effective end date of the record.
Date Date format is YYYYMMDD; defaults to
99991231 if not provided.
11 locationName No STRING 60 Yes The name of the location.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Field Field Natural Type Max. Size Req. Description


Count Key
12 partyRoleType No STRING 60 Yes The party role type associated with the
Name location. This implies the domain
(Supplies or Procurement) to which the
location is relevant.
For a list of valid values for this field,
refer to Enumerated Types and Values
(see page 212).
13 streetAddress No STRING 100 No The street address of the location.
Defaults to NULL if not provided.
14 locationCity No STRING 60 Yes The location city.
15 locationSub No STRING 60 No The location subdivision
Division (county/parish). Defaults to NULL if not
provided. Vertex recommends that the
name be supplied in order to
accurately determine the location via
TaxGIS.
16 locationMain No STRING 60 Yes The location main division.
Division
17 locationPostal No STRING 9 Yes The location postal code.
Code
18 locationCountry No STRING 60 Yes The location country.
19 taxAreaId No LONG 18 No The identification of a tax area where
the business location is.
20 vendorCode Yes STRING 80 Yes The user-defined vendor/supplier
code.
21 vendorStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor Tax Registration Imposition Jurisdiction fields


The following table describes TAX_REGISTRATION_IMPOSITION_
JURISDICTION_VENDOR fields for a flat tilde-delimited import file. Required fields
apply if a tax registration and its impositions are set up for the vendor and if a
lower-level jurisdiction override is set up within the tax registration imposition.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_REGISTRATION_
to text in IMPOSITION_JURISDICTION_VE
description field. NDOR
2 actionType Yes STRING 60 Yes Action types for inheriting
coverage behavior from
higher-level jurisdictions.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Coverage Action Type.
3 registrationIdCode Yes STRING 60 No The ID that the jurisdiction
assigns to the registration.
4 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Tax Registration Type.
5 jurisdictionId Yes LONG 18 Yes The jurisdiction that overrides
the tax registration imposition
setting.
6 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationImp association of a Tax Registration
Key Imposition with related
overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor Tax Registration Imposition fields


The following table describes TAX_REGISTRATION_IMPOSITION_VENDOR fields
for a flat tilde-delimited import file. Required fields apply if a tax registration and
its impositions are set up for the vendor.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_REGISTRATION_
to text in IMPOSITION_VENDOR
description field.
2 impositionType Yes STRING 60 Yes Tax Imposition Type for the tax
registration.
3 impositionType Yes STRING 128 Yes Name related to Source ID for
SourceName Tax Imposition Type.
4 activeIndicator No LONG 1 No A flag to indicate the entity is
registered in this imposition.
1 = true, 0 = false. Defaults to
0, if not supplied.
5 jurisdictionType Yes STRING 60 Yes The Jurisdiction Type Set name.
Set For a list of valid values for this
field, refer to Enumerated
Types and Values (see page
212).
6 registrationId Yes STRING 60 No The ID that the jurisdiction
Code assigns to the registration.
7 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this
field, refer to Enumerated
Types and Values (see page
212), the Tax Registration Type.
8 temporaryTax No STRING 155 Yes A temporary key to facilitate
RegistrationKey the association of a Tax
Registration with related Tax
Registration Imposition.
9 temporaryTax No STRING 155 Yes A temporary key to facilitate
RegistrationImp the association of a Tax
Key Registration Imposition with
related overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor Tax Registration Jurisdiction fields


The following table describes TAX_REGISTRATION_JURISDICTION_ VENDOR fields
for a flat tilde-delimited import file. Required fields apply if a tax registration is
set up for the vendor and if a lower-level jurisdiction override is set up within the
tax registration.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_REGISTRATION_
text in description JURISDICTION_VENDOR
field.
2 actionType Yes STRING 60 Yes Action types for inheriting coverage
behavior from higher-level
jurisdictions.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Coverage Action Type.
3 jurisdictionId Yes LONG 18 Yes The lower-level jurisdiction that
override the tax registration
setting.
4 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationKey association of a Tax Registration
with related overrides.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor Tax Registration fields


The following table describes TAX_REGISTRATION_VENDOR fields for a flat
tilde-delimited import file. Required fields apply if a tax registration is set up for
the vendor.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_REGISTRATION_
to text in VENDOR
description field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer
CompanyCode company code.
3 taxpayerDivisionC Yes STRING 80 No The user-defined code that
ode identifies the Division.
Defaults to NULL, if not
supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined code that
DepartmentCode identifies the Department.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name corresponding to Source
ID.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 allCities No LONG 1 No Indicates if the entity is
Registered registered in all cities of the
high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
8 allCounties No LONG 1 No Indicates if the entity is
Registered registered in all subdivisions of
high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Field Field Natural Type Max. Size Req. Description


Count Key
9 allStates No LONG 1 No Indicates if the entity is
Registered registered in all main divisions
of high-level jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
10 allOthers No LONG 1 No Indicates if the entity is
Registered registered in all district-level
jurisdictions of high-level
jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
11 activeIndicator No LONG 1 No Indicates if the entity is
registered in this jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
12 physicalPresence No LONG 1 No Indicator for existence of a
Indicator physical presence in the
jurisdiction.
1 = true, 0 = false.
Defaults to 0, if not supplied.
13 jurisdictionId Yes LONG 18 Yes The jurisdiction in which the
entity is registered.
14 registrationId Yes STRING 60 No The ID that the jurisdiction
Code assigns to the registration.
15 registrationType Yes STRING 60 No The tax registration type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Tax Registration Type.
16 VIESvalidation No LONG 8 No The date when validation is
Date performed.
17 VIESvalidation Yes STRING 60 No The types of validation results.
Status For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Field Field Natural Type Max. Size Req. Description


Count Key
18 startEffDate No LONG 8 No The start date on which the
registration is effective.
The format is YYYYMMDD.
Defaults to the current date if
not provided.
19 endEffDate No LONG 8 No The date on which the
registration expires and is no
longer effective.
Defaults to 99991231 if not
supplied.
20 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RegistrationKey association of a Tax Registration
with related Jurisdiction Type
Sets and values. For a Vertex
export file, the
Tax_Registration_Id is used to
populate this field. However,
user-created import files (for
example, files not created via
the Vertex export), may use any
unique identifier.
21 vendorCode Yes STRING 80 Yes The user-defined vendor code.
22 vendorStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
23 vendorClassInd No LONG 1 No Indicates whether this is a
vendor or a vendor class.
1 = is class, 0 = not a class.
Defaults to 0, if not supplied.
24 allImpositionsInd No LONG 1 No Indicates if all impositions are
considered registered by the
registration unless overridden.
1 = true, 0 = false.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Vendor

Vendor Recoverable Percentage for VAT fields


The following table describes VENDOR_VAT_RECOVERABLE_ PERCENTAGE fields
for a flat tilde-delimited import file. Required fields apply if a Recoverable
Percentage is set up for the vendor.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes VENDOR_VAT_RECOVERABLE_
to text in PERCENTAGE
description field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
CompanyCode code.
3 taxpayerDivision Yes STRING 80 No The user-defined taxpayer division
Code code.
Defaults to NULL, if not supplied.
Division Code is required if a non-NULL
Department Code is supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer department
DepartmentCode code.
Defaults to NULL, if not supplied.
5 sourceName Yes STRING 128 Yes The user-defined source name for the
taxpayer.
6 taxpayerStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
7 vendorCode Yes STRING 80 Yes The user defined vendor/supplier
code.
8 vendorStartEff Yes LONG 8 Yes Date format is YYYYMMDD.
Date
9 costCenter No STRING 40 No Cost Center Name.
10 jurisdictionId Yes LONG 18 Yes The jurisdiction in which the entity is
registered.
11 percent No DOUBLE 10 Yes Recoverable percentage
12 effDate Yes LONG 8 Yes Recoverable Percentage Start Effective
Date.
13 endDate Yes LONG 8 Yes Recoverable Percentage End Effective
Date.
Defaults to 99991231 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Category Mapping

Taxability Category Mapping formats


This section describes the formats pertaining to Taxability Category Mapping and
presents them in the order they must appear in the import file. Taxability
Category Mapping formats and the corresponding record indicators are listed in
the following table.
Format Record Indicator
Taxability Category Mapping Drivers fields (see page TAXABILITY_CATEGORY_MAPPING_DRIVERS
92)
Taxability Category Mapping fields (see page 94) TAXABILITY_CATEGORY_MAPPING

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Category Mapping

Taxability Category Mapping Drivers fields


The following table describes TAXABILITY_CATEGORY_MAPPING_ DRIVERS fields
for a flat tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXABILITY_CATEGORY_
text in description MAPPING_DRIVERS
field.
2 taxabilityDriver No STRING 80 No The user-defined taxpayer company
Taxpayer code.
CompanyCode
3 taxabilityDriver No STRING 80 No The user-defined taxpayer division
TaxpayerDivision code.
Code Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxabilityDriver No STRING 80 No The user-defined taxpayer
Taxpayer department code.
DepartmentCode Defaults to NULL if not supplied.
5 taxabilityDriver No LONG 8 No Date format is YYYYMMDD.
TaxpayerStart
Date
6 taxabilityDriver Yes STRING 40 No The user-defined product or
Code purchase or usage code.
7 taxabilityDriver Yes LONG 8 No Date format is YYYYMMDD.
StartDate
8 taxabilityDriver Yes STRING 60 Yes This field indicates the type of Input
TaxabilityInput Parameter of the taxability driver.
ParameterType For a list of valid values for this
Name field, refer to Enumerated Types
and Values (see page 212).
9 taxabilityDriver No LONG 1 Yes This field indicates whether this
SuppliesProduct taxability driver should be displayed
DomainIndicator in the Supplies Product Domain.
1 = true, 0 = false.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Category Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
10 taxabilityDriver No LONG 1 Yes This field indicates whether this
Procurement taxability driver should be displayed
ProductDomain in the Procurement Product
Indicator Domain.
1 = true, 0 = false
11 taxability Yes STRING 128 Yes Name related to Source ID.
CategoryMapping
SourceName
12 flexFieldData Yes STRING 60 No Flex Field Definition data type name
TypeName of taxability driver.
13 flexFieldField Yes LONG 5 No Flex Field Definition number of
Number taxability driver.
14 flexFieldSource Yes STRING 128 No Flex Field Definition source name of
Name taxability driver.
15 flexFieldStart Yes LONG 8 No Flex Field Definition start effective
Date date of taxability driver.
16 flexfieldSupplies No LONG 1 Yes Flex Field Definition supplies
ProductDomain indicator of taxability driver.
Indicator 1 = true, 0 = false.
17 flexfield No LONG 1 Yes Flex Field Definition procurement
Procurement indicator of taxability driver.
ProductDomain 1 = true, 0 = false
Indicator
18 temporary No STRING 155 Yes A temporary key to facilitate the
Taxability association of a Taxability Mapping
MappingKey with related entities and values. For
a Vertex export file, the Taxability
Mapping ID is used to populate this
field. However, user-created import
files (for example, files not created
via the Vertex export), may use any
unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Category Mapping

Taxability Category Mapping fields


The following table describes TAXABILITY_CATEGORY_MAPPING fields for a flat
tilde-delimited import file. Required fields apply if taxability category mapping
has taxability drivers.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXABILITY_CATEGORY_
text in description MAPPING
field.
2 partyTaxpayer Yes STRING 80 No The user-defined taxpayer company
CompanyCode code.
3 partyTaxpayer Yes STRING 80 No The user-defined taxpayer division
DivisionCode code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 partyTaxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
5 partyTaxpayer Yes LONG 8 No Date format is YYYYMMDD.
StartDate
6 partyCode Yes STRING 80 No User-defined customer/ vendor/
customer class/ vendor class code.

7 partyClass No LONG 1 No Indicates whether this is a


Indicator customer/vendor or a
customer/vendor class.
1 = is class, 0 = not a class.
Defaults to 0 if not supplied.
8 partyStartDate Yes LONG 8 No Customer/Vender/Customer
Class/Vendor Class start effective
date.
9 partyTypeName Yes STRING 20 No The name of the party type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Party
Type.
10 taxpayer Yes STRING 80 No The user-defined taxpayer company
CompanyCode code.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Category Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
11 taxpayerDivisionC Yes STRING 80 No The user-defined taxpayer division
ode code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
12 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
13 taxpayerStart Yes LONG 8 No Date format is YYYYMMDD.
Date
14 taxability Yes LONG 8 No Date format is YYYYMMDD.
CategoryMapping
StartDate
15 taxability No LONG 8 No Date format is YYYYMMDD. Defaults
CategoryMapping to 99991231 if not supplied.
EndDate
16 taxability Yes STRING 60 Yes Taxability Category Code
CategoryCode
17 taxability Yes LONG 8 No Date format is YYYYMMDD.
CategoryStart
Date
18 taxability Yes STRING 128 No Name related to Source ID.
CategorySource
Name
19 taxability Yes STRING 60 No The name of the Taxability Category
CategoryData Data Type.
TypeName See the “Enumerated Types and
Values” chapter for a list of valid
values for this field.
20 taxability Yes STRING 128 Yes Name related to Source ID.
CategoryMapping
SourceName

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Form

Field Field Natural Type Max. Size Req. Description


Count Key
21 temporary No STRING 155 Yes A temporary key to facilitate the
Taxability association of a Taxability Category
MappingKey Mapping with related entities and
values. For a Vertex export file, the
Taxability Category Mapping ID is
used to populate this field. However,
user-created import files (for
example, files not created via the
Vertex export), may use any unique
identifier.
22 note No STRING 1000 No The taxability category mapping
note.
Defaults to NULL if not supplied.

Form formats
This section describes the formats pertaining to Forms and presents them in the
order they must appear in the import file. Form formats and the corresponding
record indicators are listed in the following table.
Format Record Indicator
Form Jurisdiction fields (see page 97) FORM_JURISDICTION
Form fields (see page 98) FORM

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Form

Form Jurisdiction fields


The following table describes FORM_JURISDICTION fields for a flat tilde-delimited
import file. Required fields apply if there are Form fields.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes FORM_JURISDICTION
to text in
description field.
2 temporaryForm No STRING 155 Yes A temporary key to facilitate
Key the association of a form with
related records. This must
match a Temporary Form Key
in a FORM row.
3 sourceName Yes STRING 128 Yes Name corresponding to Source
ID.
4 jurisdictionId Yes LONG 18 Yes The Jurisdiction ID associated
with the form. You can look
this up in TaxGIS.
5 startDate Yes LONG 8 Yes Form jurisdiction start effective
date.
Date format is YYYYMMDD.
6 endDate No LONG 8 No Date format is YYYYMMDD.
Defaults to 99991231 if not
supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Form formats

Form fields
The following table describes FORM fields for a flat tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes FORM
text in description
field.
2 formIdCode Yes STRING 30 Yes The unique Form ID Code.
3 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
4 formName No STRING 60 No The name of the form.
5 formDesc No STRING 255 No The description of the form.
6 imageName No STRING 255 No Name of the image, which is the
actual file name of an image file
(not the full path).
7 startDate Yes LONG 8 Yes Form start effective date. Date
format is YYYYMMDD.
8 endDate No LONG 8 No Date format is YYYYMMDD.
Defaults to 99991231 if not
supplied.
9 temporaryForm No STRING 155 Yes A temporary key to facilitate the
Key association of a Form with related
records. For a Vertex export file,
the Form ID is used to populate this
field. However, user-created import
files (for example, files not created
via the Vertex export) may use any
unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Certificate formats

Certificate formats
This section describes the formats pertaining to Certificates and presents them in
the order they must appear in the import file. Certificate formats and the
corresponding record indicators are listed in the following table.
Format Record Indicator
Certificate Taxability Driver fields (see page 100) CERTIFICATE_TAXABILITY_DRIVER
Certificate Transaction Type fields (see page 103) CERTIFICATE_TRANSACTION_TYPE
Certificate Imposition Jurisdiction fields (see page 104) CERT_IMPOSITION_JURISDICTION
Certificate Imposition fields (see page 105) CERTIFICATE_IMPOSITION
Certificate Jurisdiction fields (see page 106) CERTIFICATE_JURISDICTION
Certificate Coverage fields (see page 107) CERTIFICATE_COVERAGE
Certificate Image fields (see page 111) CERTIFICATE_IMAGE
Certificate fields (see page 112) CERTIFICATE

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate Taxability Driver fields


The following table describes CERTIFICATE_TAXABILITY_DRIVER fields for a flat
tilde-delimited import file. Required fields apply when importing a specific
certificate.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for more detail.
Field Field Natural Type Max. Size Req. Description
Count Key

1 Record Indicator No STRING Size is identical Yes CERTIFICATE_TAXABILITY_


to text in DRIVER
description
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
CompanyCode code.
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
DivisionCode code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
5 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
6 taxpayerStart Yes LONG 8 Yes Date format is YYYYMMDD.
EffDate
7 flexFieldData Yes STRING 60 No* Flex Field Definition data type name
TypeName of taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
8 flexFieldField Yes LONG 5 No* Flex Field Definition number of
Number taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

9 flexFieldSource Yes STRING 128 No* Flex Field Definition source name of
Name taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
10 flexFieldStart Yes LONG 8 No* Flex Field Definition start effective
Date date of taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
11 flexfieldSupplies No LONG 1 Yes* Flex Field Definition supplies indicator
ProductDomain of taxability driver.
Indicator 1 = true, 0 = false.
*If the Taxability Driver has an
associated flex field, this field is
required.
12 flexfield No LONG 1 Yes* Flex Field Definition procurement
Procurement indicator of taxability driver.
ProductDomain 1 = true, 0 = false.
Indicator
*If the Taxability Driver has an
associated flex field, this field is
required.
13 taxabilityDriver Yes STRING 60 Yes This field indicates the type of Input
TaxabilityInput Parameter of the taxability driver.
ParameterType For a list of valid values for this field,
Name refer to Enumerated Types and
Values (see page 212).
14 taxabilityDriver Yes STRING 40 Yes User defined code of taxability driver
Code for certificate.
15 taxabilityDriver Yes LONG 8 Yes The taxability driver start effective
StartDate date.
16 taxabilityDriver No LONG 1 Yes Supplies indicator of taxability driver
SuppliesProduct for certificate.
DomainIndicator 1 = true, 0 = false.
17 taxabilityDriver No LONG 1 Yes Procurement indicator of taxability
Procurement driver for certificate.
ProductDomain 1 = true, 0 = false.
Indicator

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

18 temporary No STRING 155 Yes A temporary key to facilitate the


CertificateKey association of a Certificate with
related taxability drivers. For a Vertex
export file, the certificate Id is used to
populate this field. However,
user-created import files (for
example, files not created via the
Vertex export) can use any unique
identifier.
19 relationship Yes LONG 8 Yes The start effective date of the
StartDate relationship between the certificate
and the taxability driver. In almost all
cases this is the start date of the
certificate, unless the certificate is not
associated with the driver the entire
time that it is effective.
20 relationshipEnd Yes LONG 8 Yes The end effective date of the
Date relationship between the certificate
and the taxability driver. In almost all
cases this is the end date of the
certificate, unless the certificate is not
associated with the driver the entire
time that it is effective.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate Transaction Type fields


The following table describes CERTIFICATE_TRANSACTION_TYPE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CERTIFICATE_TRANSACTION_
to text in TYPE
description
field.
2 temporary No STRING 155 Yes A temporary key to facilitate the
CertificateKey association of a Certificate with
related records. This must match a
Temporary Certificate Key in a
CERTIFICATE row.
3 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
4 transactionType Yes STRING 60 Yes The name of the transaction type of
Name the certificate.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the
Transaction Type.
5 startDate Yes LONG 8 Yes Certificate transaction type start
effective date.
Date format is YYYYMMDD.
6 endDate No LONG 8 No Date format is YYYYMMDD.
Defaults to 99991231 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate Imposition Jurisdiction fields


The following table describes CERT_IMPOSITION_JURISDICTION fields for a flat
tilde-delimited import file. Required fields apply when importing certificates with
jurisdictions that override default imposition settings.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CERT_IMPOSITION_
to text in JURISDICTION
description
field.
2 temporary No STRING 155 Yes A temporary key to facilitate the
Certificate association of a Certificate Imposition
ImpositionKey with related records. This must match
a Temporary Certificate Imposition
Key in a CERTIFICATE_ IMPOSITION
row.
3 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
4 jurisdictionId Yes LONG 18 Yes The jurisdiction ID that overrides the
imposition in the certificate
imposition record. You can look up
Jurisdiction IDs by running the
Jurisdictions template in Data Extract.
5 coverageAction No STRING 60 Yes Action types for inheriting coverage
TypeName behavior from higher-level
jurisdictions.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Coverage
Action Type.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate Imposition fields


The following table describes CERTIFICATE_IMPOSITION fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes CERTIFICATE_IMPOSITION
text in description
field.
2 temporary No STRING 155 Yes A temporary key to facilitate the
Certificate association of a Certificate
CoverageKey Coverage with related records.
This must match a Temporary
Certificate Coverage Key in a
CERTIFICATE_ COVERAGE row.
3 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
4 jurisdictionType Yes STRING 60 Yes The Jurisdiction Type Set name.
Set For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
5 impTypeName Yes STRING 60 Yes The name of a Vertex-defined or
user-defined imposition type.
6 impTypeSource Yes STRING 128 Yes The source (partition) name of the
Name imposition type. Will be “Vertex”
for Vertex-defined imposition
types.
7 impActiveInd No LONG 1 Yes Indicates if the covered imposition
is active.
1 = true, 0 = false.
8 temporary No STRING 155 Yes A temporary key to facilitate the
Certificate association of a Certificate
ImpositionKey Imposition with related records.
For a Vertex export file, the
certificate imposition ID is used to
populate this field. However,
user-created import files (for
example, files not created via the
Vertex export) may use any unique
identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate Jurisdiction fields


The following table describes CERTIFICATE_JURISDICTION fields for a flat
tilde-delimited import file. Required fields apply when importing certificates with
jurisdictions that override default jurisdiction settings.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes CERTIFICATE_JURISDICTION
text in description
field.
2 temporary No STRING 155 Yes A temporary key to facilitate the
Certificate association of a Certificate Coverage
CoverageKey with related records. This must
match a Temporary Certificate
Coverage Key in a CERTIFICATE_
COVERAGE row.
3 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
4 jurisdictionId Yes LONG 18 Yes The jurisdiction ID that overrides the
jurisdiction in the coverage. This
typically is a lower-level jurisdiction
than the jurisdiction in the coverage
(for example, a city overriding a
state). You can look up Jurisdiction
IDs by running the Jurisdictions
template in Data Extract.
5 coverageAction No STRING 60 Yes Action types for inheriting coverage
TypeName behavior from higher-level
jurisdictions.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Coverage
Action Type.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate Coverage fields


The following table describes CERTIFICATE_COVERAGE fields for a flat
tilde-delimited import file. These fields apply to a particular jurisdiction
associated with the certificate.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CERTIFICATE_COVERAGE
to text in
description
field.
2 temporary No STRING 155 Yes A temporary key to facilitate the
CertificateKey association of a Certificate with
related records. This must match a
Temporary Certificate Key in a
CERTIFICATE row.
3 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
4 jurisdictionId Yes LONG 18 Yes The jurisdiction ID associated with the
certificate. This must always be a
country, state, or province. You can
look up Jurisdiction IDs by running the
Jurisdictions template in Data Extract.
5 certificate No STRING 30 No A user-defined or
Number jurisdiction-supplied identifier for this
certificate.
Defaults to NULL if not supplied.
6 validationType No STRING 60 No The name of the validation type of
Name the coverage.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Validation
Type.
7 validationDate No LONG 8 No Certificate coverage validation date.
Date format is YYYYMMDD.
8 certReason No STRING 60 No The certificate reason type name.
CodeName Valid values for this field can be
selected from a list of Vertex-defined
Certificate Reason Codes, which are
jurisdiction-dependent. You can look
up Reason Code IDs by running the
Certificate Reason Codes template in
Data Extract.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Field Field Natural Type Max. Size Req. Description


Count Key
9 issueDate No LONG 8 No The date on which the jurisdiction
issued the certificate, as printed on
the certificate. This field corresponds
to the Issue Date field on the
Jurisdictions tab in the Add Certificate
window in Vertex Central.
Date format is YYYYMMDD.
Defaults to NULL if not supplied.
10 expirationDate No LONG 8 No The date on which the jurisdiction
intends the certificate to expire, as
printed on the certificate. This field
corresponds to the Expiration Date
field on the Jurisdictions tab in the
Add Certificate window in Vertex
Central. Note that if the date in the
CERTIFICATE endEffDate field
precedes the date in the CERTIFICATE
COVERAGE expirationDate field, the
certificate coverage ends in Vertex
Central, regardless of the
expirationDate.
Date format is YYYYMMDD.
Defaults to NULL if not supplied.
11 reviewDate No LONG 8 No Date format is YYYYMMDD.
Defaults to NULL if not supplied.
12 allStatesInd No LONG 1 Yes 1 = true, 0 = false. Indicates if all
states below this jurisdiction are
covered.
13 allCountiesInd No LONG 1 Yes 1 = true, 0 = false. Indicates if all
counties below this jurisdiction are
covered.
14 allCitiesInd No LONG 1 Yes 1 = true, 0 = false. Indicates if all cities
below this jurisdiction are covered.
15 allOthersInd No LONG 1 Yes 1 = true, 0 = false. Indicates if all other
jurisdictions (usually districts) below
this jurisdiction are covered.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Field Field Natural Type Max. Size Req. Description


Count Key
16 jurActiveInd No LONG 1 Yes 1 = true, 0 = false. Indicates if the
covered jurisdiction is active – this
typically is true for a coverage tied to
a state, and false for a coverage that
is for a lower-level (county, city,
district) jurisdiction only.
17 startDate Yes LONG 8 Yes The date on which the certificate
becomes effective in O Series for a
particular jurisdiction.
This field is system-defined in critical
change events. When you make a
critical change - for example,
associating a certificate with a new
form - O Series applies an endDate to
the original certificate coverage
record and applies a startDate to the
newly created certificate coverage
record for the new form.
If you are importing a certificate
record to add the certificate in O
Series, provide the startDate in the
import file. In this case, the startDate
is the same as the CERTIFICATE
startEffDate.
Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Field Field Natural Type Max. Size Req. Description


Count Key
18 endDate No LONG 8 No The date on which the certificate
ceases to be effective in O Series for a
particular jurisdiction.
This field is system-defined in critical
change events. When you make a
critical change - for example,
associating a certificate with a new
form - O Series applies an endDate to
the original certificate coverage
record and applies a startDate to the
newly created certificate coverage
record for the new form.
If you are importing a certificate
record as the means for adding the
certificate in O Series, provide the
endDate in the import file. In this
case, the endDate is the same as the
CERTIFICATE endEffDate.
Date format is YYYYMMDD.
Defaults to 99991231 if not supplied.
19 temporary No STRING 155 Yes A temporary key to facilitate the
Certificate association of a Certificate Coverage
CoverageKey with related records. For a Vertex
export file, the certificate coverage ID
is used to populate this field.
However, user-created import files
(for example, files not created via the
Vertex export) can use any unique
identifier.
20 allImpositionsInd No LONG 1 No 1 = true, 0 = false. Indicates if all
impositions are considered covered
by the certificate unless overridden.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate Image fields


The following table describes CERTIFICATE_IMAGE fields for a flat tilde-delimited
import file. Required fields apply when importing certificates with images.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CERTIFICATE_IMAGE
to text in
description
field.
2 temporary No STRING 155 Yes A temporary key to facilitate the
CertificateKey association of a Certificate with
related records. This must match a
Temporary Certificate Key in a
CERTIFICATE row.
3 sourceName Yes STRING 128 Yes Name corresponding to Source ID.
4 imageName Yes STRING 255 Yes Name of the image, either a URL or
the actual file name of an image (not
the full path).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Certificate fields
The following table describes CERTIFICATE fields for a flat tilde-delimited import
file. These fields apply to all jurisdictions associated with the certificate.
Field Field Natural Type Max. Size Req. Description
Count Key

1 Record Indicator No STRING Size is identical Yes CERTIFICATE


to text in
description
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
CompanyCode code.
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
DivisionCode code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
5 taxpayerStart Yes LONG 8 No Taxpayer start effective date.
EffDate Date format is YYYYMMDD.
6 customerCode No STRING 80 No The user-defined customer code for
the customer associated with the
certificate. This is relevant for
certificates that are set up in the
Supplies perspective only.
7 customerStart No LONG 8 No Customer start effective date.
EffDate Date format is YYYYMMDD.
8 sourceName Yes STRING 128 Yes Name corresponding to the Source ID.
9 certificateClass No STRING 60 Yes The certificate class type.
Type For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
10 taxResultType No STRING 60 No Defaults to Exempt.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

11 taxResultPct No DOUBLE 10 No A rate for the certificate if it is not


fully exempt.
12 hardCopyInd No LONG 1 No 1 = true, 0 = false. Defaults to 0 if not
supplied.
13 hardCopy No STRING 255 No The location of the hard copy of the
LocationName certificate.
14 industryType No STRING 60 No The industry type.
Name
15 blanketInd No LONG 1 No 1 = true, 0 = false. Defaults to 0 if not
supplied.If true, there should be no
associated taxability drivers.
16 singleUseInd No LONG 1 No 1 = true, 0 = false. Defaults to 0 if not
supplied.
17 invoiceNumber No STRING 20 No The invoice number to which a single
use certificate applies.
18 startEffDate Yes LONG 8 Yes The date on which the certificate is
effective in O Series. This field
corresponds to the Start Date field on
the General tab in the Add Certificate
window in Vertex Central.
For a certificate to be applied to
transactions in a jurisdiction, both the
CERTIFICATE startEffDate and the
CERTIFICATE COVERAGE startDate for
that jurisdiction must be effective.
Date format is YYYYMMDD.
19 endEffDate No LONG 8 No The date on which the certificate
ceases to be effective in O Series for
all jurisdictions covered by the
certificate. This date specifies when
the certificate ceases to be effective
and no longer applies in any of the
covered jurisdictions, regardless of
the jurisdictions' expiration dates.
This field corresponds to the End Date
field on the General tab in the Add
Certificate window in Vertex Central.
Date format is YYYYMMDD.
Defaults to 99991231 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

20 note No STRING 1000 No The certificate note.


Defaults to NULL if not supplied.
21 formSourceName Yes STRING 128 No The source (partition) name of the
form associated to this certificate.
Will be Vertex for Vertex-
supplied forms.
22 formIdCode Yes STRING 30 No The unique code of the associated
form.
23 formStartEffDate No LONG 8 No The start date of the associated form.
Date format is YYYYMMDD.
24 contactRoleType No STRING 60 No The name of the role type of the
associated contact.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Contact
Role Type.
25 departmentId No STRING 20 No The department code of the
Code associated contact.
26 temporary No STRING 155 No A temporary key to facilitate the
CertificateKey association of a Certificate with
related records. For a Vertex export
file, the certificate ID is used to
populate this field. However,
user-created import files (for
example, files not created via the
Vertex export) can use any unique
identifier.
27 custClassInd No LONG 1 No Indicates whether this is a customer
or a customer class.
1 = is class, 0 = not a class.
Defaults to 0 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Batch Certificate formats

Batch Certificate formats


This section describes the formats pertaining to Batch Certificates and presents
them in the order they must appear in the import file. Batch Certificate formats
and the corresponding record indicators are listed in the following table.
For additional information about batch certificate file names, file locations, file
layouts, and header fields, refer to Appendix A. Batch Certificate import (see
page 218).
Format Record Indicator
Batch Certificate Jurisdiction fields (see page 116) BATCH_CERTIFICATE_JURISDICTION
Batch Certificate fields (see page 119) BATCH_CERTIFICATE

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Batch Certificate

Batch Certificate Jurisdiction fields


Each BATCH_CERTIFICATE row must be associated with one or more
BATCH_CERTIFICATE_JURISDICTION rows. All BATCH_CERTIFICATE_
JURISDICTION rows must be grouped together and must precede all
BATCH_CERTIFICATE rows in the file. These rows are linked by the
temporaryCertificateKey, which must be unique for each BATCH_CERTIFICATE
row.
The following table describes BATCH_CERTIFICATE_JURISDICTION fields for a flat
tilde-delimited import file:
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is Yes Value must be BATCH_
identical to CERTIFICATE_JURISDICTION for
text in every record.
description
field.
2 temporary No STRING 128 Yes A temporary key that associates a
CertificateKey BATCH_CERTIFICATE_JURISDICTION
row or rows with the related
BATCH_CERTIFICATE row.
This value must match the value in
temporaryCertificateKey in field 19
in a BATCH_CERTIFICATE row.
3 sourceName No STRING 128 Yes The system partition name. It must
match the name of the partition to
which you want to import
certificates.
4 countryName No STRING 80 No The country of the jurisdiction. If not
supplied, defaults to United States.
5 stateName No STRING 80 No The state of the jurisdiction. Must be
the full state name. Abbreviations
are not valid.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key
6 countyName No STRING 80 No The county of the jurisdiction.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.
7 cityName No STRING 80 No The city of the jurisdiction.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.
8 districtName No STRING 80 No The district of the jurisdiction.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.
9 certificateNumber No STRING 30 No A user-defined or
jurisdiction-supplied identifier for
this certificate.
Defaults to NULL if not supplied.
10 certReasonCodeName No STRING 60 No Must match a Vertex-supplied
certificate reason code name that is
valid for the certificate's jurisdiction.
Valid values for this field are
jurisdiction-dependent and may be
found in the Reason Type drop-down
in Vertex Central (In the Certificates
add or edit function, navigate to the
Jurisdiction tab and select the
appropriate jurisdiction. In the
Details subtab, view the Reason Type
drop-down.)
11 issueDate No LONG 8 No Date format is YYYYMMDD.
Defaults to NULL if not supplied.
12 expirationDate No LONG 8 No Date format is YYYYMMDD.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key
13 reviewDate No LONG 8 No Date format is YYYYMMDD.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Batch Certificate

Batch Certificate fields


The following table describes BATCH_CERTIFICATE fields for a flat tilde-delimited
import file.
Field Field Natural Type Max. Size Req. Description
Count Key

1 Record Indicator No STRING Size is Yes Value must be BATCH_


identical to CERTIFICATE for every record.
text in
description
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
CompanyCode code. This code must match the
company code that is already set up
for the taxpayer in O Series.
The taxpayerCompanyCode is
required if a non-NULL
taxpayerDivisionCode is supplied in
field 3.
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
DivisionCode code. This code must match the
division code that is already set up
for the taxpayer in O Series.
Defaults to NULL if not supplied.
The taxpayerDivisionCode is
required if a non-NULL
taxpayerDepartmentCode is supplied
in field 4.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code. This code must
match the department code that is
already set up for the taxpayer in O
Series.
Defaults to NULL if not supplied.
The taxpayerCompanyCode (field 2)
and taxpayerDivisionCode (field 3)
are required if a non-NULL
taxpayerDepartmentCode is
supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

5 customerCode Yes STRING 80 No The user-defined customer code for


the customer associated with the
certificate. This code must match the
customer code that is already set up
in O Series.
This is relevant for certificates set up
in the Supplies perspective only.
6 sourceName Yes STRING 128 Yes The system partition name. It must
match the name of the partition to
which you want to import
certificates.
7 certificateClassType No STRING 60 Yes The certificate class type.
Valid values are:
 Exemption Certificate
 Direct Pay Permit
8 hardCopyLocationName No STRING 255 No The location of the hard copy of the
certificate.
If a location is supplied in this field,
the Hard Copy Received check box in
Vertex Central is selected.
If a location is not supplied in this
field, the Hard Copy Received check
box in Vertex Central is not selected.
9 industryTypeName No STRING 60 No The user-defined industry type.
10 invoiceNumber No STRING 20 No The invoice number to which the
single-use certificate applies.
If invoiceNumber is supplied, then
Certificate Scope in Vertex Central is
Single Use.
If invoiceNumber is NULL, then
Certificate Scope in Vertex Central is
Blanket.
Note: Batch Certificate Import
does not support certificates
with a Certificate Scope of
Limited. You must manually
enter certificates that are
taxability driver-specific
(limited).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

11 startDate Yes LONG 8 Yes The certificate start effective date.


This date is used to look up
Customers and Forms, so it cannot
be outside the date range of the
Customer or Form associated with
this certificate.
Date format is YYYYMMDD.
12 endDate No LONG 8 No Date format is YYYYMMDD.
Defaults to 99991231 if not supplied.
13 note No STRING 1000 No A free-form note added to the
certificate record. This text displays
in the Note field in Certificates > Add
Certificate > General tab in My
Enterprise.
Defaults to NULL if not supplied.
14 formUserDefined No LONG 1 No A flag that indicates if a form is
supplied by the user or by Vertex.
Valid values are:
1 = form is user-defined
0 = form is Vertex-supplied
If supplied, the formIdCode in field
15 is required.
15 formIdCode No STRING 30 No The unique code of the associated
form. If formUserDefined in field 14
is not NULL, this code is required.
This code must exactly match the
form code of a user-defined or
Vertex-supplied form.
16 contactRoleType No STRING 60 No The name of the role type of the
associated contact.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
If supplied, then contactDeptCode in
field 17 is required.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

17 contactDeptCode No STRING 20 No The department code of the


associated contact.
If supplied, then contactRoleType in
field 16 is required.
Note: Contact information must
already be set up in
Taxpayer and Customer
records in Vertex Central.
18 imageName No STRING 255 No The name of the file inside the
image's ZIP file or subdirectory.
The name that you enter here must
match the actual file name exactly
(including case-sensitivity).
If there are multiple images per
certificate, the images must be
chained to be a multi-page image,
resulting in one image file. For more
information about multiple images,
refer to File names and locations
(see page 219).
19 temporary No STRING 128 Yes A temporary, unique key that
CertificateKey associates this certificate with its
related BATCH_CERTIFICATE_
JURISDICTION row or rows.
20 custClassInd No LONG 1 No Indicates whether this is a customer
or a customer class.
1 = is class, 0 = not a class.
Defaults to 0 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Letter formats

Letter formats
This section describes the formats pertaining to Letter Templates and Letter
Batches and presents them in the order they must appear in the import file.
Letter Templates and Letter Batches and the corresponding record indicators are
listed in the following table.
Format Record Indicator
Letter Template fields (see page 123) LETTER_TEMPLATE
Letter Batch Taxpayer fields (see page 124) LETTER_BATCH_TAXPAYER
Letter Batch Customer fields (see page 126) LETTER_BATCH_CUSTOMER
Letter Batch Jurisdiction fields (see page 128) LETTER_BATCH_JURISDICTION
Letter Batch fields (see page 129) LETTER_BATCH

Letter Template fields


The following table describes LETTER_TEMPLATE fields for a flat tilde-delimited
import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes LETTER_TEMPLATE
to text in
description field.
2 sourceName Yes STRING 128 Yes Name corresponding to Source
ID.
3 letterTemplate No STRING 60 Yes For a list of valid values for this
TypeName field, refer to Enumerated
Types and Values (see page
212), the Letter Template Type.
4 letterTemplate Yes STRING 60 Yes The letter template name.
Name
5 letterTemplate No STRING 100 No The letter template
Desc description.
6 letterTemplate No STRING 4000 Yes The letter template text.
Text

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Letter

Letter Batch Taxpayer fields


The following table describes LETTER_BATCH_TAXPAYER fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes LETTER_BATCH_
to text in CUSTOMER
description field.
2 Taxpayer Yes STRING 80 No The user-defined Taxpayer
CompanyCode Company code.
This is required if a Taxpayer is
associated with a letter batch.
3 TaxpayerDivision Yes STRING 80 No The user-defined Taxpayer
Code Division code.
Defaults to NULL if not
supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 Taxpayer Yes STRING 80 No The user-defined Taxpayer
DepartmentCode Department code.
Defaults to NULL if not
supplied.
5 taxpayer Yes LONG 8 No The start date associated with
CompanyStart the Taxpayer Company (field
Date 2).
This field is required if a
Taxpayer Company Code is
supplied.
Date format is YYYYMMDD.
6 taxpayerDivision Yes LONG 8 No The start date associated with
StartDate the Taxpayer Division (field 3).
This field is required if a
Taxpayer Division Code is
supplied.
Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Letter

Field Field Natural Type Max. Size Req. Description


Count Key
7 taxpayerDept Yes LONG 8 No The start date associated with
StartDate the Taxpayer Department (field
4).
This field is required if a
Taxpayer Department Code is
supplied.
Date format is YYYYMMDD.
8 taxpayerSource Yes STRING 128 Yes Name corresponding to Source
Name ID.
9 temporaryKey Yes STRING 155 Yes A temporary key to facilitate
the association of a letter batch
with other related entities.
For a Vertex export file, the
letter batch ID and source ID
are used to populate this field.
Files not created via the Vertex
export, for example,
user-created import files, may
use any unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Letter

Letter Batch Customer fields


The following table describes LETTER_BATCH_CUSTOMER fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes LETTER_BATCH_
to text in CUSTOMER
description field.
2 customer Yes STRING 80 No The Taxpayer Company code
Taxpayer for the customer/customer
CompanyCode class.
3 customer Yes STRING 89 No The Taxpayer Division code for
TaxpayerDivision the customer/customer class.
Code Defaults to NULL if not
supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 customer Yes STRING 80 No The Taxpayer Department code
Taxpayer of the customer/customer
DepartmentCode class.
Defaults to NULL if not
supplied.
5 customer Yes LONG 8 No The start date associated with
Taxpayer the Taxpayer Company (field
CompanyStart 2).
Date This field is required if a
taxpayer company code is
supplied.
Date format is YYYYMMDD.
6 customer Yes LONG 8 No The start date associated with
TaxpayerDivision the Taxpayer Division (field 3).
StartDate This field is required if a parent
Taxpayer Division Code is
supplied.
Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Letter

Field Field Natural Type Max. Size Req. Description


Count Key
7 customer Yes LONG 8 No The start date associated with
TaxpayerDept the Taxpayer Department (field
StartDate 4).
This field is required if a parent
Taxpayer Department Code is
supplied.
Date format is YYYYMMDD.
8 customerCode Yes STRING 80 No The user-defined code for a
customer/customer class
associated with this letter
batch.
9 customerClass No LONG 1 No Indicates whether this is a
Indicator customer or a customer class.
1 = class; 0 = not a class.
Defaults to 0, if not supplied.
10 customerStart Yes LONG 8 No The start date for the
Date customer/customer class
associated with this letter
batch.
Date format is YYYYMMDD.
11 customerSource Yes STRING 128 Yes Name corresponding to Source
Name ID.
12 temporaryKey Yes STRING 155 Yes A temporary key to facilitate
the association of a letter batch
with other related entities.
For a Vertex export file, the
letter batch ID and source ID
are used to populate this field.
Files not created via the Vertex
export, for example,
user-created import files, may
use any unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Letter

Letter Batch Jurisdiction fields


The following table describes LETTER_BATCH_JURISDICTION fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes LETTER_BATCH_
text in description JURISDICTION
field.
2 jurisdictionID Yes LONG 18 Yes The jurisdiction ID associated
with the letter batch.
You can look this up in Vertex
Central, Tools menu, Tax Area
Lookup.
3 lookUpDate No LONG 8 No Date to look up an effective
jurisdiction.
Date format is YYYYMMDD.
Defaults to the current date if
not provided.
4 temporaryKey Yes STRING 155 Yes A temporary key to facilitate
the association of a letter batch
with other related entities.
For a Vertex export file, the
letter batch ID and source ID
are used to populate this field.
Files not created via the Vertex
export, for example,
user-created import files, may
use any unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Letter

Letter Batch fields


The following table describes LETTER_BATCH fields for a flat tilde-delimited
import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes LETTER_BATCH
to text in
description field.
2 sourceName Yes STRING 128 Yes Name corresponding to Source
ID.
3 batchDate Yes LONG 8 Yes Date when batch was
processed.
Date format is YYYYMMDD.
4 certificateStatus Yes STRING 60 No Status of certificates to be
retrieved.
Use Null for all certificates.
For a list of valid values for this
field, refer to Enumerated
Types and Values (see page
212).
5 daysSince Yes LONG 18 No Number of days since
Expiration certificate expired.
Value -1 if no restriction.
Defaults to -1 if not supplied.
6 daysToExpiration Yes LONG 18 No Number of days until certificate
expires.
Value -1 if no restriction.
Defaults to -1 if not supplied.
7 expRangeEnd Yes LONG 8 No End date for certificate
Date expiration date range.
Date format is YYYYMMDD.
Defaults to 99991231 if not
supplied.
8 expRangeStart Yes LONG 8 No Start date for certificate
Date expiration date range.
Date format is YYYYMMDD.
9 letterBatchName Yes STRING 100 Yes The letter batch name.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Letter

Field Field Natural Type Max. Size Req. Description


Count Key
10 findCustomers Yes LONG 1 No True if search should locate
WithNo customers with no certificates.
Certificates 1 = true; 0 = false. Defaults to
0, if not supplied.
11 letterTemplate Yes STRING 128 Yes Name corresponding to Source
SourceName ID.
12 letterTemplate No STRING 60 Yes For a list of valid values for this
TypeName field, refer to Enumerated
Types and Values (see page
212), the Letter Template Type.
13 letterTemplate Yes STRING 60 Yes The letter template name.
Name
14 temporaryKey Yes STRING 155 Yes A temporary key to facilitate
the association of a letter batch
with other related entities.
For a Vertex export file, the
letter batch ID and source ID
are used to populate this field.
Files not created via the Vertex
export, for example,
user-created import files, may
use any unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule formats


This section describes the formats pertaining to Tax Rules and presents them in
the order they must appear in the import file. Tax Rule formats and the
corresponding record indicators are listed in the following table.
Format Record Indicator
Tax Rule Transaction Type fields (see page 132) TAX_RULE_TRANSACTION_TYPE
Tax Rule Tax Type fields (see page 133) TAX_RULE_TAX_TYPE
Tax Rule Tax Imposition fields (see page 134) TAX_RULE_TAX_IMPOSITION
Tax Rule Qualifying Condition fields (see page 135) TAX_RULE_QUALIFYING_CONDITION
Tax Rule Conditional Jurisdiction fields (see page 140) TAX_RULE_CONDITIONAL_JURISDICTION
Child Single Rate Tax Structure fields (see page 141) CHILD_SINGLE_RATE_TAX_STRUCTURE
Single Rate Tax Structure fields (see page 142) SINGLE_RATE_TAX_STRUCTURE
Child Quantity Tax Structure fields (see page 143) CHILD_QUANTITY_TAX_STRUCTURE
Quantity Tax Structure fields (see page 144) QUANTITY_TAX_STRUCTURE
Child Tier fields (see page 145) CHILD_TIER
Tier fields (see page 147) TIER
Child Tiered Tax Structure fields (see page 149) CHILD_TIERED_TAX_STRUCTURE
Tiered Tax Structure fields (see page 150) TIERED_TAX_STRUCTURE
Flat Tax Tax Structure fields (see page 151) FLAT_TAX_TAX_STRUCTURE
Tax Rule Conditional Tax Expression Tax Factor fields TAX_RULE_CONDITIONAL_TAX_EXPRESSION_TAX_ FACTOR
(see page 152)
Tax Rule Tax Basis Conclusion Tax Factor fields (see TAX_RULE_TAX_BASIS_CONCLUSION_TAX_FACTOR
page 154)
Tax Rule Conditional Tax Expression fields (see page TAX_RULE_CONDITIONAL_TAX_EXPRESSION
157)
Tax Basis Rule Tax Basis Conclusion fields (see page TAX_BASIS_RULE_TAX_BASIS_CONCLUSION
158)
Taxability Rule fields (see page 159) TAXABILITY_RULE
Max Tax Rule fields (see page 165) MAX_TAX_RULE
Tax Basis Rule fields (see page 169) TAX_BASIS_RULE

You must always provide both the Where and Transaction Type information
when you are importing a tax rule. In addition, you must provide one of the
following types of information: Taxpayer, Customer, or Qualifying Condition.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

If this information is available, the tax rule is validated and imported successfully.
If this information is not available during the import process, an error occurs and
the tax rule is not imported.

Tax Rule Transaction Type fields


This format associates a Tax Rule with a Transaction Type. There may be more
than one of this type of record, to permit a Tax Rule to be associated with
multiple Transaction Types.
The following table describes TAX_RULE_TRANSACTION_TYPE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_TRANSACTION_
to text in TYPE
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Transaction Type
to a Tax Rule.
3 transactionType Yes STRING 60 Yes The name of the Transaction Type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule Tax Type fields


This format associates a Tax Rule with a Tax Type. There may be more than one
of this type of record, to permit a Tax Rule to be associated with multiple Tax
Types.
The following table describes TAX_RULE_TAX_TYPE fields for a flat tilde-delimited
import file. Required fields apply when importing a calculation tax rule.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_TAX_TYPE
to text in
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Type to a Tax
Rule.
3 taxType Yes STRING 60 Yes The name of the Tax Type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule Tax Imposition fields


This format associates a Tax Rule with a Tax Imposition. There should be only one
tax imposition associated to a tax rule.
The following table describes TAX_RULE_TAX_IMPOSITION fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_TAX_IMPOSITION
to text in
description field.
2 jurisdictionId Yes LONG 18 Yes The jurisdiction ID associated with the
Tax Imposition.
3 impSourceName Yes STRING 128 Yes Name related to Source ID for Tax
Imposition.
4 impTypeName Yes STRING 60 Yes Tax Imposition Type Name.
5 impTypeSource Yes STRING 128 Yes Name related to Source ID for Tax
Name Imposition Type.
6 impStartDate Yes LONG 8 Yes Date format is YYYYMMDD.
7 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Imposition to a
Tax Rule.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule Qualifying Conditions fields


This format associates a Tax Rule with a Qualifying Condition. A Qualifying
Condition may include one of the following entities:
 A Taxability Driver
 A Taxability Category
 A Flexible Field Definition
There may be more than one type of this record, to permit multiple Qualifying
Conditions to be associated with a single Tax Rule.
The following table describes TAX_RULE_QUALIFYING_CONDITION fields for a flat
tilde-delimited import file. The required fields for this format depend on which
entities are represented.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for more detail.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_QUALIFYING_
to text in CONDITION
description field.
2 temporaryTaxRule No STRING 155 Yes A temporary key to facilitate the
Key association of this qualifying
condition to a Tax Rule.
3 taxRuleSource Yes STRING 128 Yes Name related to the Source ID for
Name the Tax Rule.
4 taxabilityDriver No STRING 80 No* The user-defined taxpayer
Taxpayer company code.
CompanyCode *Required if this condition
represents a taxability driver.
5 taxabilityDriver No STRING 80 No The user-defined taxpayer division
TaxpayerDivision code.
Code Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
6 taxabilityDriver No STRING 80 No The user-defined taxpayer
Taxpayer department code.
DepartmentCode Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
7 taxabilityDriver No LONG 8 No* Date format is YYYYMMDD.
TaxpayerStart *Required if this condition
Date represents a taxability driver.
8 taxabilityDriver Yes STRING 60 Yes* This field indicates the type of
TaxabilityInput Input Parameter of the taxability
ParameterType driver.
Name *Required if this condition
represents a taxability driver.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
9 taxabilityDriver Yes STRING 40 No* The user-defined taxability driver
Code code.
*Required if this condition
represents a taxability driver.
10 taxabilityDriver Yes LONG 8 No* Date format is YYYYMMDD.
StartDate *Required if this condition
represents a taxability driver.
11 taxabilityDriver No LONG 1 Yes* Financial Event Perspective of the
SuppliesProduct driver.
DomainIndicator *Required if this condition
represents a taxability driver.
1=true, 0=false
12 taxabilityDriver No LONG 1 Yes* Financial Event Perspective of the
Procurement driver.
ProductDomain *Required if this condition
Indicator represents a taxability driver.
1=true, 0=false
13 taxabilityDriver Yes STRING 60 No* Taxability Driver Flex Field
FlexFieldDataType Definition data type name of
Name taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
14 taxabilityDriver Yes LONG 5 No* Taxability Driver Flex Field
FlexFieldField Definition number of taxability
Number driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
15 taxabilityDriver Yes STRING 128 No* Taxability Driver Flex Field
FlexFieldSource Definition source name of
Name taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
16 taxabilityDriver Yes LONG 8 No* Taxability Driver Flex Field
FlexFieldStartDate Definition start effective date of
taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
17 taxabilityDriver No LONG 1 Yes* This field indicates whether this
FlexfieldSupplies taxability driver should be
ProductDomain displayed in the Supplies Financial
Indicator Event Perspective.
*Required if this condition
represents a taxability driver.
1 = true, 0 = false.
*At least one of these two
Financial Event Perspective
Indicators must be set to true.
18 taxabilityDriver No LONG 1 Yes* This field indicates whether this
Flexfield taxability driver should be
Procurement displayed in the Procurement
ProductDomain Financial Event Perspective.
Indicator *Required if this condition
represents a taxability driver.
1 = true, 0 = false.
*At least one of these two
Financial Event Perspective
Indicators must be set to true.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
19 taxabilityCategory Yes STRING 60 No* The user-defined taxability
Code category code.
*Required if this condition
represents a taxability category.
20 taxabilityCategory Yes LONG 8 No* Date format is YYYYMMDD.
StartDate *Required if this condition
represents a taxability category.
21 taxabilityCategory Yes STRING 128 No* Name related to Source ID.
SourceName *Required if this condition
represents a taxability category.
22 taxabilityCategory Yes STRING 60 No* Taxability Category Data Type
DataTypeName Name.
*Required if this condition
represents a taxability category.
23 flexFieldDataType Yes STRING 60 No* Flex Field Definition data type
Name name.
*Required if this condition
represents a flexible field
definition.
24 flexFieldField Yes LONG 5 No* Flex Field Definition number.
Number *Required if this condition
represents a flexible field
definition.
25 flexFieldSource Yes STRING 128 No* Flex Field Definition source name.
Name *Required if this condition
represents a flexible field
definition.
26 flexFieldStartDate Yes LONG 8 No* Flex Field Definition start effective
date.
*Required if this condition
represents a flexible field
definition.
27 flexfieldSupplies No LONG 1 Yes* Financial Event Perspective name
ProductDomain of flex field.
Indicator *Required if this condition
represents a flexible field
definition.
1=true, 0=false

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
28 flexfield No LONG 1 Yes* Financial Event Perspective name
Procurement of flex field.
ProductDomain *Required if this condition
Indicator represents a flexible field
definition.
1=true, 0=false
29 minDate Yes LONG 8 No The minimum date range used to
test against a DATE Taxability
Category or a DATE flexible field.
Null indicates no minimum date.
Date testing is inclusive.
30 maxDate Yes LONG 8 No The maximum date range used to
test against a DATE Taxability
Category or a DATE flexible field.
Null indicates no maximum date.
Date testing is inclusive.
31 comparisonValue No DOUBLE 10 No A numeric value used with the
Comparison Type when the
Taxability Category or the flexible
field is type NUMERIC.
32 comparisonType Yes STRING 60 No* An enumeration of types of
Name conditions used in tax expressions.
*This field is required if
comparison value exists.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Expression Condition Type.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule Conditional Jurisdiction fields


The following table describes TAX_RULE_CONDITIONAL_JURISDICTION fields for a
flat tilde-delimited import file. Required fields apply when importing a Tax Rule
with Conditional Jurisdictions.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_CONDITIONAL_
to text in JURISDICTION
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this qualifying condition
to a Tax Rule.
3 taxRuleSource Yes STRING 128 Yes Name related to Source ID.
Name
4 jurisdictionId Yes LONG 18 Yes The identifier for the conditional
jurisdiction.
5 effDate Yes LONG 8 Yes The date on which this record is
effective.
Date format is YYYYMMDD.
6 endDate No LONG 8 Yes The end date for this record.
Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Child Single Rate Tax Structure fields


The following table describes CHILD_SINGLE_RATE_TAX_STRUCTURE fields for a
flat tilde-delimited import file. Required fields apply when importing a Tax Rule
with a Single-Rate Tax Structure.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record No STRING Size is identical Yes CHILD_SINGLE_RATE_TAX_
Indicator to text in STRUCTURE
description
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Structure to a
Tax Rule.
3 basis No DOUBLE 10 No A factor by which the basis should be
Reduction reduced for tax calculation purposes.
Factor
4 basisRedAmt No STRING 60 No The Deduction Type of the amount by
Deduction which the basis is reduced.
Type For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
5 taxScopeType No STRING 60 No The Tax Scope for this tax structure.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
6 singleRate No DOUBLE 10 Yes A single rate for tax calculation.
7 usesStandard No LONG 1 Yes An indicator of whether this tax
RateInd structure uses the standard rate.
0 = does not use the standard rate, 1
= uses the standard rate.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Single Rate Tax Structure fields


The following table describes SINGLE_RATE_TAX_STRUCTURE fields for a flat
tilde-delimited import file. Required fields apply when importing a Tax Rule with
a Single-Rate Tax Structure.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes SINGLE_RATE_TAX_STRUCTURE
to text in
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Structure to a Tax
Rule.
3 basisReduction No DOUBLE 10 No A factor by which the basis should be
Factor reduced for tax calculation purposes.
4 basisRedAmt No STRING 60 No The Deduction Type of the amount by
DeductionType which the basis is reduced.
For a list of valid values for this field,
refer to Enumerated Types and Values
(see page 212).
5 taxScopeType No STRING 60 No The Tax Scope for this tax structure.
For a list of valid values for this field,
refer to Enumerated Types and Values
(see page 212).
6 singleRate No DOUBLE 10 Yes A single rate for tax calculation.
7 usesStandard No LONG 1 Yes An indicator of whether this tax
RateInd structure uses the standard rate.
0 = does not use the standard rate,
1 = uses the standard rate.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Child Quantity Tax Structure fields


The following table describes CHILD_QUANTITY_TAX_STRUCTURE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record No STRING Size is identical Yes CHILD_QUANTITY_TAX_
Indicator to text in STRUCTURE
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Structure to a
Tax Rule.
3 basis No DOUBLE 10 No A factor by which the basis should be
Reduction reduced for tax calculation purposes.
Factor
4 basisRedAmt No STRING 60 No The Deduction Type of the amount by
Deduction which the basis is reduced.
Type For a list of valid values for this field,
refer to Enumerated Types and Values
(see page 212).
5 taxScopeType No STRING 60 No The Tax Scope for this tax structure.
For a list of valid values for this field,
refer to Enumerated Types and Values
(see page 212).
6 unitOfMeasur No STRING 3 Yes The ISO Code for the Unit of Measure.
eISOCode
7 taxPerUnit No DOUBLE 18 Yes The tax amount per unit of measure.
Amount
8 unitOfMeasur No DOUBLE 18 Yes The quantity basis for the tax
eQuantity structure.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Quantity Tax Structure fields


The following table describes QUANTITY_TAX_STRUCTURE fields for a flat
tilde-delimited import file. Required fields apply when importing a Tax Rule with
a Quantity Tax Structure. This format does not apply to tax basis rules.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes QUANTITY_TAX_
to text in STRUCTURE
description field.
2 temporaryTaxRule No STRING 155 Yes A temporary key to facilitate
Key the association of this Tax
Structure to a Tax Rule.
3 basisReduction No DOUBLE 10 No A factor by which the basis
Factor should be reduced for tax
calculation purposes.
4 basisRedAmt No STRING 60 No The Deduction Type of the
DeductionType amount by which the basis is
reduced.
For a list of valid values for this
field, refer to Enumerated
Types and Values (see page
212).
5 taxScopeType No STRING 60 No The Tax Scope for this tax
structure.
For a list of valid values for this
field, refer to Enumerated
Types and Values (see page
212).
6 unitOfMeasureISO No STRING 3 Yes The ISO Code for the Unit of
Code Measure.
7 taxPerUnitAmount No DOUBLE 18 Yes The tax amount per unit of
measure.
8 unitOfMeasure No DOUBLE 18 Yes The quantity basis for the tax
Quantity structure.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Child Tier fields


The following table describes CHILD_TIER fields for a flat tilde-delimited import
file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CHILD_TIER
to text in
description
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Structure to
a Tax Rule.
3 tierNumber Yes LONG 3 Yes A sequence number for this Tier.
4 minBasisAmount No DOUBLE 18 Yes The minimum basis amount for this
Tier.
5 maxBasisAmount No DOUBLE 18 No The maximum basis amount for this
Tier.
6 tierRate No DOUBLE 10 No A rate for this Tier.
7 taxResultType No STRING 60 Yes Valid values are: Taxable, Exempt,
Nontaxable.
8 reasonCode No STRING 60 No A reason code for a Tier with an
Exempt or Nontaxable Tax Result
Type.
9 reasonType No STRING 20 No The reason code type.
Valid values are: Vertex Defined
and User Defined.
10 usesStandard No LONG 1 Yes An indicator on whether the tier
RateInd uses the standard rate.
0 = does not use the standard rate,
1 = uses the standard rate.
11 filingCategory No LONG 5 No A filing category code associated
Code with the tier.
This can be a value between 5 and
99999, which must match a valid
Vertex-supplied Filing Category
Code for the jurisdiction specified.
12 filingCategory No LONG 8 No The jurisdiction for the filing
Juris category specified.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
13 filingCategory No LONG 18 No The effective date for the filing
EffDate category specified.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tier fields
This format defines a Tier that can be associated with a Tiered Tax Structure. This
format does not apply to tax basis rules.
The following table describes TIER fields for a flat tilde-delimited import file.
Required fields apply when importing a Tax Rule with a Tiered Tax Structure.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TIER
text in description
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate
RuleKey the association of this Tax
Structure to a Tax Rule.
3 tierNumber Yes LONG 3 Yes A sequence number for this
Tier.
4 minBasisAmount No DOUBLE 18 Yes The minimum basis amount for
this Tier.
5 maxBasisAmount No DOUBLE 18 No The maximum basis amount for
this Tier.
6 tierRate No DOUBLE 10 No A rate for this Tier.
7 taxResultType No STRING 60 Yes Valid values are: Taxable,
Exempt, Nontaxable.
8 reasonCode No STRING 60 No A reason code for a Tier with
an Exempt or Nontaxable Tax
Result Type.
9 reasonType No STRING 20 No The reason code type.
Valid values are: Vertex
Defined and User Defined.
10 usesStandard No LONG 1 Yes An indicator as to whether the
RateInd tier uses the standard rate.
0 = does not use the standard
rate; 1 = uses the standard
rate.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
11 filingCategory No LONG 5 No A filing category code
Code associated with the tier.
This can be a value between 5
and 99999, which must match
a valid Vertex-supplied Filing
Category Code for the
jurisdiction specified.
12 filingCategory No LONG 8 No The jurisdiction for the filing
Juris category specified.
13 filingCategoryEff No LONG 18 No The effective date for the filing
Date category specified.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Child Tiered Tax Structure fields


The following table describes CHILD_TIERED_TAX_STRUCTURE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes CHILD_TIERED_TAX_
to text in STRUCTURE
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Structure to
a Tax Rule.
3 basisReduction No DOUBLE 10 No A factor by which the basis should
Factor be reduced for tax calculation
purposes.
4 basisRedAmt No STRING 60 No The Deduction Type of the amount
DeductionType by which the basis is reduced.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
5 taxScopeType No STRING 60 No The Tax Scope for this tax structure.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
6 allAtTopTier No LONG 1 Yes Indicates that tax should be
Indicator calculated entirely at the top tier's
percentage.
1 = true, 0 = false
7 unitBased No LONG 1 Yes Indicates that the unit price has to
Indicator be used to look up the tier rate.
1 = true, 0 = false

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tiered Tax Structure fields


The following table describes TIERED_TAX_STRUCTURE fields for a flat
tilde-delimited import file. Required fields apply when importing a Tax Rule with
a Tiered Tax Structure.
A Tiered Tax Structure may have multiple Tiers associated with it. This format
does not apply to tax basis rules.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TIERED_TAX_STRUCTURE
text in description
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Structure
to a Tax Rule.
3 basisReduction No DOUBLE 10 No A factor by which the basis
Factor should be reduced for tax
calculation purposes.
4 basisRedAmt No STRING 60 No The Deduction Type of the
DeductionType amount by which the basis is
reduced.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
5 taxScopeType No STRING 60 No The Tax Scope for this tax
structure.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
6 allAtTopTier No LONG 1 Yes Indicates that tax should be
Indicator calculated entirely at the top
tier's percentage.
1 = true, 0 = false
7 unitBased No LONG 1 Yes Indicates that the unit price has
Indicator to be used to look up the tier
rate.
1 = true, 0 = false

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Flat Tax Tax Structure fields


The following table describes FLAT_TAX_TAX_STRUCTURE fields for a flat
tilde-delimited import file. Required fields apply when importing a Tax Rule with
a Flat Tax Structure.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes FLAT_TAX_TAX_STRUCTURE
text in description
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Structure to
a Tax Rule.
3 basisReduction No DOUBLE 10 No A factor by which the basis should
Factor be reduced for tax calculation
purposes.
4 basisRedAmt No STRING 60 No The Deduction Type of the amount
DeductionType by which the basis is reduced.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
5 taxScopeType No STRING 60 No The Tax Scope for this tax
structure.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
6 flatTax No DOUBLE 10 Yes A flat tax amount for tax
calculation.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule Conditional Tax Expression Tax Factor fields


The following table describes TAX_RULE_CONDITIONAL_TAX_
EXPRESSION_TAX_FACTOR fields for a flat tilde-delimited import file. Required
fields apply when importing a Tax Basis Rule.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_CONDITIONAL_
to text in TAX_EXPRESSION_TAX_
description field. FACTOR
2 temporaryTaxRule No STRING 155 Yes A temporary key to facilitate the
Key association of a Tax_Rule with
related entities and values. For a
Vertex export file, the Tax_Rule_ID
is used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export), may use any
unique identifier.
3 temporaryCond No STRING 155 Yes A temporary key to facilitate the
TaxExprTaxFactor association of a Tax Basis Rule
Key with related entities and values.
For a Vertex export file, the
Tax_Rule ID and Condition ID is
used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export), may use any
unique identifier.
4 parentTaxFactor No STRING 155 Yes A temporary key to facilitate the
Key association of a tax factor with its
parent tax factor. For a Vertex
export file, the Tax_Rule_ID ,
Condition ID, and Tax Factor ID are
used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export) may use any
unique identifier.
5 parentNodeLevel Yes LONG 155 Yes This field pertains to internal
Vertex tree structures for tax
factors.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
6 leftInd Yes LONG 1 Yes This field pertains to internal
Vertex tree structures for tax
factors.
7 rightInd No LONG 1 No A flag to indicate this tax factor is a
right tax factor of its parent.
8 factorTypeName Yes STRING 60 Yes Tax factor type name.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), Tax
Factor Type.
9 basisTypeName No STRING 60 No Basis type name for a basis
amount tax factor.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
10 computationType No STRING 60 No Computation type name for a
Name computation tax factor. This field
must be populated if the tax factor
type name is Computation.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
11 constantTaxFactor No DOUBLE 18 No Constant tax factor value for a
Value constant tax factor. This field must
be populated if the tax factor type
name is Constant.
12 taxFactorSource Yes STRING 128 Yes The source name for a tax factor.
Name
13 taxFactorKey No STRING 155 Yes A temporary key to facilitate the
association of a tax factor with its
child tax factor. For a Vertex
export file, the Tax Rule ID,
Condition ID and Tax Factor ID is
used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export), may use any
unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule Tax Basis Conclusion Tax Factor fields


The following table describes TAX_RULE_TAX_BASIS_CONCLUSION_ TAX_FACTOR
fields for a flat tilde-delimited import file. Required fields apply when importing a
Tax Basis Rule.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_TAX_BASIS_
to text in CONCLUSION_TAX_FACTOR
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax Rule with
related entities and values. For a
Vertex export file, the Tax_Rule_ID
is used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export), may use any
unique identifier.
3 temporary No STRING 155 Yes A temporary key to facilitate the
ConclusionTax association of a Tax Basis_Rule with
FactorKey related entities and values. For a
Vertex export file, the Tax_Rule_ID,
and Conclusion ID are used to
populate this field. However,
user-created import files (for
example, files not created via the
Vertex export), may use any unique
identifier.
4 parentTaxFactor No STRING 155 Yes A temporary key to facilitate the
Key association of a tax factor with its
parent tax factor. For a Vertex
export file, the Tax_Rule_ID,
Conclusion ID, and Tax Factor ID are
used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export), may use any
unique identifier.
5 parentNodeLevel No LONG 155 Yes This field pertains to internal Vertex
tree structures for tax factors.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
6 leftInd Yes LONG 1 Yes A flag to indicate this tax factor is a
left tax factor of its parent. This
field pertains to internal Vertex tree
structures for tax factors.
7 rightInd No LONG 1 No A flag to indicate this tax factor is a
right tax factor of its parent. This
field pertains to internal Vertex tree
structures for tax factors.
8 factorTypeName Yes STRING 60 Yes Tax factor type name.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
9 basisTypeName No STRING 60 No Basis type name for a basis amount
tax factor.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
10 computationType No STRING 60 No Computation type name for a
Name computation tax factor. This field
must be populated if the tax factor
type name is Computation.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
11 constantTax No DOUBLE 18 No Constant tax factor value for a
FactorValue constant tax factor. This field must
be populated if the tax factor type
name is Constant.
12 taxFactorSource Yes STRING 128 Yes The source name for a tax factor.
Name
13 taxFactorKey No STRING 155 Yes A temporary key to facilitate the
association of a tax factor with its
child tax factor. For a Vertex export
file, the Tax Rule ID, Conclusion ID,
and Tax Factor ID are used to
populate this field. However,
user-created import files (for
example, files not created via the
Vertex export), may use any unique
identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
14 flexFieldDefData No STRING 60 No Flex Field Definition data type
TypeName name.
15 flexFieldDef No LONG 2 No Flex Field Definition number.
Number
16 flexFieldDef No STRING 128 No Flex Field Definition source name.
SourceName
17 flexFieldDef No LONG 8 No Flex Field Definition start effective
StartDate date. Date format is YYYYMMDD.
18 flexfieldSupplies No LONG 1 Yes Indicates that the flex field for this
ProductDomain factor is applicable to supplies.
Indicator
19 flexfield No LONG 1 Yes Indicates that the flex field for this
Procurement factor is applicable to procurement.
ProductDomain
Indicator
20 taxability No STRING 60 No The user-defined taxability category
CategoryCode code. All category codes are
required to be unique.
21 taxability No LONG 8 No Date format is YYYYMMDD.
CategoryStart
Date
22 taxability No STRING 128 No Name related to Source ID.
CategorySource
Name
23 taxability No STRING 60 No Taxability Category Data Type
CategoryData Name.
TypeName
24 taxability No STRING 60 No The code for the parent taxability
CategoryParent category. This field is required
DataTypeName because user-defined categories
cannot be root categories;
therefore, a user-defined category
must have a parent.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Rule Conditional Tax Expression fields


The following table describes TAX_RULE_CONDITIONAL_TAX_ EXPRESSION fields
for a flat tilde-delimited import file. Required fields apply when importing a Tax
Basis Rule.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAX_RULE_CONDITIONAL_
to text in TAX_EXPRESSION
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax_Rule with related
entities and values. For a Vertex
export file, the Tax_Rule_ID is used to
populate this field. However,
user-created import files (for
example, files not created via the
Vertex export), may use any unique
identifier.
3 temporaryCond No STRING 155 Yes A temporary key to facilitate the
TaxExprTax association of a Tax_Rule with related
FactorKey entities and values. For a Vertex
export file, the Tax_Rule_ID and
Condition ID is used to populate this
field. However, user-created import
files (for example, files not created via
the Vertex export), may use any
unique identifier.
4 conditionSource Yes STRING 128 Yes The source name for a tax rule
Name condition.
5 conditionalType Yes STRING 60 Yes The type of condition to be satisfied.
Name

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Basis Rule Tax Basis Conclusion fields


The following table describes TAX_BASIS_RULE_TAX_BASIS_ CONCLUSION fields
for a flat tilde-delimited import file. Required fields apply when importing a Tax
Basis Rule.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_BASIS_RULE_TAX_
text in description BASIS_CONCLUSION
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax Rule with
related entities and values. For a
Vertex export file, the Tax_Rule ID
is used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export) may use any
unique identifier.
3 temporary No STRING 155 Yes A temporary key to facilitate the
ConclusionTax association of a Tax Basis Rule
FactorKey with related entities and values.
For a Vertex export file, the Tax
Rule_ID and Conclusion ID are
used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export) may use any
unique identifier.
4 conclusionSource Yes STRING 128 Yes The source name for tax basis rule
Name conclusion.
5 overrideTaxType Yes STRING 60 No The tax type to be used instead of
Name the original tax type already
specified by situs determination.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Taxability Rule fields


The following table describes TAXABILITY_RULE fields for a flat tilde-delimited
import file. At least one of the following entities is required for a Taxability Rule:
Taxpayer, Customer, or Qualifying Condition.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for more detail.
Field Field Natural Type Max. Size Req. Description
Count Key

1 Record Indicator No STRING Size is identical Yes TAXABILITY_RULE


to text in
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax Rule with related
entities and values. For a Vertex
export file, the Tax_Rule ID is used to
populate the field. User- created
import files, for example, files not
created via the Vertex export, may
use any unique identifier.
3 taxRuleSource Yes STRING 128 Yes Name related to Source ID.
Name
4 partyTaxpayer Yes STRING 80 No Parent taxpayer company code of
CompanyCode party/party class.
5 partyTaxpayer Yes STRING 80 No Parent taxpayer division code of
DivisionCode party/party class.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
6 partyTaxpayer Yes STRING 80 No Parent taxpayer department code of
DepartmentCode party/party class.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

7 partyTaxpayer Yes LONG 8 No The start date associated with the


CompanyStart parent taxpayer Department start
Date date.
This field is required if a parent
Taxpayer Department Code is
supplied.
8 partyTaxpayer Yes LONG 8 No The start date associated with the
DivisionStartDate parent Taxpayer Department start
date.
This field is required if a parent
Taxpayer Department Code is
supplied.
9 partyTaxpayer Yes LONG 8 No The start date associated with the
DeptStartDate parent Taxpayer Department start
date.
This field is required if a parent
Taxpayer Department Code is
supplied.
10 partyCode Yes STRING 80 No The user-defined code for a
customer or vendor, customer class,
or vendor class associated with this
rule.
11 partyClass No LONG 1 No Indicates whether the party code
Indicator refers to a class.
1 = true, 0 = false.
12 partyStartDate Yes LONG 8 No The start date for the party/party
class associated with this rule.
13 partyRoleType Yes STRING 60 No For a list of valid values for this field,
Name refer to Enumerated Types and
Values (see page 212).
14 partyTypeName Yes STRING 20 No The name of the party type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Party
Type.
15 taxpayer Yes STRING 80 No The user-defined taxpayer company
CompanyCode code.
This is required if a Taxpayer is
associated with this rule.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

16 taxpayer Yes STRING 80 No The user-defined taxpayer division


DivisionCode code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
17 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
18 taxpayer Yes LONG 8 No The start date associated with the
CompanyStart Taxpayer Department start date.
Date This field is required if a Taxpayer
Department Code is supplied.
19 taxpayerDivision Yes LONG 8 No The start date associated with the
StartDate Taxpayer Department start date.
This field is required if a Taxpayer
Department Code is supplied.
20 taxpayerDept Yes LONG 8 No The start date associated with the
StartDate Taxpayer Department start date.
This field is required if a Taxpayer
Department Code is supplied.
21 taxpayerParty Yes STRING 60 No For a list of valid values for this field,
RoleType refer to Enumerated Types and
Values (see page 212).
22 taxRuleStartDate Yes LONG 8 No Format is YYYYMMDD.
23 note No STRING 1000 No A note associated with the Tax Rule.
24 uniqueToLevel No LONG 1 Yes A flag to indicate that this tax rule
Ind only applies to the selected
item/usage category. Relevant for a
conditional rule.
1 = true, 0= false.
25 qualifierDetail No STRING 100 No A description of the qualifier for the
Description Tax Rule.
26 taxRuleEndDate No LONG 8 No Format is YYYYMMDD. Defaults to
99991231 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

27 condition No LONG 18 No A sequence number that indicates


Sequence the precedence of this rule with
Number respect to other rules with
conditions.
28 description No STRING 1000 No A text string giving a more detailed
explanation of the taxability.
29 locationRoleType No STRING 30 No The location role type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
30 currencyUnit No STRING 3 No The three-letter ISO code for the
currency unit in which amounts are
specified for the rule.
31 reasonCode No STRING 60 No A reason code associated with an
Exempt or Nontaxable Tax Rule.
32 reasonCodeType No STRING 20 No The reason code type.
The valid values are: Vertex Defined
and User Defined.
33 taxResultType Yes STRING 60 Yes For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
34 deferredTo No STRING 60 No The Jurisdiction Type to which to
JurisdictionType defer for Tax Result Type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
35 automaticRuleInd No LONG 1 Yes Indicates whether this is an
automatic rule.
1 = automatic, 0 = not automatic
36 standardRuleInd No LONG 1 Yes Indicates whether this is a standard
rule.
1 = standard, 0 = non-standard
37 deferToStandard No LONG 1 Yes An indicator as to whether this rule
RuleInd defers to the standard rule.
1 = true, 0 = false

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

38 filingCategory No LONG 5 No A filing category code associated


Code with the Tax Rule. This can be a
value between 5 and 99999, which
must match a valid Vertex-supplied
Filing Category Code for the
jurisdiction associated with the Tax
Rule.
39 appliesToSingle No LONG 1 No When this is set to true, and a local
Jurisdiction rule defers to the state level for
taxability, the local jurisdiction
assumes it is taxable at the full basis
amount rather than using any result
from the state-level rule.
The default value is false.
40 rateClassification No STRING 18 No The Rate Classification associated
with this Taxability Rule, if any.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
41 appnTaxability No STRING 60 No* The user-defined taxability category
CategoryCode code.
*Required if this tax rule has an
apportionment taxability category.
42 appnTaxability No LONG 8 No* Date format is YYYYMMDD.
CategoryStart *Required if this tax rule has an
Date apportionment taxability category.
43 appnTaxability No STRING 128 No* Name related to Source ID.
Category *Required if this tax rule has an
SourceName apportionment taxability category.
44 appnTaxability No STRING 60 No* Taxability Category Data Type Name.
CategoryData *Required if this tax rule has an
TypeName apportionment taxability category.
45 appnFlexField No STRING 60 No* Flex Field Definition data type name.
DataTypeName *Required if this tax rule has an
apportionment flex field.
46 appnFlexField No LONG 5 No* Flex Field Definition number.
FieldNumber *Required if this tax rule has an
apportionment flex field.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

47 appnFlexField No STRING 128 No* Flex Field Definition source name.


SourceName *Required if this tax rule has an
apportionment flex field.
48 appnFlexField No LONG 8 No* Flex Field Definition start effective
StartDate date.
*Required if this tax rule has an
apportionment flex field.
49 appnFlexfield No LONG 1 Yes* Financial Event Perspective of flex
SuppliesProduct field.
DomainIndicator *Required if this tax rule has an
apportionment flex field.
1 = true, 0 = false
50 appnFlexfield No LONG 1 Yes* Financial Event Perspective of flex
Procurement field.
ProductDomain *Required if this tax rule has an
Indicator apportionment flex field.
1 = true, 0 = false
51 apportionment No STRING 30 No* *Required if this tax rule has any
TypeName associated apportionment data.
52 applyFiling No LONG 1 No When this is set to true, apply the
Category filing category associated with this
tax rule.
The default value is false.
53 taxResponsibility No STRING 20 No Tax Responsibility Role Type Name.
RoleTypeName For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Tax
Responsibility Role Type.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Max Tax Rule fields


The following table describes MAX_TAX_RULE fields for a flat tilde-delimited
import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes MAX_TAX_RULE
to text in
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax Rule with
related entities and values. For a
Vertex export file, the Tax_Rule
ID is used to populate the field.
User-created import files (for
example, files not created via the
Vertex export) may use any
unique identifier.
3 taxRuleSource Yes STRING 128 Yes Name related to Source ID.
Name
4 partyTaxpayer Yes STRING 80 No Parent taxpayer company code of
CompanyCode party/party class.
5 partyTaxpayer Yes STRING 80 No Parent taxpayer division code of
DivisionCode party/party class.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
6 partyTaxpayer Yes STRING 80 No Parent taxpayer department code
DepartmentCode of party/party class.
Defaults to NULL if not supplied.
7 partyTaxpayer Yes LONG 8 No The start date associated with
CompanyStart the parent taxpayer Department
Date start date. This field is required if
a parent Taxpayer Department
Code is supplied.
8 partyTaxpayer Yes LONG 8 No The start date associated with
DivisionStartDate the parent Taxpayer Department
start date. This field is required if
a parent Taxpayer Department
Code is supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
9 partyTaxpayer Yes LONG 8 No The start date associated with
DeptStartDate the parent Taxpayer Department
start date. This field is required if
a parent Taxpayer Department
Code is supplied.
10 partyCode Yes STRING 80 No The user-defined code for a
customer or vendor, customer
class, or vendor class associated
with this rule.
11 partyClass No LONG 1 No Indicates whether the party code
Indicator refers to a class.
1 = true, 0 = false.
12 partyStartDate Yes LONG 8 No The start date for the party/party
class associated with this rule.

13 partyRoleType Yes STRING 60 No The role type name of the party.


For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
14 partyType Yes STRING 20 No The name of the party type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Party Type.
15 taxpayer Yes STRING 80 No The user-defined taxpayer
CompanyCode company code. This is required if
a Taxpayer is associated with this
rule.
16 taxpayerDivision Yes STRING 80 No The user-defined taxpayer
Code division code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
17 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
18 taxpayer Yes LONG 8 No The start date associated with
CompanyStar the Taxpayer Department start
Date date.
This field is required if a Taxpayer
Department Code is supplied.
19 taxpayerDivision Yes LONG 8 No The start date associated with
StartDate the Taxpayer Department start
date.
This field is required if a Taxpayer
Department Code is supplied.
20 taxpayerDept Yes LONG 8 No The start date associated with
StartDate the Taxpayer Department start
date. This field is required if a
Taxpayer Department Code is
supplied.
21 taxpayerParty Yes STRING 60 No The taxpayer's party role type.
RoleType For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
22 taxRuleStartDate Yes LONG 8 No Format is YYYYMMDD.
23 note No STRING 1000 No A note associated with the Tax
Rule.
24 uniqueToLevel No LONG 1 Yes A flag to indicate that this tax rule
Ind only applies to the selected
item/usage category. Relevant
for a conditional rule.
1 = true, 0= false.
25 qualifierDetail No STRING 100 No A description of the qualifier for
Description the Tax Rule.
26 taxRuleEndDate No LONG 8 No Format is YYYYMMDD. Defaults
to 99991231 if not supplied.
27 condition No LONG 18 No A sequence number that
Sequence indicates the precedence of this
Number rule with respect to other rules
with conditions.
28 description No STRING 1000 No A text string giving a more
detailed explanation of the
taxability.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
29 locationRoleType No STRING 30 No The location role type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
30 currencyUnit No STRING 3 No The three-letter ISO code for the
currency unit in which amounts
are specified for this rule.
31 maxTaxRuleType No STRING 20 Yes The max tax rule type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
32 maxTaxAmount No DOUBLE 18 No The maximum tax amount for a
Max Tax Rule.
33 taxScopeType No STRING 60 Yes The Tax Scope for this rule.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Tax Basis Rule fields


The following table describes TAX_BASIS_RULE fields for a flat tilde-delimited
import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAX_BASIS_RULE
text in description
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax Rule with
related entities and values. For a
Vertex export file, the Tax_Rule ID
is used to populate the field.
User-created import files (for
example, files not created via the
Vertex export) may use any unique
identifier.
3 taxRuleSource Yes STRING 128 Yes Name related to Source ID.
Name
4 partyTaxpayer Yes STRING 80 No Parent taxpayer company code of
CompanyCode party/party class.
5 partyTaxpayer Yes STRING 80 No Parent taxpayer division code of
DivisionCode party/party class.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
6 partyTaxpayer Yes STRING 80 No Parent taxpayer department code
DepartmentCode of party/party class.
Defaults to NULL if not supplied.
7 partyTaxpayer Yes LONG 8 No The start date associated with the
CompanyStart parent taxpayer Company start
Date date.
This field is required if a parent
Taxpayer Company Code is
supplied.
8 partyTaxpayer Yes LONG 8 No The start date associated with the
DivisionStartDate parent Taxpayer Division start
date.
This field is required if a parent
Taxpayer Division Code is supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
9 partyTaxpayer Yes LONG 8 No The start date associated with the
DeptStartDate parent Taxpayer Department start
date.
This field is required if a parent
Taxpayer Department Code is
supplied.
10 partyCode Yes STRING 80 No The user-defined code for a
customer or vendor, customer
class, or vendor class associated
with this rule.
11 partyClass No LONG 1 No Indicates whether the party code
Indicator refers to a class.
1 = true, 0 = false.
12 partyStartDate Yes LONG 8 No The start date for the party/party
class associated with this rule.
13 partyRoleType Yes STRING 60 No The name of the party role type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
14 partyType Yes STRING 20 No The name of the party type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Party Type.
15 taxpayer Yes STRING 80 No The user-defined taxpayer
CompanyCode company code.
This is required if a Taxpayer is
associated with this rule.
16 taxpayerDivision Yes STRING 80 No The user-defined taxpayer division
Code code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
17 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
18 taxpayer Yes LONG 8 No The start date associated with the
CompanyStart Taxpayer Department start date.
Date This field is required if a Taxpayer
Department Code is supplied.
19 taxpayerDivision Yes LONG 8 No The start date associated with the
StartDate Taxpayer Department start date.
This field is required if a Taxpayer
Department Code is supplied.
20 taxpayerDept Yes LONG 8 No The start date associated with the
StartDate Taxpayer Department start date.
This field is required if a Taxpayer
Department Code is supplied.
21 taxpayerParty Yes STRING 60 No The name of the taxpayer's party
RoleType role type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
22 taxRuleStartDate Yes LONG 8 No Format is YYYYMMDD.
23 note No STRING 1000 No A note associated with the Tax
Rule.
24 uniqueToLevel No LONG 1 No A flag to indicate that this tax rule
Ind only applies to the selected
item/usage category. Relevant for
a conditional rule.
1 = true, 0= false.
25 qualifierDetail No STRING 100 No A description of the qualifier for
Description the Tax Rule.
26 taxRuleEndDate No LONG 8 No Format is YYYYMMDD. Defaults to
99991231 if not supplied.
27 condition No LONG 5 No A sequence number that indicates
Sequence the precedence of this rule with
Number respect to other rules with
conditions.
28 description No STRING 1000 No A text string giving a more detailed
explanation of the taxability.
29 locationRoleType No STRING 30 No The location role type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
30 currencyUnit No STRING 3 No The three-letter ISO code for the
currency unit in which amounts
are specified for the rule.
31 discount No STRING 80 No The taxpayer company code for
Taxpayer the discount type.
CompanyCode
32 discount No STRING 80 No The taxpayer division code for the
TaxpayerDivision discount type.
Code
33 discount No STRING 80 No The taxpayer department code for
Taxpayer the discount type.
DepartmentCode
34 discount No STRING 128 No The taxpayer source name for the
TaxpayerSource discount type.
Name
35 discount No LONG 8 No The taxpayer start effective date
TaxpayerStart for the discount type.
Date
36 discountType No STRING 20 No Discount type code.
Code
37 discountType No LONG 8 No Discount type start effective date.
StartDate
38 discountType No STRING 128 No Discount type source name.
SourceName
39 discountType No STRING 60 No Discount category name for the
CategoryName discount category associated with
the discount type.
40 discountType No LONG 8 No The discount category start
CategoryStart effective date for the discount
Date category associated with the
discount type.
41 discountCategory No STRING 60 No The name of the discount category
Name associated with the rule.
42 discountCategory No LONG 8 No The start date of the discount
StartDate category associated with the rule.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key
43 appliesToSingle No LONG 1 No An indicator that, if true, implies
Imposition that this tax basis rule applies to
only the current imposition within
the same tax jurisdiction. The
default value is true.
44 appliesToSingle No LONG 1 No An indicator that, if true, implies
Jurisdiction that this tax basis rule applies to
only the current tax jurisdiction.
The default value is false.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Recoverability Rule fields


The following table describes RECOVERABILITY_RULE fields for a flat
tilde-delimited import file. At least one of the following entities is required for a
Recoverability Rule: Taxpayer, Customer, or Qualifying Condition.
Field Field Natural Type Max. Size Req. Description
Count Key

1 Record Indicator No STRING Size is identical Yes RECOVERABILITY_RULE


to text in the
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax Rule with related
entities and values. For a Vertex
export file, the Tax_Rule ID is used to
populate the field. User-created
import files, such as files not created
via the Vertex export, can use any
unique identifier.
3 taxRuleSource Yes STRING 128 Yes Name related to the Source ID.
Name
4 partyTaxpayer Yes STRING 80 No Parent taxpayer company code of
CompanyCode party or party class.
5 partyTaxpayer Yes STRING 80 No Parent taxpayer division code of
DivisionCode party or party class.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
6 partyTaxpayer Yes STRING 80 No Parent taxpayer department code of
DepartmentCode party/party class.
Defaults to NULL if not supplied.
7 partyTaxpayer Yes LONG 8 No The start date associated with the
CompanyStart parent taxpayer Company start date.
Date If a parent Taxpayer Department
Code is supplied, this field is
required.
8 partyTaxpayer Yes LONG 8 No The start date associated with the
DivisionStartDate parent Taxpayer Department start
date.
If a parent Taxpayer Division Code is
supplied, this field is required.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

9 partyTaxpayer Yes LONG 8 No The start date associated with the


DeptStartDate parent Taxpayer Department start
date.
If a parent Taxpayer Department
Code is supplied, this field is
required.
10 partyCode Yes STRING 80 No The user-defined code for a
customer or vendor, customer class,
or vendor class associated with this
rule.
11 partyClass No LONG 1 No Indicates whether the party code
Indicator refers to a class.
1 = true, 0 = false.
12 partyStartDate Yes LONG 8 No The start date for the party/party
class associated with this rule.
13 partyRoleType Yes STRING 60 No The name of the party role type.
Name For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
14 partyTypeName Yes STRING 20 No The name of the party type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
15 taxpayer Yes STRING 80 No The user-defined taxpayer company
CompanyCode code.
If a Taxpayer is associated with this
rule, this field is required.
16 taxpayer Yes STRING 80 No The user-defined taxpayer division
DivisionCode code.
Defaults to NULL if not supplied.
If a non-NULL Department Code is
supplied, the Division Code is
required.
17 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

18 taxpayer Yes LONG 8 No The start date associated with the


CompanyStart Taxpayer Company start date.
Date If a Taxpayer Department Code is
supplied, this field is required.
19 taxpayerDivision Yes LONG 8 No The start date associated with the
StartDate Taxpayer Division start date.
If a Taxpayer Department Code is
supplied, this field is required.
20 taxpayerDept Yes LONG 8 No The start date associated with the
StartDate Taxpayer Department start date.
If a Taxpayer Department Code is
supplied, this field is required.
21 taxpayerParty Yes STRING 60 No The taxpayer party role type.
RoleType For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
22 taxRuleStartDate Yes LONG 8 No The start date for a tax rule.
Format is YYYYMMDD.
23 note No STRING 1000 No A note associated with the Tax Rule.
24 uniqueToLevel No LONG 1 Yes A flag to indicate that this tax rule
Ind applies to only the selected item or
usage category. Relevant for a
conditional rule.
1 = true, 0= false.
25 qualifierDetail No STRING 100 No A description of the qualifier for the
Description Tax Rule.
26 taxRuleEndDate No LONG 8 No The end date for a tax rule.
Format is YYYYMMDD. Defaults to
99991231 if not supplied.
27 condition No LONG 18 No A sequence number that indicates
Sequence the precedence of this rule with
Number respect to other rules with
conditions.
28 description No STRING 1000 No A text string giving a more detailed
explanation of the taxability.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Rule

Field Field Natural Type Max. Size Req. Description


Count Key

29 locationRoleType No STRING 30 No The location role type.


For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
30 currencyUnit No STRING 3 No The three-letter ISO code for the
currency unit in which amounts are
specified for the rule.
31 appliesToSingle No LONG 1 No When this field is set to true and a
Jurisdiction local rule defers to the state level for
taxability, the local jurisdiction
assumes taxability at the full basis
amount rather than using any result
from the state-level rule. The default
value is false.
32 recoverable No DOUBLE 10 Yes A single rate for tax calculation.
Percent

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Taxability Mapping formats

Taxability Mapping formats


This section describes the formats pertaining to Taxability Mapping and presents
them in the order they must appear in the import file. Taxability Mapping
formats and the corresponding record indicators are listed in the following table.
Format Record Indicator
Taxability Mapping Rule Transaction Type fields (see MAPPING_RULE_TRANSTYPE
page 179)
Taxability Mapping Rule Tax Type fields (see page 180) MAPPING_RULE_TAXTYPE
Taxability Mapping Rule Tax Imposition fields (see page MAPPING_RULE_TAXIMP
181)
Taxability Mapping Rule Qualifying Condition fields (see MAPPING_RULE_QUALIFYING_CONDITION
page 182)
Taxability Mapping Rule Conditional Jurisdiction fields MAPPING_RULE_CONDITIONAL_JURISDICTION
(see page 187)
Taxability Mapping Rule fields (see page 188) MAPPING_RULE
Taxability Mapping Category Mapping Drivers fields MAPPING_TAXABILITY_CATEGORY_MAPPING
(see page 194)
Taxability Mapping Category Mapping fields (see page MAPPING_TAXABILITY_CATEGORY_MAPPING_
196) DRIVERS
Taxability Mapping fields (see page 198) TAXABILITY_MAPPING

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Rule Transaction Type fields


The following table describes MAPPING_RULE_TRANSTYPE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes MAPPING_RULE_
text in description TRANSTYPE
field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Taxability
Mapping with related entities
and values. For a Vertex export
file, the Taxability Mapping ID is
used to populate this field.
However, user-created import
files (for example, files not
created via the Vertex export)
may use any unique identifier.
3 transactionType Yes STRING 60 Yes The Transaction Type that is
associated with the Tax Rule.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Rule Tax Type fields


The following table describes MAPPING_RULE_TAXTYPE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes MAPPING_RULE_TAXTYPE
to text in
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Taxability Mapping
with related entities and values. For
a Vertex export file, the Taxability
Mapping ID is used to populate this
field. However, user-created import
files (for example, files not created
via the Vertex export) may use any
unique identifier.
3 taxType Yes STRING 60 Yes The Tax Type that is associated with
the Tax Rule.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Rule Tax Imposition fields


The following table describes MAPPING_RULE_TAXIMP fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes MAPPING_RULE_TAXIMP
to text in
description
field.
2 jurisdictionId Yes LONG 18 Yes The jurisdiction ID associated with the
Tax Imposition.
3 impSourceName Yes STRING 128 Yes Name related to Source ID for Tax
Imposition.
4 impTypeName Yes STRING 60 Yes Tax Imposition Type Name.
5 impTypeSource Yes STRING 128 Yes Name related to Source ID for Tax
Name Imposition Type.
6 impStartDate Yes LONG 8 Yes Date format is YYYYMMDD.
7 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of this Tax Imposition to a
Tax Rule.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Rule Qualifying Conditions fields


The following table describes MAPPING_RULE_QUALIFYING_CONDITION fields
for a flat tilde-delimited import file. A Qualifying Condition may include one of
the following entities:
 A Taxability Driver
 A Taxability Category
 A Flexible Field Definition
Required fields apply if you are mapping a rule associated to qualifying
conditions.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for more detail.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes MAPPING_RULE_
text in description QUALIFYING_CONDITION
field.
2 temporary No STRING 155 Yes A temporary key to facilitate the
MappingRuleKey association of this qualifying
condition to a Mapping Tax Rule.
3 mappingRule Yes STRING 128 Yes Name related to Source ID.
SourceName
4 taxabilityDriver No STRING 80 No* The user-defined taxpayer
Taxpayer company code.
CompanyCode *Required if this condition
represents a taxability driver.
5 taxabilityDriver No STRING 80 No The user-defined taxpayer division
TaxpayerDivision code.
Code Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
6 taxabilityDriver No STRING 80 No The user-defined taxpayer
Taxpayer department code.
DepartmentCode Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
7 taxabilityDriver No LONG 8 No* Date format is YYYYMMDD.
TaxpayerStart *Required if this condition
Date represents a taxability driver.
8 taxabilityDriver Yes STRING 60 Yes* This field indicates the type of
TaxabilityInput Input Parameter of the taxability
ParameterType driver.
Name *Required if this condition
represents a taxability driver.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
9 taxabilityDriver Yes STRING 40 No* The user-defined taxability driver
Code code.
*Required if this condition
represents a taxability driver.
10 taxabilityDriver Yes LONG 8 No* Date format is YYYYMMDD.
StartDate *Required if this condition
represents a taxability driver.
11 taxabilityDriver Yes LONG 1 Yes* Applies to Supplies Financial Event
SuppliesProduct Perspective.
DomainIndicator *Required if this condition
represents a taxability
driver.1=true, 0=false
12 taxabilityDriver Yes LONG 1 Yes* Applies to Procurement Financial
Procurement Event Perspective.
ProductDomain *Required if this condition
Indicator represents a taxability
driver.1=true, 0=false
13 taxabilityDriver Yes STRING 60 No* Taxability Driver Flex Field
FlexFieldData Definition data type name of
TypeName taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
14 taxabilityDriver Yes LONG 5 No* Taxability Driver Flex Field
FlexFieldField Definition number of taxability
Number driver.
*If the Taxability Driver has an
associated flex field, this field is
required.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
15 taxabilityDriver Yes STRING 128 No* Taxability Driver Flex Field
FlexFieldSource Definition source name of
Name taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
16 taxabilityDriver Yes LONG 8 No* Taxability Driver Flex Field
FlexFieldStart Definition start effective date of
Date taxability driver.
*If the Taxability Driver has an
associated flex field, this field is
required.
17 taxabilityDriver No LONG 1 Yes* This field indicates whether this
FlexfieldSupplies taxability driver should be
ProductDomain displayed in the Supplies Financial
Indicator Event Perspective.
*Required if this condition
represents a taxability driver.
1 = true, 0 = false.
*At least one of these two
Financial Event Perspective
Indicators must be set to true.
18 taxabilityDriver No LONG 1 Yes* This field indicates whether this
Flexfield taxability driver should be
Procurement displayed in the Procurement
ProductDomain Financial Event Perspective.
Indicator *Required if this condition
represents a taxability driver.
1 = true, 0 = false.
*At least one of these two
Financial Event Perspective
Indicators must be set to true.
19 taxability Yes STRING 60 No* The user-defined taxability
CategoryCode category code.
*Required if this condition
represents a taxability category.
20 taxability Yes LONG 8 No* Date format is YYYYMMDD.
CategoryStart *Required if this condition
Date represents a taxability category.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
21 taxability Yes STRING 128 No* Name related to Source ID.
CategorySource *Required if this condition
Name represents a taxability category.
22 taxability Yes STRING 60 No* Taxability Category Data Type
CategoryData Name.
TypeName *Required if this condition
represents a taxability category.
23 flexFieldData Yes STRING 60 No* Flex Field Definition data type
TypeName name.
*Required if this condition
represents a flexible field
definition.
24 flexFieldField Yes LONG 5 No* Flex Field Definition number.
Number *Required if this condition
represents a flexible field
definition.
25 flexFieldSource Yes STRING 128 No* Flex Field Definition source name.
Name *Required if this condition
represents a flexible field
definition.
26 flexFieldStart Yes LONG 8 No* Flex Field Definition start effective
Date date.
*Required if this condition
represents a flexible field
definition.
27 flexfieldSupplies No LONG 1 Yes* Financial Event Perspective of flex
ProductDomain field.
Indicator *Required if this condition
represents a flexible field
definition.1=true, 0=false
28 flexfield No LONG 1 Yes* Financial Event Perspective of flex
Procurement field.
ProductDomain *Required if this condition
Indicator represents a flexible field
definition.1=true, 0=false
29 minDate Yes LONG 8 No The minimum date range used to
test against a DATE Taxability
Category or a DATE flexible field.
Null indicates no minimum date.
Date testing is inclusive.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
30 maxDate Yes LONG 8 No The maximum date range used to
test against a DATE Taxability
Category or a DATE flexible field.
Null indicates no maximum date.
Date testing is inclusive.
31 comparisonValue No DOUBLE 10 No A numeric value used with the
Comparison Type when the
Taxability Category or the flexible
field is type NUMERIC.
32 comparisonType Yes STRING 60 No* An enumeration of types of
Name conditions used in tax expressions.
*This field is required if
comparison value exists.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212),
Expression Condition Type.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Rule Conditional Jurisdiction fields


The following table describes MAPPING_RULE_CONDITIONAL_ JURISDICTION
fields for a flat tilde-delimited import file. Required fields apply if you are
mapping a rule associated to conditional jurisdiction.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes MAPPING_RULE_
to text in CONDITIONAL_
description field. JURISDICTION
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
MappingKey association of this qualifying
condition to a Taxability Mapping.
3 taxRuleSource Yes STRING 128 Yes Name related to Source ID.
Name
4 jurisdictionId Yes LONG 18 Yes The identifier for the conditional
jurisdiction. You can look this up in
TaxGIS.
5 effDate Yes LONG 8 Yes The date on which this record is
effective.
Date format is YYYYMMDD.
6 endDate No LONG 8 Yes The end date for this record.
Date format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Rule fields


The following table describes MAPPING_RULE fields for a flat tilde-delimited
import file.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for more detail.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes MAPPING_RULE
to text in
description field.
2 temporaryTax No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Tax Rule with related
entities and values. For a Vertex
export file, the Tax_Rule ID is used to
populate the field. User- created
import files (for example, files not
created via the Vertex export) may
use any unique identifier.
3 taxRuleSource Yes STRING 128 Yes Name related to Source ID.
Name
4 partyTaxpayer Yes STRING 80 No Parent taxpayer company code of
CompanyCode party/party class.
5 partyTaxpayer Yes STRING 80 No Parent taxpayer division code of
DivisionCode party/party class.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
6 partyTaxpayer Yes STRING 80 No Parent taxpayer department code of
DepartmentCode party/party class.
Defaults to NULL if not supplied.
7 partyTaxpayer Yes LONG 8 No The start date associated with the
CompanyStart parent taxpayer Department start
Date date.
This field is required if a parent
Taxpayer Department Code is
supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
8 partyTaxpayer Yes LONG 8 No The start date associated with the
DivisionStartDate parent Taxpayer Department start
date.
This field is required if a parent
Taxpayer Department Code is
supplied.
9 partyTaxpayer Yes LONG 8 No The start date associated with the
DeptStartDate parent Taxpayer Department start
date.
This field is required if a parent
Taxpayer Department Code is
supplied.
10 partyCode Yes STRING 80 No The user-defined code for a
customer or vendor, customer class,
or vendor class associated with this
rule.
11 partyClass No LONG 1 No Indicates whether the party code
Indicator refers to a class.
1 = true, 0 = false.
12 partyStartDate Yes LONG 8 No The start date for the party/party
class associated with this rule.
13 partyRoleType Yes STRING 60 No The name of the party role type.
Name For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
14 partyTypeName Yes STRING 20 No The name of the party type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Party
Type.
15 taxpayer Yes STRING 80 No The user-defined taxpayer company
CompanyCode code.
This is required if a Taxpayer is
associated with this rule.
16 taxpayerDivision Yes STRING 80 No The user-defined taxpayer division
Code code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
17 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
18 taxpayer Yes LONG 8 No The start date associated with the
CompanyStart Taxpayer Department start date.
Date This field is required if a Taxpayer
Department Code is supplied.
19 taxpayerDivision Yes LONG 8 No The start date associated with the
StartDate Taxpayer Department start date.
This field is required if a Taxpayer
Department Code is supplied.
20 taxpayerDept Yes LONG 8 No The start date associated with the
StartDate Taxpayer Department start date.
This field is required if a Taxpayer
Department Code is supplied.
21 taxpayerParty Yes STRING 60 No The taxpayer's party role type.
RoleType For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
22 taxRuleStartDate Yes LONG 8 No Format is YYYYMMDD.
23 note No STRING 1000 No A note associated with the Tax Rule.

24 uniqueToLevel No LONG 1 Yes A flag to indicate that this tax rule


Ind only applies to the selected
item/usage category. Relevant for a
conditional rule.
1 = true, 0= false.
25 qualifierDetail No STRING 100 No A description of the qualifier for the
Description Tax Rule.
26 taxRuleEndDate No LONG 8 No Format is YYYYMMDD. Defaults to
99991231 if not supplied.
27 condition No LONG 18 No A sequence number that indicates
Sequence the precedence of this rule with
Number respect to other rules with
conditions.
28 description No STRING 1000 No A text string giving more detailed
explanation of the taxability.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
29 locationRoleType No STRING 30 No The location role type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
30 currencyUnit No STRING 3 No The three-letter ISO code for the
currency unit in which amounts are
specified for this rule.
31 reasonCode No STRING 60 No A reason code associated with an
Exempt or Nontaxable Tax Rule.
32 reasonCodeType No STRING 20 No The reason code type.
The valid values are: Vertex Defined
and User Defined.
33 taxResultType Yes STRING 60 Yes The tax result type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
34 deferredTo No STRING 60 No The jurisdiction type to which to
JurisdictionType defer for Tax Result Type.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
35 automaticRuleInd No LONG 1 Yes Indicates whether this rule is
automatic.
1 = automatic, 0 = not automatic
36 standardRuleInd No LONG 1 Yes Indicates whether this is a standard
rule.
1 = standard, 0 = non-standard
37 deferToStandard No LONG 1 Yes An indicator as to whether this rule
RuleInd defers to the standard rule.
1 = true, 0 = false
38 filingCategory No LONG 5 No A filing category code associated
Code with the Tax Rule. This can be a
value between 5 and 99999, which
must match a valid Vertex-supplied
Filing Category Code for the
jurisdiction associated with the Tax
Rule.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
39 appliesToSingle No LONG 1 No When this is set to true, and a local
Jurisdiction rule defers to the state level for
taxability, the local jurisdiction
would assume it is taxable at the full
basis amount rather than using any
result from the state-level rule.
The default value is false.
40 rateClassification No STRING 18 No The Rate Classification associated
with this taxability rule, if any.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
41 appnTaxability No STRING 60 No* The user-defined taxability category
CategoryCode code.
*Required if this tax rule has an
apportionment taxability category.
42 appnTaxability No LONG 8 No* Date format is YYYYMMDD.
CategoryStart *Required if this tax rule has an
Date apportionment taxability category.
43 appnTaxability No STRING 128 No* Name related to Source ID.
CategorySource *Required if this tax rule has an
Name apportionment taxability category.
44 appnTaxability No STRING 60 No* Taxability Category Data Type Name.
CategoryData *Required if this tax rule has an
TypeName apportionment taxability category.
45 appnFlexField No STRING 60 No* Flex Field Definition data type name.
DataTypeName *Required if this tax rule has an
apportionment flex field.
46 appnFlexField No LONG 5 No* Flex Field Definition number.
FieldNumber *Required if this tax rule has an
apportionment flex field.
47 appnFlexField No STRING 128 No* Flex Field Definition source name.
SourceName *Required if this tax rule has an
apportionment flex field.
48 appnFlexField No LONG 8 No* Flex Field Definition start effective
StartDate date.
*Required if this tax rule has an
apportionment flex field.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
49 appnFlexfield No LONG 1 Yes* Financial Event Perspective of flex
SuppliesProduct field.
DomainIndicator *Required if this tax rule has an
apportionment flex field.
1 = true, 0 = false
50 appnFlexfield No LONG 1 Yes* Financial Event Perspective of flex
Procurement field.
ProductDomain *Required if this tax rule has an
Indicator apportionment flex field.
1 = true, 0 = false
51 apportionment No STRING 30 No* *Required if this tax rule has any
TypeName associated apportionment data.
52 applyFiling No LONG 1 No When this is set to true, apply the
Category filing category associated with this
tax rule.
The default value is false.
53 taxResponsibility No STRING 20 No Tax Responsibility Role Type Name.
RoleTypeName For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the Tax
Responsibility Role Type.
54 vertexMapping No LONG 18 No This field is used to support reuse of
RuleId this format by the Taxability
Mapping import/export. It
represents the internal Tax Rule ID
for a Vertex-defined tax rule that is
involved in a taxability mapping.
* This field will only be present for
the Taxability Mapping – Tax Rule
format. It will not be present for the
Taxability Rule format.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Category Mapping Drivers fields


The following table describes MAPPING_TAXABILITY_CATEGORY_
MAPPING_DRIVERS fields for a flat tilde-delimited import file. Required fields
apply if taxability category mapping has taxability drivers.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes MAPPING_TAXABILITY_
to text in CATEGORY_MAPPING_
description field. DRIVERS
2 taxabilityDriver No STRING 80 No The user-defined taxpayer company
Taxpayer code.
CompanyCode
3 taxabilityDriver No STRING 80 No The user-defined taxpayer division
TaxpayerDivision code.
Code Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 taxabilityDriver No STRING 80 No The user-defined taxpayer
Taxpayer department code.
DepartmentCode Defaults to NULL if not supplied.
5 taxabilityDriver No LONG 8 No Date format is YYYYMMDD.
TaxpayerStart
Date
6 taxabilityDriver Yes STRING 40 No The user-defined product or
Code purchase or usage code.
7 taxabilityDriver Yes LONG 8 No Date format is YYYYMMDD.
StartDate
8 taxabilityDriver Yes STRING 60 Yes This field indicates the type of Input
TaxabilityInput Parameter of the taxability driver.
ParameterType For a list of valid values for this
Name field, refer to Enumerated Types
and Values (see page 212).
9 taxabilityDriver Yes LONG 1 Yes This field indicates whether this
SuppliesProduct taxability driver should be displayed
DomainIndicator in the Supplies Product Domain.
1 = true, 0 = false.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
10 taxabilityDriver Yes LONG 1 Yes This field indicates whether this
Procurement taxability driver should be displayed
ProductDomain in the Procurement Product
Indicator Domain.
1 = true, 0 = false
11 taxability Yes STRING 128 Yes Name related to Source ID.
Category
MappingSource
Name
12 flexFieldData Yes STRING 60 No Flex Field Definition data type name
TypeName of taxability driver.
13 flexFieldField Yes LONG 5 No Flex Field Definition number of
Number taxability driver.
14 flexFieldSource Yes STRING 128 No Flex Field Definition source name of
Name taxability driver.
15 flexFieldStart Yes LONG 8 No Flex Field Definition start effective
Date date of taxability driver.
16 flexfieldSupplies No LONG 1 Yes Flex Field Definition supplies
ProductDomain indicator of taxability driver.
Indicator 1 = true, 0 = false.
17 flexfield No LONG 1 Yes Flex Field Definition procurement
Procurement indicator of taxability driver.
ProductDomain 1 = true, 0 = false
Indicator
18 temporary No STRING 155 Yes A temporary key to facilitate the
Taxability association of a Taxability Mapping
MappingKey with related entities and values. For
a Vertex export file, the Taxability
Mapping ID is used to populate this
field. However, user-created import
files (for example, files not created
via the Vertex export) may use any
unique identifier.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Taxability Mapping Category Mapping fields


The following table describes MAPPING_TAXABILITY_CATEGORY_ MAPPING
fields for a flat tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes MAPPING_TAXABILITY_
to text in CATEGORY_MAPPING
description field.
2 partyTaxpayer Yes STRING 80 No The user-defined taxpayer
CompanyCode company code.
3 partyTaxpayer Yes STRING 80 No The user-defined taxpayer
DivisionCode division code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
4 partyTaxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
5 partyTaxpayer Yes LONG 8 No Date format is YYYYMMDD.
StartDate
6 partyCode Yes STRING 80 No User defined
customer/vendor/customer
class/vendor class code
7 partyClass No LONG 1 No Indicates whether this is a
Indicator customer/vendor or a
customer/vendor class.
1 = is class, 0 = not a class.
Defaults to 0 if not supplied.
8 partyStartDate Yes LONG 8 No Customer/Vender/Customer
Class/Vendor Class start
effective date
9 partyTypeName Yes STRING 20 No The name of the party type.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212), the
Party Type.
10 taxpayer Yes STRING 80 No The user-defined taxpayer
CompanyCode company code.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
11 taxpayer Yes STRING 80 No The user-defined taxpayer
DivisionCode division code.
Defaults to NULL if not supplied.
Division Code is required if a
non-NULL Department Code is
supplied.
12 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code.
Defaults to NULL if not supplied.
13 taxpayerStart Yes LONG 8 No Date format is YYYYMMDD.
Date
14 taxability Yes LONG 8 No Date format is YYYYMMDD.
CategoryMapping
StartDate
15 taxability No LONG 8 No Date format is YYYYMMDD.
CategoryMapping Defaults to 99991231 if not
EndDate supplied.
16 taxability Yes STRING 60 No The taxability category code.
CategoryCode
17 taxability Yes LONG 8 No Date format is YYYYMMDD.
CategoryStart
Date
18 taxability Yes STRING 128 No The name of the category
CategorySource source.
Name  If the category is
user-defined, this field
displays the partition name
in which the category was
created.
 If the category is a standard
Vertex category, this field
displays Vertex.
19 taxability Yes STRING 60 No The Data Type of the taxability
CategoryData category.
TypeName See the “Enumerated Types and
Values” chapter for a list of valid
values for this field.
20 taxability Yes STRING 128 Yes The partition ID.
CategoryMapping
SourceName

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Taxability Mapping

Field Field Natural Type Max. Size Req. Description


Count Key
21 temporary No STRING 155 Yes A temporary key to facilitate the
Taxability association of a Taxability
MappingKey Mapping with related entities
and values. For a Vertex export
file, the Taxability Mapping ID is
used to populate this field.
However, user-created import
files (for example, files not
created via the Vertex export)
may use any unique identifier.
22 note No STRING 1000 No The taxability mapping note.
Defaults to NULL if not supplied.

Taxability Mapping fields


The following table describes TAXABILITY_MAPPING fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXABILITY_MAPPING
text in description
field.
2 tempKey No STRING 155 Yes A temporary key to facilitate
the association of a Taxability
Mapping with related entities
and values. For a Vertex export
file, the Taxability Mapping ID
is used to populate this field.
However, user-created import
files (for example, files not
created via the Vertex export),
may use any unique identifier.
3 taxMappingStart Yes LONG 8 Yes The date on which this
Date Taxability Mapping is effective.
Date format is YYYYMMDD.
4 taxMappingEnd No LONG 8 No Date format is YYYYMMDD.
Date Defaults to 99991231 if not
provided.
5 sourceName Yes STRING 128 Yes Name related to Source ID.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File Layouts  Situs Treatment Rule formats

Situs Treatment Rule formats


This section describes the formats pertaining to Situs Treatment Rules and
presents them in the order they must appear in the import and export files. Situs
Treatment Rule formats and the corresponding record indicators are listed in the
following table.
Format Record Indicator
Situs Treatment Rule Transaction Event fields (see page SITUS_TREATMENT_RULE_TRANSACTION_EVENT
199)
Situs Treatment Rule fields (see page 200) SITUS_TREATMENT_RULE

Situs Treatment Rule Transaction Event fields


The following table describes SITUS_TREATMENT_RULE_TRANSACTION_EVENT
fields for a flat tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes SITUS_TREATMENT_RULE_
text in description TRANSACTION_EVENT
field.
2 temporarySitus No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Situs Treatment Rule
with related entities and values. For
a Vertex export file, the Situs
Treatment RuleID and source name
are used to populate this field.
However, user-created import files
(for example, files not created via
the Vertex export) may use any
unique identifier.
3 transactionEvent Yes STRING 60 Yes The transaction event to which the
situs treatment rule applies.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212), the
Transaction Event Type.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Situs Treatment Rule

Situs Treatment Rule fields


The following table describes SITUS_TREATMENT_RULE fields for a flat
tilde-delimited import file.
Note: An asterisk (*) next to the value in the Req. column indicates that while
the field has a certain requirement to pass an input file edit, it has
different requirements in certain contexts. Refer to the Description column
for more detail.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes SITUS_TREATMENT_RULE
to text in
description field.
2 temporarySitus No STRING 155 Yes A temporary key to facilitate the
RuleKey association of a Situs Treatment
Rule with related entities and
values. For a Vertex export file, the
Situs Treatment Rule ID and
source name are used to populate
this field. However, user-created
import files (for example, files not
created via the Vertex export) may
use any unique identifier.
3 situsTreatmentId Yes LONG 18 Yes The unique identifier for a situs
treatment.
4 situsTreatment Yes STRING 128 Yes The source name of the situs
SourceName treatment.
5 situsTreatment Yes LONG 8 Yes Situs treatment rule start effective
RuleStartEffDate date.
6 sourceName Yes STRING 128 Yes The source name of the situs
treatment rule.
7 taxability Yes STRING 60 Yes The taxability category code to
CategoryCode which this situs treatment rule
applies.
8 taxability Yes STRING 128 Yes The source name of taxability
CategorySource category.
Name
9 taxability Yes LONG 8 Yes The start effective date of
CategoryStart taxability category.
Date

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Situs Treatment Rule

Field Field Natural Type Max. Size Req. Description


Count Key
10 taxability Yes STRING 60 Yes Taxability Category Data Type
CategoryData Name.
TypeName See the “Enumerated Types and
Values” chapter for a list of valid
values for this field.
11 primary Yes LONG 18 No* The primary jurisdiction identifier
Jurisdiction to which the situs treatment rule
applies.
*Required if there is a primary
jurisdiction/location role pair
associated with the situs
treatment rule.
12 primaryLocation Yes STRING 30 No* The name of the primary location
Role role to which the situs treatment
rule applies.
*Required if there is a primary
jurisdiction/location role pair
associated with the situs
treatment rule.
13 secondary Yes LONG 18 No* The secondary jurisdiction
Jurisdiction identifier to which the situs
treatment rule applies.
*Required if there is a secondary
jurisdiction/location role pair
associated with the situs
treatment rule.
14 secondary Yes STRING 30 No* The name of the secondary
LocationRole location role to which the situs
treatment rule applies.
*Required if there is a secondary
jurisdiction/location role pair
associated with the situs
treatment rule.
15 situsTreatment No LONG 8 No The Situs Treatment Rule end
RuleEndEffDate effective date.
16 notes No STRING 1000 No Notes about the Situs Treatment
Rule.
17 situsTreatment No LONG 8 No The date the situs treatment rule
RuleCreateDate is created.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Field Field Natural Type Max. Size Req. Description


Count Key
18 situsTreatment No LONG 8 No The last update date of the situs
RuleLastUpdate treatment rule.
Date

Tax Assist formats


This section describes the formats pertaining to Tax Assist and presents them in
the order they must appear in the import file. Tax Assist formats and the
corresponding record indicators are listed in the following table.
Format Record Indicator
Tax Assist Lookup Table fields (see page 203) TAXASSIST_LOOKUP_TABLE
Tax Assist Lookup Record fields (see page 205) TAXASSIST_LOOKUP_RECORD
Tax Assist Allocation Table fields (see page 206) TAXASSIST_ALLOCATION_TABLE
Tax Assist Allocation Column fields (see page 207) TAXASSIST_ALLOCATION_COLUMN
Tax Assist Allocation Column Value fields (see page TAXASSIST_ALLOCATION_COLUMN_VALUE
208)
Tax Assist Rule fields (see page 210) TAXASSIST_RULE

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Tax Assist Lookup Table fields


The following table describes TAXASSIST_LOOKUP_TABLE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXASSIST_LOOKUP_TABLE
to text in
description field.
2 tableName Yes STRING 60 Yes The name of the lookup table.
3 sourceName Yes STRING 128 Yes The name of the partition with which
the lookup table is associated.
4 tableStartDate Yes LONG 8 Yes The start effective date of the lookup
table.
Format is YYYYMMDD.
5 financialEvent No STRING 60 Yes The financial event to which the
lookup table applies.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
6 dataType No STRING 30 Yes The data type of the lookup result for
this lookup table.
The data type may be String or
Numeric.
7 description No STRING 1000 No A description for the lookup table.
8 tableEndDate No LONG 8 No The end effective date of the lookup
table.
Format is YYYYMMDD. Defaults to
99991231 if not supplied.
9 resultName No STRING 60 Yes The name of the result column for the
lookup table.
10 param1Name No STRING 60 Yes The name of the param1 column for
the lookup table.
11 param2Name No STRING 60 No The name of the param2 column for
the lookup table.
12 param3Name No STRING 60 No The name of the param3 column for
the lookup table.
13 param4Name No STRING 60 No The name of the param4 column for
the lookup table.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Field Field Natural Type Max. Size Req. Description


Count Key
14 param5Name No STRING 60 No The name of the param5 column for
the lookup table.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Tax Assist Lookup Record fields


The following table describes TAXASSIST_LOOKUP_RECORD fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXASSIST_LOOKUP_RECORD
to text in
description field.
2 tableName Yes STRING 60 Yes The name of the lookup table with
which the lookup record is
associated.
3 sourceName Yes STRING 128 Yes The name of the partition with which
the lookup record is associated.
4 tableStartDate Yes LONG 8 Yes The start effective date of the lookup
table with which the lookup record is
associated.
Format is YYYYMMDD.
5 result No STRING 200 No The result value for the lookup
record.
6 param1 Yes STRING 200 No The param1 value for the lookup
record.
7 param2 Yes STRING 200 No The param2 value for the lookup
record.
8 param3 Yes STRING 200 No The param3 value for the lookup
record.
9 param4 Yes STRING 200 No The param4 value for the lookup
record.
10 param5 Yes STRING 200 No The param5 value for the lookup
record.
11 recordStartDate Yes LONG 8 Yes The start effective date of the lookup
record.
Format is YYYYMMDD.
12 recordEndDate No LONG 8 No The end effective date of the lookup
record.
Format is YYYYMMDD. Defaults to
99991231 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Tax Assist Allocation Table fields


The following table describes TAXASSIST_ALLOCATION_TABLE fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXASSIST_ALLOCATION_
text in description TABLE
field.
2 tableName Yes STRING 60 Yes The name of the allocation table.
3 sourceName Yes STRING 128 Yes The name of the partition with
which the allocation table is
associated.
4 tableStartDate Yes LONG 8 Yes The start effective date of the
allocation table.
Format is YYYYMMDD.
5 financialEvent No STRING 60 Yes The financial event to which the
allocation table applies.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
6 description No STRING 1000 No A description for the allocation
table.
7 tableEndDate No LONG 8 No The end effective date of the
lookup table.
Defaults to 99991231 if not
supplied.
Format is YYYYMMDD.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Tax Assist Allocation Column fields


The following table describes TAXASSIST_ALLOCATION_COLUMN fields for a flat
tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXASSIST_ALLOCATION_
to text in COLUMN
description field.
2 tableName Yes STRING 60 Yes The name of the allocation table
with which the allocation column is
associated.
3 sourceName Yes STRING 128 Yes The name of the partition with which
the allocation column is associated.
4 tableStartDate Yes LONG 8 Yes The start effective date of the
allocation table with which the
allocation column is associated.
Format is YYYYMMDD.
5 tableFinancial No STRING 60 Yes The financial event to which the
Event allocation table applies.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
6 columnName Yes STRING 60 Yes Allocation column name.
7 dataType No STRING 30 Yes The data type of the column.
The data type may be String or
Numeric.
8 columnSeqNum Yes LONG 8 Yes The numeric location of the column
in the associated allocation table.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Tax Assist Allocation Column Value fields


The following table describes TAXASSIST_ALLOCATION_COLUMN_VALUE fields
for a flat tilde-delimited import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical Yes TAXASSIST_ALLOCATION_
to text in COLUMN_VALUE
description field.
2 tableName Yes STRING 60 Yes The name of the allocation table with
which the allocation column is
associated.
3 sourceName Yes STRING 128 Yes The name of the partition with which
the allocation column is associated.
4 tableStartDate Yes LONG 8 Yes The start effective date of the
allocation table with which the
allocation column is associated.
Format is YYYYMMDD.
5 tableFinancial No STRING 60 Yes The financial event to which the
Event allocation table applies.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
6 columnName Yes STRING 60 Yes Allocation column name.
7 columnDataType No STRING 30 Yes The data type of the column.
The data type may be String or
Numeric.
8 columnSeqNum Yes LONG 8 Yes The numeric location of the column in
the associated allocation table.
9 columnValue Yes LONG 8 Yes The start effective date of the
StartDate allocation column value.
Format is YYYYMMDD.
10 rowCode Yes STRING 20 Yes A code to uniquely identify the
column value.
11 columnValueEnd No LONG 8 No The end effective date of the
Date allocation column value.
Format is YYYYMMDD.
12 columnValue No STRING 30 Yes The numeric data type of the column
NumericType value.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Field Field Natural Type Max. Size Req. Description


Count Key
13 columnValue No STRING 20 Yes The column value.
0 should be used if the numeric data
type is REMAINDER.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Tax Assist

Tax Assist Rule fields


The following table describes TAXASSIST_RULE fields for a flat tilde-delimited
import file.
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is identical to Yes TAXASSIST_RULE
text in description
field.
2 ruleName Yes STRING 60 Yes The name of the rule.
3 sourceName Yes STRING 128 Yes The name of the partition with
which the rule is associated.
4 ruleStartDate Yes LONG 8 Yes The start effective date of the rule.
Format is YYYYMMDD.
5 financialEvent No STRING 60 Yes The financial event to which the
rule applies.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).
6 precedence No LONG 18 Yes The precedence order in which the
rule should be applied. Precedence
is in ascending order. For example,
a rule with a precedence of 5 will
apply prior to a rule with a
precedence of 10. Precedence for
each rule must be unique
throughout the entire system
(across all partitions).
7 description No STRING 1000 No A description of the rule.
8 ruleEndDate No LONG 8 No The end effective date of the rule.
Format is YYYYMMDD. Defaults to
99991231 if not supplied.
9 condition No STRING 40000 No The condition that determines
whether the rule applies. Leaving
this field blank means that the rule
will always apply.
10 conclusions No STRING 40000 Yes The conclusions that should be
applied if the rule applies. Each
conclusion must be separated by a
semicolon.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 2. File  Data Extract

Field Field Natural Type Max. Size Req. Description


Count Key
11 phase No STRING 30 Yes The phase in which the Tax Assist
Rule may apply.
For a list of valid values for this
field, refer to Enumerated Types
and Values (see page 212).

Data Extract fields


This section lists the Data Extracts formats that Vertex O Series uses when you
import or export Data Extract definitions between multiple instances of Vertex O
Series. These fields define the specific details about the Data Extract formats.
Data Extract formats and the corresponding record indicators are listed in the
following table:

Format Record Indicators

Data Extract Report fields DATA_EXTRACT_REPORT


Data Extract Report Fields fields DATA_EXTRACT_REPORT_FIELD
Data Extract Report Filter fields DATA_EXTACT_REPORT_FILTER
Data Extract Report Property fields DATA_EXTRACT_REPORT_PROPERTY

June  Page
Chapter 3

Enumerated Types and Values


The following table provides a current list of enumerated types for Vertex O
Series.
Note: You must match the spacing and capitalization when using these values.

Name Valid Values

Basis Type Extended Amount


Cost
Total Cost
Fair Market Value
Fair Rental Value
Net Book Value
Certificate Class Type Exemption Certificate
Direct Pay Permit
Net Exporter Certificate
Reverse Charge Certificate
Zero Rate Certificate
Certificate Status APPROVED
ARCHIVED
DENIED
INVALID
NONE
NOT_PROCESSED
NOT_VALIDATED
VALID
Computation Type Add
Subtract
Multiply
Divide
Max
Min
Contact Role Type Shipping
Billing
Both

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 3. Enumerated Types and  Data Extract

Name Valid Values

Coverage Action Type ON


OFF
DEFAULT
Creation Source OSeries
ECMWizard
Data Type String
Numeric
Boolean
Date
Deduction Type Exemption Deduction Type
Nontaxable Deduction Type
Expression Condition Type Greater Than
Greater Than or Equal
Less Than
Less Than or Equal
Equals
Exists
Financial Event Type Asset/Goods Movement
Inventory Removal
Procurement
Sales/Supplies
Jurisdiction Type Set Districts
Main Divisions
Subdivisions
Cities
Country
Letter Template Type Standard Audit Letter
Standard Certificate Request Letter
Standard Invalid Certificate Letter
Location Role Type Destination
Physical Origin
Administrative Origin
Administrative Destination
Max Tax Rule Type Max Amount Rule
Max Tier Rule

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 3. Enumerated Types and  Data Extract

Name Valid Values

Party Role Type Buyer


Seller
Owner
Dispatcher
Recipient
Party Type Taxpayer
Customer
Vendor
Phase Pre-Calculation
Post-Calculation
Rate Classification Luxury Rate
Standard Rate
Reduced Rate 1
Reduced Rate 2
Reduced Rate 3
Reduced Rate 4
Reduced Rate 5
Zero Rate
Exempt
Outside the Scope
User Defined
Reason Code Type Vertex Defined
User Defined
Rounding Type Round Off
Round Down
Round Up

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 3. Enumerated Types and  Data Extract

Name Valid Values

Shipping Terms CFR - Cost and Freight


CIF - Cost, Insurance, and Freight
CIP - Carriage Insurance Paid To
CPT - Carriage Paid To
CUS - Customer
DAF - Delivered at Frontier
DAP - Delivered at Place
DAT - Delivered at Terminal
DDP - Delivered Duty Paid
DDU - Delivered Duty Unpaid
DEQ - Delivered Ex Quay Duty Unpaid
DES - Delivered Ex-Ship
EXW - Ex Works
FAS - Free Along Ship
FCA - Free Carrier
FOB - Free On Board
SUP - Supplier
Tax Factor Type Constant
Basis Type
Computation
Tax Registration Type VAT Registration
Federal Employer Identification Number (FEIN)
Tax Identification Number (TIN)
Social Security Number (SSN)
Business Number
State Identification Number
Electronically Supplied Services (ESS)
Tax Responsibility Role Type Buyer
Dispatcher
Owner
Recipient
Seller
Tax Result Type Taxable
Nontaxable
Exempt
DPP Applied

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 3. Enumerated Types and  Data Extract

Name Valid Values

Tax Scope Invoice


Multi Component
Line Item
Tax Type Sales
Seller Use
Consumer Use
Valued Added Tax
Import VAT
Taxability Input Parameter Type Cost Center
Department Code
GL Account #
Material Code
Project Number
Usage
Vendor SKU/Product ID
Flexible Field 1 - Flexible Field 15
Item
Item Class
Usage Class
Taxpayer
Customer
Vendor
Transaction Event Sale Invoice
Lease Invoice
Rental Invoice
Purchase
Lease Purchase
Rental Purchase
Asset Movement
Inventory Removal
Transaction Type Sale
Lease
Rental
Product Movement
Inventory Removal

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Chapter 3. Enumerated Types and  Data Extract

Name Valid Values

Validation Type Invalid


N/A
Valid

June  Page
Appendix A

Batch Certificate Import


This appendix provides information about the data for batch certificate import, as
well as the required location, record layouts, and fields.

In this appendix
Overview of batch certificate import..........................................218
Before you import a batch of certificates...................................219
Batch certificate import: File names and locations.....................219
Batch certificate import: File layouts..........................................220
Batch certificate import: Header fields.......................................221
Batch Certificate fields................................................................223
Batch Certificate Jurisdiction fields.............................................227

Overview of batch certificate import


Batch certificate import allows you to add to Vertex Central any certificates that you
maintain in software other than O Series, without having to retype all of the
information. You import the batch certificate records using Data Management
features in Vertex Central.
Note: The batch certificate import file format is an import-only format. O Series 6.0
does not export in this format.
Review this appendix to understand file name conventions and locations, file
layouts, and header fields. Field descriptions for Batch Certificate fields and Batch
Certificate Jurisdiction fields are provided.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate Import  Before you import a batch of certificates

Before you import a batch of certificates


Before you begin the batch certificate import process, ensure that:
 Taxpayers and customers that are in the batch data are set up in Vertex Central.
 The certificates to be imported are within the Start date and End date ranges of
the associated taxpayers and customers.
 You know the partition to which the data will be imported and have the
appropriate security access. The level of partition data access depends on the
security role of the user ID being used to perform the import. See the Security
section of the Vertex Central Help for more information about user roles.

Batch certificate import: File names and locations


If you import certificate images, use unique file names in the batch certificate data
to refer to the certificate images. Specifically, provide the unique file names of your
certificates' images in BATCH_CERTIFICATE records, field 18, imageName.
When you place the batch certificate data import file in the data/import folder, the
image files can be in one of the following formats and locations:
 A ZIP file in the data/import folder with the same name as the batch certificate
data import file
For example, if the batch certificate data import file is named
certificate_import.txt, then the associated ZIP file that contains the
certificate images is named certificate_import.zip.
If you use subfolders in the ZIP file, each subfolder name must be in a
BATCH_CERTIFICATE row, field 18, imageName.
 An image file in the data/import/images subfolder
For example, if the batch certificate data import file is located in the
data/import folder, then the associated images are located in the
data/import/images subfolder.
If you use subfolders below data/import/images, each subfolder name must be
in a BATCH_CERTIFICATE row, field 18, imageName.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate Import  Batch certificate import: File layouts

Batch certificate import: File layouts


Certificate data to be imported must be in one flat file with two types of rows:
BATCH_CERTIFICATE rows and BATCH_CERTIFICATE_JURISDICTION rows. All
BATCH_CERTIFICATE_JURISDICTION rows must be grouped together and must
precede all BATCH_CERTIFICATE rows in the file. These rows are linked by the
temporaryCertificateKey, which must be unique for each BATCH_CERTIFICATE row.
Each certificate record is in one row, with the columns separated by tilde (~),
comma (,), semicolon (;), forward slash (/), asterisk (*), pipe (|), or carat (^). Vertex
recommends the tilde (~) since it is the default in O Series.
Field information for these file layouts is provided in the following sections:
 Batch Certificate fields (see page 119)
 Batch Certificate Jurisdiction fields (see page 116)

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate Import  Batch certificate import: Header fields

Batch certificate import: Header fields


The following table describes the batch certificate import header fields for a flat
delimited import file.

Field Field Type Max. Size Req. Description


Count

1 Record Indicator STRING Size is identical Yes Value must be VERSION.


to text in
description field.
2 Internal Build Version STRING 60 No A build version number that is
internal to Vertex. Version number
format is Major.Minor.Interim.
This field applies only to files
exported from O Series.
3 TPS Data Release STRING 60 No The data release number for the O
Series data.
This field applies only to files
exported from O Series.
4 TaxGIS Data Release STRING 60 No The data release number for the
TaxGIS data.
This field applies only to files
exported from O Series.
5 Util Data Release STRING 60 No The data release number for the Util
data.
This field applies only to files
exported from O Series.
6 File Creation Date NUMERIC 8 No The system date on which the file was
created. Date format is YYYYMMDD.

Note: For any non-O Series database, the batch certificate import header omits
fields 2, 3, 4, and 5. If the batch to be imported was originally exported from
O Series, fields 2, 3, 4, and 5 should be included in the header.
Valid field delimiters in the batch certificate import header are tilde (~), comma (,),
semicolon (;), forward slash (/), asterisk (*), pipe (|), and carat (^). Vertex
recommends the tilde (~), since it is the default in O Series.
Examples of a batch certificate import header row
 For a batch of certificates that did not originate in O Series
If the delimiter is tilde, and the file creation date is January 29, 2011, the header
row is:

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate Import  Batch certificate import: Header fields

VERSION~~~~~20110129

The four additional tilde (~) file delimiters represent fields 2, 3, 4, and 5, which
do not apply to non-O Series batches.
 For a batch of certificates that was originally exported from O Series
If the batch has the following characteristics:
Characteristic Value
Field delimiter Tilde (~)
File creation date January 29, 2011
Internal build version 6.0.01
TPS data release 83.0
TaxGIS data release 83.0
Util data release 83.0

The header row is:


VERSION~6.0.01~83.0~83.0~83.0~20110129

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate  Batch Certificate

Batch Certificate fields


The following table describes BATCH_CERTIFICATE fields for a flat tilde-delimited
import file.
Field Field Natural Type Max. Size Req. Description
Count Key

1 Record Indicator No STRING Size is Yes Value must be BATCH_


identical to CERTIFICATE for every record.
text in
description
field.
2 taxpayer Yes STRING 80 Yes The user-defined taxpayer company
CompanyCode code. This code must match the
company code that is already set up
for the taxpayer in O Series.
The taxpayerCompanyCode is
required if a non-NULL
taxpayerDivisionCode is supplied in
field 3.
3 taxpayer Yes STRING 80 No The user-defined taxpayer division
DivisionCode code. This code must match the
division code that is already set up
for the taxpayer in O Series.
Defaults to NULL if not supplied.
The taxpayerDivisionCode is
required if a non-NULL
taxpayerDepartmentCode is supplied
in field 4.
4 taxpayer Yes STRING 80 No The user-defined taxpayer
DepartmentCode department code. This code must
match the department code that is
already set up for the taxpayer in O
Series.
Defaults to NULL if not supplied.
The taxpayerCompanyCode (field 2)
and taxpayerDivisionCode (field 3)
are required if a non-NULL
taxpayerDepartmentCode is
supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

5 customerCode Yes STRING 80 No The user-defined customer code for


the customer associated with the
certificate. This code must match the
customer code that is already set up
in O Series.
This is relevant for certificates set up
in the Supplies perspective only.
6 sourceName Yes STRING 128 Yes The system partition name. It must
match the name of the partition to
which you want to import
certificates.
7 certificateClassType No STRING 60 Yes The certificate class type.
Valid values are:
 Exemption Certificate
 Direct Pay Permit
8 hardCopyLocationName No STRING 255 No The location of the hard copy of the
certificate.
If a location is supplied in this field,
the Hard Copy Received check box in
Vertex Central is selected.
If a location is not supplied in this
field, the Hard Copy Received check
box in Vertex Central is not selected.
9 industryTypeName No STRING 60 No The user-defined industry type.
10 invoiceNumber No STRING 20 No The invoice number to which the
single-use certificate applies.
If invoiceNumber is supplied, then
Certificate Scope in Vertex Central is
Single Use.
If invoiceNumber is NULL, then
Certificate Scope in Vertex Central is
Blanket.
Note: Batch Certificate Import
does not support certificates
with a Certificate Scope of
Limited. You must manually
enter certificates that are
taxability driver-specific
(limited).

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

11 startDate Yes LONG 8 Yes The certificate start effective date.


This date is used to look up
Customers and Forms, so it cannot
be outside the date range of the
Customer or Form associated with
this certificate.
Date format is YYYYMMDD.
12 endDate No LONG 8 No Date format is YYYYMMDD.
Defaults to 99991231 if not supplied.
13 note No STRING 1000 No A free-form note added to the
certificate record. This text displays
in the Note field in Certificates > Add
Certificate > General tab in My
Enterprise.
Defaults to NULL if not supplied.
14 formUserDefined No LONG 1 No A flag that indicates if a form is
supplied by the user or by Vertex.
Valid values are:
1 = form is user-defined
0 = form is Vertex-supplied
If supplied, the formIdCode in field
15 is required.
15 formIdCode No STRING 30 No The unique code of the associated
form. If formUserDefined in field 14
is not NULL, this code is required.
This code must exactly match the
form code of a user-defined or
Vertex-supplied form.
16 contactRoleType No STRING 60 No The name of the role type of the
associated contact.
For a list of valid values for this field,
refer to Enumerated Types and
Values (see page 212).
If supplied, then contactDeptCode in
field 17 is required.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate  Batch Certificate

Field Field Natural Type Max. Size Req. Description


Count Key

17 contactDeptCode No STRING 20 No The department code of the


associated contact.
If supplied, then contactRoleType in
field 16 is required.
Note: Contact information must
already be set up in
Taxpayer and Customer
records in Vertex Central.
18 imageName No STRING 255 No The name of the file inside the
image's ZIP file or subdirectory.
The name that you enter here must
match the actual file name exactly
(including case-sensitivity).
If there are multiple images per
certificate, the images must be
chained to be a multi-page image,
resulting in one image file. For more
information about multiple images,
refer to File names and locations
(see page 219).
19 temporary No STRING 128 Yes A temporary, unique key that
CertificateKey associates this certificate with its
related BATCH_CERTIFICATE_
JURISDICTION row or rows.
20 custClassInd No LONG 1 No Indicates whether this is a customer
or a customer class.
1 = is class, 0 = not a class.
Defaults to 0 if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate  Batch Certificate Jurisdiction

Batch Certificate Jurisdiction fields


Each BATCH_CERTIFICATE row must be associated with one or more
BATCH_CERTIFICATE_JURISDICTION rows. All BATCH_CERTIFICATE_ JURISDICTION
rows must be grouped together and must precede all BATCH_CERTIFICATE rows in
the file. These rows are linked by the temporaryCertificateKey, which must be
unique for each BATCH_CERTIFICATE row.
The following table describes BATCH_CERTIFICATE_JURISDICTION fields for a flat
tilde-delimited import file:
Field Field Natural Type Max. Size Req. Description
Count Key
1 Record Indicator No STRING Size is Yes Value must be BATCH_
identical to CERTIFICATE_JURISDICTION for
text in every record.
description
field.
2 temporary No STRING 128 Yes A temporary key that associates a
CertificateKey BATCH_CERTIFICATE_JURISDICTION
row or rows with the related
BATCH_CERTIFICATE row.
This value must match the value in
temporaryCertificateKey in field 19
in a BATCH_CERTIFICATE row.
3 sourceName No STRING 128 Yes The system partition name. It must
match the name of the partition to
which you want to import
certificates.
4 countryName No STRING 80 No The country of the jurisdiction. If not
supplied, defaults to United States.
5 stateName No STRING 80 No The state of the jurisdiction. Must be
the full state name. Abbreviations
are not valid.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate  Batch Certificate Jurisdiction

Field Field Natural Type Max. Size Req. Description


Count Key
6 countyName No STRING 80 No The county of the jurisdiction.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.
7 cityName No STRING 80 No The city of the jurisdiction.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.
8 districtName No STRING 80 No The district of the jurisdiction.
This jurisdiction name must match
the jurisdiction name in
Vertex-supplied data. See
"Guidelines for jurisdiction names
(see page 229)" for more
information.
9 certificateNumber No STRING 30 No A user-defined or
jurisdiction-supplied identifier for
this certificate.
Defaults to NULL if not supplied.
10 certReasonCodeName No STRING 60 No Must match a Vertex-supplied
certificate reason code name that is
valid for the certificate's jurisdiction.
Valid values for this field are
jurisdiction-dependent and may be
found in the Reason Type drop-down
in Vertex Central (In the Certificates
add or edit function, navigate to the
Jurisdiction tab and select the
appropriate jurisdiction. In the
Details subtab, view the Reason Type
drop-down.)
11 issueDate No LONG 8 No Date format is YYYYMMDD.
Defaults to NULL if not supplied.
12 expirationDate No LONG 8 No Date format is YYYYMMDD.
Defaults to NULL if not supplied.

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Appendix A. Batch Certificate  Batch Certificate Jurisdiction

Field Field Natural Type Max. Size Req. Description


Count Key
13 reviewDate No LONG 8 No Date format is YYYYMMDD.
Defaults to NULL if not supplied.

Guidelines for jurisdiction names


The jurisdiction names in the batch of certificates must match the corresponding
jurisdiction names used in Vertex data, including the following:
 Letter case (The jurisdiction names in the Vertex system are stored in all
uppercase letters.)
 Spaces
 Hyphens
 Punctuation
The following examples illustrate invalid matches:
Valid Invalid
NEW JERSEY NewJersey
new jersey
SAINT JAMES AMBULANCE DISTRICT St. James Ambulance District
ST. JOSEPH GATEWAY TRANSPORTATION Saint Joseph Gateway Transportation
DEVELOPMENT DISTRICT Development District

Note: To get an up-to-date list of jurisdiction names, run a Data Extract report in O
Series, using either the Jurisdictions template or the Tax Area template. For
information on using Data Extract, see the Data Extract section of the Vertex
Central Help.

June  Page
Index F
FLAT_TAX_TAX_STRUCTURE 151
Flexible Field Definition formats 57
B
FORM 98
Batch Certificate formats 218 Form formats 96
Batch Certificate fields 119 Form fields 98
Batch Certificate Jurisdiction fields 116 Form Jurisdiction fields 97
BUSINESS_LOCATION_CUSTOMER 69 FORM_JURISDICTION 97
BUSINESS_LOCATION_TAXPAYER 43
BUSINESS_LOCATION_VENDOR 82 L
Letter formats 123
C
Letter Batch Customer fields 126
CERT_IMPOSITION_JURISDICTION 104 Letter Batch fields 129
CERTIFICATE 112 Letter Batch Jurisdiction fields 128
Certificate formats 99 Letter Batch Taxpayer fields 124
Certificate Coverage fields 107 Letter Template fields 123
Certificate fields 112 LETTER_BATCH 129
Certificate Image fields 111 LETTER_BATCH_CUSTOMER 126
Certificate Imposition fields 105 LETTER_BATCH_JURISDICTION 128
Certificate Imposition Jurisdiction fields 104 LETTER_BATCH_TAXPAYER 124
Certificate Jurisdiction fields 106 LETTER_TEMPLATE 123
Certificate Taxability Driver fields 100
Certificate Transaction Type fields 103 M
CERTIFICATE_COVERAGE 107 MAPPING_RULE 188
CERTIFICATE_IMAGE 111 MAPPING_RULE_CONDITIONAL_ JURISDICTION
CERTIFICATE_IMPOSITION 105 187
CERTIFICATE_JURISDICTION 106 MAPPING_RULE_QUALIFYING_CONDITION 182
CERTIFICATE_TAXABILITY_DRIVER 100 MAPPING_RULE_TAXIMP 181
CERTIFICATE_TRANSACTION_TYPE 103 MAPPING_RULE_TAXTYPE 180
CHILD_QUANTITY_TAX_STRUCTURE 143 MAPPING_RULE_TRANSTYPE 179
CHILD_SINGLE_RATE_TAX_STRUCTURE 141 MAPPING_TAXABILITY_CATEGORY_ MAPPING 196
CHILD_TIER 145 MAPPING_TAXABILITY_CATEGORY_
CHILD_TIERED_TAX_STRUCTURE 149 MAPPING_DRIVERS 194
CUSTOMER 67 MAX_TAX_RULE 165
Customer formats 63
Customer Business Location fields 69 Q
Customer Contact fields 65 QUANTITY_TAX_STRUCTURE 144
Customer fields 67
Customer Reason Code fields 64 S
Customer Tax Registration fields 74 SINGLE_RATE_TAX_STRUCTURE 142
Customer Tax Registration Imposition fields 72 Situs Treatment Rule formats 199
Customer Tax Registration Imposition Jurisdiction Situs Treatment Rule fields 200
fields 71 Situs Treatment Rule Transaction Event fields
Customer Tax Registration Jurisdiction fields 73 199
CUSTOMER_CONTACT 65 SITUS_TREATMENT_RULE 200
CUSTOMER_REASON_CODE 64 SITUS_TREATMENT_RULE_TRANSACTION_ EVENT
199

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Handbook

T
TAX_REGISTRATION_JURISDICTION_ CUSTOMER
Tax Assist formats 202 73
Tax Assist Allocation Column fields 207 TAX_REGISTRATION_JURISDICTION_ TAXPAYER 47
Tax Assist Allocation Column Value fields 208 TAX_REGISTRATION_JURISDICTION_ VENDOR 86
Tax Assist Allocation Table fields 206 TAX_REGISTRATION_TAXPAYER 48
Tax Assist Lookup Record fields 205 TAX_REGISTRATION_VENDOR 87
Tax Assist Lookup Table fields 203 TAX_RULE_CONDITIONAL_JURISDICTION 140
Tax Assist Rule fields 210 TAX_RULE_CONDITIONAL_TAX_EXPRESSION 157
Tax Rule formats 131 TAX_RULE_CONDITIONAL_TAX_EXPRESSION_TAX_FA
Child Quantity Tax Structure fields 143 CTOR 152
Child Single Rate Tax Structure fields 141 TAX_RULE_QUALIFYING_CONDITION 135
Child Tier fields 145 TAX_RULE_TAX_BASIS_CONCLUSION_TAX_ FACTOR
Child Tiered Tax Structure fields 149 154
Flat Tax Structure fields 151 TAX_RULE_TAX_IMPOSITION 134
Max Tax Rule fields 165 TAX_RULE_TAX_TYPE 133
Quantity Tax Structure fields 144 TAX_RULE_TRANSACTION_TYPE 132
Single Rate Tax Structure fields 142 Taxability Category format 55
Tax Basis Rule fields 169 Taxability Category Mapping formats 91
Tax Basis Rule Tax Basis Conclusion fields 158 Taxability Category Mapping Drivers fields 92
Tax Imposition fields 34 Taxability Category Mapping fields 94
Tax Imposition Inclusion fields 33 Taxability Driver format 60
Tax Rule Conditional Jurisdiction fields 140 Taxability Mapping formats 178
Tax Rule Conditional Tax Expression fields 157 Taxability Mapping Category Mapping Drivers
Tax Rule Conditional Tax Expression Tax Factor fields 194
fields 152 Taxability Mapping Category Mapping fields
Tax Rule Qualifying Condition fields 135 196
Tax Rule Tax Basis Conclusion Tax Factor fields Taxability Mapping fields 198
154 Taxability Mapping Rule Conditional Jurisdiction
Tax Rule Tax Imposition fields 134 fields 187
Tax Rule Tax Type fields 133 Taxability Mapping Rule fields 188
Tax Rule Transaction Type fields 132 Taxability Mapping Rule Qualifying Conditions
Taxability Rule fields 159 fields 182
Tier fields 147 Taxability Mapping Rule Tax Imposition fields
Tiered Tax Structure fields 150 181
TAX_BASIS_RULE 169 Taxability Mapping Rule Tax Type fields 180
TAX_BASIS_RULE_TAX_BASIS_CONCLUSION 158 Taxability Mapping Rule Transaction Type fields
TAX_IMPOSITION 34 179
TAX_IMPOSITION_INCLUSION 33 TAXABILITY_CATEGORY_MAPPING 94
TAX_REGISTRATION_CUSTOMER 74 TAXABILITY_CATEGORY_MAPPING_ DRIVERS 92
TAX_REGISTRATION_IMPOSITION_ CUSTOMER 72 TAXABILITY_MAPPING 198
TAX_REGISTRATION_IMPOSITION_ TAXABILITY_RULE 159
JURISDICTION_CUSTOMER 71 TAXASSIST_ALLOCATION_COLUMN 207
TAX_REGISTRATION_IMPOSITION_ TAXASSIST_ALLOCATION_COLUMN_VALUE 208
JURISDICTION_TAXPAYER 45 TAXASSIST_ALLOCATION_TABLE 206
TAX_REGISTRATION_IMPOSITION_ TAXASSIST_LOOKUP_RECORD 205
JURISDICTION_VENDOR 84 TAXASSIST_LOOKUP_TABLE 203
TAX_REGISTRATION_IMPOSITION_ TAXPAYER 46 TAXASSIST_RULE 210
TAX_REGISTRATION_IMPOSITION_VENDOR 85 TAXPAYER 40
Taxpayer formats 36

June  Page
Vertex® Indirect Tax O Series® 7.0 Tax Data File Formats
Handbook

Taxpayer Business Location fields 43


Taxpayer Contact fields 39
Taxpayer Currency Rounding Rule fields 52
Taxpayer Discount Type fields 51
Taxpayer fields 40
Taxpayer Reason Code fields 37
Taxpayer Recoverable Percentage for VAT fields
54
Taxpayer Tax Registration fields 48
Taxpayer Tax Registration Imposition fields 46
Taxpayer Tax Registration Imposition Jurisdiction
fields 45
Taxpayer Tax Registration Jurisdiction fields 47
TAXPAYER_CONTACT 39
TAXPAYER_CURRENCY_ROUNDING_RULE 52
TAXPAYER_DISCOUNT_TYPE 51
TAXPAYER_REASON_CODE 37
TAXPAYER_VAT_RECOVERABLE_PERCENTAGE 54
TIER 147
TIERED_TAX_STRUCTURE 150
V
VENDOR 79
Vendor formats 77
Vendor Business Location fields 82
Vendor fields 79
Vendor Reason Code fields 78
Vendor Recoverable Percentage for VAT fields
90
Vendor Tax Registration fields 87
Vendor Tax Registration Imposition fields 85
Vendor Tax Registration Imposition Jurisdiction
fields 84
Vendor Tax Registration Jurisdiction fields 86
VENDOR_REASON_CODE 78
VENDOR_VAT_RECOVERABLE_PERCENTAGE 90
Version format 31

June  Page

You might also like