Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Avalara AvaTax Data Sources API
description: Welcome to the AvaTax API Postman Collection!
version: 1.0.0
servers:
- url: http://{{baseurl}}
security:
- basicAuth: []
tags:
- name: Data Sources
paths:
/api/v2/companies/{companyId}/datasources:
post:
tags:
- Data Sources
summary: Avalara CreateDataSources
description: 'Create one or more datasource objects.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
requestBody:
content:
application/json:
schema:
type: object
example:
id: 1
companyId: 12345
source: Amazon v2 Extractor
instance: e3ed7bac-88f3-4697-9ef5-f3f04e086666
isEnabled: false
isSynced: false
isAuthorized: false
createdUserId: 123
createdDate: '2023-08-13T00:00:00+00:00'
modifiedUserId: 12
modifiedDate: '2023-08-13T00:00:00+00:00'
name: TestName
externalState: Test Path
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: postApiV2CompaniesByCompanyIdDatasources
x-operation-id-source: derived
get:
tags:
- Data Sources
summary: Avalara ListDataSources
description: 'Gets multiple datasource objects for a given company.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: getApiV2CompaniesByCompanyIdDatasources
x-operation-id-source: derived
/api/v2/companies/{companyId}/datasources/{id}:
delete:
tags:
- Data Sources
summary: Avalara DeleteDataSource
description: 'Marks the existing datasource for a company as deleted.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: deleteApiV2CompaniesByCompanyIdDatasourcesById
x-operation-id-source: derived
get:
tags:
- Data Sources
summary: Avalara GetDataSourceById
description: 'Retrieve the data source by its unique ID number.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: getApiV2CompaniesByCompanyIdDatasourcesById
x-operation-id-source: derived
put:
tags:
- Data Sources
summary: Avalara UpdateDataSource
description: 'Updates a datasource for a company.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
requestBody:
content:
application/json:
schema:
type: object
example:
id: 1
companyId: 12345
source: Amazon v2 Extractor
instance: e3ed7bac-88f3-4697-9ef5-f3f04e086666
isEnabled: false
isSynced: false
isAuthorized: false
createdUserId: 123
createdDate: '2023-08-13T00:00:00+00:00'
modifiedUserId: 12
modifiedDate: '2023-08-13T00:00:00+00:00'
name: TestName
externalState: Test Path
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putApiV2CompaniesByCompanyIdDatasourcesById
x-operation-id-source: derived
/api/v2/datasources:
get:
tags:
- Data Sources
summary: Avalara QueryDataSources
description: 'Get multiple datasource objects across all companies.
Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on Filtering in REST .
Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: getApiV2Datasources
x-operation-id-source: derived
components:
securitySchemes:
basicAuth:
type: http
scheme: basic