Creates a new alternate product code record. The alternate product is validated and sanitized
before insertion.

x-company-id

Identifies the software you are using to call this API. For more information on the client header, see <a href="https://developer.avalara.com/avatax/client-headers/">Client Headers</a>.

X-Avalara-Client

request

Returns an error if the request is invalid.

Updates an existing alternate product code record. The record is looked up by its composite
primary key.

Returns an error if the alternate product is not found.

Updates an existing alternate product record.

Deletes an existing alternate product code record. The record is looked up by its composite
primary key.

Deletes an existing alternate product record.

Creates a new AvaTax Excise transaction and calculates the applicable taxes. The transaction
is processed by the determination engine and the calculated tax results are returned.

transaction

Specifies one or more options to include additional nested data in the response. Separate multiple values with commas.

include

Returns the calculated tax results and transaction details for the created transaction.

Creates and calculates taxes for an AvaTax Excise transaction.

Creates a new transaction or adjusts an existing one, then recalculates the applicable taxes.
If a transaction with the same transaction code already exists, it is adjusted; otherwise a new
transaction is created.

Returns the calculated tax results and transaction details for the created or adjusted transaction.

Alters and recalculates taxes for an existing AvaTax Excise transaction.

Adjusts an existing transaction identified by the transaction code and recalculates the applicable taxes.
The adjustment request contains the corrected transaction data that replaces the original.

The unique value that identifies a transaction.

transactionCode

Returns the calculated tax results and transaction details for the adjusted transaction.

Commits a previously created AvaTax Excise transaction, making it final. Once committed,
the transaction is locked and can only be voided, not further adjusted.

Returns the calculated tax results and transaction details for the committed transaction.

Commits an existing AvaTax Excise transaction.

Voids a previously committed AvaTax Excise transaction. Voiding reverses the tax effects
of the transaction while preserving the transaction record for audit purposes.

Returns the calculated tax results and transaction details for the voided transaction.

Voids a committed AvaTax Excise transaction.

Updates the tax return data for an existing transaction identified by the transaction code.
This allows correction of return-specific fields without recalculating the entire transaction.

Returns the calculated tax results and transaction details after updating return data.

Updates the tax return data for the specified transaction.

Submits an array of transactions for tax calculation. Each transaction is processed by the
determination engine and tax results are returned for all submitted transactions.
            
The number of transactions in a single request is limited by a configurable maximum transaction count.

transactions

Returns a summary of processing results for the submitted transactions.

The number of transactions exceeds the maximum allowed per request.

Calculates taxes for an array of AvaTax Excise transactions.

Uploads a license image file for the specified business account. The file must be a valid image type
as defined by the site settings. If the business account already has a license image, the previous
image is replaced and the old file is removed from storage.
            
The request must be a multipart/form-data request containing exactly one image file.

accountId

Returns a response indicating the result of the upload operation.

Upload a license image for a business account.

Imports business entity records and their associated business accounts into the Excise Platform.
The import engine processes the provided entities and returns a summary of the results including
inserted, updated, and failed records.
            
The request supports options for matching existing business entities and controlling whether
new records are terminated and whether all account types are created.

Returns a summary of the business entity import results.

Import business entities and associated business accounts.

Permanently deletes a business entity and its associated business accounts by the entity's unique identifier.
The entity must belong to the current master company and must not be locked or in use by profiles,
scenarios, or business profile details. Associated location cross-references and comments are also deleted.

The unique identifier of the business entity to delete.

businessEntityId

Returns a message indicating the result of the delete operation.

The business entity was not found, does not belong to the current company, or is locked.

Delete unlocked or unused business entities and associated business accounts.

Retrieves the details of a single import job by its load ID. Returns information such as the job status,
total batches, source records, inserted records, and processing time.

loadId

Retrieves a filtered and paginated list of import job headers. You can filter by load ID, status,
description, batch counts, record counts, processing time, and unassigned document ID.
            
Use the offset and limit parameters to paginate through large result sets, and the sort parameter
to control the ordering of results.

statusInd

description

totalBatches

The number of batches with a status of Passed.

totalPassedBatches

The number of batches with a status of Failed.

totalFailedBatches

totalSourceRecords

totalInsertedRecords

The elapsed time for the import in seconds

processTimeElapsedSeconds

unassignedDocumentId

Specifies the sort criteria for the results.

sort

Specifies the number of rows to skip before returning results.

offset

Specifies the maximum number of results to return.

limit

Returns a collection of import job headers that match the specified filters.

Retrieves a filtered and paginated list of import job headers based on the date the job was loaded
or deleted. You can also filter by job status.
            
Use the offset and limit parameters to paginate through large result sets, and the sort parameter
to control the ordering of results.

loadOnDate

deletedOnDate

Returns a collection of import job headers filtered by load or deleted date.

Gets import job headers by load date or deleted date.

