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

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

Parameters
TransactionLinesOptional
array

Line-level results and inputs echoed for each item in the calculated transaction.

TransactionExchangeRatesOptional
array

Exchange rates applied when converting amounts across currencies on this transaction.

TranIdOptional
integer

The system-assigned identifier for this calculated transaction.

CompanyIdOptional
integer

The company context under which tax was calculated.

ProcessIndOptional
string

How the engine treated this run (for example estimate, commit, or reverse).

EffectiveDateOptional
string

The date tax rules and rates are evaluated against for this transaction.

InvoiceNumberOptional
string

The invoice or document number associated with this transaction.

InvoiceDateOptional
string

The invoice date supplied for this transaction.

FuelUseCodeOptional
string

The intended end use of fuel when fuel-specific excise rules apply.

TitleTransferCodeOptional
string

When title to the goods transfers for purposes of excise sourcing rules.

TransactionTypeOptional
string

The business nature of the transaction (for example sale, purchase, or transfer).

TransportationModeCodeOptional
string

The primary mode used to move the product (for example truck, rail, or pipeline).

AlternateTransportationModeOptional
string

A secondary or override transportation mode when multiple modes apply.

SellerIdOptional
integer

The seller party identifier in the host system when party-based rules apply.

BuyerIdOptional
integer

The buyer party identifier in the host system when party-based rules apply.

PreviousSellerIdOptional
integer

The upstream seller in a multi-leg supply chain, when modeled.

NextBuyerIdOptional
integer

The downstream buyer in a multi-leg supply chain, when modeled.

MiddlemanIdOptional
integer

An intermediary party in the chain when middleman rules apply.

CustomsStatusOptional
string

Customs or cross-border status affecting duty and excise treatment.

FormAPresentedIndOptional
string

Whether Form A or equivalent documentation was indicated for duty treatment.

SimplifiedProcedureIndOptional
string

Whether a simplified customs procedure applies to this movement.

IncotermsOptional
string

Incoterms governing risk, cost, and delivery for international trade context.

PerspectiveBusinessTypeOptional
string

The reporting or filing perspective used when determining tax (for example seller vs buyer).

ChainLegOptional
string

Identifies the position of this movement in a multi-hop supply chain.

OrderTypeOptional
string

The commercial order type influencing tax or exemption logic.

TotalDyedUnitsOptional
number

Total quantity of dyed fuel units across the transaction when dyed-fuel rules apply.

TotalTaxesOptional
number

The total calculated tax amount for the whole transaction.

TotalTaxesCurrencyOptional
string

The currency in which total tax is expressed.

TotalReportingTaxesOptional
number

Total tax restated in the reporting currency for compliance or GL posting.

ReportingCurrencyOptional
string

The currency used for reporting totals and related figures.

ReportingUnitOfMeasureOptional
string

The unit of measure used for reporting quantity on the transaction.

UserDataOptional
string

Opaque client data echoed on the transaction for integration or audit.

UserTranIdOptional
string

The client-supplied transaction identifier echoed in the response.

UserReturnedValueOptional
string

A value returned with the transaction for client-side correlation or downstream use.

SourceSystemOptional
string

The originating system name or code when transactions are federated.

CustomString1Optional
string

First client-defined string extension echoed on the transaction header.

CustomString2Optional
string

Second client-defined string extension echoed on the transaction header.

CustomString3Optional
string

Third client-defined string extension echoed on the transaction header.

CustomString4Optional
string

Fourth client-defined string extension echoed on the transaction header.

CustomString5Optional
string

Fifth client-defined string extension echoed on the transaction header.

CustomString6Optional
string

Sixth client-defined string extension echoed on the transaction header.

CustomString7Optional
string

Seventh client-defined string extension echoed on the transaction header.

CustomString8Optional
string

Eighth client-defined string extension echoed on the transaction header.

CustomString9Optional
string

Ninth client-defined string extension echoed on the transaction header.

CustomString10Optional
string

Tenth client-defined string extension echoed on the transaction header.

CustomNumeric1Optional
number

First client-defined numeric extension echoed on the transaction header.

CustomNumeric2Optional
number

Second client-defined numeric extension echoed on the transaction header.

CustomNumeric3Optional
number

Third client-defined numeric extension echoed on the transaction header.

CustomNumeric4Optional
number

Fourth client-defined numeric extension echoed on the transaction header.

CustomNumeric5Optional
number

Fifth client-defined numeric extension echoed on the transaction header.

CustomNumeric6Optional
number

Sixth client-defined numeric extension echoed on the transaction header.

CustomNumeric7Optional
number

Seventh client-defined numeric extension echoed on the transaction header.

CustomNumeric8Optional
number

Eighth client-defined numeric extension echoed on the transaction header.

CustomNumeric9Optional
number

Ninth client-defined numeric extension echoed on the transaction header.

CustomNumeric10Optional
number

Tenth client-defined numeric extension echoed on the transaction header.

CommitStatusOptional
string

Whether this transaction is committed, estimated, or in another lifecycle state in the host.

AvaTaxTransactionTypeOptional
string

The mapped AvaTax document type when results are bridged to AvaTax.

TotalDiscountOptional
number

The aggregate discount applied at the transaction level before or after tax, per product rules.