AvaTax API Models

An account user who is permitted to use AvaTax.

An AvaTax account.

Specifies a duration for which to grant TSA accounts write access. See AVT-25316

Represents a request to activate an account by reading and accepting its terms and conditions.

Information about all the addresses involved in this transaction.

For a physical in-person transaction at a retail point-of-sale location, please specify only one address using the singleLocation field.

For a transaction that was shipped, delivered, or provided from an origin location such as a warehouse to a destination location such as a customer, please specify the shipFrom and shipTo addresses.

In the United States, some jurisdictions recognize the address types pointOfOrderOrigin and pointOfOrderAcceptance. These address types affect the sourcing models of some transactions.

VAT transactions support a goodsPlaceOrServiceRendered address, which indicates where goods are located or where services are rendered. VAT transactions also support an import address, which specifies the address of the buyer importing a good from another country.

India GST transactions support a billTo address, which specifies where invoices and other billing-related information are sent to the buyer.

If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses.

Represents an address to resolve.

TextCase info for input address

Replace an existing MultiDocument transaction recorded in AvaTax with a new one.

Input model for the Advanced Rules bulk import API

Model for retrieving customer data schema

Model for Advanced Rules when full details are requested

Model for the results of importing a single rule execution with the Advanced Rules bulk import API

AP Config Setting Request Model

Provides detailed information about an API call.

The information on this record was captured by AvaTax when your API call was made. If you are unsure why you received an error, you can fetch these audit objects and examine the RequestUrl, RequestBody, and ErrorMessage fields to determine root cause for the error.

Information about a previously created MultiDocument transaction

Information about a previously created transaction

Informational or warning messages returned by AvaTax with a transaction

Replace an existing transaction recorded in AvaTax with a new one.

Represents a batch of uploaded documents.

A request to void a previously created transaction.

Returns information about transactions that were locked

Cache memory usage details

A certificate attribute can be thought of as a feature or flag that is applied to a certificate. A single certificate can be linked to zero, one, or many certificate attributes. The full list of attributes can be obtained by calling the ListCertificateAttributes API.

The reason the certificate is invalid.

A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on criteria you specify when you store the certificate. To view or manage your certificates directly, please log onto the administrative website for the product you purchased.

Settle this transaction with your ledger by verifying its amounts. If the transaction is not yet committed, you may specify the "commit" value to commit it to the ledger and allow it to be reported. You may also optionally change the transaction's code by specifying the "newTransactionCode" value.

usage of system defined parameters.

Represents a physical location used in exemption certificate management.

An AvaTax account.

Commit this transaction as permanent so that it can be reported on a tax filing.

Encloses count and model value details

Encloses Communication exemption designator details

Represents information about a type of telecommunications transaction

Represents a transaction/service type pair for telecommunications tax

Encloses communication tax type details

Represents one configuration setting for this company

A company or business entity.

Represents a parameter associated with a company.

Model for distinct jurisdictions.

Model for RateOption.

A flattened model for State Config.

The tax rate model.

A contact person for a company.

Model to represent the system

Represents a bulk upload input model.

Cost Center Request Model

Represents the Country coefficients model, using which tax rules rates can be modified dynamically for CB transaciotns while applying tax rules in order to reduce the variance for all the transactions at country level.

Represents the Country coefficients request input model, using which tax rules rates can be modified dynamically for CB transaciotns while applying tax rules in order to reduce the variance for all the transactions at country level.

Represents the coefficient, using which tax rules rates can be modified dynamically while applying tax rules in order to reduce the variance for all the transactions at country level.

Avalara supports a few different types of tax rules. For information about tax rule types, see TaxRuleTypeId

The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates. An invitation allows customers to use CertExpress to upload their exemption certificates directly; this cover letter explains why the invitation was sent.

Represents a create advanced rules batch request model.

Represents an invitation for a customer to use CertExpress to self-report their own certificates. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where they can follow a step-by-step guide to enter information about their exemption certificates. The certificates entered will be recorded and automatically linked to their customer record.

Represents a create item import batch request model.

A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.

A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately.

Model to create a new tax notice root cause type.

Represents a create transaction batch request model.

Create a transaction

Credit Transaction Details

Represents a customer to whom you sell products and/or services.

Represents a parameter associated with a company.

Model which can provide a summary of any custom rule variety. Custom rules is the umbrella term for traditional Tax Rules, legacy Advanced Rules (transaction rules), and the newest Dynamic Rules.