Downloads a ZIP file containing the unassigned schedule transactions for the specified import job.
If no unassigned transactions exist for the given load ID, an empty response is returned.

Returns the unassigned schedule transaction file for the specified import.

Downloads the unassigned schedule transaction file for an import.

Imports item code records into the Excise Platform. The import engine processes the provided
item codes and returns a summary of the results including inserted, updated, and failed records.

Returns a summary of the item code import results.

Permanently deletes an item code by its unique identifier. The item code must belong to the current
master company and must not be locked.

The unique identifier of the item code to delete.

itemCodeId

The item code was not found, does not belong to the current company, or is locked.

Imports location records into the Excise Platform. The import engine processes the provided
locations and returns a summary of the results including inserted, updated, and failed records.
            
The request supports options for matching existing locations by various fields such as country code,
jurisdiction, description, address, airport code, and more.

Returns a summary of the location import results.

Permanently deletes a location by its unique identifier. The location must belong to the current
master company and must not be locked or in use by profiles, scenarios, cross-references, or company accounts.
Associated location alternates and special jurisdictions are also deleted.

The unique identifier of the location to delete.

locationId

The location was not found, does not belong to the current company, or is locked.

Imports manufacturer records into the Excise Platform. The import engine processes the provided
manufacturers and returns a summary of the results including inserted, updated, and failed records.
            
The request supports options for matching existing manufacturers and controlling how jurisdiction
data is updated during the import.

Returns a summary of the manufacturer import results.

Imports tobacco product records into the Excise Platform. The import engine processes the provided
tobacco products and returns a summary of the results including inserted, updated, and failed records.
            
If manufacturer assignment is enabled, manufacturers are imported first and linked to their
corresponding tobacco products before the product import is executed.

Returns a summary of the tobacco product import results.

Permanently deletes a tobacco product by its unique identifier. The product must belong to the
current master company and must not be locked.

The unique identifier of the tobacco product to delete.

ProductTobaccoId

The product was not found, does not belong to the current company, or is locked.

Accepts a multipart file upload containing schedule transaction data. The uploaded file is stored
and a scheduled task is created to process the import asynchronously.
            
Monitor the System Activity Logs for processing status and results.

Accepts a JSON request containing schedule transaction records to import. The request is serialized
and stored, then a scheduled task is created to process the import asynchronously.
            
The import supports batching - multiple batches can be sent with the same load ID. Options include
business entity matching, location matching, tobacco product matching, manufacturer matching,
workflow reset, and email notifications at various import steps.
            
Monitor the System Activity Logs for processing status and results.

Returns a message indicating the result of the schedule transaction import.

Returns the list of jurisdictions that are licensed for Returns for the specified country code.
Only jurisdictions accessible to the current user and master company are included.

The country code used to retrieve acceptable jurisdictions.

countryCode

Returns a list of acceptable jurisdictions for the specified country.

Gets a list of jurisdictions licensed for returns for the current master company and user.

Sends a notification email to the specified recipient with information about an import job.
The notification includes the import step, job status, summary, and description details.
            
Returns true if the email was sent successfully, or false otherwise.

The recipient of the notification message.

messageRecipient

The import step associated with the notification.

importStep

The status associated with the notification.

status

The summary information for the job included in the notification.

jobSummary

The detailed description of the job included in the notification.

jobDescription

Returns true if the notification request was processed successfully.

Requests that a notification message be sent.

Returns all licensed rates that have been modified since the specified start date. Results can be
optionally filtered by country code, jurisdiction, tax type, rate subtype, and master company ID.
            
This endpoint is useful for keeping an external system in sync with rate changes in the Excise Platform.

The start date and time used to retrieve rates changed after this point.

startDate

The country code used to filter the rates.

The jurisdiction used to filter the rates.

jurisdiction

taxType

The rate subtype used to filter the rates.

rateSubtype

The master company ID used to filter the rates.

masterCompanyId

Returns a list of rates that were changed since the specified date.

Gets a list of licensed rates that have been changed since the specified date.

Returns the list of taxpayer types that are valid for the specified country code and jurisdiction
within the current master company. An optional activity date can be provided to filter results
to taxpayer types that are active as of that date.

The country code used to retrieve acceptable taxpayer types.

The jurisdiction used to retrieve acceptable taxpayer types.

The activity date used to filter acceptable taxpayer types.

activityDate

Returns a list of acceptable taxpayer types for the specified criteria.

Gets a list of licensed taxpayer types for the current master company.

Check connectivity to the Excise Platform API and return information about the API server.
            
This API is intended to help you verify that your connection is working. This API will always succeed and will
never return an error. It provides basic information about the server you connect to:
            
* `version` - The version number of the Excise Platform API server that responded to your request.
* `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request.
* `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.

Returns service version information and authentication status.

Tests connectivity and the version of the service.

Looks up the company ID for a given company name. The requesting user must have access to the specified company.

