VAT Expansion 2021 - Models

Model Summary
AccountConfigurationModel

Represents one configuration setting for this account

AddTransactionLineModel

Model to add specific lines to exising transaction

AddressLocationInfo

Represents an address to resolve.

AddressesModel

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.

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.

AdjustMultiDocumentModel

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

AdjustTransactionModel

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

AuditMultiDocumentModel

Information about a previously created MultiDocument transaction

AuditTransactionModel

Information about a previously created transaction

AvaTaxMessage

Informational or warning messages returned by AvaTax with a transaction

BulkLockTransactionModel

Bulk lock documents model

BulkLockTransactionResult

Returns information about transactions that were locked

ChangeTransactionCodeModel

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.

CommitMultiDocumentModel

Commit this MultiDocument object so that all transactions within it can be reported on a tax filing.

CommitTransactionModel

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

CreateMultiDocumentModel

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.

CreateOrAdjustTransactionModel

Create or adjust transaction model

CreateTransactionModel

Create a transaction.

VAT Expansion 2021

As part of the efforts to expand the VAT functionality, the ability to convert the tax details into another currency for reporting purposes is being added. The converted tax details for all tax types will be returned as part of following properties: reportingTaxable, reportingNonTaxable, reportingExempt, reportingTax, reportingTaxCalculated .

InvoiceMessageModel

Represents a message to be displayed on an invoice.

LineItemModel

Represents one line item in a transaction

LockTransactionModel

Commit this transaction as permanent

MultiDocumentLineItemModel

Represents one line item in a MultiDocument transaction

MultiDocumentModel

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.

OriginalApiRequestResponseModel

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

ParameterModel

‘An extra property that can change the behavior of tax transactions.

ReconstructedApiRequestResponseModel

This model contains a reconstructed CreateTransaction request object that could potentially be used to recreate this transaction.

Note that the API changes over time, and this reconstructed model is likely different from the exact request that was originally used to create this transaction.

ReconstructedMultiDocumentModel

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

RefundTransactionModel

Refund a committed transaction

RemoveTransactionLineModel

Model to specify lines to be removed

SettleTransactionModel

Settle this transaction with your ledger by executing one or many actions against that transaction.

You may use this endpoint to verify the transaction, change the transaction’s code, and commit the transaction for reporting purposes. This endpoint may be used to execute any or all of these actions at once.

TaxDetailsByTaxSubType

Tax Details by Tax subtype

TaxDetailsByTaxType

Tax Details by Tax Type

TaxOverrideModel

Represents a tax override for a transaction

TransactionAddressModel

An address used within this transaction.

TransactionLineDetailModel

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

TransactionLineLocationTypeModel

Represents information about location types stored in a line

TransactionLineModel

One line item on this transaction.

TransactionLineParameterModel

Represents a transaction parameter.

TransactionLocationTypeModel

Information about a location type

TransactionModel

This object represents a single transaction; for example, a sales invoice or purchase order.

TransactionParameterModel

Represents a transaction parameter.

TransactionSummary

Summary information about an overall transaction.

VerifyMultiDocumentModel

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.

VerifyTransactionModel

Verify this transaction by matching it to values in your accounting system.

You may specify one or more of the following fields to verify: date, totalAmount, or totalTax. This call will report an error if there is any difference between the data stored in AvaTax and the data stored in your accounting system.

VoidTransactionModel

A request to void a previously created transaction