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

Represents tax information for a REST transaction, including tax rates, amounts, jurisdictions, and calculation details.

Parameters
TransactionTaxAmountsOptional
array

Currency-level tax amounts that sum to this tax line when multiple currencies apply.

SequenceIdOptional
integer

The sequence of this tax line within the transaction tax breakdown.

TransactionLineOptional
integer

The transaction line index this tax applies to, if the tax is line-specific.

InvoiceLineOptional
integer

The invoice line index this tax applies to, when distinct from the transaction line.

CountryCodeOptional
string

The country for which this tax was determined.

JurisdictionOptional
string

The primary jurisdiction (for example state or province) for this tax.

LocalJurisdictionOptional
string

The local jurisdiction (for example city or county) when tax is levied below the primary level.

ProductCategoryOptional
number

The product category used when matching this line to tax rules.

TaxingLevelOptional
string

The government level at which this tax applies (for example federal, state, or local).

TaxTypeOptional
string

The category of tax (for example excise, sales, or VAT).

RateTypeOptional
string

How the rate is expressed (for example ad valorem, per unit, or specific).

RateSubtypeOptional
string

A finer classification of the rate within the rate type.

CalculationTypeIndOptional
string

Indicates how the engine computed this tax (for example standard, bracket, or override).

TaxRateOptional
number

The effective tax rate applied.

TaxQuantityOptional
number

The quantity basis used to compute this tax.

TaxAmountOptional
number

The tax amount for this line in the primary result currency before per-currency splits.

TaxExemptionIndOptional
string

Whether this line is exempt or how exemption was applied.

DeferredIndOptional
string

Whether collection or liability for this tax is deferred.

PayableToCodeOptional
string

The remittance destination or party type for this tax (for example jurisdiction or vendor).

SalesTaxBaseAmountOptional
number

The taxable base used when sales or similar tax logic applies.

LicenseNumberOptional
string

The license identifier tied to this tax determination when licensing rules apply.

UserReturnedValueOptional
string

A client- or system-provided value echoed on this tax line for correlation.

ScenarioIdOptional
integer

The rule scenario that produced this tax line, when scenario-based determination is used.

ScenarioTaxGroupIdOptional
integer

The scenario tax group that produced this line, when grouping applies.

ScenarioSequenceOptional
integer

The ordering of this line within its scenario tax group.

RateDescriptionOptional
string

Human-readable text describing the applied rate or bracket.

CurrencyOptional
string

The currency in which the primary tax figures on this line are expressed.

UnitOfMeasureOptional
string

The unit of measure for quantity-based rate application on this line.

SubtotalIndOptional
string

Whether this line represents a subtotal or roll-up for display or reporting.

StatusCodeOptional
string

The processing status of this record.

QuantityIndOptional
string

How quantity was interpreted for this tax line (for example gross, net, or billed).

ReportingTaxAmountOptional
number

The tax amount restated in the reporting currency for compliance or ledger use.

ReportingTaxQuantityOptional
number

The tax quantity restated for reporting purposes.

ReportingTaxRateOptional
number

The effective rate in reporting terms when it differs from the transaction currency rate.

ReportingTaxCurrencyOptional
string

The currency used for reporting tax figures on this line.

ReportingUnitOfMeasureOptional
string

The unit of measure used for reporting quantity on this line.

EntityUseCodeOptional
string

The buyer entity use or exemption code that influenced this determination.

CustomString1Optional
string

First client-defined string extension returned on this tax line.

CustomString2Optional
string

Second client-defined string extension returned on this tax line.

CustomString3Optional
string

Third client-defined string extension returned on this tax line.

CustomNumeric1Optional
number

First client-defined numeric extension returned on this tax line.

CustomNumeric2Optional
number

Second client-defined numeric extension returned on this tax line.

CustomNumeric3Optional
number

Third client-defined numeric extension returned on this tax line.

TaxCodeOptional
string

The product or tax product code that drove this determination.

RateCodeOptional
string

The rate table or schedule code applied to this line.

VatCodeOptional
string

The VAT classification code when value-added tax rules apply.

PaymentTermsOptional
string

Payment terms associated with this tax line for accrual or cash-basis logic.

AccountMappingOptional
string

General ledger or ERP account mapping suggested for this tax.

RecoverabilityPercentageOptional
number

The percentage of this tax that is recoverable for the buyer, when applicable.

RecoverableAmountOptional
number

The portion of the tax that is recoverable in recoverability scenarios.

NonRecoverableAmountOptional
number

The portion of the tax that is not recoverable in recoverability scenarios.

BuyerLicenseNumberOptional
string

The buyer license identifier used or validated for this tax line.

BuyerLicenseDescriptionOptional
string

The description of the buyer license tied to this line.

SellerLicenseNumberOptional
string

The seller license identifier used or validated for this tax line.

SellerLicenseDescriptionOptional
string

The description of the seller license tied to this line.

MiddlemanLicenseNumberOptional
string

The middleman or intermediary license identifier when the chain includes one.

MiddlemanLicenseDescriptionOptional
string

The description of the middleman license tied to this line.

CustomString4Optional
string

Fourth client-defined string extension returned on this tax line.

CustomString5Optional
string

Fifth client-defined string extension returned on this tax line.

CustomString6Optional
string

Sixth client-defined string extension returned on this tax line.

CustomString7Optional
string

Seventh client-defined string extension returned on this tax line.

CustomString8Optional
string

Eighth client-defined string extension returned on this tax line.

CustomString9Optional
string

Ninth client-defined string extension returned on this tax line.

CustomString10Optional
string

Tenth client-defined string extension returned on this tax line.

CustomNumeric4Optional
number

Fourth client-defined numeric extension returned on this tax line.

CustomNumeric5Optional
number

Fifth client-defined numeric extension returned on this tax line.

CustomNumeric6Optional
number

Sixth client-defined numeric extension returned on this tax line.

CustomNumeric7Optional
number

Seventh client-defined numeric extension returned on this tax line.

CustomNumeric8Optional
number

Eighth client-defined numeric extension returned on this tax line.

CustomNumeric9Optional
number

Ninth client-defined numeric extension returned on this tax line.

CustomNumeric10Optional
number

Tenth client-defined numeric extension returned on this tax line.