The name of the company for which to retrieve the company ID.

companyName

Returns the company ID associated with the specified company name.

The company was not found or the user does not have access.

Returns the company ID for the requested company name, if the user has access to that company.

Returns a list of master company details that the requesting user has access to. Only non-obsolete, licensed
master companies are included. The effective date must not be in the future.
            
Each result includes the master company ID, name, deployment status, active status, and licensing information
for Returns Excise and AvaTax Excise products.

The effective date used to determine accessible master companies.

effectiveDate

Returns a list of master company details available to the requesting user.

Returns a list of all non-obsolete licensed master company IDs that the requesting user has access to as of the requested date.

Maps to process_time_elapsed_seconds as int

Maps to sti_version_number as nvarchar(255)

Represents a request object for importing business entities through the REST service.
This class contains all the necessary information to perform a business entity import operation,
including the entities to import, import configuration options, and matching behavior settings.

Gets or sets an array of business entities to be imported.
Each business entity contains the data that will be processed and imported into the system.

Gets or sets a boolean value indicating whether all account types should be created for imported entities.
When true, the system will automatically create all supported account types for each imported business entity.

Gets or sets the name identifier for this import operation.
This name is used to identify and track the import operation in logs and reports.

Gets or sets the unique identifier for this import load operation.
This GUID is used to correlate related import operations and track the overall import process.

Gets or sets a boolean value indicating whether new records should be terminated after import.
When true, newly imported records will be marked as terminated, typically used for historical data imports.

Gets or sets the update matching mode that determines how existing records are handled during import.
This setting controls whether and how the system should match and update existing business entities
when duplicates are found during the import process.

Represents a request object for importing item codes through the REST service.
This class contains all the necessary information to perform an item code import operation,
including the item codes to import, import configuration options, and matching behavior settings.

Gets or sets an array of item codes to be imported.
Each item code contains the data that will be processed and imported into the system
for tax classification and product identification purposes.

Gets or sets the update matching mode that determines how existing records are handled during import.
This setting controls whether and how the system should match and update existing item codes
when duplicates are found during the import process.

Represents a request object for importing location data through the REST service.
This class contains all the necessary information to perform a location import operation,
including the locations to import, import configuration options, matching behavior settings,
and exact match criteria for various location attributes.

Gets or sets a boolean value indicating whether to require exact matching on address line 1.
When true, only locations with identical first address lines will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on address line 2.
When true, only locations with identical second address lines will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on airport code.
When true, only locations with identical airport codes will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on alternate facility number.
When true, only locations with identical alternate facility numbers will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on alternate jurisdiction.
When true, only locations with identical alternate jurisdictions will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on city.
When true, only locations with identical cities will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on country code.
When true, only locations with identical country codes will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on county name.
When true, only locations with identical county names will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on county code.
When true, only locations with identical county codes will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on depot number.
When true, only locations with identical depot numbers will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on description.
When true, only locations with identical descriptions will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on jurisdiction.
When true, only locations with identical jurisdictions will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on location type.
When true, only locations with identical location types will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on outside city limit indicator.
When true, only locations with identical outside city limit indicators will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on postal code.
When true, only locations with identical postal codes will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on site code.
When true, only locations with identical site codes will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on special jurisdiction indicator.
When true, only locations with identical special jurisdiction indicators will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on state assigned code.
When true, only locations with identical state assigned codes will be considered matches.

Gets or sets an array of locations to be imported.
Each location contains the data that will be processed and imported into the system
for tax compliance and regulatory reporting purposes.

Gets or sets the update matching mode that determines how existing records are handled during import.
This setting controls whether and how the system should match and update existing locations
when duplicates are found during the import process.

Represents a request object for importing manufacturer data through the REST service.
This class contains all the necessary information to perform a manufacturer import operation,
including the manufacturers to import, import configuration options, matching behavior settings,
and jurisdiction update preferences.

Gets or sets a boolean value indicating whether to require exact matching on country code.
When true, only manufacturers with identical country codes will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on custom ID.
When true, only manufacturers with identical custom IDs will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on ID type and ID code.
When true, only manufacturers with identical ID type and ID code combinations will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on jurisdiction.
When true, only manufacturers with identical jurisdictions will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on legal name.
When true, only manufacturers with identical legal names will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on license number.
When true, only manufacturers with identical license numbers will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on manufacturer code.
When true, only manufacturers with identical manufacturer codes will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on MSA status.
When true, only manufacturers with identical Metropolitan Statistical Area status will be considered matches.

Gets or sets a boolean value indicating whether to require exact matching on trade name.
When true, only manufacturers with identical trade names will be considered matches.

Gets or sets the manufacturer jurisdiction update mode that controls how jurisdiction information
is updated during the import process.

Gets or sets an array of manufacturers to be imported.
Each manufacturer contains the data that will be processed and imported into the system
for tax compliance and regulatory reporting purposes.