AvaTax for VAT

Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

LineItemModel

Represents one line item in a transaction

Parameters
numberOptional
string

The line number of this line within the document. This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text.

quantityOptional
number

Quantity of items in this line. This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds.

If not provided, or if set to zero, the quantity value is assumed to be one (1).

amountRequired
number

Total amount for this line. The amount represents the net currency value that changed hands from the customer (represented by the customerCode field) to the company (represented by the companyCode) field.

For sale transactions, this value must be positive. It indicates the amount of money paid by the customer to the company.

For refund or return transactions, this value must be negative.

addressesOptional
AddressesModel

The addresses to use for this transaction line.

If you set this value to null, or if you omit this element from your API call, then instead the transaction will use the addresses from the document level.

If you specify any other value besides null, only addresses specified for this line will be used for this line.

taxCodeOptional
string

Tax Code - System or Custom Tax Code.

You can use your own tax code mapping or standard Avalara tax codes. For a full list of tax codes, see ListTaxCodes.

customerUsageTypeOptional
string

DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.

entityUseCodeOptional
string

Entity Use Code - The client application customer or usage type. This field allows you to designate a type of usage that may make this transaction considered exempt by reason of exempt usage.

For a list of entity use codes, see the Definitions API ListEntityUseCodes.

itemCodeOptional
string

Item Code (SKU). If you provide an itemCode field, the AvaTax API will look up the item you created with the CreateItems API call and use all the information available about that item for this transaction.

exemptionCodeOptional
string

The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options. Note: This is same as 'exemptNo' in TransactionModel.

discountedOptional
boolean

True if the document discount should be applied to this line. If this value is false, or not provided, discounts will not be applied to this line even if they are specified on the root discount element.

taxIncludedOptional
boolean

Indicates whether the amount for this line already includes tax.

If this value is true, the final price of this line including tax will equal the value in amount.

If this value is null or false, the final price will equal amount plus whatever taxes apply to this line.

revenueAccountOptional
string

Revenue Account (Customer Defined Field).

This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.

ref1Optional
string

Ref1 (Customer Defined Field)

This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.

ref2Optional
string

Ref2 (Customer Defined Field)

This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.

descriptionOptional
string

Item description.

For Streamlined Sales Tax (SST) customers, this field is required if an unmapped itemCode is used.

businessIdentificationNoOptional
string

VAT business identification number for the customer for this line item. If you leave this field empty, this line item will use whatever business identification number you provided at the transaction level.

If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.

taxOverrideOptional
TaxOverrideModel

Specifies a tax override for this line.

parametersOptional
array

Special parameters that apply to this line within this transaction.

To get a full list of available parameters, please use the ListParameters API.

userDefinedFieldsOptional
array

Custom user fields/flex fields for this line.

hsCodeOptional
string

The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction.

For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes.

merchantSellerIdOptional
integer

DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead. ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.

merchantSellerIdentifierOptional
string

ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.

marketplaceLiabilityTypeOptional
string

This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.

Enum: Marketplace, Seller
originationDocumentIdOptional
string

The transaction's original ID in its origination system

originationSiteOptional
string

Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.

categoryOptional
string

Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “. Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.

summaryOptional
string

A long description of the product.