Reporting Columns
The table below describes the reporting columns for the Customer Portal Reporting portals. Customer Portal Explorer is the main source of client reporting. Additional report descriptions and reporting columns are available in TM_00561_AFC Comprehensive Guide to Reports and Data Files for all AvaTax for Communications products:
- Avalara AvaTax for Communications SaaS Pro (REST)
- Avalara AvaTax for Communications SaaS Pro (SOAP)
- Avalara AvaTax for Communications SaaS Standard
- Avalara AvaTax for Communications License
For more information about the reports, see Report Descriptions.
| Explorer | |||||
|---|---|---|---|---|---|
| Column Name | Description | Source | Transaction Detail | Compliance | Transaction Service Report |
| Account Ref | Optional account reference | Input in the transaction | X (Default) | X | |
| Adjustment Method | Adjustment setting. Always set to 0. The use of this field has been deprecated 0 Default: Tax brackets applied normally 1 Least Favorable Rate: Tax brackets applied to product the smallest tax refund 2 Most Favorable Rate: Tax brackets applied to produce the largest tax refund |
Input in the transaction | X | X | |
| Adjustments | The total adjustments or "credits." An adjustment produces a negative tax amount. | Input in the transaction | X (Default) | X (Default) | |
| Alloc Bundle Charge | For bundled transactions, when the charge is greater than 0, this is the absolute value charge for the specific portion of the bundle | Output from tax calculation | X | X | |
| Bill Cycle Ref | Optional bill cycle reference | input in the transaction | X (Default) | X | |
| Bill To Country | Bill-to country for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To County | Bill-to county for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To FIPS Code | Bill-to Fips code for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To City | Bill-to locality for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To NPANXX | Bill-to NpaNxx for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To PCode | Bill-to PCode for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To State/Province | Bill-to state for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To Zip Code | Bill-to ZIP code for the taxing jurisdiction. | Input in the transaction | X | X | |
| Bill To Zip P4 | Bill-to ZIP code plus 4 for the taxing jurisdiction. | Input in the transaction | X | X | |
| Billable | Billable flag for tax. Indicates if the tax is billable to your customer true: Standard billable tax false: Non-billable tax that cannot be billed to the customer |
Output from tax calculation | X (Default) | X | |
| Billing Period Month | Billing Period Month during which the transaction applies | Input in the transaction | X | X | |
| Billing Period Year | Billing Period Year during which the transaction applies | Input in the transaction | X | X | |
| Bundle ID | Bundle Service Type Value | Input in the transaction | X | X | X |
| Bundle Package | Bundle Transaction Type Value | Input in the transaction | X | X | X |
| Business Class | Specification of business as CLEC or ILEC 0: Incumbent Local Exchange Carrier (ILEC) 1: Not an ILEC |
Input in the transaction | X | X | |
| Calculation Type | Calculation type for tax. Indicates how the tax is calculated 1 Rate: Taxable Measure is multiplied by Rate 2 Fixed: Fixed taxes represent a fixed tax that applies to the product being taxed 3 PerMinute: Number of Minutes is multiplied by Rate 4 PerLine: Number of Lines is multiplied by Rate 5 SelfTaxingRate: Taxable Measure is multiplied by Self-Taxing Rate 6 PerBracket: Number of Lines is multiplied by Rate based on tax bracket for line count 7 FixedOnTier: Sale Amount is multiplied by Rate based on tax tier for sale amount |
Output from tax calculation | X (Default) | X | |
| Calc Type Description | Description for CalcType field Indicates how the tax is calculated 1 Rate: Taxable Measure is multiplied by Rate 2 Fixed: Fixed taxes represent a fixed tax that applies to the product being taxed 3 PerMinute: Number of Minutes is multiplied by Rate 4 PerLine: Number of Lines is multiplied by Rate 5 SelfTaxingRate: Taxable Measure is multiplied by Self-Taxing Rate 6 PerBracket: Number of Lines is multiplied by Rate based on tax bracket for line count 7 FixedOnTier: Sale Amount is multiplied by Rate based on tax tier for sale amount |
Output from tax calculation | X | X | |
| Category Description | Category description for tax. | Output from tax calculation | X | X | |
| Category ID | Category ID for tax. | Output from tax calculation | X | X | |
| Charge | Initial amount to be taxed. | Input in the transaction | X (Default) | X | X (Default) |
| Calc Charge | Aggregated amount that was taxed | Output from tax calculation | |||
| Charge Type | Type of charge Non-Compliance (Compliance = 0) Billable (Billable = 1) Non-Billable (Billable = 0) |
Output from tax calculation | X | X (Default) | |
| City | Locality name for the reporting jurisdiction (where you remit the tax). | Output from tax calculation | X (Default) | X (Default) | |
| Taxing Jurisdiction Locality | Locality for the taxing jurisdiction (where the charge occurred). | Output from tax calculation | X | X | X |
| Committed Date | Date when the Document Code relating to a transaction was committed | Input in the transaction | X (Default) | X | |
| Company Identifier | An optional company identifier used in reporting. Represents your company or, if you are a third-party billing provider, could represent one of your clients | Input in the transaction | X | X | |
| Company Name | Name of the client | Input in the transaction | X | X | |
| Compliance | Compliance flag from tax record. Indicates if the tax is to be reported to the jurisdiction true: Standard compliance tax false: Non-compliance tax that should not be reported to the jurisdiction |
Output from tax calculation | X (Default) | X | |
| Country | Three-character country ISO for the reporting jurisdiction (where you remit the tax). | Output from tax calculation | X (Default) | X (Default) | |
| Taxing Jurisdiction Country | Three-character country ISO for the taxing jurisdiction (where the charge occurred). | Output from tax calculation | X | X | X (Default) |
| County | County name for the reporting jurisdiction (where you remit the tax). | Output from tax calculation | X (Default) | X (Default) | |
| Taxing Jurisdiction County | County name for the taxing jurisdiction (where the charge occurred). | Output from tax calculation | X | X | X |
| County Exempt | Indicates if the county level taxes are exempt | Input in the transaction | X | X | |
| Currency Code | Currency Code identifier for the transaction | Input in the transaction | X | X | |
| Customer Number | Optional customer account number | Input in the transaction | X | X | |
| Customer Ref | Optional customer reference | Input in the transaction | X (Default) | X | |
| Customer Type | Defines the type of customer. 0: Residential 1: Business 2: Senior Citizen 3: Industrial |
Input in the transaction | X (Default) | X | |
| Debit | Indicates if the transaction is prepaid true: the transaction is prepaid false: the transaction is not prepaid |
Input in the transaction | X (Default) | X | |
| Discount Type | Discount Type for adjustments 0 None 1 Retail Product: An amount subtracted from the original price to arrive at a lower price 2 Manufacturer Product: A discount of the total amount reimbursed to either the retailer or the customer by the manufacturer 3 Account Level: A stand-alone discount that is not applied against any service but instead as a stand-alone product 4 Subsidized: A discount caused exclusively in telephone service where the telephone provider provides a service to a lifeline eligible customer. The discount will be on the local exchange service 5 Goodwill: The total discount of a service that is recorded for accounting purposes but never billed to a customer |
Input in the transaction | X (Default) | X | |
| Discount Type Description | Description of the discount type for adjustments. | Input in the transaction | X | X | |
| Document Code | Identifier for a transaction or group of transactions for commit processing | Input in the transaction | X (Default) | X | |
| Exempt Sale Amount | Exempt sale amount from tax record. | Output from tax calculation | X (Default) | X | |
| Exemption Type | Specifies the exemption type for reporting purposes. 0 None (Default): Exemption Type not applicable. 1 Fed Sales Supremacy: Sales to the Federal government exempt based on supremacy. 2 State Local Gov Sales: Sales to the State or Local government in the state that you operate in. 3 Sales for Resale: Sales that are designated for resale. 4 Fed Coupons WIC Vouchers: Sales at retail for which Federal government coupons or vouchers under the supplemental feeding for women, infants and children program are used as payment. 5 Reduced Food Rate: Tax imposed on food that is taxed at a reduced rate. 6 Non Profit Sales: Sales made by or to not-for-profit civic, social, service or fraternal organizations. 7 Public School Sales: Sales made by or to all elementary and secondary schools operated at public expense in their educational functions and activities. 8 Religious Charitable Sales: Sales made by or to religious and charitable organizations and institutions in their religious, charitable or educational functions and activities. 9 Prescription Drug Sales: Drugs which may be legally dispensed by a licensed pharmacist only upon a lawful prescription of a practitioner licensed to administer those items. 10 Prostho Ortho Devices: Prosthetic or orthopedic devices as defined on January 1, 1980, by the Federal Medicare program pursuant to Title XVIII of the Social Security Act of 1965. 11 Insulin Sales: All sales of insulin. 12 Interstate Foreign Sales: Sales in commerce between various states or between any foreign country (Export Sales). 13 Ingredient Component Parts: Sale of ingredient or component parts. |
Input in the transaction | X (Default) | X | |
| Exemption Type Description | Description of the exemption type for reporting purposes. | Input in the transaction | X | X | |
| Facilities Based | Specifies if the carrier delivering the service has company-owned facilities to provide the service true: Seller is facilities-based (cable operators and telephone companies) false: Seller is not facilities-based (Internet-based providers) |
Input in the transaction | X | X | |
| Federal Exempt | Indicates if the federal-level taxes are exempt | Input in the transaction | X | X | |
| Franchise | Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction true: Seller has a franchise agreement false: Franchise taxes do not apply to the seller |
Input in the transaction | X | X | |
| General Ledger Ref | Optional general ledger reference | Input in the transaction | X (Default) | X | |
| Gross Sales | Taxable Measure - Adjustments + Exempt Sale Amount | Output from tax calculation | X | X (Default) | |
| Incorporated | Indicates if the location is within city limits true: Address is within city limits false: Address is outside of city limits (unincorporated) |
Input in the transaction | X | X | |
| Initial Commit Status | Field indicating the initial commit status of the transaction | Output from tax calculation | X | X | |
| Invoice Number | Optional invoice number (RESTv1 only) | Input in the transaction | X | X | |
| Invoice Ref | Optional invoice number reference (RESTv2 only) | Input in the transaction | X (Default) | X | |
| Invoice Date | The date passed in the transaction specifying when the transaction took place (often set to the Invoice Date) | Input in the transaction | X (Default) | X | |
| Is Adjustment | Flag indicating whether bundle is an adjustment or tax calculation true: Transaction is an adjustment false: Transaction is not an adjustment |
Output from tax calculation | X | X | |
| Is Committed | Flag indicating if the transaction has been committed true: The document code on the transaction has been committed false: The document code on the transaction hasn't been committed |
Output from tax calculation | X | X | |
| Is No Tax Transaction | Flag indicating that the transaction processed successfully but returned no taxes true: No taxes returned for the transaction false: Taxes are available for the transaction |
Output from tax calculation | X | X | |
| Lifeline | Identifier as a Lifeline participant true: The customer is a Lifeline participant false: The customer is not a Lifeline participant Lifeline is a federal program that subsidizes the cost of phone and internet for eligible customers |
Input in the transaction | X | X | |
| Line Item Ref | Optional Line Item reference | Input in the transaction | X | X | |
| Local Exempt | Indicates if the local level taxes are exempt | Input in the transaction | X | X | |
| Net Taxable Measure | Taxable Measure - (Adjustments * 2) | Output from tax calculation | X | X | |
| Optional | Optional integer field (RESTv1 only) | Input in the transaction | X | X | |
| Optional 10 | Indicates the billing cycle in YYYYMM format (RESTv1 only) | Input in the transaction | X | X | |
| Optional 4 | Optional integer field (RESTv1 only) | Input in the transaction | X | X | |
| Optional 5 | Optional integer field (RESTv1 only) | Input in the transaction | X | X | |
| Optional 6 | Optional integer field (RESTv1 only) | Input in the transaction | X | X | |
| Optional 7 | Optional integer field (RESTv1 only) | Input in the transaction | X | X | |
| Optional 8 | Optional integer field (RESTv1 only) | Input in the transaction | X | X | |
| Optional 9 | Optional integer field (RESTv1 only) | Input in the transaction | X | X | |
| Optional Alpha 1 | Optional alpha-numeric field (RESTv1 only) | Input in the transaction | X | X | |
| Optional Field 1 | Additional Extended Optional fields in which column headers are defined by the user upon creation of each one (RESTv2 only). | Input in the transaction | X | X | |
| Optional Field 10 | Input in the transaction | X | X | ||
| Optional Field 2 | Input in the transaction | X | X | ||
| Optional Field 3 | Input in the transaction | X | X | ||
| Optional Field 4 | Input in the transaction | X | X | ||
| Optional Field 5 | Input in the transaction | X | X | ||
| Optional Field 6 | Input in the transaction | X | X | ||
| Optional Field 7 | Input in the transaction | X | X | ||
| Optional Field 8 | Input in the transaction | X | X | ||
| Optional Field 9 | Input in the transaction | X | X | ||
| Origination Country | Originating country for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination County | Originating county for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination FIPS Code | Originating FIPS code for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination City | Originating locality for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination NPANXX | Originating NpaNxx for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination PCode | Originating PCode for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination State/Province | Originating state for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination Zip Code | Originating ZIP code for the taxing jurisdiction. | Input in the transaction | X | X | |
| Origination Zip P4 | Originating ZIP code plus 4 for the taxing jurisdiction. | Input in the transaction | X | X | |
| PCode | PCode for the reporting jurisdiction (where you remit the tax). | Output from tax calculation | X | X | |
| Taxing Jurisdiction Pcode | PCode for the taxing jurisdiction (where the charge occurred). | Output from tax calculation | X | X | |
| Quantity | Quantity applied to the line item - taxation is equivalent to repeating the item the number of times of the quantity | Input in the transaction | X | X | |
| Rate | Rate for tax | Output from tax calculation | X (Default) | X (Default) | |
| Regulated | true: Seller is regulated false: Seller is not regulated |
Input in the transaction | X | X | |
| Sale | Indicates the type of transaction, such as retail or wholesale 0 Wholesale 1 Retail 2 Consumed (Sales and Use Only) 3 Vendor Use (Sales and Use Only) |
Input in the transaction | X (Default) | X | |
| Service Class | Specification of service class 0: Primary Local 1: Primary Long Distance |
Input in the transaction | X (Default) | X | |
| Service Type | Service Type used in the input transaction. If bundles are used, this column shows the specific Service Type used for the portion of the bundle | Input in the transaction | X | X | |
| Service Level Number | Optional service level number | Input in the transaction | X | X | |
| Input Service Type | Service Type used in the input transaction. If a bundle is used, this column shows the bundle package passed in the transaction | Input in the transaction | X (Default) | X | X (Default) |
| Source System | Version of the web service in which the data was entered | Output from tax calculation | X | X | |
| State/Province | State or province abbreviation for the reporting jurisdiction (where you remit the tax). | Output from tax calculation | X (Default) | X (Default) | |
| Taxing Jurisdiction State | State or province abbreviation for the taxing jurisdiction (where the charge occurred). | Output from tax calculation | X | X | X (Default) |
| State Exempt | Indicates if the state-level taxes are exempt | Input in the transaction | X | X | |
| Server Date | Server date when the transaction was processed. | Output from tax calculation | X (Default) | X | |
| Surcharge | Indicates if this tax is a surcharge true: Surcharge rules apply to this tax false: Tax is not a surcharge |
Output from tax calculation | X | X | |
| Tax Amount | Tax amount. For rate-based taxes, Tax Amount = Taxable Measure * Rate | Output from tax calculation | X (Default) | X (Default) | |
| Tax Data ID | Unique identifier for the tax data item. | Output from tax calculation | X | X | |
| Lines | Number of lines used for calculating the tax in per-line taxes. | Input in the transaction | X | X | |
| Locations | Number of locations. | Input in the transaction | X | X | |
| Minutes | Number of minutes used for calculating the tax in per-minute taxes. | Input in the transaction | X | X | |
| Tax Level | Tax level identifier. Indicates the jurisdiction level of the tax 0: Federal 1: State 2: County 3: City 4: Unincorporated |
Output from tax calculation | X | X (Default) | |
| Tax Level Description | Tax level description. Indicates the jurisdiction level of the tax 0: Federal 1: State 2: County 3: City 4: Unincorporated |
Output from tax calculation | X (Default) | X | |
| Tax Log ID | Unique identifier for the transaction. | Output from tax calculation | X | X | |
| Tax Type | Tax type identifier. | Output from tax calculation | X | X (Default) | |
| Tax Type Description | Tax Type description | Output from tax calculation | X (Default) | X | |
| Taxable Measure | The basis for calculation of rate-based taxes. Simple transactions result in a taxable measure equal to the sale price. However, tax-on-tax, caps, thresholds, tiers, and taxable amount modifiers can all result in taxable measures that are greater than or less than the sale price. For rate-based taxes, Tax Amount = Taxable Measure * Rate. Taxable measure is adjusted by any factor that changes the tax calculation. Examples: Taxable measure exceeds the sale amount: Tax-on-tax occurs - the tax amount calculated includes tax amount from other taxes. The additional taxes to be included are added to the taxable measure Taxable measure is less than the sale price: A discount is applied - safe harbor exemptions or internet tax in Texas where the first $25 is exempt from taxation |
Output from tax calculation | |||
| Telecom Transaction ID | Unique identifier for a telecom line item. | Output from tax calculation | X | X | |
| Termination Country | Termination country for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination County | Termination county for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination FIPS Code | Termination FIPS code for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination City | Termination locality for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination NPANXX | Termination NpaNxx for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination PCode | Termination PCode for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination State/Province | Termination state for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination Zip Code | Termination ZIP code for the taxing jurisdiction. | Input in the transaction | X | X | |
| Termination Zip P4 | Termination ZIP code plus 4 for the taxing jurisdiction. | Input in the transaction | X | X | |
| Transaction Charge | Charge for the specific portion of a Bundle | Output from tax calculation | |||
| Transaction Count | Number of transactions processed during the request | Output from tax calculation | X | X | |
| Input Lines | Number of lines used for calculating the tax in per-line taxes. | Output from tax calculation | X | X (Default) | |
| Input Locations | Number of locations | Output from tax calculation | X | X | |
| Input Minutes | Number of minutes used for calculating the tax in per-minute taxes. | Output from tax calculation | X | X (Default) | |
| Input Transaction Type | Transaction Type used in the input transaction. If bundles are used, this column shows the specific Transaction Type used for the portion of the bundle | Input in the transaction | |||
| Transaction Type | Transaction Type used in the input transaction. If a bundle is used, this column shows the bundle ID passed in the transaction | Input in the transaction | X (Default) | X | X (Default) |
| User Exempt | Flag indicating if the tax has been exempted by the user via Exemptions (exms) |
Output from tax calculation | X (Default) | X | |