AvaTax for Excise

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

Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction

Represents a schedule transaction for excise reporting import, including session context, parties, locations, product details, and line-level taxes. Any changes to this structure will require a newly versioned class.

Parameters
SupplementalFieldsOptional
array

Additional field names supplied with the transaction beyond the standard properties.

SupplementalValuesOptional
array

Values corresponding to {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.SupplementalFields}, in the same order.

TaxSessionCountryCodeOptional
string

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

TaxSessionJurisdictionOptional
string

The jurisdiction or state code for the tax session.

TaxSessionTaxpayerTypeOptional
string

The taxpayer type for the tax session.

TaxSessionTerminalCodeOptional
string

The terminal code for the tax session.

TaxSessionLocationIdOptional
integer

The location identifier for the tax session.

ScheduleCodeOptional
string

The reporting schedule code.

ScheduleTypeOptional
string

The schedule type classification.

ProductCodeOptional
string

The product code identifier.

ModeCodeOptional
string

The transport or transaction mode code.

BillOfLadingOptional
string

The bill of lading number.

BillOfLadingDateOptional
string

The bill of lading date.

InvoiceNumberOptional
string

The invoice number.

InvoiceDateOptional
string

The invoice date.

OriginOptional
Avalara.Excise.Common.Contracts.Services.RestLocation

The origin location for the movement or transaction.

DestinationOptional
Avalara.Excise.Common.Contracts.Services.RestLocation

The destination location for the movement or transaction.

DiversionDestinationOptional
Avalara.Excise.Common.Contracts.Services.RestLocation

The diversion destination location, when the shipment is diverted.

PointOfOrderAcceptanceOptional
Avalara.Excise.Common.Contracts.Services.RestLocation

The location where the order was accepted.

PointOfOrderOriginOptional
Avalara.Excise.Common.Contracts.Services.RestLocation

The location where the order originated.

DiversionNumberOptional
string

The diversion reference number.

NetUnitsOptional
number

The net quantity in the stated unit of measure.

GrossUnitsOptional
number

The gross quantity in the stated unit of measure.

BilledUnitsOptional
number

The billed quantity in the stated unit of measure.

UnitOfMeasureOptional
string

The unit of measure for quantity fields.

BuyerOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The buyer business entity on the transaction.

SellerOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The seller business entity on the transaction.

ConsignorOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The consignor business entity on the transaction.

CarrierOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The carrier business entity on the transaction.

ExchangePositionOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The exchange position business entity, when applicable.

PositionHolderOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The position holder business entity, when applicable.

ImporterOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The importer business entity on the transaction.

MiddleManOptional
Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

The middleman or intermediary business entity on the transaction.

FuelUseCodeOptional
string

The fuel use code for the product or movement.

ProductSubsetCodeOptional
string

The product subset code for more specific classification.

UnitPriceOptional
number

The unit price for the product line.

TaxCollectedOptional
number

The tax amount collected on the line.

CurrencyOptional
string

The currency code for monetary amounts.

ExchangeIndOptional
string

Whether the transaction is an exchange transaction.

Enum: Y, N
SourceSystemIdOptional
string

The identifier of the record in the source system.

LoadIdOptional
string

The unique identifier grouping this line with its import batch.

SequenceIdOptional
string

The sequence identifier for ordering lines within a load.

OriginIdOptional
integer

The origin location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Origin} object.

DestinationIdOptional
integer

The destination location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Destination} object.

DiversionDestinationIdOptional
integer

The diversion destination location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.DiversionDestination} object.

PointOfOrderAcceptanceIdOptional
integer

The point-of-order-acceptance location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.PointOfOrderAcceptance} object.

PointOfOrderOriginIdOptional
integer

The point-of-order-origin location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.PointOfOrderOrigin} object.

BuyerIdOptional
integer

The buyer business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Buyer} object.

SellerIdOptional
integer

The seller business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Seller} object.

ConsignorIdOptional
integer

The consignor business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Consignor} object.

CarrierIdOptional
integer

The carrier business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Carrier} object.

ExchangePositionIdOptional
integer

The exchange position business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.ExchangePosition} object.

PositionHolderIdOptional
integer

The position holder business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.PositionHolder} object.

ImporterIdOptional
integer

The importer business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Importer} object.

ActivityDateOptional
string

The business activity date for the transaction.

AllowanceCodeOptional
string

The allowance or credit code applied to the line.

BaseProductOptional
string

The base product code for blend reporting.

BaseProductUnitsOptional
number

The quantity of the base blend component.

BlendProduct1Optional
string

The first blend component product code.

BlendProduct1UnitsOptional
number

The quantity of the first blend component.

BlendProduct2Optional
string

The second blend component product code.

BlendProduct2UnitsOptional
number

The quantity of the second blend component.

BlendProduct3Optional
string

The third blend component product code.

BlendProduct3UnitsOptional
number

The quantity of the third blend component.

BlendToProductCodeOptional
string

The product code of the blend result or target product.

CustomIdOptional
string

A custom identifier for the line or shipment.

ExemptionTypeOptional
string

The exemption category or type, when the line is exempt or partially exempt.

PaymentDateOptional
string

The payment date associated with the transaction.

PurchaseDateOptional
string

The purchase date associated with the transaction.

TitleTransferOptional
string

Indicates how or where title transferred for the product.

SystemOfRecordOptional
string

The system or application that is the authoritative source for this data.

FilingEntityOptional
string

The entity responsible for filing or reporting this transaction.

SystemOfRecordProductCodeOptional
string

The product code as recorded in the system of record.

StampAttributeOptional
string

The stamp or fiscal attribute associated with the product line.

ProductTobaccoOptional
Avalara.Excise.Common.Contracts.Services.RestProductTobacco

Tobacco-specific product attributes when the line is a tobacco product.

ProductTobaccoIdOptional
integer

The identifier linking to tobacco product detail when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.ProductTobacco} object.

ManufacturerOptional
Avalara.Excise.Common.Contracts.Services.RestManufacturer

The manufacturer associated with the product line.

ManufacturerIdOptional
integer

The manufacturer identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Manufacturer} object.

DocumentTypeOptional
string

The type of supporting document for the transaction.

ItemCodeOptional
Avalara.Excise.Common.Contracts.Services.RestItemCode

The item code reference for the product line.

ItemCodeIdOptional
integer

The item code identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.ItemCode} object.

SalesAmountOptional
number

The sales amount for the line.

TranIdOptional
integer

The internal transaction identifier after persistence.

TransactionLineOptional
integer

The line number of the transaction within the schedule or import batch.

TaxesOptional
array

The tax breakdown lines applied to this schedule transaction.