Avalara Developer

Administration and utilities

Name	Type	Description
Sign-in page	Required	Users must be provided with a configuration page or file that allows them to type in their authentication credentials and the company ID.
Sandbox or Production mode	Required	Your integration must provide a method for users to specify whether they’re working in a Sandbox or Production environment.
Test connection button	Required	Users must be able to test the connection to the AvaTax service and verify their AvaTax credentials.
Enable client side logging	Suggested	Users should have access to detailed AvaTax for Excise transaction logging within the application.
User guide	Required	Users must be provided with a guide that contains screenshots and steps describing how to configure and use ATE.

Business entities

Name	Type	Description
Import name	Required	When importing business entities, users must be able to specify a name for each import.
Import matches mode	Required	When importing business entities, users must be able to specify the behavior for treating existing business entities. Options include: * None * Insert * Update * Copy
Terminate new records	Required	When importing business entities, users must be able to specify whether to terminate new records.
Create all account types	Required	When importing business entities, users must be able to specify whether to create all account types.
Load ID	Required	When importing business entities, users must be able to specify a unique value indicating a group of imports.
Legal name	Required	Users must be provided with a method for specifying the name of the person or entity that owns a business.
Legal name priority	Required	Users must be able to specify a priority for a legal name. This determines the value that a legal name search will use first.
Trade name	Suggested	Users should be provided with an option to specify the name of the business that is used for advertising and sales purposes. Sometimes, this is different than the legal name.
Name control	Suggested	Users should be provided with an option to specify a business’s name control. This is the sequence of characters derived from a taxpayer’s name that is used by the IRS when processing the tax returns filed by the taxpayer.
Effective date	Required	Your integration must provide a method for specifying the date when a business entity will be valid for use.
Obsolete date	Suggested	Your integration should provide a method for specifying the date when a business entity will no longer be valid for use.
Business address	Suggested	Users should be able to specify the business address, including the country, jurisdiction (for example, state), county, city, postal code, and street address.
Business entity ID codes	Required	Users must be able to define an array of business entity ID codes. The codes include the country code, ID type, and ID code for each business entity.
Custom ID	Required	User must be able to specify a unique value to identify a business entity
Custom ID priority	Required	Users must be able to specify a priority for a custom ID. This determines the value that a custom ID search will use first.
ID code and ID type priority	Required	Users must be able to specify a priority for an ID code and ID type. This determines the value an ID code and ID type search will use first.
Business entity mapping ID	Required	Users must be able to specify a business entity mapping ID.
Business account country code	Suggested	If including business accounts, users should be able to specify a business account country code.
Business account jurisdiction	Suggested	If including business accounts, users should be able to specify the business account jurisdiction (for example, the state).
Business type	Suggested	If including business accounts, users should be able to specify the business type.
Business sub type	Suggested	If including business accounts, users should be provided with a field to further define the type of account being created
Business account custom ID	Suggested	If including business accounts, users should be provided with a way to uniquely identify a business entity.
Business account effective date	Suggested	If including business accounts, users should be provided with a method for specifying the date when a business account will be valid for use.
Business account obsolete date	Suggested	If including business accounts, users should be provided with a method for specifying the date when a business account will no longer be valid for use.
Business account license number	Suggested	If including business accounts, then should must be able to enter a business account’s state-specific license. This is used for a tax exemption, a tax deferral, a tax activation or to provide a tax collection allowance.
Business account license percentage	Suggested	If including business accounts, then users should be able to specify a license percentage for this account. This percentage will be applied to a tax exemption, tax deferral, tax activate, or tax collection allowance.
Business account mapping ID	Suggested	If including business accounts, then your integration should assign a unique ID to map to each business account.

Adjustments

Name	Type	Description
Transaction code	Required	Your integration must allow users to include a code that corresponds to the transaction that should be adjusted.
Adjustment reason code	Required	Your integration must allow users to specify a reason code that relates to the adjustment.
Adjustment description	Required	Your integration must allow users to include an optional description for the adjustment. This description is a string with a maximum length of 256.
New transaction	Required	Your integration must allow users to enter new transaction details for the adjustment.

Advanced feature: Tobacco, nicotine, and vape transactions - document level

