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

Response returned by Tax Session Create, GetByHeader, and Amend endpoints.

This model is used in the following APIs:

Parameters
CompanyNameOptional
string

The company name.

CompanyIdOptional
integer

The company context under which the session was created.

HeaderIdOptional
integer

The unique header identifier.

CountryOptional
string

The ISO 3166-1 alpha-3 country code.

JurisdictionOptional
string

The jurisdiction or state code.

TaxpayerTypeOptional
string

The taxpayer type code.

TaxpayerDescriptionOptional
string

The human-readable taxpayer type description.

TerminalCodeOptional
string

The terminal or facility code.

TrackingNumberOptional
string

The tracking number.

LocationIDOptional
integer

The location identifier.

ReturnCodeOptional
string

The return code.

ReturnEffectiveDateOptional
string

The effective date used for determining applicable return rules and rates.

StartDateOptional
string

The first day of the reporting period.

SequenceOptional
integer

The sequence number (0 = original, 1+ = amendments).

EndDateOptional
string

The last day of the reporting period.

DueDateOptional
string

The due date for filing the return.

FiledDateOptional
string

The date the return was filed, or null if not yet filed.

PurgedDateOptional
string

The date the session was purged, or null if not purged.

CriticalScheduleErrorsOptional
integer

The count of critical schedule-level errors.

ReturnGenerationNeededOptional
boolean

Whether the return needs to be regenerated.

ReturnStatusOptional
string

The calculation status of the return.

FrequencyTypeOptional
string

The filing frequency description (e.g. Monthly, Quarterly, Annual).

FrequencyTypeIndOptional
string

The filing frequency indicator character.

SessionSourceIndOptional
string

The session source indicator character.

SessionSourceOptional
string

The human-readable session source description.

SessionLockedOptional
boolean

Whether the session is locked from editing.

PurgeExcludeIndOptional
boolean

The purge-exclude indicator.

PreventArchiveandPurgeOptional
boolean

Whether archive and purge is prevented.

ReturnPdfSegmentCountOptional
integer

The number of PDF segments generated for the return.

GLReconGenerationNeededOptional
boolean

Whether GL reconciliation data needs to be generated.

LocationCountryOptional
string

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

LocationJurisdictionOptional
string

The jurisdiction or state code for the associated location.

LocationCountyOptional
string

The county name for the associated location.

LocationCountyCodeOptional
string

The county code for the associated location.

LocationCityOptional
string

The city name for the associated location.

LocationTerminalCodeOptional
string

The terminal code associated with the location.

LocationDescriptionOptional
string

A human-readable description of the associated location.

LocationCustomIdCodeOptional
string

A client-defined identifier for the associated location.

LocationAddressLine1Optional
string

The first line of the street address for the associated location.

LocationAddressLine2Optional
string

The second line of the street address for the associated location.

LocationPostalCodeOptional
string

The postal or ZIP code for the associated location.

LocationAirportCodeOptional
string

The airport code for the associated location, if applicable.

LocationAlternateJurisdictionOptional
string

An alternate jurisdiction designation for the associated location, when applicable.

FiledByOptional
string

The user who filed the return.

PreparedByOptional
string

The user who prepared the return.

ReviewedByOptional
string

The user who reviewed the return.

ApprovedByOptional
string

The user who approved the return.

LastGeneratedDateOptional
string

The date the return was last generated.

PostedDateOptional
string

The date the return was posted to GL or downstream systems.

WorkflowTaskOptional
string

The current workflow task code.

WorkflowTaskDescriptionOptional
string

The human-readable description of the current workflow task.

WorkflowNameOptional
string

The assigned workflow name.

TotalTaxOptional
number

The total calculated tax amount for the return.

CollectionAllowanceOptional
number

The collection allowance amount credited on the return.

TotalAmountDueOptional
number

The total amount due after taxes and allowances.

TaxpayerGroupOptional
string

The taxpayer group classification.

LicenseNumberOptional
string

The license or registration number.

SubmissionTypeOptional
string

The submission type indicator character.

SubmissionTypeDisplayOptional
string

The human-readable display name for the submission type.

ThresholdAmountOptional
number

The amount-due threshold for the return.

ReturnCalculationDateOptional
string

The date the return calculation was last performed.

LastDataFileUploadDateOptional
string

The date of the last data file upload.

LasteFileUploadDateOptional
string

The date of the last eFile upload.

IncludeSchedulesOptional
boolean

Whether schedules are included in the return.

CalculationViewIndOptional
string

The calculation view description.

BackEndIndOptional
boolean

Whether this is a back-end session.

AmmendmentTypeOptional
string

The amendment type (ORIGINAL or AMENDED).

EFileHeaderIdOptional
integer

The associated eFile header identifier, if an eFile has been created.

CreatedByOptional
string

The user who created the record.

CreatedDateOptional
string

The date and time the record was created.

UpdatedByOptional
string

The user who last updated the record.

UpdatedDateOptional
string

The date and time the record was last updated.