AvaTax for Excise

Version v1
AlternateProductsController
AvaTaxExciseController
ImportBusinessEntitiesController
ImportHeadersController
ImportItemCodesController
ImportLocationsController
ImportManufacturersController
ImportProductsTobaccoController
ImportScheduleTransactionsController
JurisdictionsController
NotificationController
RatesController
Tax Sessions
TaxpayerTypesController
UtilitiesController

Avalara.Excise.Determination.Engine.RestTransactionLine

One product or charge line on an excise transaction, including locations, quantities, pricing, and schedule context for tax determination.

Parameters
TransactionLineScheduleOptional
Avalara.Excise.Determination.Engine.RestTransactionLineSchedule

Schedule-level attributes for this line used in excise tax determination (rates, bases, and jurisdiction-specific fields).

TransactionLineMeasuresOptional
array

Supplemental quantity measures for this line (for example alternate UOMs or gauge readings).

OriginSpecialJurisdictionsOptional
array

Special tax jurisdictions that apply at the origin of the movement.

DestinationSpecialJurisdictionsOptional
array

Special tax jurisdictions that apply at the destination of the movement.

SaleSpecialJurisdictionsOptional
array

Special tax jurisdictions that apply at the sale location.

CounterSpecialJurisdictionsOptional
array

Special tax jurisdictions that apply at the counterparty location.

OrderOriginSpecialJurisdictionsOptional
array

Special tax jurisdictions that apply at the point of order origin.

OrderAcceptanceSpecialJurisdictionsOptional
array

Special tax jurisdictions that apply at the point of order acceptance.

GpsrSpecialJurisdictionsOptional
array

Special tax jurisdictions for the goods place or service rendered location.

BillToSpecialJurisdictionsOptional
array

Special tax jurisdictions that apply at the bill-to location.

InvoiceLineOptional
integer

The line number on the invoice or source document.

MovementStartDateOptional
string

The start date of the movement or activity for this line.

MovementEndDateOptional
string

The end date of the movement or activity for this line.

ProductCodeOptional
string

The product code identifier.

BlendToProductCodeOptional
string

The target product code when this line represents a blend into another product.

UnitPriceOptional
number

Price per unit in the line currency before extensions.

AlternateUnitPriceOptional
number

Alternate price per unit used when a secondary pricing basis applies.

NetUnitsOptional
number

Net quantity after deductions, in the line unit of measure.

GrossUnitsOptional
number

Gross quantity before deductions, in the line unit of measure.

BilledUnitsOptional
number

Quantity billed or invoiced, in the line unit of measure.

LineAmountOptional
number

Extended line amount in the line currency.

AlternateLineAmountOptional
number

Extended line amount on an alternate pricing or currency basis.

BillOfLadingNumberOptional
string

The bill of lading or transport document number.

BillOfLadingDateOptional
string

The date on the bill of lading or transport document.

OriginCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the origin.

OriginJurisdictionOptional
string

The jurisdiction or state code for the origin.

OriginCountyOptional
string

The origin county name or description.

OriginCityOptional
string

The origin city.

OriginPostalCodeOptional
string

The origin postal or ZIP code.

OriginTypeOptional
string

The type of origin location (for example terminal, rack, or retail).

OriginOptional
string

The origin location or facility identifier.

OriginOutCityLimitIndOptional
string

Whether the origin is outside municipal limits for tax sourcing.

OriginSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies at the origin.

OriginExciseWarehouseOptional
string

Excise warehouse or bonded location identifier at the origin.

OriginAddress1Optional
string

The first line of the origin street address.

OriginAddress2Optional
string

The second line of the origin street address.

OriginAirportCodeOptional
string

The IATA or FAA airport code for the origin when movement is by air.

DestinationCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the destination.

DestinationJurisdictionOptional
string

The jurisdiction or state code for the destination.

DestinationCountyOptional
string

The destination county name or description.

DestinationCityOptional
string

The destination city.

DestinationPostalCodeOptional
string

The destination postal or ZIP code.

DestinationTypeOptional
string

The type of destination location (for example terminal, rack, or retail).

DestinationOptional
string

The destination location or facility identifier.

DestinationOutCityLimitIndOptional
string

Whether the destination is outside municipal limits for tax sourcing.

DestinationSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies at the destination.

DestinationExciseWarehouseOptional
string

Excise warehouse or bonded location identifier at the destination.

DestinationAddress1Optional
string

The first line of the destination street address.

DestinationAddress2Optional
string

The second line of the destination street address.

DestinationAirportCodeOptional
string

The IATA or FAA airport code for the destination when movement is by air.

SaleCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the sale location.

SaleJurisdictionOptional
string

The jurisdiction or state code for the sale location.

SaleCountyOptional
string

The county for the sale location.

SaleCityOptional
string

The city for the sale location.

SalePostalCodeOptional
string

The postal or ZIP code for the sale location.

SaleTypeOptional
string

