The Avalara AvaTax connector lets your AI agent work with Avalara AvaTax. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 25 tools.
- Tools
- 25
- What they doRead · write · destructive
- 16 · 8 · 116 read8 write1 destructive
- Users sign in with
- Username and password
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Avalara AvaTax connection
In AgentKit > Connections, create an Avalara AvaTax connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolavalara_address_resolveValidate and normalize a US or Canadian address against Avalara's address database.Read-onlyResolve Address
Validate and normalize a US or Canadian address against Avalara's address database. Returns validatedAddresses with the normalized address, latitude and longitude, resolutionQuality, the tax jurisdictions that apply, and any messages if it could not be resolved. Use avalara_address_resolve to clean an address before a transaction. Use avalara_tax_rates_by_address_get for an estimated rate.
Inputs
citystring- City. Example: Irvine
countrystring- Two-letter ISO 3166 country code. Example: US
line1string- Street address line 1. Example: 2000 Main Street
line2string- Street address line 2. Example: Suite 200
line3string- Street address line 3. Example: Building B
postal_codestring- Postal or ZIP code. Example: 92614
regionstring- State, province or region, as a two-letter code or full name. Example: CA
text_casestring- Text case of the returned address: Default, Upper or Mixed. Example: Mixedone of
DefaultUpperMixed
avalara_companies_listList the companies in the AvaTax account, with filtering, sorting and paging.Read-onlyList Companies
List the companies in the AvaTax account, with filtering, sorting and paging. Returns value[] with id, companyCode, name, isDefault, isActive, taxpayerIdNumber and defaultCountry, plus @recordsetCount. Use avalara_companies_list to find a company's numeric id and companyCode. Use avalara_company_get for one company.
Inputs
filterstring- AvaTax filter expression on the record fields (eq, ne, gt, lt, contains, startswith, and, or). See https://developer.avalara.com/avatax/filtering-in-rest/. Example: isActive eq true
includestring- Comma-separated extra data to return: child objects such as Contacts, Items, Locations, Nexus, Settings, TaxCodes, TaxRules, UPCs. Example: Locations,Nexus
order_bystring- Sort order as 'field ASC|DESC', comma-separated for several. Example: companyCode ASC
skipinteger- Number of records to skip before returning results, for paging. Example: 100
topinteger- Maximum records to return (up to 1000). Use with skip to page. Example: 100
avalara_company_getGet one AvaTax company by its numeric ID.Read-onlyGet Company
Get one AvaTax company by its numeric ID. Returns the company's code, name, tax ID, default country, settings and, with include, its contacts, items, locations, nexus or tax codes. Use avalara_company_get for a known ID. Use avalara_companies_list to find IDs.
Inputs
company_idintegerrequired- Numeric ID of the company to get. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
includestring- Comma-separated extra data to return: Contacts, FilingCalendars, Items, Locations, Nexus, TaxCodes. Example: Locations,Nexus
avalara_item_getGet one item from an AvaTax company's catalog.Read-onlyGet Item
Get one item from an AvaTax company's catalog. Returns its itemCode, description, taxCode, group, category and, with include, parameters and classifications. Use avalara_item_get before avalara_item_update to read the current values.
Inputs
company_idintegerrequired- Numeric ID of the company that owns the item. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
item_idintegerrequired- Numeric ID of the item. Example: 1234567
includestring- Comma-separated extra data to return: Parameters, Classifications, Tags. Example: Parameters,Classifications
avalara_items_listList the items (products and services) in an AvaTax company's catalog, with filtering and paging.Read-onlyList Items
List the items (products and services) in an AvaTax company's catalog, with filtering and paging. Returns value[] with id, itemCode, description, taxCode, itemGroup and category. Use avalara_items_list to find item IDs or check tax codes. Use avalara_item_get for one item.
Inputs
company_idintegerrequired- Numeric ID of the company that owns the records. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
filterstring- AvaTax filter expression on the record fields (eq, ne, gt, lt, contains, startswith, and, or). See https://developer.avalara.com/avatax/filtering-in-rest/. Example: itemCode startswith 'SKU-'
includestring- Comma-separated extra data to return: Parameters, Classifications, Tags. Example: Parameters,Classifications
order_bystring- Sort order as 'field ASC|DESC', comma-separated for several. Example: itemCode ASC
skipinteger- Number of records to skip before returning results, for paging. Example: 100
tag_namestring- Only items with this tag. Example: seasonal
topinteger- Maximum records to return (up to 1000). Use with skip to page. Example: 100
avalara_location_getGet one business location of an AvaTax company.Read-onlyGet Location
Get one business location of an AvaTax company. Returns the location's code, description, address and settings. Use avalara_location_get with an ID from avalara_locations_list.
Inputs
company_idintegerrequired- Numeric ID of the company that owns the location. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
location_idintegerrequired- Numeric ID of the location. Example: 56789
includestring- Comma-separated extra data to return: Settings, Parameters. Example: Settings
avalara_locations_listList the business locations (stores, warehouses, offices) of an AvaTax company.Read-onlyList Locations
List the business locations (stores, warehouses, offices) of an AvaTax company. Returns value[] with id, locationCode, description, address fields and addressTypeId. Use avalara_locations_list to find location IDs and codes. Use avalara_location_get for one location.
Inputs
company_idintegerrequired- Numeric ID of the company that owns the records. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
filterstring- AvaTax filter expression on the record fields (eq, ne, gt, lt, contains, startswith, and, or). See https://developer.avalara.com/avatax/filtering-in-rest/. Example: region eq 'CA'
includestring- Comma-separated extra data to return: Settings, Parameters. Example: Settings
order_bystring- Sort order as 'field ASC|DESC', comma-separated for several. Example: locationCode ASC
skipinteger- Number of records to skip before returning results, for paging. Example: 100
topinteger- Maximum records to return (up to 1000). Use with skip to page. Example: 100
avalara_nexus_listList the jurisdictions where an AvaTax company has declared nexus (an obligation to collect tax).Read-onlyList Company Nexus
List the jurisdictions where an AvaTax company has declared nexus (an obligation to collect tax). Returns value[] with id, country, region, jurisDname, jurisTypeId, nexusTypeId, effectiveDate and endDate. Use avalara_nexus_list to check where a company collects tax.
Inputs
company_idintegerrequired- Numeric ID of the company that owns the records. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
filterstring- AvaTax filter expression on the record fields (eq, ne, gt, lt, contains, startswith, and, or). See https://developer.avalara.com/avatax/filtering-in-rest/. Example: region eq 'WA'
includestring- Comma-separated extra data to return: Parameters. Example: Parameters
order_bystring- Sort order as 'field ASC|DESC', comma-separated for several. Example: region ASC
skipinteger- Number of records to skip before returning results, for paging. Example: 100
topinteger- Maximum records to return (up to 1000). Use with skip to page. Example: 100
avalara_pingTest the connection to AvaTax and report whether the credentials authenticated.Read-onlyPing
Test the connection to AvaTax and report whether the credentials authenticated. Returns version, authenticated (true or false), authenticationType, userName, userId and accountId. Use avalara_ping to check credentials. Use avalara_subscriptions_list to see which services the account has.
Inputs
This tool takes no inputs.
avalara_subscriptions_listList the Avalara services the authenticated account is subscribed to.Read-onlyList Subscriptions
List the Avalara services the authenticated account is subscribed to. Returns subscriptions with subscriptionTypeId, subscriptionDescription, effectiveDate and endDate. Use avalara_subscriptions_list to check whether a feature (for example AvaTaxPro or exemption certificates) is available.
Inputs
This tool takes no inputs.
avalara_tax_codes_listList the Avalara system tax codes that describe how products and services are taxed.Read-onlyList Tax Codes
List the Avalara system tax codes that describe how products and services are taxed. Returns value[] with taxCode (for example P0000000 or PC040100), description, taxCodeTypeId and parentTaxCode. Use avalara_tax_codes_list to pick the taxCode for transaction lines or items.
Inputs
filterstring- AvaTax filter expression on the record fields (eq, ne, gt, lt, contains, startswith, and, or). See https://developer.avalara.com/avatax/filtering-in-rest/. Example: description contains 'clothing'
order_bystring- Sort order as 'field ASC|DESC', comma-separated for several. Example: taxCode ASC
skipinteger- Number of records to skip before returning results, for paging. Example: 100
topinteger- Maximum records to return (up to 1000). Use with skip to page. Example: 100
avalara_tax_rates_by_address_getEstimate the combined sales tax rate for a US street address, assuming general tangible goods sold at retail.Read-onlyGet Tax Rates by Address
Estimate the combined sales tax rate for a US street address, assuming general tangible goods sold at retail. Returns totalRate and rates[] with each jurisdiction's rate, name and type. Use avalara_tax_rates_by_address_get for a quick rate estimate. Use avalara_transaction_create for an exact tax calculation with nexus, product taxability and exemptions.
Inputs
countrystringrequired- Country code or name; only US is supported. Example: US
line1stringrequired- Street address of the location. Example: 2000 Main Street
postal_codestringrequired- ZIP code. Example: 92614
regionstringrequired- State as a two-letter code or full name. Example: CA
citystring- City name. Example: Irvine
line2string- Street address line 2. Example: Suite 200
line3string- Street address line 3. Example: Building B
avalara_transaction_auditGet the original API request and response that created a transaction, for debugging tax results.Read-onlyAudit Transaction
Get the original API request and response that created a transaction, for debugging tax results. Returns the original call's timestamp, server details, request body and response. Use avalara_transaction_audit to see exactly what a client sent. Use avalara_transaction_get for the current transaction.
Inputs
company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
transaction_codestringrequired- Code of the transaction to audit (the code you set, or the GUID AvaTax assigned). Example: INV-1001
avalara_transaction_getGet one transaction by company code and transaction code.Read-onlyGet Transaction
Get one transaction by company code and transaction code. Returns the latest version with status, totals, addresses, lines and per-jurisdiction tax details. Use avalara_transaction_get when you know the code. Use avalara_transaction_get_by_id for a numeric ID, including older versions.
Inputs
company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
transaction_codestringrequired- Code of the transaction to get (the code you set, or the GUID AvaTax assigned). Example: INV-1001
document_typestring- Document type of the transaction, when the same code exists for more than one type. Defaults to SalesInvoice. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrderAny includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
avalara_transaction_get_by_idGet one transaction by its numeric AvaTax ID.Read-onlyGet Transaction by ID
Get one transaction by its numeric AvaTax ID. Returns that exact version of the transaction with totals, lines and tax details; an adjusted transaction keeps its old versions under their own IDs. Use avalara_transaction_get_by_id with an id from a list or create result. Use avalara_transaction_get to fetch by code.
Inputs
transaction_idintegerrequired- Numeric transaction ID (the id field of a transaction). Example: 123456789
includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
avalara_transactions_listList the transactions recorded for one AvaTax company, with filtering, sorting and paging; by default only the last 30 days.Read-onlyList Transactions
List the transactions recorded for one AvaTax company, with filtering, sorting and paging; by default only the last 30 days. Returns value[] with id, code, type, date, status, customerCode, totalAmount and totalTax, plus @recordsetCount. Use avalara_transactions_list to search transactions (filter on date to see older ones). Use avalara_transaction_get for one transaction with lines.
Inputs
company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
data_source_idinteger- Only transactions from this data source ID. Example: 12
filterstring- AvaTax filter expression on the record fields (eq, ne, gt, lt, contains, startswith, and, or). See https://developer.avalara.com/avatax/filtering-in-rest/. Example: date ge '2026-10-01' and status eq 'Committed'
includestring- Comma-separated extra data to return: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly. Example: Summary
order_bystring- Sort order as 'field ASC|DESC', comma-separated for several. Example: date DESC
skipinteger- Number of records to skip before returning results, for paging. Example: 100
topinteger- Maximum records to return (up to 1000). Use with skip to page. Example: 100
avalara_item_createAdd an item (product or service) with its tax code to an AvaTax company's catalog.WriteCreate Item
Add an item (product or service) with its tax code to an AvaTax company's catalog. Returns an array with the created item, including its id. Use avalara_item_create so transaction lines can send just itemCode. Use avalara_item_update to change an existing item.
Inputs
company_idintegerrequired- Numeric ID of the company to add the item to. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
descriptionstringrequired- Description of the item. Example: Cotton T-shirt
item_codestringrequired- Unique code for the item, usually the SKU. Example: SKU-1001
categorystring- Product category path, with levels separated by ' > '. Example: Clothing > Shirts
item_groupstring- Group for similar items. Example: Apparel
tax_codestring- Avalara tax code for the item, from avalara_tax_codes_list. Example: PC040100
avalara_item_updateReplace an item in an AvaTax company's catalog; fields left empty are cleared.WriteUpdate Item
Replace an item in an AvaTax company's catalog; fields left empty are cleared. Returns the updated item. Use avalara_item_update to change an item's tax code or description; read it first with avalara_item_get and send every value you want to keep.
- Idempotent
Inputs
company_idintegerrequired- Numeric ID of the company that owns the item. Use avalara_companies_list to find it (the id field, not companyCode). Example: 12345
descriptionstringrequired- Description of the item. Example: Cotton T-shirt, organic
item_codestringrequired- Item code (SKU); send the current code to keep it. Example: SKU-1001
item_idintegerrequired- Numeric ID of the item to update. Example: 1234567
categorystring- Product category path, with levels separated by ' > '. Example: Clothing > Shirts
item_groupstring- Group for similar items. Example: Apparel
tax_codestring- Avalara tax code for the item, from avalara_tax_codes_list. Example: PC040100
avalara_transaction_adjustReplace a saved or committed transaction with a corrected version, recording why it changed.WriteAdjust Transaction
Replace a saved or committed transaction with a corrected version, recording why it changed. Returns the new version of the transaction; the old version stays under its own ID with status Adjusted. Use avalara_transaction_adjust to correct amounts, lines or addresses. Use avalara_transaction_void to cancel it.
Inputs
adjustment_reasonstringrequired- Why the transaction is being adjusted. Example: PriceAdjustedone of
NotAdjustedSourcingIssueReconciledWithGeneralLedgerExemptCertAppliedPriceAdjustedProductReturnedProductExchangedBadDebtOtherOfflineOffset company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
new_transactionobjectrequired- The full corrected transaction, in the same shape as avalara_transaction_create's body (type, code, companyCode, date, customerCode, addresses, lines and so on). Example: {"type": "SalesInvoice", "code": "INV-1001", "companyCode": "DEFAULT", "date": "2026-11-15", "customerCode": "CUST-001", "addresses": {"singleLocation": {"line1": "2000 Main Street", "city": "Irvine", "region": "CA", "postalCode": "92614", "country": "US"}}, "lines": [{"amount": 120}]}
transaction_codestringrequired- Code of the transaction to adjust (the code you set, or the GUID AvaTax assigned). Example: INV-1001
adjustment_descriptionstring- Free-text reason; required when adjustment_reason is Other. Example: Customer moved
document_typestring- Document type of the transaction, when the same code exists for more than one type. Defaults to SalesInvoice. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrderAny includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
avalara_transaction_commitCommit (or un-commit with commit false) a saved transaction so it is included in tax reporting.WriteCommit Transaction
Commit (or un-commit with commit false) a saved transaction so it is included in tax reporting. Returns the transaction with status Committed. Use avalara_transaction_commit after creating an uncommitted SalesInvoice. Use avalara_transaction_uncommit to move a committed one back to Saved.
- Idempotent
Inputs
commitbooleanrequired- true to commit the transaction for reporting. Example: truedefault
true company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
transaction_codestringrequired- Code of the transaction to commit (the code you set, or the GUID AvaTax assigned). Example: INV-1001
document_typestring- Document type of the transaction, when the same code exists for more than one type. Defaults to SalesInvoice. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrderAny includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
avalara_transaction_createCalculate tax for a sale, purchase, return or transfer and, for Invoice document types, record it in AvaTax.WriteCreate Transaction
Calculate tax for a sale, purchase, return or transfer and, for Invoice document types, record it in AvaTax. Returns the transaction with id, code, status, totalAmount, totalTax, and lines with per-jurisdiction tax details. Use avalara_transaction_create with type SalesOrder for a quote that is not saved, or SalesInvoice to record a sale. Use avalara_transaction_create_or_adjust to update an existing code.
Inputs
customer_codestringrequired- Your code for the customer (case-sensitive). Example: CUST-001
datestringrequired- Transaction date (yyyy-MM-dd), used to find the tax rates in effect. Example: 2026-11-15
linesarrayrequired- Line items. Each needs amount (the line's total, not unit price); add quantity, number, itemCode, taxCode (such as P0000000), description, discounted, taxIncluded or line-level addresses as needed. Example: [{"number": "1", "quantity": 1, "amount": 100, "taxCode": "PS081282", "itemCode": "Y0001", "description": "Yarn"}]
addressesobject- Addresses for the whole document. Use singleLocation for a point-of-sale sale, or shipFrom and shipTo for shipped goods; each address has line1, city, region, postalCode and country. Example: {"shipFrom": {"line1": "2000 Main Street", "city": "Irvine", "region": "CA", "postalCode": "92614", "country": "US"}, "shipTo": {"line1": "100 Ravine Lane NE", "city": "Bainbridge Island", "region": "WA", "postalCode": "98110", "country": "US"}}
codestring- Your reference code for the transaction, used later to get, commit, adjust or void it. AvaTax assigns a GUID if empty. Example: INV-1001
commitboolean- true to commit the transaction so it is reported on tax returns. Only applies to Invoice types. Example: false
company_codestring- Company code to record the transaction under. Defaults to the account's default company. Example: DEFAULT
currency_codestring- Three-letter ISO 4217 invoice currency. Defaults to USD. Example: USD
descriptionstring- Description of the transaction. Example: Online order 1001
discountnumber- Document-level discount amount, applied to lines that have discounted true. Example: 10
emailstring- Email address relevant to the transaction. Example: buyer@example.com
entity_use_codestring- Entity use code for exempt usage, such as A (federal government) or G (resale). Example: G
exemption_nostring- Exemption number; when set, the whole document is treated as exempt. Example: EX-12345
includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
purchase_order_nostring- Purchase order number for the document. Example: PO-7781
reference_codestring- Your reference, for example the original invoice for a return. Example: ORIG-INV-1000
salesperson_codestring- Salesperson code. Example: SP-12
typestring- Document type. Types ending in Invoice are saved permanently; types ending in Order are estimates that are not saved. Defaults to SalesOrder. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrder
avalara_transaction_create_or_adjustCreate a transaction, or adjust it if one with the same code and type already exists and is not locked.WriteCreate or Adjust Transaction
Create a transaction, or adjust it if one with the same code and type already exists and is not locked. Returns the created or adjusted transaction with totals and line tax details. Use avalara_transaction_create_or_adjust when re-sending an invoice that may already exist. Use avalara_transaction_adjust to correct a known transaction with a reason.
Inputs
customer_codestringrequired- Your code for the customer (case-sensitive). Example: CUST-001
datestringrequired- Transaction date (yyyy-MM-dd), used to find the tax rates in effect. Example: 2026-11-15
linesarrayrequired- Line items. Each needs amount (the line's total, not unit price); add quantity, number, itemCode, taxCode (such as P0000000), description, discounted, taxIncluded or line-level addresses as needed. Example: [{"number": "1", "quantity": 1, "amount": 100, "taxCode": "PS081282", "itemCode": "Y0001", "description": "Yarn"}]
addressesobject- Addresses for the whole document. Use singleLocation for a point-of-sale sale, or shipFrom and shipTo for shipped goods; each address has line1, city, region, postalCode and country. Example: {"shipFrom": {"line1": "2000 Main Street", "city": "Irvine", "region": "CA", "postalCode": "92614", "country": "US"}, "shipTo": {"line1": "100 Ravine Lane NE", "city": "Bainbridge Island", "region": "WA", "postalCode": "98110", "country": "US"}}
adjustment_descriptionstring- Free-text reason; required when adjustment_reason is Other. Example: Corrected shipping address
adjustment_reasonstring- Reason recorded if an existing transaction is adjusted. Example: PriceAdjustedone of
NotAdjustedSourcingIssueReconciledWithGeneralLedgerExemptCertAppliedPriceAdjustedProductReturnedProductExchangedBadDebtOtherOfflineOffset codestring- Your reference code for the transaction, used later to get, commit, adjust or void it. AvaTax assigns a GUID if empty. Example: INV-1001
commitboolean- true to commit the transaction so it is reported on tax returns. Only applies to Invoice types. Example: false
company_codestring- Company code to record the transaction under. Defaults to the account's default company. Example: DEFAULT
currency_codestring- Three-letter ISO 4217 invoice currency. Defaults to USD. Example: USD
descriptionstring- Description of the transaction. Example: Online order 1001
discountnumber- Document-level discount amount, applied to lines that have discounted true. Example: 10
emailstring- Email address relevant to the transaction. Example: buyer@example.com
entity_use_codestring- Entity use code for exempt usage, such as A (federal government) or G (resale). Example: G
exemption_nostring- Exemption number; when set, the whole document is treated as exempt. Example: EX-12345
includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
purchase_order_nostring- Purchase order number for the document. Example: PO-7781
reference_codestring- Your reference, for example the original invoice for a return. Example: ORIG-INV-1000
salesperson_codestring- Salesperson code. Example: SP-12
typestring- Document type. Types ending in Invoice are saved permanently; types ending in Order are estimates that are not saved. Defaults to SalesOrder. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrder
avalara_transaction_refundCreate a ReturnInvoice that refunds all or part of an earlier sale.WriteRefund Transaction
Create a ReturnInvoice that refunds all or part of an earlier sale. Returns the new refund transaction with negative amounts and tax. Use avalara_transaction_refund for returns. Use avalara_transaction_void to cancel a sale that should never have been recorded.
Inputs
company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
refund_datestringrequired- Date of the refund (yyyy-MM-dd); controls which filing period reports it. Example: 2026-11-20
transaction_codestringrequired- Code of the transaction to refund (the code you set, or the GUID AvaTax assigned). Example: INV-1001
document_typestring- Document type of the transaction, when the same code exists for more than one type. Defaults to SalesInvoice. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrderAny includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
reference_codestring- Your reference for the refund. Example: RMA-5521
refund_linesarray- Line numbers of the original transaction to refund, for Partial refunds. Example: ["1", "2"]
refund_percentagenumber- Percentage to refund, for Percentage or Partial refunds. Example: 50
refund_transaction_codestring- Code for the new ReturnInvoice. Example: REFUND-INV-1001
refund_typestring- Full, Partial (with refund_lines), TaxOnly or Percentage (with refund_percentage). Example: Fullone of
FullPartialTaxOnlyPercentage use_tax_date_overrideboolean- true to process the refund with a tax date override instead of a tax amount override (required for SST states). Defaults to false. Example: false
avalara_transaction_uncommitMove a committed transaction back to Saved so it can be changed or voided before it is reported.WriteUncommit Transaction
Move a committed transaction back to Saved so it can be changed or voided before it is reported. Returns the transaction with status Saved. Use avalara_transaction_uncommit before editing a committed transaction. Use avalara_transaction_commit to commit it again.
- Idempotent
Inputs
company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
transaction_codestringrequired- Code of the transaction to uncommit (the code you set, or the GUID AvaTax assigned). Example: INV-1001
document_typestring- Document type of the transaction, when the same code exists for more than one type. Defaults to SalesInvoice. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrderAny includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
avalara_transaction_voidVoid or cancel a transaction so it is no longer reported; a voided transaction keeps its record.DestructiveVoid Transaction
Void or cancel a transaction so it is no longer reported; a voided transaction keeps its record. Returns the transaction with status Cancelled (or Voided). Use avalara_transaction_void with code DocVoided to cancel an invoice. Use avalara_transaction_refund to record a return instead.
- Idempotent
Inputs
codestringrequired- Reason for voiding. Use DocVoided to void a transaction; the others are for special cases (PostFailed, DocDeleted, AdjustmentCancelled). Example: DocVoidedone of
UnspecifiedPostFailedDocDeletedDocVoidedAdjustmentCancelled company_codestringrequired- Company code of the company that recorded the transaction (companyCode from avalara_companies_list, often DEFAULT). Example: DEFAULT
transaction_codestringrequired- Code of the transaction to void (the code you set, or the GUID AvaTax assigned). Example: INV-1001
document_typestring- Document type of the transaction, when the same code exists for more than one type. Defaults to SalesInvoice. Example: SalesInvoiceone of
SalesOrderSalesInvoicePurchaseOrderPurchaseInvoiceReturnOrderReturnInvoiceInventoryTransferOrderInventoryTransferInvoiceReverseChargeOrderReverseChargeInvoiceCustomsInvoiceCustomsOrderInventoryTransferOutboundInvoiceInventoryTransferOutboundOrderAny includestring- Extra data in the response, comma-separated: Lines, Details, Summary, Addresses, SummaryOnly, LinesOnly, TaxDetailsByTaxType, ForceTimeout. Example: Summary,Addresses
No tools match.