Name	Type	Description
Transaction effective date	Required	Users must be able to specify the date when the tax rate should be applied to this transaction. This would typically be the bill of lading date.
Invoice number	Required	Users must be able to specify the invoice number of a transaction.
Invoice date	Required	Users must be able to specify the date of the invoice on a transaction.
Title transfer code	Required	Users must be able to specify whether the title transfer takes place at the `ORIG` or `DEST`.
Transaction type	Required	Users must be able to specify where the entire order is in the supply chain. For tobacco, nicotine, and vape tax, the available transaction types are: `WHOLESALE`, `RETAIL`, and `DIRECT`.
Seller	Required	Users must be able to specify the unique seller ID.
Buyer	Required	Users must be able to specify the unique buyer ID.
User transaction ID	Required	Users must be able to specify the corresponding AvaTax transaction code that is used to commit a transaction in both environments. Every new transaction must have a new `UserTranId`.
Entity use code	Required	Users must be able to specify an entity use code for a sales/use tax exemption at the document and line levels.
Custom strings and numerics	Required	Users must have a way to enter up to ten custom strings and up to ten custom numeric values as a way to customize calculations based on their business rules.
Source system	Required	Users must be able to specify a string that identifies the system that’s calling the application with this transaction.
User data	Suggested	Users should be provided with a field for entering data about the user at the document and line levels.
AvaTax transaction type	Suggested	Users should be able to specify the corresponding AvaTax transaction type.
Discount amount	Suggested	Users should be able to specify a discount amount at the header level. This discount will then be applied to all lines with `"Discounted": true`.

Advanced feature: Tobacco, nicotine, and vape transactions - line level

Name	Type	Description
Invoice line	Required	Users must be able to specify multiple lines on a transaction.
Product code	Required	Users must be able to specify a product code when creating an ATE transaction.
Origin address	Required	Users must be able to specify the origination country code, jurisdiction (for example, the state), county, city, and postal code. In addition, including a street-level address will provide more accurate tax determination.
Origin code	Suggested	Users should be able to specify a custom ID for a defined origination location rather than specifying the full origin address.
Destination address	Required	Users must be able to specify the destination country code, jurisdiction (for example, the state), county, city, and postal code. In addition, including a street-level address will provide more accurate tax determination.
Destination code	Suggested	Users should be able to specify a custom ID for a defined destination location rather than specifying the full destination address.
Sale address	Required	Users must be able to specify the sales country code, jurisdiction (for example, the state), county, city, and postal code. In addition, including a street-level address will provide more accurate tax determination.
Line amount	Suggested	Transactions must know the cost or amount of an item to perform a tax calculation. This is done by specifying either a unit price and/or a line amount.
Alternate line amount	Suggested	Transactions may include an alternate line amount. This is the total amount of value of product on the line item calculated by BilledUnits * AlternateUnitPrice. If left blank, ATE will calculate this value.
Unit price	Required	Transactions must know the cost or amount of an item to perform a tax calculation. This is done by specifying either a unit price and/or a line amount.
Alternate unit price	Required	Transactions must include an alternate cost per unit. This is used in calculating taxes from manufacturing.
Tax included	Suggested	Your integration should allow users to specify whether tax is already included in a transaction line’s unit price and/or amount.
Billed units	Required	Users must be able to specify the unit amount that is used for billing. This value must match either the net units or gross units.
Net units	Required	Users must be able to specify the net unit volume of a product on a line item.
Gross units	Required	Users must be able to specify the gross unit volume at the time of delivery for an item.
Currency	Required	Users must be able to specify the currency that the unit price and/or line amount use.
Discounted	Conditional	If users can specify a discount amount at the document level, then they must be able to specify whether that value applies to a transaction line.
Unit of measure	Required	Users must be able to specify the unit of measure that the net, gross, and billed units are defined in.
Unit quantity	Suggested	Users should be able to specify a unit quantity, or the number of subunits within a unit (for example, the number of cigars in a box). This attribute can be assigned directly to the product code within ATE.
Unit quantity unit of measure	Suggested	Users should be able to specify the unit of measure for subunits. This attribute can be assigned directly to the product code within ATE.
Unit volume	Suggested	Users should be able to specify a volume for a line item. This attribute can be assigned directly to the product code within ATE.
Unit volume unit of measure	Suggested	Users should be able to specify the unit of measure for the volume. This attribute can be assigned directly to the product code within ATE.
Unit weight	Suggested	Users should be able to specify a weight value for a line item. This attribute can be assigned directly to the product code within ATE.
Unit weight unit of measure	Suggested	Users should be able to specify the unit of measure for a weight. This attribute can be assigned directly to the product code within ATE.

Advanced feature: Fuel transactions - document level