The type of sale location (for example retail, wholesale, or delivery).

SaleLocationOptional
string

The sale location or outlet identifier.

SaleOutCityLimitIndOptional
string

Whether the sale location is outside municipal limits for tax sourcing.

SaleSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies at the sale location.

SaleExciseWarehouseOptional
string

Excise warehouse or bonded location identifier at the sale location.

SaleAddress1Optional
string

The first line of the sale location street address.

SaleAddress2Optional
string

The second line of the sale location street address.

SaleAirportCodeOptional
string

The IATA or FAA airport code for the sale location when relevant.

CounterCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the counterparty.

CounterJurisdictionOptional
string

The jurisdiction or state code for the counterparty.

CounterCountyOptional
string

The county for the counterparty address.

CounterCityOptional
string

The city for the counterparty address.

CounterPostalCodeOptional
string

The postal or ZIP code for the counterparty address.

CounterTypeOptional
string

The type of counterparty location for tax sourcing.

CounterPartyOptional
string

The counterparty location or entity identifier.

CounterOutCityLimitIndOptional
string

Whether the counterparty is outside municipal limits for tax sourcing.

CounterSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies to the counterparty.

CounterExciseWarehouseOptional
string

Excise warehouse or bonded location identifier for the counterparty.

CounterFiscalRepIndOptional
string

Whether the counterparty acts through a fiscal representative for indirect tax.

CounterAddress1Optional
string

The first line of the counterparty street address.

CounterAddress2Optional
string

The second line of the counterparty street address.

CounterAirportCodeOptional
string

The IATA or FAA airport code for the counterparty when relevant.

PtOrderOriginOptional
string

The point-of-order-origin location identifier.

PtOrderOriginCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the point of order origin.

PtOrderOriginJurisdictionOptional
string

The jurisdiction or state code for the point of order origin.

PtOrderOriginCountyOptional
string

The county for the point of order origin.

PtOrderOriginCityOptional
string

The city for the point of order origin.

PtOrderOriginPostalCodeOptional
string

The postal or ZIP code for the point of order origin.

PtOrderOriginTypeOptional
string

The location type for the point of order origin.

PtOrderOriginOutCityLimitIndOptional
string

Whether the point of order origin is outside municipal limits for tax sourcing.

PtOrderOriginCustomIdOptional
string

Client-defined identifier for the point of order origin.

PtOrderOriginSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies at the point of order origin.

PtOrderOriginExciseWarehouseOptional
string

Excise warehouse or bonded location identifier at the point of order origin.

PtOrderOriginAddress1Optional
string

The first line of the point-of-order-origin street address.

PtOrderOriginAddress2Optional
string

The second line of the point-of-order-origin street address.

PtOrderOriginAirportCodeOptional
string

The IATA or FAA airport code for the point of order origin when relevant.

PtOrderAcceptOptional
string

The point-of-order-acceptance location identifier.

PtOrderAcceptCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the point of order acceptance.

PtOrderAcceptJurisdictionOptional
string

The jurisdiction or state code for the point of order acceptance.

PtOrderAcceptCountyOptional
string

The county for the point of order acceptance.

PtOrderAcceptCityOptional
string

The city for the point of order acceptance.

PtOrderAcceptPostalCodeOptional
string

The postal or ZIP code for the point of order acceptance.

PtOrderAcceptTypeOptional
string

The location type for the point of order acceptance.

PtOrderAcceptOutCityLimitIndOptional
string

Whether the point of order acceptance is outside municipal limits for tax sourcing.

PtOrderAcceptCustomIdOptional
string

Client-defined identifier for the point of order acceptance.

PtOrderAcceptSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies at the point of order acceptance.

PtOrderAcceptExciseWarehouseOptional
string

Excise warehouse or bonded location identifier at the point of order acceptance.

PtOrderAcceptAddress1Optional
string

The first line of the point-of-order-acceptance street address.

PtOrderAcceptAddress2Optional
string

The second line of the point-of-order-acceptance street address.

PtOrderAcceptAirportCodeOptional
string

The IATA or FAA airport code for the point of order acceptance when relevant.

GpsrOptional
string

The location identifier for where goods are situated or the service is rendered.

GpsrCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the goods place or service rendered.

GpsrJurisdictionOptional
string

The jurisdiction or state code for the goods place or service rendered.

GpsrCountyOptional
string

The county for the goods place or service rendered.

GpsrCityOptional
string

The city for the goods place or service rendered.

GpsrPostalCodeOptional
string

The postal or ZIP code for the goods place or service rendered.

GpsrTypeOptional
string

The location type for the goods place or service rendered.

GpsrOutCityLimitIndOptional
string

Whether the goods place or service rendered is outside municipal limits for tax sourcing.

GpsrCustomIdOptional
string

Client-defined identifier for the goods place or service rendered.

GpsrSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies to the goods place or service rendered.

GpsrExciseWarehouseOptional
string

Excise warehouse or bonded location identifier for the goods place or service rendered.

