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

Represents the response data for a REST transaction line, containing calculated results and processed transaction line information.

Parameters
TransactionLineMeasuresOptional
array

Supplemental measures (density, temperature, and similar) used in tax determination for this line.

OriginSpecialJurisdictionsOptional
array

Additional taxing jurisdictions applied at the origin when special sourcing rules apply.

DestinationSpecialJurisdictionsOptional
array

Additional taxing jurisdictions applied at the destination when special sourcing rules apply.

SaleSpecialJurisdictionsOptional
array

Additional taxing jurisdictions applied at the sale location when special sourcing rules apply.

TransactionLineOptional
integer

The line index within the transaction used to correlate taxes and errors.

InvoiceLineOptional
integer

The invoice line index when it differs from the transaction line sequence.

BillOfLadingNumberOptional
string

The shipping document identifier tied to this movement, when provided.

BillOfLadingDateOptional
string

The date on the bill of lading or equivalent shipping document.

MovementStartDateOptional
string

The start of the movement or delivery window for this line.

MovementEndDateOptional
string

The end of the movement or delivery window for this line.

ProductCodeOptional
string

The primary product identifier used to match excise product rules.

AlternateProductCodeOptional
string

An alternate catalog or host code for the same product when multiple identifiers exist.

AlternativeFuelContentOptional
number

The share of alternative fuel content when blend or bifuel rules apply.

BlendToProductCodeOptional
string

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

BlendToAltProductCodeOptional
string

The alternate code for the blend target product when applicable.

BlendToAltFuelContentOptional
number

The alternative fuel content of the blend target when relevant to the calculation.

BlendToIndOptional
string

Whether this line is modeled as blending into another product.

Enum: Y, N
UnitPriceOptional
number

The price per primary unit of measure before tax.

AlternateUnitPriceOptional
number

The price per unit in the alternate unit of measure when dual pricing is used.

NetUnitsOptional
number

The quantity after deductions (returns, losses) used as a tax basis when applicable.

GrossUnitsOptional
number

The total physical quantity before deductions on this line.

BilledUnitsOptional
number

The quantity invoiced or charged to the customer on this line.

UnitOfMeasureOptional
string

The primary unit of measure for net, gross, or billed quantities.

AlternateUnitOfMeasureOptional
string

The alternate unit of measure for quantity reporting or conversion.

UnitQuantityOptional
number

A distinct quantity basis (for example per-container count) used alongside weight or volume.

UnitQuantityUnitOfMeasureOptional
string

The unit of measure for the unit quantity value.

UnitQuantityAltUnitOfMeasureOptional
string

The alternate unit of measure for the unit quantity value.

UnitVolumeOptional
number

The volume of one selling unit (for example per bottle or drum).

UnitVolumeUnitOfMeasureOptional
string

The unit of measure for unit volume.

UnitVolumeAltUnitOfMeasureOptional
string

The alternate unit of measure for unit volume.

UnitWeightOptional
number

The weight of one selling unit when weight-based rules apply.

UnitWeightUnitOfMeasureOptional
string

The unit of measure for unit weight.

UnitWeightAltUnitOfMeasureOptional
string

The alternate unit of measure for unit weight.

UnitLengthOptional
number

The length of one selling unit when length-based rules apply.

UnitLengthUnitOfMeasureOptional
string

The unit of measure for unit length.

UnitLengthAltUnitOfMeasureOptional
string

The alternate unit of measure for unit length.

LineAmountOptional
number

The extended line value in the line currency before or after tax per product configuration.

AlternateLineAmountOptional
number

The line value expressed in an alternate currency or basis when dual amounts are returned.

FreightUnitPriceOptional
number

The freight rate per freight unit for this line.

FreightTypeOptional
string

The kind of freight charge (for example prepaid, collect) affecting tax treatment.

FreightLineAmountOptional
number

The total freight charge allocated to this line.

CurrencyOptional
string

The currency in which line monetary amounts are expressed.

OriginCountryCodeOptional
string

The country from which the product ships or originates for sourcing.

OriginJurisdictionOptional
string

The state or province of the origin location.

OriginCountyOptional
string

The county of the origin location when sub-state sourcing applies.

OriginCityOptional
string

The city of the origin location.

OriginPostalCodeOptional
string

The postal or ZIP code of the origin location.

OriginTypeOptional
string

The category of origin site (for example terminal, rack, or retail).

OriginIdOptional
integer

The host-system identifier for the origin location when locations are master-managed.

OriginOutCityLimitIndOptional
string

Whether the origin lies outside incorporated city limits for local tax boundaries.

OriginCustomIdOptional
string

A client-defined origin location key echoed in the response.

OriginSpecialJurisdictionIndOptional
string

Whether additional origin special jurisdictions are in effect on this line.

OriginExciseWarehouseOptional
string

The bonded or excise warehouse identifier at origin when duty suspension applies.

OriginAddress1Optional
string

The first line of the street address at origin.

OriginAddress2Optional
string

The second line of the street address at origin.

OriginAirportCodeOptional
string

The IATA or system airport code when origin is an air node.

DestinationCountryCodeOptional
string

The country where the product is delivered or consumed for sourcing.

