APConfigSetting

Accounts

Addresses

AvaFileForms

Batches

CertExpressInvites

Certificates

CommunicationCertificates

Compliance

Contacts

CostCenter

Customers

DataSources

Definitions

DistanceThresholds

DomainControlVerification

ECommerceToken

EcmEventNotifications

FirmClientLinkages

FundingRequests

GLAccount

JurisdictionOverrides

Locations

MultiDocument

Nexus

Notices

Notifications

Provisioning

Registrar

Reports

Settings

Subscriptions

TaxCodes

TaxContent

TaxRules

Upcs

UserDefinedFields

Users

Utilities

Models

Top 10 EndPoints

AvaTax API

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

Check top 10 endpoints

Transactions

LockTransaction

Lock a single transaction

Lock a transaction uniquely identified by this URL.

This API is mainly used for connector developers to simulate what happens when the Returns product locks a document. After this API call succeeds, the document will be locked and can't be voided or adjusted.

On Sandbox, this API is only available to customers who have both an AvaTaxPro and a Managed Returns subscription. On Production, this API is only available internally for the Avalara Returns team.

If you have more than one document with the same code, specify the documentType parameter to choose between them.

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)
TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.

NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:

Replace '/' with '_-ava2f-_' For example: document/Code becomes document_-ava2f-_Code
Replace '+' with '_-ava2b-_' For example: document+Code becomes document_-ava2b-_Code
Replace '?' with '_-ava3f-_' For example: document?Code becomes document_-ava3f-_Code
Replace '%' with '_-ava25-_' For example: document%Code becomes document_-ava25-_Code
Replace '#' with '_-ava23-_' For example: document#Code becomes document_-ava23-_Code
Replace ' ' with '%20' For example: document Code becomes document%20Code

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:Returns (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.Firm Managed (for accounts managed by a firm): ARA, ARAManaged.

LockTransaction

LockTransaction

POSThttps://sandbox-rest.avatax.com/api/v2/companies/{companyCode}/transactions/{transactionCode}/lock

SAMPLE

PARAMETERS

Request

Curl

cURL

1curl -g 'https://sandbox-rest.avatax.com/api/v2/companies/{companyCode}/transactions/{transactionCode}/lock' \
2-H 'X-Avalara-Client: {X-Avalara-Client}' \
3-H 'Authorization: Basic <Base64-encoded credentials>' \
4-H 'Content-Type: application/json' \
5-d '{"isLocked":true}'

Response

HEADER

Content-type: application/json

BODY

1{
2 	"id": 123456789,
3 	"code": "e80619cd-ff84-4da2-86a5-25b0bd05418b",
4 	"companyId": 12345,
5 	"date": "2025-05-09",
6 	"status": "Committed",
7 	"type": "SalesInvoice",
8 	"currencyCode": "USD",
9 	"exchangeRateCurrencyCode": "USD",
10 	"entityUseCode": "",
11 	"customerVendorCode": "ABC",
12 	"customerCode": "ABC",
13 	"exemptNo": "",
14 	"reconciled": true,
15 	"locationCode": "DEFAULT",
16 	"salespersonCode": "DEF",
17 	"taxOverrideType": "None",
18 	"taxOverrideAmount": 0,
19 	"taxOverrideReason": "",
20 	"totalAmount": 1000,
21 	"totalExempt": 0,
22 	"totalDiscount": 0,
23 	"totalTax": 62.5,
24 	"totalTaxable": 1000,
25 	"totalTaxCalculated": 62.5,
26 	"adjustmentReason": "NotAdjusted",
27 	"adjustmentDescription": "",
28 	"locked": false,
29 	"region": "CA",
30 	"country": "US",
31 	"version": 0,
32 	"originAddressId": 123456789,
33 	"destinationAddressId": 123456789,
34 	"exchangeRateEffectiveDate": "2025-05-09",
35 	"exchangeRate": 2,
36 	"isSellerImporterOfRecord": false,
37 	"description": "Yarn",
38 	"taxDate": "2025-05-09T00:00:00+00:00",
39 	"lines": [
40 	 	{
41 	 	 	"id": 123456789,
42 	 	 	"transactionId": 123456789,
43 	 	 	"lineNumber": "1",
44 	 	 	"boundaryOverrideId": 0,
45 	 	 	"entityUseCode": "",
46 	 	 	"description": "Yarn",
47 	 	 	"destinationAddressId": 12345,
48 	 	 	"originAddressId": 123456789,
49 	 	 	"discountAmount": 100,
50 	 	 	"discountTypeId": 0,
51 	 	 	"exemptAmount": 0,
52 	 	 	"exemptCertId": 0,
53 	 	 	"exemptNo": "",
54 	 	 	"isItemTaxable": true,
55 	 	 	"isSSTP": false,
56 	 	 	"itemCode": "116292",
57 	 	 	"lineAmount": 1000,
58 	 	 	"quantity": 1,
59 	 	 	"ref1": "Note: Deliver to Bob",
60 	 	 	"reportingDate": "2025-05-09",
61 	 	 	"revAccount": "",
62 	 	 	"sourcing": "Destination",
63 	 	 	"tax": 62.5,
64 	 	 	"taxableAmount": 1000,
65 	 	 	"taxCalculated": 62.5,
66 	 	 	"taxCode": "PS081282",
67 	 	 	"taxDate": "2025-05-09",
68 	 	 	"taxEngine": "",
69 	 	 	"taxOverrideType": "None",
70 	 	 	"taxOverrideAmount": 0,
71 	 	 	"taxOverrideReason": "",
72 	 	 	"taxIncluded": false,
73 	 	 	"details": [
74 	 	 	 	{
75 	 	 	 	 	"id": 123456789,
76 	 	 	 	 	"transactionLineId": 123456789,
77 	 	 	 	 	"transactionId": 123456789,
78 	 	 	 	 	"addressId": 12345,
79 	 	 	 	 	"country": "US",
80 	 	 	 	 	"region": "CA",
81 	 	 	 	 	"stateFIPS": "06",
82 	 	 	 	 	"exemptAmount": 0,
83 	 	 	 	 	"exemptReasonId": 4,
84 	 	 	 	 	"exemptRuleId": 0,
85 	 	 	 	 	"inState": false,
86 	 	 	 	 	"jurisCode": "06",
87 	 	 	 	 	"jurisName": "CALIFORNIA",
88 	 	 	 	 	"jurisdictionId": 5000531,
89 	 	 	 	 	"signatureCode": "AGAM",
90 	 	 	 	 	"stateAssignedNo": "",
91 	 	 	 	 	"jurisType": "STA",
92 	 	 	 	 	"nonTaxableAmount": 0,
93 	 	 	 	 	"nonTaxableRuleId": 0,
94 	 	 	 	 	"nonTaxableType": "BaseRule",
95 	 	 	 	 	"rate": 0.0625,
96 	 	 	 	 	"rateRuleId": 1321915,
97 	 	 	 	 	"rateSourceId": 3,
98 	 	 	 	 	"serCode": "",
99 	 	 	 	 	"sourcing": "Destination",
100 	 	 	 	 	"tax": 62.5,
101 	 	 	 	 	"taxableAmount": 1000,
102 	 	 	 	 	"taxType": "Sales",
103 	 	 	 	 	"taxName": "CA STATE TAX",
104 	 	 	 	 	"taxAuthorityTypeId": 45,
105 	 	 	 	 	"taxRegionId": 2127184,
106 	 	 	 	 	"taxCalculated": 62.5,
107 	 	 	 	 	"taxOverride": 0,
108 	 	 	 	 	"rateType": "General",
109 	 	 	 	 	"taxableUnits": 62.5,
110 	 	 	 	 	"nonTaxableUnits": 1000,
111 	 	 	 	 	"exemptUnits": 62.5,
112 	 	 	 	 	"reportingTaxableUnits": 125,
113 	 	 	 	 	"reportingNonTaxableUnits": 2000,
114 	 	 	 	 	"reportingExemptUnits": 125,
115 	 	 	 	 	"reportingTax": 125,
116 	 	 	 	 	"reportingTaxCalculated": 125,
117 	 	 	 	 	"recoverabilityPercentage": 1,
118 	 	 	 	 	"recoverableAmount": 62.5,
119 	 	 	 	 	"nonRecoverableAmount": 0
120 	 	 	 	}
121 	 	 	],
122 	 	 	"vatNumberTypeId": 0,
123 	 	 	"recoverabilityPercentage": 1,
124 	 	 	"recoverableAmount": 62.5,
125 	 	 	"nonRecoverableAmount": 0
126 	 	}
127 	],
128 	"addresses": [
129 	 	{
130 	 	 	"id": 0,
131 	 	 	"transactionId": 0,
132 	 	 	"boundaryLevel": "Address",
133 	 	 	"line1": "100 Ravine Lane Northeast #220",
134 	 	 	"city": "Bainbridge Island",
135 	 	 	"region": "WA",
136 	 	 	"postalCode": "98110",
137 	 	 	"country": "US",
138 	 	 	"taxRegionId": 0
139 	 	}
140 	],
141 	"taxDetailsByTaxType": [
142 	 	{
143 	 	 	"taxType": "SalesAndUse",
144 	 	 	"totalTaxable": 100,
145 	 	 	"totalExempt": 0.05,
146 	 	 	"totalNonTaxable": 0,
147 	 	 	"totalTax": 0.625
148 	 	}
149 	]
150}

SAMPLE

PARAMETERS