GpsrAddress1Optional
string

The first line of the street address for the goods place or service rendered.

GpsrAddress2Optional
string

The second line of the street address for the goods place or service rendered.

GpsrAirportCodeOptional
string

The IATA or FAA airport code for the goods place or service rendered when relevant.

BillToOptional
string

The bill-to location identifier.

BillToCountryCodeOptional
string

The ISO 3166-1 alpha-3 country code for the bill-to address.

BillToJurisdictionOptional
string

The jurisdiction or state code for the bill-to address.

BillToCountyOptional
string

The county for the bill-to address.

BillToCityOptional
string

The city for the bill-to address.

BillToPostalCodeOptional
string

The postal or ZIP code for the bill-to address.

BillToTypeOptional
string

The bill-to location type for tax sourcing.

BillToOutCityLimitIndOptional
string

Whether the bill-to location is outside municipal limits for tax sourcing.

BillToCustomIdOptional
string

Client-defined identifier for the bill-to party or location.

BillToSpecialJurisdictionIndOptional
string

Whether a special tax jurisdiction applies at the bill-to location.

BillToExciseWarehouseOptional
string

Excise warehouse or bonded location identifier for the bill-to address.

BillToAddress1Optional
string

The first line of the bill-to street address.

BillToAddress2Optional
string

The second line of the bill-to street address.

BillToAirportCodeOptional
string

The IATA or FAA airport code for the bill-to location when relevant.

UserDataOptional
string

Opaque client-defined data carried with this line.

AlternativeFuelContentOptional
number

Share of alternative fuel content for the line product, when applicable.

BlendToAltFuelContentOptional
number

Alternative fuel content for the blend-to product, when applicable.

BlendToIndOptional
string

Whether this line represents or participates in a product blend.

CurrencyOptional
string

The ISO currency code for monetary amounts on this line.

UnitOfMeasureOptional
string

The unit of measure for the billed, net, and gross quantities on this line.

FreightUnitPriceOptional
number

Freight charge per unit in the line currency.

FreightTypeOptional
string

Classification of freight or delivery charges for tax treatment.

FreightLineAmountOptional
number

Total freight amount in the line currency.

CustomString1Optional
string

Extension string field 1 for line-level attributes.

CustomString2Optional
string

Extension string field 2 for line-level attributes.

CustomString3Optional
string

Extension string field 3 for line-level attributes.

CustomNumeric1Optional
number

Extension numeric field 1 for line-level attributes.

CustomNumeric2Optional
number

Extension numeric field 2 for line-level attributes.

CustomNumeric3Optional
number

Extension numeric field 3 for line-level attributes.

NthTimeSaleOptional
number

Ordinal indicating which sale in a series this line represents (for recurring or tiered rules).

TaxIncludedOptional
boolean

Whether excise or sales tax is included in the stated unit or line price.

UnitQuantityOptional
number

Count of sellable units (for example packs or items) distinct from volume or weight.

UnitQuantityUnitOfMeasureOptional
string

The unit of measure for the unit quantity count.

UnitVolumeOptional
number

Volume per single unit of product (for example per bottle or container).

UnitVolumeUnitOfMeasureOptional
string

The unit of measure for the unit volume.

UnitWeightOptional
number

Weight per single unit of product.

UnitWeightUnitOfMeasureOptional
string

The unit of measure for the unit weight.

UnitLengthOptional
number

Length per single unit of product when dimension-based rules apply.

UnitLengthUnitOfMeasureOptional
string

The unit of measure for the unit length.

DiscountedOptional
boolean

Whether the line is subject to a discount for tax base purposes.

EntityUseCodeOptional
string

Entity use code affecting exemption or tax treatment for this line.

CustomString4Optional
string

Extension string field 4 for line-level attributes.

CustomString5Optional
string

Extension string field 5 for line-level attributes.

CustomString6Optional
string

Extension string field 6 for line-level attributes.

CustomString7Optional
string

Extension string field 7 for line-level attributes.

CustomString8Optional
string

Extension string field 8 for line-level attributes.

CustomString9Optional
string

Extension string field 9 for line-level attributes.

CustomString10Optional
string

Extension string field 10 for line-level attributes.

CustomNumeric4Optional
number

Extension numeric field 4 for line-level attributes.

CustomNumeric5Optional
number

Extension numeric field 5 for line-level attributes.

CustomNumeric6Optional
number

Extension numeric field 6 for line-level attributes.

CustomNumeric7Optional
number

Extension numeric field 7 for line-level attributes.

CustomNumeric8Optional
number

Extension numeric field 8 for line-level attributes.

CustomNumeric9Optional
number

Extension numeric field 9 for line-level attributes.

CustomNumeric10Optional
number

Extension numeric field 10 for line-level attributes.

ExemptionCodeOptional
string

Code indicating a tax exemption reason or program for this line.

HsCodeOptional
string

Harmonized System (HS) tariff code for the product on this line.