Skip to content

avadev/Avalara-SDK-Typescript

BranchesTags

Repository files navigation

Avalara-SDK

This generator creates TypeScript/JavaScript client that utilizes Fetch API. The generated Node module can be used in the following environments:

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install avalara-sdk@24.12.0 --save

Getting Started

import * as AvalaraSdk from "avalara-sdk";
import { AvaTaxEnvironment } from "avalara-sdk/runtime";

const configParams: AvalaraSdk.Runtime.ConfigurationParameters = {
  appName: "asv-sdk-test-app",
  appVersion: "1.0",
  environment: AvaTaxEnvironment.Sandbox,
  machineName: "test-machine",
  timeout: 3000,
  bearerToken: "<YOUR BEARER TOKEN>",
  testBasePath: "https://localhost:3000",
};
const config = new AvalaraSdk.Runtime.Configuration(configParams);
let client = new AvalaraSdk.Runtime.ApiClient(config);
let api = new AvalaraSdk.EInvoicing.V1.MandatesApi(client);
let requestParameters: AvalaraSdk.EInvoicing.V1.GetMandatesInterface = {
  xAvalaraClient: "Swagger UI; 22.7.0; Custom; 1.0",
};
const result = await api.getMandates(requestParameters);
console.log(result);

Documentation for API Endpoints

EInvoicing V1 API Documentation

Class Method HTTP request Description
DataInputFieldsApi getDataInputFields GET /data-input-fields Returns the optionality of document fields for different country mandates
DocumentsApi downloadDocument GET /documents/{documentId}/$download Returns a copy of the document
DocumentsApi fetchDocuments POST /documents/$fetch Fetch the inbound document from a tax authority
DocumentsApi getDocumentList GET /documents Returns a summary of documents for a date range
DocumentsApi getDocumentStatus GET /documents/{documentId}/status Checks the status of a document
DocumentsApi submitDocument POST /documents Submits a document to Avalara E-Invoicing API
InteropApi submitInteropDocument POST /interop/documents Submit a document
MandatesApi getMandateDataInputFields GET /mandates/{mandateId}/data-input-fields Returns document field information for a country mandate, a selected document type, and its version
MandatesApi getMandates GET /mandates List country mandates that are supported by the Avalara E-Invoicing platform
TradingPartnersApi batchSearchParticipants POST /trading-partners/batch-searches Creates a batch search and performs a batch search in the directory for participants in the background.
TradingPartnersApi downloadBatchSearchReport GET /trading-partners/batch-searches/{id}/$download-results Download batch search results in a csv file.
TradingPartnersApi getBatchSearchDetail GET /trading-partners/batch-searches/{id} Get the batch search details for a given id.
TradingPartnersApi listBatchSearches GET /trading-partners/batch-searches List all batch searches that were previously submitted.
TradingPartnersApi searchParticipants GET /trading-partners Returns a list of participants matching the input query.

Documentation for Models

EInvoicing V1 Model Documentation

Documentation for API Endpoints

EInvoicing V1 API Documentation