Model with options for adding a new filing calendar

Cycle Safe Expiration results.

Options for expiring a filing calendar.

CycleSafe Option Result

ViewModel to get Domain control verification

Delete Custom Field request model

Request model for when a user is deleting multiple error transaction

Represents information about a single legal taxing jurisdiction within a specific Avalara tax region.

ViewModel to receive DomainName from user

Represents a component within a Dynamic Rule definition. Components define the logic and flow of a rule, and include condition nodes, action nodes, and rule-wide variables.

Represents the definition of a Dynamic Rule, which defines its execution flow.

Represents the a field available in the Dynamic Rules interface.

Information about a field at a specific "level" (Document or Line).

A Dynamic Rule is a type of a custom rule which is similar to an Advanced Rule, but has a graph-based execution flow made up of modular Conditions and Actions that may be linked to one or more traditional custom Tax Rules.

Represents a valid expression token in Dynamic Rules, i.e. the variables, delimited by double curly braces, that may be used when performing string manipulation or evaluating formulas within a Dynamic Rule.

Represents a single validation message for a dynamic rule.

Represents the complete validation result for a dynamic rule, including a summary, individual messages, an execution plan, and affected tax rules.

Represents an ECMS record, used internally by AvaTax to track information about exemptions.

Exempt certificate

The resource model returned by the ECommerceTokenController's endpoints.

Represents a code describing the intended use for a product that may affect its taxability

Model that has the matching count for an errorcode

Helper function for throwing known error response

Error Transaction Model

Model to delete message

Encloses event message details

An exemption reason defines why a certificate allows a customer to be exempt for purposes of tax calculation. For a full list of defined exemption reasons, please call the ListCertificateExemptionReasons API.

Indicates the customer's exemption status in a specific country and region.

Information about a physical area or zone in which a certificate can apply. An exposure zone for an exemption certificate will generally be a tax authority such as a state, country, or local government entity.

Failed HS code classification model.

A model for return augmentations.

Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.

FilingFrequency Model

Represents a listing of all tax calculation data for filings and for accruing to future filings.

A model for return payments.

Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.

Filing Returns Model

Results of the Worksheet Checkup report

Represents a change request for filing status for a company

Represents a listing of all tax calculation data for filings and for accruing to future filings.

Represents a filter value that can be a string, array, or object

Account Linkage output model

Represents information about a tax form known to Avalara

Represents the resolved extraction task information for a given form type.

Frequency Available object

Represents the current status of a funding ESign method

Status of an Avalara Managed Returns funding configuration for a company

Represents a bulk upload response model.

GL account response model

Represents a GL account upload error model

Describes an element in the harmonized tariff system.

According to the United States International Trade Commission, the harmonized tariff schedule is defined as follows:

The HTS is a U.S. nomenclature system used to classify traded goods based on their material composition, product name, and/or intended function. The HTS is designed so that each article falls into only one category. It is divided into chapters, each of which has a 2-digit number. Each product category within the various chapters is designated by 4, 6, 8, or 10 digits. The 4-digit categories are called "headings." The 6-, 8- and 10-digit classifications are called "subheadings."

Within AvaTax, the HsCodeModel object can refer to sections, chapters, headings, subheadings, or articles. Each object represents one classification. Many of these objects have child objects underneath them; these child objects are more specific than their parent objects.

Response model used as output for InspectLine API.

This is used to map the error details in response

Represents an ISO 3166 recognized country

Represents a language-specific localized name of a particular geographic entity such as a country or a region.

Represents a bulk upload input model.

Represents an item in your company's product catalog.

Product classification output model.

Class to accommodate Custom defined parameters

Input model of the HS code classification.

Represents a HsCodeClassification SLA Response for a given company.

Represent HS code classification for a given item.

Represents HS Code CVD (Countervailing Duty) and ADD (Anti-Dumping Duty) Details.

Represents HS Code FTA (Free Trade Agreement) Details.

Represents HS Code Restriction Details.

Item image details model

Represents a Premium Classification output model associated with an item's SystemCode..

Represents a parameter associated with an item.

Output model for item status

Represents a tax code classification request output model

One recommended tax code (code, level, and Indix description) for bulk tax code recommendation responses.

Represents the output model for tax code recommendation batches (both synchronous and asynchronous).

Status Output Model

Represents information about a single legal taxing jurisdiction with parent jurisdiction

Represents information about a single legal taxing jurisdiction

