AvaTax API
Search Icon
v2
cardImage
Definitions
cardImage
DomainControlVerification
Models
Top 10 EndPoints

TransactionLineModel

One line item on this transaction.

Parameters
idOptional
integer

The unique ID number of this transaction line item.

transactionIdOptional
integer

The unique ID number of the transaction to which this line item belongs.

lineNumberOptional
string

The line number or code indicating the line on this invoice or receipt or document.

boundaryOverrideIdOptional
integer

The unique ID number of the boundary override applied to this line item.

customerUsageTypeOptional
string

DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. The customer usage type for this line item. Usage type often affects taxability rules.

entityUseCodeOptional
string

The entity use code for this line item. Usage type often affects taxability rules.

descriptionOptional
string

A description of the item or service represented by this line.

destinationAddressIdOptional
integer

The unique ID number of the destination address where this line was delivered or sold. In the case of a point-of-sale transaction, the destination address and origin address will be the same. In the case of a shipped transaction, they will be different.

originAddressIdOptional
integer

The unique ID number of the origin address where this line was delivered or sold. In the case of a point-of-sale transaction, the origin address and destination address will be the same. In the case of a shipped transaction, they will be different.

discountAmountOptional
number

The amount of discount that was applied to this line item. This represents the difference between list price and sale price of the item. In general, a discount represents money that did not change hands; tax is calculated on only the amount of money that changed hands.

discountTypeIdOptional
integer

The type of discount, if any, that was applied to this line item.

exemptAmountOptional
number

The amount of this line item that was exempt.

exemptCertIdOptional
integer

The unique ID number of the exemption certificate that applied to this line item. It is the calc_id associated with a certificate in CertCapture.

certificateIdOptional
string

The CertCapture Certificate ID

exemptNoOptional
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.

isItemTaxableOptional
boolean

True if this item is taxable.

isSSTPOptional
boolean

True if this item is a Streamlined Sales Tax line item.

itemCodeOptional
string

The code string of the item represented by this line item.

lineAmountOptional
number

The total amount of the transaction, including both taxable and exempt. This is the total price for all items. To determine the individual item price, divide this by quantity.

quantityOptional
number

The quantity of products sold on this line item.

ref1Optional
string

A user-defined reference identifier for this transaction line item.

ref2Optional
string

A user-defined reference identifier for this transaction line item.

reportingDateOptional
string

The date when this transaction should be reported. By default, all transactions are reported on the date when the actual transaction took place. In some cases, line items may be reported later due to delayed shipments or other business reasons.

revAccountOptional
string

The revenue account number for this line item.

sourcingOptional
string

Indicates whether this line item was taxed according to the origin or destination.

Enum:
Mixed,Destination,Origin
taxOptional
number

The tax for this line in this transaction.

If you used a taxOverride of type taxAmount for this line, this value will represent the amount of your override. AvaTax will still attempt to calculate the correct tax for this line and will store that calculated value in the taxCalculated field.

You can compare the tax and taxCalculated fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

taxableAmountOptional
number

The taxable amount of this line item.

taxCalculatedOptional
number

The amount of tax that AvaTax calculated for the transaction.

If you used a taxOverride of type taxAmount, there may be a difference between the tax field which applies your override, and the taxCalculated field which represents the amount of tax that AvaTax calculated without the override.

You can compare the tax and taxCalculated fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

taxCodeOptional
string

The code string for the tax code that was used to calculate this line item.

taxCodeIdOptional
integer

The unique ID number for the tax code that was used to calculate this line item.

taxDateOptional
string

The date that was used for calculating tax amounts for this line item. By default, this date should be the same as the document date. In some cases, for example when a consumer returns a product purchased previously, line items may be calculated using a tax date in the past so that the consumer can receive a refund for the correct tax amount that was charged when the item was originally purchased.

taxEngineOptional
string

The tax engine identifier that was used to calculate this line item.

taxOverrideTypeOptional
string

If a tax override was specified, this indicates the type of tax override.

Enum:
None,TaxAmount,Exemption,TaxDate,AccruedTaxAmount,DeriveTaxable,OutOfHarbor,TaxAmountByTaxType,VendorChargedTax
businessIdentificationNoOptional
string

VAT business identification number used for this transaction.

taxOverrideAmountOptional
number

If a tax override was specified, this indicates the amount of tax that was requested.

taxOverrideReasonOptional
string

If a tax override was specified, represents the reason for the tax override.

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.

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.

detailsOptional
array

Optional: A list of tax details for this line item.

Tax details represent taxes being charged by various tax authorities. Taxes that appear in the details collection are intended to be displayed to the customer and charged as a 'tax' on the invoice.

To fetch this list, add the query string ?$include=Details to your URL.

Optional: A list of Account payable Sales tax details for this line item.

To fetch this list, add the query string ?$include=AccountPayableSalesTaxDetails to your URL.

Optional: A list of non-passthrough tax details for this line item.

Tax details represent taxes being charged by various tax authorities. Taxes that appear in the nonPassthroughDetails collection are taxes that must be paid directly by the company and not shown to the customer.

array

Optional: A list of location types for this line item. To fetch this list, add the query string "?$include=LineLocationTypes" to your URL.

parametersOptional
array

Contains a list of extra parameters that were set when the transaction was created.

array

Custom user fields/flex fields for this transaction.

hsCodeOptional
string

The cross-border harmonized system code (HSCode) used to calculate tariffs and duties for this line item. For a full list of HS codes, see ListCrossBorderCodes().

costInsuranceFreightOptional
number

Indicates the cost of insurance and freight for this line.

vatCodeOptional
string

Indicates the VAT code for this line item.

vatNumberTypeIdOptional
integer

Indicates the VAT number type for this line item.

array

Contains a list of TaxType that are to be overridden with their respective TaxOverrideAmount.

deemedSupplierOptional
string

Deemed Supplier field indicates which party on the marketplace transaction is liable for collecting and reporting the VAT. This is based on the 2021 E-commerce legislative reforms in EU and UK. This field will not be used until after July 1, 2021.

Enum:
Marketplace,Merchant
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.

recoverabilityPercentageOptional
number

The percentage of input VAT/GST that is recoverable.

recoverableAmountOptional
number

The amount of input VAT/GST that is recoverable based on the recoverability percentage.

nonRecoverableAmountOptional
number

The amount of input VAT/GST that is not recoverable.

card-img
View Example
card-img