Administration & Utilities
Name | Type | Description | Comments |
AvaTax Configuration Window | Required | The AvaTax Configuration Dialog Window must allow the user to specify the configuration/connection information
| |
Test Connection | Required | Test the connection to the AvaTax service and verify the AvaTax credentials. This is an important element to allow for successful troubleshooting of the AvaTax Service. | |
Control - Disable Document Recording | Required | In order for this connector to be used in conjunction with other integrations to AvaTax, the user must be able to control which connector is used for recording documents to AvaTax. From a technical standpoint, simply use | |
Disable AvaTax Option | Required | The user must have an option to turn on or off the AvaTax Calculation service independent of any other Avalara product or service. | |
Enable client side logging | Required | Enables detailed AvaTax transaction logging within the application including capture of round-trip processing time. We need the complete request/response for each call made to Avalara services. It does not need to run all the time as we understand the database will grow unnecessarily large – you are free to only log the last week, 30 days, custom, or have a control for the next N hours, etc. The spirit of the requirement is to assist customers and support in troubleshooting exercises, so it needs to be retrievable by an end user (or an administrator). It should be specifically Avalara service calls. | |
Request time out definition | Suggested | Define a timeout value for AvaTax requests. | |
Display prices with Tax Included | Suggested | Enable the tax inclusive flag in the tax calculation request. | |
Enable AvaTax UPC | Suggested | When set to true: pass in UPC code into the Avalara ItemCode on the line level of the requests to our service. When UPC is unavailable, default to ItemCode. When set to false: use the default ItemCode mapping. See Product Master Management for more details. | Alternately, UPC can be enabled on the item level. |
User Implementation Guide | Required | The User Implementation Guide should contain screenshots and information allowing the end user to configure for AvaTax including where the company code is entered, where the credentials are entered, where customer data is entered, and where tax codes can be mapped within the application. Click Here for a user guide template. | |
Address Validation Implemented | Required | An Address Validation utility is present in the application. |
Customer Record Integration
Name | Type | Description | Comments |
Customer Code | Required | Identify the customerCode value (number, ID) to pass to the AvaTax service. | |
Entity/Use Code | Required | This is a group of codes that indicate the type of exemption. See the standard codes, but be aware that users are able to create custom codes as well. It is best to manage this value in your application’s Customer record and pass it to AvaTax as entityUseCode at either the document or line level, whichever is applicable. | BevAlc customers are most likely to use “G - resale” if they are wholesalers and tax is not collected at the Supplier → WS level. |
Exemption Number | Suggested | Customer record field populating exemption number in an AvaTax transaction. This is used for tracking those customers who have tax exempt transactions. | |
Line Level Exemptions | Suggested | Ability to identify individual items on a transaction as exempt from tax. | |
Line Level Exemption Override | Suggested | Ability to identify individual items on a transaction as Taxable to an otherwise exempt customer. Functionally, you will need to pass the value 'Taxable' in the entityUseCode field at the line level. | |
Ship-To Address Exemption | Suggested | Ability to individually identify customer, ship-to locations as Exempt, separate from the customers default address. |
Transaction Parties Integration
Name | Type | Description | Comments |
Purchaser Name | Required | Represents the first and last name of purchaser associated with the transaction | |
Purchaser DOB | Required | The date of birth (DOB) associated with the "Bill To" recipient. Must be formatted as YYYY-MM-DD | |
Recipient Name | Required | Represents the first and last name of the recipient associated with the transaction | |
Recipient DOB | Required | The date of birth (DOB) associated with the "Ship To" recipient. Must be formatted as YYYY-MM-DD | |
Purchaser Street Address | Suggested | Street address of the purchaser associated with the transaction | Parameter Name: PurchaserStreetAddress |
Purchaser Destination City | Suggested | City of the purchaser associated with the transaction | Parameter Name: PurchaserToCity |
Purchaser Destination State | Suggested | State of the purchaser associated with the transaction | Parameter Name: PurchaserToState |
Purchaser Destination Zip | Suggested | ZIP of the purchaser associated with the transaction | Parameter Name: PurchaserToZip |
Sales/Billing Document Integration
Name | Type | Description | Comments |
Document Code | Required | Values that can come across to AvaTax as the docCode | |
Customer Code | Required | Values that can come across to AvaTax as the docCode | |
Document Date | Required | Value comes across to AvaTax as the docDate | |
Tax Calculation Date | Required | Value that comes across to AvaTax as the taxCalculationDate | |
Document Type | Required | Integrations must send docType values corresponding to the stages of the transaction life cycle | |
Header Level - Destination Address | Required | Value that is sent to AvaTax for Destination Address at the header level. | |
Header Level - Origin Address | Required | Value that is sent to AvaTax for Origin Address at the header level. | |
Header Level - Point of Order Acceptance | Suggested | Value that is sent to AvaTax for PoA at the header level | |
Header Level - Point of Order Origin | Suggested | Value that is sent to AvaTax for PoO at the header level. | |
Header Level - Exemption Override | Suggested | Area at Invoice screen where end user can check box to override existing Tax Exemption for the client. | |
Location Code | Conditional | Value that is sent to AvaTax for locationCode at the header level | If the application supports multiple 'origin' addresses, locationCode must be passed with the transactions. |
Exemption Number | Conditional | Value that is sent to AvaTax for exemptionNo | Required if Entity Use Code exemption functionality is not present |
Line Number | Required | Value that is sent to AvaTax for the line number | |
Item Code | Required | Value that is sent to AvaTax for the itemCode | |
Item Description | Required | Value that is sent to AvaTax for the itemDescription | |
Quantity | Required | Value that is sent to AvaTax for the quantity | |
Amount (extended) | Required | Value that is sent to AvaTax for the amount | |
Tax Code | Required | Value that is sent to AvaTax for the Tax Code | |
Line Level - Destination Address | Conditional | Value that is sent to AvaTax for Destination Address at the line level. | Required if destination (shipTo) address can be managed at the item line level |
Line Level - Origin Address | Conditional | Value that is sent to AvaTax for Origin Address at the line level. | Required if origin (shipFrom) address can be managed at the item line level |
Line Level - Point of Order Acceptance | Conditional | Value that is sent to AvaTax for PoA at the line level | Required if Point of Order Acceptance address can be managed at the item line level |
Line Level - Point of Order Origin | Conditional | Value that is sent to AvaTax for PoO at the line level. | Required if Point of Order Origin address can be managed at the item line level |
Verify Avalara Calculated Tax Amount is used in transaction | Required | Confirm that the integration is taking the Tax Amount value from the tax calculation response and using that to decorate the tax fields in the platform. Do NOT take our rate and use it to calculate the tax within the platform itself | |
Freight items must be transmitted separately | Required | Freight items must be sent to AvaTax as a separate line item with a configurable tax code | |
Tax Calculation - Sales Order/Sales Invoices | Required | Ensure that invoices are processed through a logical document lifecycle | |
Transaction Posting/Committing - Invoices | Required | Ensure that invoices are committed/posted for reporting appropriately | |
Transaction Cancelation/Voiding - Invoices | Required | When invoices are deleted/canceled, this information must be transmitted to AvaTax | If the source application supports void/delete, then the corresponding transaction on AvaTax must be updated with the current transaction status |
Discounts | Required | Standard discounts included in line-level extended amount, manufacturer’s coupons and hostess credits transmitted as additional line items | |
Purchase Order Number | Suggested | Value sent to AvaTax as the purchaseOrderNo | |
Line Level - Entity/Use Code | Conditional | Value sent to AvaTax for the entityUseCode at the line level | Line level exempt triggers are required if line-level exemption can be managed in the application, and should be transmitted in a manner analogous to document-level exemption |
Latitude/Longitude Support | Suggested | If host application captures GPS coordinates with Addresses; for US addresses, pass the Lat and Long along with address. This is especially useful in situations where a location or service site can only be pinpointed by geo location |
Sales/Billing Document Integration - Beverage Alcohol
Name | Type | Description | Comments |
Seller Classification | Required | Used to calculate taxes based on InStateDirectShipper or OutOfStateDirectShipper | We have Tax calc rules setup in Content Central where some tax rates might change if a company has claimed they are an In-state vs out-of-state shipper. (Most of our rules include both.) |
Tracking Number | Required | Tracking number associated with a direct alcohol shipment. When multiple tracking numbers apply to a shipment, they must be separated by a semicolon (;) | Most of the time, this information is not available at the time of transaction creation, so when the product ships, the tracking number needs to be updated so the returns team can properly file returns. |
Direct Alcohol Import Indicator | Required | Used to indicate whether a beverage alcohol product is a direct import product (directAlcoholImport) | |
Alcohol Route Type | Required | Used to indicate the sales channel for a beverage alcohol transaction Possible values: 3T, DTC, DTT, Pickup | DTC = Direct to consumer 3T = wholesaler DTT = Direct to Trade Pick up = customer pickup |
Ship Date | Required | The day merchandise associated with an order was shipped. Must be formatted as YYYY-MM-DD. Will default to transaction date (docDate value) | Most of the time, this information is not available at the time of transaction creation, so when the product ships, the ship date needs to be updated so the returns team can properly file returns. |
Sales Location | Required | Distinguishes orders that were placed onsite at a business’s location vs. offsite Possible values: onsite, offsite. Will default to offsite | Default = offsite |
Carrier Code | Required | Carrier code of shipment (EX, FFO, FXG, FEH, FXP, FXO, FXE, FEXA, FHA, FHD, FHE, FEXCC, GSC, GSP, GSN, GES, GSS, GPC, GPA, UP1, UP2, UP2A, UP3, UPA, UPS, UPSA, UWE, UWED, UWEP) | Most of the time, this information is not available at the time of transaction creation, so when the product ships, the carrier code needs to be updated so the returns team can properly file returns. |
Fulfillment House Code | Required - Wine Only | Name of fulfilment house (WineDirect, CopperPeakLogistics, WineServicesCoop, WineCareLogistics, WineCountryShipping, WineCountryConnect, Vinfillment, WineCountyPackAndShip, Wineshipping) | Connectors need to be able to send this information so it can be used to filed returns, but it might not be applicable to the winery if they do not use a fulfillment warehouse to store/ship their product. |
Varietal (wine only) | Optional | For wine only, to indicate what varietal the product is classified (chardonnay) |
Items/Charge Integration
Name | Type | Description | Comments |
Item Code | Required | Identify the itemCode value (number, ID) to pass to the AvaTax service. | |
Item Description | Required | Identify item/service/charge description to pass to the AvaTax service with a human-readable description or item name. | |
AvaTax Tax Code mapping - Item Code/SKU | Required | Association of an item to an AvaTax Tax Code to describe the taxability (e.g. Clothing-Shirts – B-to-C) | |
AvaTax Tax Code mapping - Item Groups | Suggested | Association of a GROUP of items to an AvaTax Tax Code to describe the taxability of the group. | |
Tax Code Lookup | Suggested | Pull in and surface Avalara Tax Codes within application. | |
Pass UPC | Suggested | See note in Administration/Utilities Integration section. If the user elects to use AvaTax UPC, ensure that the appropriate field containing UPC data is mapped to the itemCode parameter formatted as: UPC:+. Example: “UPC:1234567890000”. by formatting the value with “UPC:” identifier, our engine can pick up the UPC code, and the user can avoid mapping a tax code for that item. If no UPC data is available still default to the regular itemCode mapping. | The UPC functionality is a premium upgrade to the Avalara AvaTax subscription providing taxability decision (taxable vs. non-taxable) without requiring an Avalara Tax Code assignment. |
Non-Standard Items | Required | Association of Freight/Shipping and/or Handling charge to an AvaTax Tax Code to describe the taxability. |
Items/Charge Integration - Beverage Alcohol
Name | Type | Description | Comments |
Net Volume | Required | The volume of only the item, substance, or product in question, exclusive of packaging, container, or other ancillary materials. Possible values: Volume as a number “100 L/mL” | |
Container Size | Required | Intended for use where tax rate is dependent on size of container, sent as a number Possible values: Volume as a number “100 L/mL” | |
Pack Size | Required | Allows customer to specify, where relevant, the number of taxable items in a package, such as cigarettes in a pack or bottles in a case. | |
Alcohol Content | Required | Alcohol percentage by volume, sent as a number | ex. value = 15, unit of measure = percentage |
Brand | Required | Brand name associated with the product being sold | |
Alcohol Sample Indicator | Required | Used to indicate whether a beverage alcohol product is a sample product (isAlcoholSample) | |
Foreign Alcohol Indicator | Required | Used to indicate whether a beverage alcohol product is a foreign beverage alcohol product (isForeignAlcohol) |
Shipping Verification
Name | Type | Description | Comments |
Display Shipping Verification Results | Required | The integration must display the Avalara Shipping Verification and Registration results on the transaction summary | |
Add Shipment to compliance registry | Required | Upon a successful 'compliant' response from the Shipping Verification utility, add transaction to the compliance register | |
Demonstrate Transaction Quarantine Functionality | Required | When Avalara Shipping Verification returns a 'non-compliant' result, function to quarantine order until merchant action is taken:
| |
Remove Shipment from compliance registry | Required | When issuing a credit memo for a returned product, the integration must remove the returned products from the compliance register | |
Add historical transactions to compliance registry | Optional | Function to add historical transaction to the compliance registry |