AvaTax for Excise
Excise Platform API Models
| Model | Summary |
|---|---|
Data Contract Class - StImportHeaderDC | |
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. | |
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. | |
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. | |
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. | |
Represents the response from a ping operation to verify service connectivity and authentication status. This class is used to check if the service is available and if the current user is properly authenticated. | |
This is the request object for the REST service | |
Represents an alternate product mapping for REST services, containing product codes, jurisdictions, and tax information. | |
Represents a business account (license or registration) tied to a business entity for excise tax purposes. | |
Represents an error that occurred during import for a business account. | |
Represents the import result for a business account, including status and any error details. | |
Data Contract Class - BusinessEntityDC for REST services. This class represents a business entity with associated accounts and identification information. Business entities can become obsolete over time, managed through the IObsoletable interface. | |
Represents an error that occurred during import for a business entity. | |
Represents business entity identification codes for REST services, containing ID types and codes by country. | |
Represents an error that occurred during import for a business entity identification code. | |
Represents the import result for a business entity identification code, including status and any error details. | |
Summarizes the results of a business entity import operation, including counts and per-record results. | |
Represents the import result for a business entity, including status and any error details. | |
Represents an item code for REST services, containing code information, dates, and tax code mappings. | |
Summarizes the results of an item code import operation, including counts and per-record results. | |
Represents the import result for an item code, including status and any error details. | |
Represents a location for REST services, including address, identifiers, and tax jurisdiction fields. | |
Represents an error that occurred during import for a location. | |
Summarizes the results of a location import operation, including counts and per-record results. | |
Represents the result of a location import operation for REST services. This class contains the outcome of processing a location during import, including success/failure status, error information, and complete location details for excise tax compliance. | |
Represents a manufacturer, including registration details, physical and mailing addresses, and associated jurisdictions. | |
Represents an error that occurred during import for a manufacturer. | |
Manufacturer Import Result Summary | |
Represents manufacturer jurisdiction information for REST services, containing jurisdiction details and status information. | |
Represents the result of a manufacturer processing operation in REST services, including status and error information. | |
Represents a tobacco product record for REST services, including identifiers, effective dates, and nested attributes and jurisdictions. | |
Represents tobacco product attributes for REST services, containing attribute names and values. | |
Product Tobacco Attribute Results | |
Represents an error that occurred during import for a tobacco product. | |
Summarizes the results of a tobacco product import operation, including counts and per-record results. | |
Represents jurisdiction-specific tobacco product data for REST services (brand, style, and reporting codes per jurisdiction). | |
Summarizes the results of a tobacco product jurisdiction import operation, including counts and per-record results. | |
Represents the import result for a tobacco product jurisdiction, including status and any error details. | |
Rest Product Tobacco Result | |
Represents an excise tax rate and its applicability (jurisdiction, product category, thresholds, and metadata) for REST APIs. | |
A single return-level or eFile-level error entry. | |
Response returned by Tax Sessions ReturnErrors and eFiles GetErrors endpoints. | |
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. | |
Represents tax jurisdiction and rate classification for a single line of a schedule transaction. | |
Request body for POST /api/v1/TaxSessions/Create. | |
A single field definition describing a tax session property name and its data type, returned by the Tax Sessions Fields endpoint. | |
Response returned by the Tax Sessions Fields endpoint, containing all available tax session field names and their data types. Also provides shared helper methods for parsing and validating field name parameters. | |
Response returned by Tax Session Create, GetByHeader, and Amend endpoints. | |
Response returned by the Tax Sessions TransactionValidationErrors endpoint, containing grouped transaction-level validation errors. | |
Request body for PUT /api/v1/TaxSessions/UpdateManualFields. | |
Response returned by the Tax Sessions UpdateManualFields endpoint. | |
Request body for PUT /api/v1/TaxSessions/UpdateSettings. | |
Response returned by the Tax Sessions UpdateSettings endpoint, echoing the settings that were applied. | |
A grouped transaction validation error for a tax session. Each item represents a unique combination of rule, error level, and schedule code, with a count of affected transactions. | |
This is the request object for the REST service | |
Represents a request to adjust an existing transaction in the system. This class contains the information needed to modify transaction data, including the reason for adjustment, description, and the new transaction data. | |
Represents a REST transaction containing all transaction details, lines, schedules, and exchange rates for excise tax calculations. | |
Represents an error that occurred during REST transaction processing, including error details and context. | |
Represents currency exchange rate information for REST transactions, including conversion factors and effective dates. | |
One product or charge line on an excise transaction, including locations, quantities, pricing, and schedule context for tax determination. | |
| — | |
| — | |
Represents the response data for a REST transaction line, containing calculated results and processed transaction line information. | |
Schedule-level facts for a transaction line used in excise tax determination (locations, products, bases, and jurisdiction-specific attributes). | |
Represents the response data for a REST transaction, containing calculated results and processed transaction information. | |
Represents the result of a REST transaction processing, including status, taxes, errors, and the complete transaction response. | |
Represents a summary of REST transaction results including counts and processing statistics. | |
Party, account, and address details at the transaction schedule level used for excise tax determination. | |
Represents tax information for a REST transaction, including tax rates, amounts, jurisdictions, and calculation details. | |
A currency-specific portion of tax within a single tax line in the calculation result. | |
Represents a request to update return data for transaction processing. This class contains the transaction lines and schedule information needed to update return data for tax determination and reporting purposes. | |
Represents a single transaction line that requires return data updates. This class contains the specific line item information and schedule details needed to process return data modifications for individual transaction lines. | |
Retrieves the master company information | |
| — |