AvaTax API
Search Icon
v2
cardImage
Definitions
cardImage
DomainControlVerification
Models
Top 10 EndPoints

AvaTax API

REST interface to Avalara's enterprise tax service, AvaTax.

Transactions

CreateOrAdjustTransaction

Create or adjust a transaction

Records a new transaction or adjust an existing transaction in AvaTax.

The CreateOrAdjustTransaction endpoint is used to create a new transaction or update an existing one. This API can help you create an idempotent service that creates transactions If there exists a transaction identified by code, the original transaction will be adjusted by using the meta data in the input transaction.

The CreateOrAdjustTransaction API cannot modify any transaction that has been reported to a tax authority using the Avalara Managed Returns Service or any other tax filing service. If you call this API to attempt to modify a transaction that has been reported on a tax filing, you will receive the error CannotModifyLockedTransaction.

To generate a refund for a transaction, use the RefundTransaction API.

An address is required for calculation. If no address is provided at the line level, the document level address will be used.

If you don't specify the field type in your request, you will get an estimate of type SalesOrder, which will not be recorded in the database.

A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:

  • Lines
  • Details (implies lines)
  • AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
  • Summary (implies details)
  • Addresses
  • SummaryOnly (omit lines and details - reduces API response size)
  • LinesOnly (omit details - reduces API response size)
  • ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection.

If you omit the $include parameter, the API will assume you want Summary,Addresses.

NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:

  • _-ava2f-_
  • _-ava2b-_
  • _-ava3f-_

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
  • This API depends on the following active services:Required (all): AvaTaxPro, BasicReturns.
card-img
CreateOrAdjustTransaction
card-img
CreateOrAdjustTransaction
breadcrumb icon
CreateOrAdjustTransaction
close
POSThttps://sandbox-rest.avatax.com/api/v2/transactions/createoradjust