naftiko: 1.0.0-alpha2
info:
label: Avalara AvaTax APIs — Definitions
description: 'Avalara AvaTax APIs — Definitions. 73 operations. Lead operation: Avalara ListParametersByAccount. Self-contained
Naftiko capability covering one Avalara business surface.'
tags:
- Avalara
- Definitions
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
AVALARA_API_KEY: AVALARA_API_KEY
capability:
consumes:
- type: http
namespace: avatax-apis-definitions
baseUri: http://{{baseurl}}
description: Avalara AvaTax APIs — Definitions business capability. Self-contained, no shared references.
resources:
- name: api-v2-definitions-accounts-accountId-parameters
path: /api/v2/definitions/accounts/{accountId}/parameters
operations:
- name: get
method: GET
description: Avalara ListParametersByAccount
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: accountId
in: path
type: string
required: true
- name: api-v2-definitions-avafileforms
path: /api/v2/definitions/avafileforms
operations:
- name: get
method: GET
description: Avalara ListAvaFileForms
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-certificateattributes
path: /api/v2/definitions/certificateattributes
operations:
- name: get
method: GET
description: Avalara ListCertificateAttributes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-certificateexemptreasons
path: /api/v2/definitions/certificateexemptreasons
operations:
- name: get
method: GET
description: Avalara ListCertificateExemptReasons
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-certificateexposurezones
path: /api/v2/definitions/certificateexposurezones
operations:
- name: get
method: GET
description: Avalara ListCertificateExposureZones
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-classification-parametersusage
path: /api/v2/definitions/classification/parametersusage
operations:
- name: get
method: GET
description: Avalara ListClassificationParametersUsage
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-communications-transactiontypes
path: /api/v2/definitions/communications/transactiontypes
operations:
- name: get
method: GET
description: Avalara ListCommunicationsTransactionTypes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-communications-transactiontypes-id-servicetypes
path: /api/v2/definitions/communications/transactiontypes/{id}/servicetypes
operations:
- name: get
method: GET
description: Avalara ListCommunicationsServiceTypes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: id
in: path
type: string
required: true
- name: api-v2-definitions-communications-tspairs
path: /api/v2/definitions/communications/tspairs
operations:
- name: get
method: GET
description: Avalara ListCommunicationsTSPairs
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-companies-companyId-countries-country-regions-taxtypes-taxTyp
path: /api/v2/definitions/companies/{companyId}/countries/{country}/regions/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}/rateTypeId/{rateTypeId}/jurisdictionTypeId/{jurisdictionTypeId}
operations:
- name: get
method: GET
description: Avalara ListRegionsByCountryAndTaxTypeAndTaxSubTypeAndRateType
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: companyId
in: path
type: string
required: true
- name: country
in: path
type: string
required: true
- name: taxTypeId
in: path
type: string
required: true
- name: taxSubTypeId
in: path
type: string
required: true
- name: rateTypeId
in: path
type: string
required: true
- name: jurisdictionTypeId
in: path
type: string
required: true
- name: api-v2-definitions-countries
path: /api/v2/definitions/countries
operations:
- name: get
method: GET
description: Avalara ListCountries
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-countries-country-ratetypes
path: /api/v2/definitions/countries/{country}/ratetypes
operations:
- name: get
method: GET
description: Avalara ListRateTypesByCountry
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: api-v2-definitions-countries-country-regions
path: /api/v2/definitions/countries/{country}/regions
operations:
- name: get
method: GET
description: Avalara ListRegionsByCountry
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: api-v2-definitions-countries-country-taxtypes-taxTypeId-taxsubtypes-taxSubTypeId
path: /api/v2/definitions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}/ratetypes
operations:
- name: get
method: GET
description: Avalara ListRateTypesByCountryTaxTypeTaxSubType
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: taxTypeId
in: path
type: string
required: true
- name: taxSubTypeId
in: path
type: string
required: true
- name: api-v2-definitions-coverletters
path: /api/v2/definitions/coverletters
operations:
- name: get
method: GET
description: Avalara ListCoverLetters
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-crossborder-sections
path: /api/v2/definitions/crossborder/sections
operations:
- name: get
method: GET
description: Avalara ListCrossBorderSections
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-crossborder-country-hsCode
path: /api/v2/definitions/crossborder/{country}/{hsCode}
operations:
- name: get
method: GET
description: Avalara ListCrossBorderCodes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: hsCode
in: path
type: string
required: true
- name: api-v2-definitions-crossborder-country-hsCode-hierarchy
path: /api/v2/definitions/crossborder/{country}/{hsCode}/hierarchy
operations:
- name: get
method: GET
description: Avalara GetCrossBorderCode
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: hsCode
in: path
type: string
required: true
- name: api-v2-definitions-currencies
path: /api/v2/definitions/currencies
operations:
- name: get
method: GET
description: Avalara ListCurrencies
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-entityusecodes
path: /api/v2/definitions/entityusecodes
operations:
- name: get
method: GET
description: Avalara ListEntityUseCodes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-filingcalendars-loginverifiers
path: /api/v2/definitions/filingcalendars/loginverifiers
operations:
- name: get
method: GET
description: Avalara ListLoginVerifiers
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-filingcalendars-loginverifiers-form
path: /api/v2/definitions/filingcalendars/loginverifiers/{form}
operations:
- name: get
method: GET
description: Avalara GetLoginVerifierByForm
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: form
in: path
type: string
required: true
- name: api-v2-definitions-filingfrequencies
path: /api/v2/definitions/filingfrequencies
operations:
- name: get
method: GET
description: Avalara ListFilingFrequencies
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-jurisdictionTypes-countries-country-taxtypes-taxTypeId-taxsub
path: /api/v2/definitions/jurisdictionTypes/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}
operations:
- name: get
method: GET
description: Avalara ListJurisdictionTypesByRateTypeTaxTypeMapping
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: taxTypeId
in: path
type: string
required: true
- name: taxSubTypeId
in: path
type: string
required: true
- name: api-v2-definitions-jurisdictions
path: /api/v2/definitions/jurisdictions
operations:
- name: get
method: GET
description: Avalara ListJurisdictions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-jurisdictions-countries-country-taxtypes-taxTypeId-taxsubtype
path: /api/v2/definitions/jurisdictions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}
operations:
- name: get
method: GET
description: Avalara ListJurisdictionsByRateTypeTaxTypeMapping
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: taxTypeId
in: path
type: string
required: true
- name: taxSubTypeId
in: path
type: string
required: true
- name: api-v2-definitions-jurisdictionsnearaddress
path: /api/v2/definitions/jurisdictionsnearaddress
operations:
- name: get
method: GET
description: Avalara ListJurisdictionsByAddress
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-listallmarketplacelocations
path: /api/v2/definitions/listallmarketplacelocations
operations:
- name: get
method: GET
description: Avalara ListAllMarketplaceLocations
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-locationquestions
path: /api/v2/definitions/locationquestions
operations:
- name: get
method: GET
description: Avalara ListLocationQuestionsByAddress
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-marketplacelocations
path: /api/v2/definitions/marketplacelocations
operations:
- name: get
method: GET
description: Avalara ListMarketplaceLocations
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-nexus
path: /api/v2/definitions/nexus
operations:
- name: get
method: GET
description: Avalara ListNexus
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-nexus-byaddress
path: /api/v2/definitions/nexus/byaddress
operations:
- name: get
method: GET
description: Avalara ListNexusByAddress
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-nexus-byform-formCode
path: /api/v2/definitions/nexus/byform/{formCode}
operations:
- name: get
method: GET
description: Avalara ListNexusByFormCode
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: formCode
in: path
type: string
required: true
- name: api-v2-definitions-nexus-bytaxtypegroup-taxTypeGroup
path: /api/v2/definitions/nexus/bytaxtypegroup/{taxTypeGroup}
operations:
- name: get
method: GET
description: Avalara ListNexusByTaxTypeGroup
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: taxTypeGroup
in: path
type: string
required: true
- name: api-v2-definitions-nexus-country
path: /api/v2/definitions/nexus/{country}
operations:
- name: get
method: GET
description: Avalara ListNexusByCountry
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: api-v2-definitions-nexus-country-region
path: /api/v2/definitions/nexus/{country}/{region}
operations:
- name: get
method: GET
description: Avalara ListNexusByCountryAndRegion
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: country
in: path
type: string
required: true
- name: region
in: path
type: string
required: true
- name: api-v2-definitions-nexustaxtypegroups
path: /api/v2/definitions/nexustaxtypegroups
operations:
- name: get
method: GET
description: Avalara ListNexusTaxTypeGroups
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticecustomerfundingoptions
path: /api/v2/definitions/noticecustomerfundingoptions
operations:
- name: get
method: GET
description: Avalara ListNoticeCustomerFundingOptions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticecustomertypes
path: /api/v2/definitions/noticecustomertypes
operations:
- name: get
method: GET
description: Avalara ListNoticeCustomerTypes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticefilingtypes
path: /api/v2/definitions/noticefilingtypes
operations:
- name: get
method: GET
description: Avalara ListNoticeFilingtypes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticepriorities
path: /api/v2/definitions/noticepriorities
operations:
- name: get
method: GET
description: Avalara ListNoticePriorities
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticereasons
path: /api/v2/definitions/noticereasons
operations:
- name: get
method: GET
description: Avalara ListNoticeReasons
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticeresponsibilities
path: /api/v2/definitions/noticeresponsibilities
operations:
- name: get
method: GET
description: Avalara ListNoticeResponsibilities
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticerootcauses
path: /api/v2/definitions/noticerootcauses
operations:
- name: get
method: GET
description: Avalara ListNoticeRootCauses
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticestatuses
path: /api/v2/definitions/noticestatuses
operations:
- name: get
method: GET
description: Avalara ListNoticeStatuses
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
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/cli
- name: api-v2-definitions-noticetypes
path: /api/v2/definitions/noticetypes
operations:
- name: get
method: GET
description: Avalara ListNoticeTypes
outputRawFormat: json
outpu
# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/capabilities/avatax-apis-definitions.yaml