Model to represent the detail of NexusTaxTpeGroup and TaxName for Jurisdiction

Represents a license key for this account.

Represents a customer to whom you sell products and/or services.

A location where this company does business. Some jurisdictions may require you to list all locations where your company does business.

The parameter associated with a company location.

Information about questions that the local jurisdictions require for each location

Represents the answer to one local jurisdiction question for a location.

Commit this transaction as permanent

Memory optimization recommendation

Memory usage trend data

A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.

A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately.

Represents a listing of all tax calculation data for filings and for accruing to future filings.

Regions

Request model for natural language search

Represents information about a newly created account

Represents a request for a new account with Avalara for a new Firm client.

Identifies all nexus that match a particular tax form

Represents a declaration of nexus within a particular taxing jurisdiction.

To create a nexus declaration for your company, you must first call the Definitions API ListNexus to obtain a list of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object.

The user selectable fields for the nexus object are companyId, effectiveDate, endDate, localNexusTypeId, taxId, nexusTypeId, hasPermanentEstablishment, and isSellerImporterOfRecord.

When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects by calling ListNexus. If any data does not match, AvaTax may not recognize your nexus declaration.

Represents a parameter associated with a nexus.

Nexus summary model

Represents a group of tax types

This is used to map the error details in response

NoticeResponsibility Model

NoticeRootCause Model

NoticeRootCause Model

Gets the response for the offer request

Represents the exact API request and response from the original transaction API call, if available

Represents a single patch operation

Point-of-Sale Data Request Model

Represents a PostalCode and its associated data like: country, region, effective dates, etc.

Response when checking if a company has a POA on file with Avalara

Represents a product classification system.

Represents a System Country.

Represents a complex query request to parse using query filter guidelines from Microsoft REST standards

Represents RateType1703 Model

Rate type Model

Rate types Model

Represents RateTypeTaxTypeMappingModel Model

Rebuild a set of filings.

Contains information about the original API request and response that created a MultiDocument object.

Refund a committed transaction

An input model for requesting an export of audit logs

Represents an operation within audit log report parameters.

A model for displaying audit log report task metadata

Represents a license key reset request.

A request to upload a file to Resource Files

Set Password Model

Defines a state, region, or province as known to Avalara's certificate management system.

Represents a service that this account has subscribed to.

Represents a service or a subscription type.

Represents a request to sync items.

Represents a tag for an item in your company's product catalog.

Represents a form that can be filed with a tax authority.

Information about a tax authority relevant for an address.

Represents a tax code that can be applied to items on a transaction. A tax code can have specific rules for specific jurisdictions that change the tax calculation behavior.

Tax Code Recommendation Output Model

Information about Avalara-defined tax code types. This list is used when creating tax codes and tax rules.

Tax Details by Tax Type

Info model for Problem Detail

Contains information about the general tangible personal property sales tax rates for this jurisdiction.

This rate is calculated by making assumptions about the tax calculation process. It does not account for:

• Sourcing rules, such as origin-and-destination based transactions.
• Product taxability rules, such as different tax rates for different product types.
• Nexus declarations, where some customers are not obligated to collect tax in specific jurisdictions.
• Tax thresholds and rate differences by amounts.
• And many more custom use cases.

To upgrade to a fully-featured and accurate tax process that handles these scenarios correctly, please contact Avalara to upgrade to AvaTax!

The tax region model.

Represents RateTypeTaxTypeMapping Model

Represents a tax subtype

Represents TaxType1703 Model

Represents a tax type group

Represents TaxTypeMapping Model

Represents a tax type

Economic nexus threshold status for a single US state.

An address used within this transaction.

An individual tax detail element. Represents the amount of tax calculated for a particular jurisdiction, for a particular line in an invoice.

One line item on this transaction.

Represents a transaction parameter.

Information about a location type

Summary information about an overall transaction.

This is used to map the error details in response

Update custom fields model

User Entitlement Model

Request model used as input for Variance API.

Represents a certificate document for vendors. This model inherits all properties from CertificateModel and adds vendor-specific functionality.

Represents a vendor from whom you purchase products and/or services. This model inherits all properties from CustomerModel and adds vendor-specific functionality.

Verify that a MultiDocument object matches the information in your accounting system.

If all attributes of the MultiDocument object match the values in your request, the MultiDocument object will be moved to the document status Posted.

For more information on document status, see DocumentStatus.

A request to void a previously created transaction