Purchases/payables document integration

This section describes requirements for how to pass information from an invoice or quote.


Requirement	Use case	Endpoints/Models	Type
Display and store the AP status code in responses	Users should display and store the AP status code returned by the AvaTax engine in the ERP transaction record.	N/A	Suggested
Display and store the AP status in responses	Users must display and store the AvaTax user's AP status and the status description returned by the AvaTax engine in the ERP transaction record.	N/A	Suggested
Document code	Users must have a way to enter a document code to tie transactions in AvaTax to the transactions in their underlying system.	CreateTransactionModel	Required
Vendor code	Your integration must include a vendor identifier field (typically the database key in the vendor master) to map to the `customerCode` field in Avalara.	CreateTransactionModel	Required
Document date	Users must be able to specify the calendar date when a transaction occurs.	CreateTransactionModel	Required
Tax calculation date	Users must be able to override the date used to calculate tax.	TaxOverrideModel	Required
Ship-to address (header and line levels)	Your integration must be able to store at the header and line levels the address where items are shipped from.	AddressModel	Required
Ship-from address (header and line levels)	Your integration must be able to store at both the header or line levels the address where items are shipped to.	AddressModel	Required
Line number	Users must be able to include multiple lines on a transaction, with each line specified using a unique line number.	LineItemModel	Required
Item/commodity code	Merchants/users must be able to specify an item code for each line in a transaction in order to associate a tax code for that item.	LineItemModel	Required
Item/commodity description	Merchants/users must be able to include a description of an item on each line of a transaction.	LineItemModel	Required
Quantity	Users must be able to specify the quantity of an item for each line of a transaction.	LineItemModel	Required
Amount	Users must be able to specify the total amount for each line item in a transaction, keeping in mind the status of the `isTaxIncluded` flag.	LineItemModel	Required
Tax code	Users must be able to specify a tax code for each line item in a transaction.	LineItemModel	Required
Tax overrides	Users must be able to set a tax override type of `VendorChargedTax` along with the override amount and reason.	TaxOverrideModel	Required
Verify that the transaction uses the Avalara-calculated tax amount	Users must ensure that the tax amount value from a transaction response is used to populate the tax field in the integration.	N/A	Required
Shipping/freight handling	The handling of shipping and freight in AvaTax must match your system's implementation.	LineItemModel	Required
Discount transactions	Users must ensure that discounts on transactions are processed appropriately.	CreateTransactionModel LineItemModel	Required
Transaction lifecycle	Your integration must mirror your system's workflow as it relates to orders and invoices and use the appropriate document types.	CreateTransactionModel	Required
Commit transactions	Your integration must mirror your system's workflow for a transaction lifecycle when committing documents.	CommitTransaction	Required
Void/delete a document	If the merchant's source application supports voiding/deleting invoices, then they must allow users to void/delete invoices in AvaTax.	VoidTransactionModel	Conditional. This is required if the source application supports voiding/deleting invoices.
Point-of-order origin address (header and line levels)	If the merchant's source application supports a Point of Order Origin address, then they must provide this option to users in AvaTax at the header and line levels.	AddressModel	Conditional. This is required if the source application supports a Point of Order Origin address.
Point-of-order acceptance address (header and line levels)	If the merchant's source application supports a Point of Order Acceptance address, then they must provide this option to users in AvaTax and the header and line levels.	AddressModel	Conditional. This is required if the source application supports a Point of Order Acceptance address.
Reporting location code	If the merchant's source application supports multiple origin addresses, then they must provide an option for users to specify a reporting location code in the determination request.	CreateTransactionModel	Conditional for core. Required if the source application supports multiple origin addresses. Required for POS.
Purchase order number	Merchants/users should be able to specify a purchase order number for a transaction.	CreateTransactionModel	Suggested
Latitude/longitude support	Merchants/users should be able to pass latitude and longitude values into each address type to pinpoint that address by geo location. This is supported for US addresses only.	AddressModel	Suggested