Name	Type	Description
Transaction effective date	Required	Users must be able to specify the date when the tax rate should be applied to this transaction. This would typically be the bill of lading date.
Invoice number	Required	Users must be able to specify the invoice number of a transaction.
Invoice date	Required	Users must be able to specify the date of the invoice on a transaction.
Title transfer code	Required	Users must be able to specify whether the title transfer takes place at the `ORIG` or `DEST`.
Transaction type	Required	Users must be able to specify where the entire order is in the supply chain. For fuel tax, the available transaction types are: * `ABOVE`: Above the rack * `BELOW`: Below the rack * `RACK`: At the rack
Seller	Required	Users must be able to specify the unique seller ID.
Buyer	Required	Users must be able to specify the unique buyer ID.
User transaction ID	Required	Users must be able to specify the corresponding AvaTax transaction code that’s used to commit a transaction in both environments. Every new transaction must have a new `UserTranId`.
Entity use code	Required	For each transaction, users must be able to specify an entity use code for a sales/use tax exemption.
Custom strings and numerics	Required	Users must have a way to enter up to ten custom strings and up to ten custom numeric values as a way to customize calculations based on their business rules.
Source system	Required	Users must be able to specify a string that identifies the system that’s calling the application with this transaction.
Fuel use code	Suggested	Users should be able to specify a code that describes how the fuel is used.
Transportation mode code	Suggested	Users should be able to specify a code that describes the transportation mode. This code comes from the transportation mode code master data table.
User data	Suggested	Users should be provided with a field for entering data about the user.
AvaTax transaction type	Suggested	Users should be able to specify the corresponding AvaTax transaction type.
Discount amount	Suggested	Users should be able to specify a discount amount at the header level. This discount will then be applied to all lines with `"Discounted": true`.

Advanced feature: Fuel transactions - line level

Name	Type	Description
Invoice line	Required	Users must be able to specify multiple lines on a transaction.
Product code	Required	Users must be able to specify a product code when creating an ATE transaction.
Unit price	Conditional	Transactions must know the cost or amount of an item to perform a tax calculation. This is done by specifying either a unit price and/or a line amount.
Line amount	Conditional	Transactions must know the cost or amount of an item to perform a tax calculation. This is done by specifying either a unit price and/or a line amount.
Currency	Required	Users must be able to specify the currency that the unit price and/or line amount use.
Net units	Required	Users must be able to specify the net unit volume when the item is at 60 degrees Fahrenheit.
Gross unit	Required	Users must be able to specify the gross unit volume at the time of delivery for an item.
Billed units	Required	Users must be able to specify the unit volume that is used for billing. This value must match either the net units or gross units.
Unit of measure	Required	Users must be able to specify the unit of measure that the net, gross, and billed units are defined in.
Origin address	Required	Users must be able to specify the origination country code, jurisdiction (for example, the state), county, city, and postal code. In addition, including a street-level address will provide more accurate tax determination.
Origin code	Required	Users must be able to specify a custom ID for a defined origination location rather than specifying the full origin address.
Origin type	Suggested	Users should have an option to specify the type of facility where the product originated from (for example, pipeline, refinery, terminal, truck, and so on).
Destination address	Required	Users must be able to specify the destination country code, jurisdiction (for example, the state), county, city, and postal code. In addition, including a street-level address will provide more accurate tax determination.
Destination code	Required	Users must be able to specify a custom ID for a defined destination location rather than specifying the full destination address.
Destination type	Suggested	Users should have an option to specify the type of facility receiving the product (for example, pipeline, refinery, terminal, truck, and so on).
Sale address	Required	Users must be able to specify the sales country code, jurisdiction (for example, the state), county, city, and postal code. In addition, including a street-level address will provide more accurate tax determination.
Sale type	Suggested	Users should have an option to specify the type of facility where the sale of the product took place (for example, pipeline, refinery, terminal, truck, and so on).
Movement start and end dates	Suggested	For specialty tax configurations, users should be able to specify the start and end dates for when items are transported.
Bill of lading number	Suggested	Users should have an option to specify a bill of lading number. This is useful for integrations that allow searching for transactions via the ATE UI.
Bill of lading date	Suggested	Users should have an option to specify a bill of lading date. This is useful for integrations that allow searching for transactions via the ATE UI.
Tax included	Suggested	Your integration should allow users to specify whether tax is already included in a transaction line’s unit price and/or amount.
Discounted	Suggested	Your integration should allow users to specify whether a transaction line’s unit price and/or amount is a discounted value.

Certification badge requirements. View on Avalara.