Avalara Developer Network Developer communications

Chapter 5.5 - Line Item

Line Item

The LineItem object contains detailed information about a single transaction:

Key Value
ref [string]Reference code
from [Location] optional The point of origin for the line item
to [Location] optional The destination of the line item
chg [double] Charge
line [int] Line Count
loc [int] Number of locations applied to the line item
min [double] Minutes applied to the line item
sale [int] Sale Type
  • 0 Wholesale
  • 1 Retail
  • 2 Consumed (Sales and Use Only)
  • 3 Vendor Use (Sales and Use Only)
plsp [double] optional Private Line Split
A percentage used to split a transaction charge between two points. For example:
  • A transaction has two points: Point 'A' and Point 'Z'
  • A plsp of 0.25 means 25% of the taxes are attributed to Point 'A', the remaining 75% to Point 'Z'
incl [bool] Tax Inclusive
  • true Tax is included in the charge
  • false Tax is exclusive to the charge
pror [double] optional Pro-rated Percentage
A percentage used for the pro-rated calculation of fixed taxes.
tran [int] Transaction Type
The first part of the T/S Pair that defines the product to be taxed.
For a list of transaction/service types, check out the /api/v2/afc/tspairs endpoint.
serv [int] Service Type
The second part of the T/S Pair that defines the product to be taxed.
For a list of transaction/service types, check out the /api/v2/afc/tspairs endpoint.
dbt [bool] Debit
  • true Apply debit card logic to the transaction
  • false Not a debit card transaction
adj [bool] IsAdjustment
  • true The transaction represents a credit or adjustment
  • false The transaction does not represent a credit or adjustment
adjm [int] Adjustment Method
  • 0 Default. Tax brackets applied normally.
  • 1 Least-favorable rate to customer. Tax brackets applied to produce smallest tax refund.
  • 2 Most-favorable rate to customer. Tax brackets applied to produce largest tax refund.
In certain cases, when the rate of a tax will change based upon the charge or the number of lines in the transaction, clients may wish to make an adjustment at a different rate than would normally apply for the transaction. For example:
  • A client purchased 20 lines at a rate of $0.67 per line.
  • A credit/adjustment is created for 5 lines at a rate of $1.25 per line.
Using the Least-favorable adjustment method, the 5 lines would be refunded at the least favorable rate for the brackets, ensuring the client was not overcompensated.
disc [int] optional Discount Type
  • 0 None
  • 1 Retail Product: An amount subtracted from the original price to arrive at a lower price.
  • 2 Manufacturer Product: A discount of the total amount reimbursed to either the retailer or the customer by the manufacturer.
  • 3 Account Level: A stand-alone discount that is not applied against any service but instead as a stand-alone product.
  • 4 Subsidized: A discount caused exclusively in telephone service where the telephone provider provides a service to a lifeline eligible customer. The discount will be on the local exchange service.
  • 5 Goodwill: The total discount of a service that is recorded for accounting purposes but never billed to a customer.