DestinationJurisdictionOptional
string

The state or province of the destination location.

DestinationCountyOptional
string

The county of the destination location when sub-state sourcing applies.

DestinationCityOptional
string

The city of the destination location.

DestinationPostalCodeOptional
string

The postal or ZIP code of the destination location.

DestinationTypeOptional
string

The category of destination site (for example delivery point or retail outlet).

DestinationIdOptional
integer

The host-system identifier for the destination location when locations are master-managed.

DestinationOutCityLimitIndOptional
string

Whether the destination lies outside incorporated city limits for local tax boundaries.

DestinationCustomIdOptional
string

A client-defined destination location key echoed in the response.

DestinationSpecialJurisdictionIndOptional
string

Whether additional destination special jurisdictions are in effect on this line.

DestinationExciseWarehouseOptional
string

The bonded or excise warehouse identifier at destination when duty suspension applies.

DestinationAddress1Optional
string

The first line of the street address at destination.

DestinationAddress2Optional
string

The second line of the street address at destination.

DestinationAirportCodeOptional
string

The IATA or system airport code when destination is an air node.

SaleCustomIdOptional
string

A client-defined key for the place of sale echoed in the response.

SaleCountryCodeOptional
string

The country where the retail or point-of-sale event occurs when sale sourcing is used.

SaleJurisdictionOptional
string

The state or province of the sale location.

SaleCountyOptional
string

The county of the sale location when sub-state sourcing applies.

SaleCityOptional
string

The city of the sale location.

SalePostalCodeOptional
string

The postal or ZIP code of the sale location.

SaleTypeOptional
string

The category of sale site (for example store, kiosk, or online).

SaleLocationOptional
string

The host or client code identifying the specific sale outlet or register.

SaleOutCityLimitIndOptional
string

Whether the sale location lies outside incorporated city limits for local tax boundaries.

SaleSpecialJurisdictionIndOptional
string

Whether additional sale-location special jurisdictions are in effect on this line.

SaleExciseWarehouseOptional
string

The bonded or excise warehouse identifier at the sale location when applicable.

SaleAddress1Optional
string

The first line of the street address at the sale location.

SaleAddress2Optional
string

The second line of the street address at the sale location.

SaleAirportCodeOptional
string

The IATA or system airport code when the sale location is an air node.

CounterCustomIdOptional
string

A client-defined key for the counterparty location echoed in the response.

CounterCountryCodeOptional
string

The country of the counterparty for party-based sourcing or licensing.

CounterJurisdictionOptional
string

The state or province of the counterparty location.

CounterCountyOptional
string

The county of the counterparty location when sub-state rules apply.

CounterCityOptional
string

The city of the counterparty location.

CounterPostalCodeOptional
string

The postal or ZIP code of the counterparty location.

CounterTypeOptional
string

The category of counterparty site (for example dealer, distributor, or end user).

CounterPartyOptional
string

The host or client identifier for the counterparty when party master data is used.

CounterOutCityLimitIndOptional
string

Whether the counterparty lies outside incorporated city limits for local tax boundaries.

CounterSpecialJurisdictionIndOptional
string

Whether additional counterparty special jurisdictions are in effect on this line.

CounterExciseWarehouseOptional
string

The bonded or excise warehouse identifier associated with the counterparty when applicable.

CounterFiscalRepIndOptional
string

Whether a fiscal representative is indicated for the counterparty under EU or similar rules.

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 system airport code when the counterparty location is an air node.

UserDataOptional
string

Opaque client-defined payload echoed with this line in the response.

CustomString1Optional
string

First client-defined string extension returned on this line.

CustomString2Optional
string

Second client-defined string extension returned on this line.

CustomString3Optional
string

Third client-defined string extension returned on this line.

CustomString4Optional
string

Fourth client-defined string extension returned on this line.

CustomString5Optional
string

Fifth client-defined string extension returned on this line.

CustomString6Optional
string

Sixth client-defined string extension returned on this line.

CustomString7Optional
string

Seventh client-defined string extension returned on this line.

CustomString8Optional
string

Eighth client-defined string extension returned on this line.

CustomString9Optional
string

Ninth client-defined string extension returned on this line.

CustomString10Optional
string

Tenth client-defined string extension returned on this line.

CustomNumeric1Optional
number

First client-defined numeric extension returned on this line.

CustomNumeric2Optional
number

Second client-defined numeric extension returned on this line.

CustomNumeric3Optional
number

Third client-defined numeric extension returned on this line.

CustomNumeric4Optional
number

Fourth client-defined numeric extension returned on this line.

CustomNumeric5Optional
number

Fifth client-defined numeric extension returned on this line.

CustomNumeric6Optional
number

Sixth client-defined numeric extension returned on this line.

CustomNumeric7Optional
number

Seventh client-defined numeric extension returned on this line.

CustomNumeric8Optional
number

Eighth client-defined numeric extension returned on this line.

CustomNumeric9Optional
number

Ninth client-defined numeric extension returned on this line.

CustomNumeric10Optional
number

Tenth client-defined numeric extension returned on this line.

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 prices on this line.

DiscountAmountOptional
number

Discount amount applied to this line for tax base or pricing purposes.