Class Method HTTP request Description
DataInputFieldsApi getDataInputFields GET /data-input-fields Returns the optionality of document fields for different country mandates
DocumentsApi downloadDocument GET /documents/{documentId}/$download Returns a copy of the document
DocumentsApi fetchDocuments POST /documents/$fetch Fetch the inbound document from a tax authority
DocumentsApi getDocumentList GET /documents Returns a summary of documents for a date range
DocumentsApi getDocumentStatus GET /documents/{documentId}/status Checks the status of a document
DocumentsApi submitDocument POST /documents Submits a document to Avalara E-Invoicing API
InteropApi submitInteropDocument POST /interop/documents Submit a document
MandatesApi getMandateDataInputFields GET /mandates/{mandateId}/data-input-fields Returns document field information for a country mandate, a selected document type, and its version
MandatesApi getMandates GET /mandates List country mandates that are supported by the Avalara E-Invoicing platform
SubscriptionsApi createWebhookSubscription POST /webhooks/subscriptions Create a subscription to events
SubscriptionsApi deleteWebhookSubscription DELETE /webhooks/subscriptions/{subscription-id} Unsubscribe from events
SubscriptionsApi getWebhookSubscription GET /webhooks/subscriptions/{subscription-id} Get details of a subscription
SubscriptionsApi listWebhookSubscriptions GET /webhooks/subscriptions List all subscriptions
TaxIdentifiersApi taxIdentifierSchemaByCountry GET /tax-identifiers/schema Returns the tax identifier request & response schema for a specific country.
TaxIdentifiersApi validateTaxIdentifier POST /tax-identifiers/validate Validates a tax identifier.
TradingPartnersApi batchSearchParticipants POST /trading-partners/batch-searches Handles batch search requests by uploading a file containing search parameters.
TradingPartnersApi createTradingPartner POST /trading-partners Creates a new trading partner.
TradingPartnersApi createTradingPartnersBatch POST /trading-partners/batch Creates a batch of multiple trading partners.
TradingPartnersApi deleteTradingPartner DELETE /trading-partners/{id} Deletes a trading partner using ID.
TradingPartnersApi downloadBatchSearchReport GET /trading-partners/batch-searches/{id}/$download-results Downloads batch search results in a csv file.
TradingPartnersApi getBatchSearchDetail GET /trading-partners/batch-searches/{id} Returns the batch search details using ID.
TradingPartnersApi listBatchSearches GET /trading-partners/batch-searches Lists all batch searches that were previously submitted.
TradingPartnersApi searchParticipants GET /trading-partners Returns a list of participants matching the input query.
TradingPartnersApi updateTradingPartner PUT /trading-partners/{id} Updates a trading partner using ID.

A1099 V2 API Documentation

Class Method HTTP request Description
CompaniesW9Api createCompany POST /w9/companies Create a company
CompaniesW9Api deleteCompany DELETE /w9/companies/{id} Delete a company
CompaniesW9Api getCompanies GET /w9/companies List companies
CompaniesW9Api getCompany GET /w9/companies/{id} Retrieve a company
CompaniesW9Api updateCompany PUT /w9/companies/{id} Update a company
Forms1099Api bulkUpsert1099Forms POST /1099/forms/$bulk-upsert Create or update multiple 1099/1095/W2/1042S forms
Forms1099Api create1099Form POST /1099/forms Create a 1099/1095/W2/1042S form
Forms1099Api delete1099Form DELETE /1099/forms/{id} Delete a 1099/1095/W2/1042S form
Forms1099Api get1099Form GET /1099/forms/{id} Retrieve a 1099/1095/W2/1042S form
Forms1099Api get1099FormPdf GET /1099/forms/{id}/pdf Retrieve the PDF file for a 1099/1095/W2/1042S form
Forms1099Api list1099Forms GET /1099/forms List 1099/1095/W2/1042S forms
Forms1099Api update1099Form PUT /1099/forms/{id} Update a 1099/1095/W2/1042S form
FormsW9Api createAndSendW9FormEmail POST /w9/forms/$create-and-send-email Create a minimal W9/W4/W8 form and sends the e-mail request
FormsW9Api createW9Form POST /w9/forms Create a W9/W4/W8 form
FormsW9Api deleteW9Form DELETE /w9/forms/{id} Delete a W9/W4/W8 form
FormsW9Api getW9Form GET /w9/forms/{id} Retrieve a W9/W4/W8 form
FormsW9Api getW9FormPdf GET /w9/forms/{id}/pdf Download the PDF for a W9/W4/W8 form.
FormsW9Api listW9Forms GET /w9/forms List W9/W4/W8 forms
FormsW9Api sendW9FormEmail POST /w9/forms/{id}/$send-email Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
FormsW9Api updateW9Form PUT /w9/forms/{id} Update a W9/W4/W8 form
FormsW9Api uploadW9Files POST /w9/forms/{id}/attachment Replace the PDF file for a W9/W4/W8 form
Issuers1099Api createIssuer POST /1099/issuers Create an issuer
Issuers1099Api deleteIssuer DELETE /1099/issuers/{id} Delete an issuer
Issuers1099Api getIssuer GET /1099/issuers/{id} Retrieve an issuer
Issuers1099Api getIssuers GET /1099/issuers List issuers
Issuers1099Api updateIssuer PUT /1099/issuers/{id} Update an issuer
JobsApi getJob GET /jobs/{id} Retrieves information about the job

Documentation for Models

EInvoicing V1 Model Documentation

A1099 V2 Model Documentation

About

Avalara-SDK-Typescript

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

1 fork
Report repository

Releases 17

25.11.2 Latest
Nov 21, 2025
+ 16 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages