Avalara Definitions API

openapi: 3.2.0
info:
  title: Avalara Definitions API
  version: '1.0'
  description: 'Operations tagged Definitions across 2 of this provider''s published API definitions: avalara-avatax-rest-openapi.yml, avatax-apis-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rest.avatax.com
  description: AvaTax Production
- url: https://sandbox-rest.avatax.com
  description: AvaTax Sandbox
- url: http://{{baseurl}}
tags:
- name: Definitions
  description: Query tax content definitions, rates, and jurisdictions
paths:
  /api/v2/definitions/taxcodes:
    servers:
    - url: https://rest.avatax.com
      description: AvaTax Production
    - url: https://sandbox-rest.avatax.com
      description: AvaTax Sandbox
    get:
      operationId: listTaxCodes
      summary: Avalara List All Tax Codes
      description: Retrieves the full list of Avalara-supported tax codes for product and service classification.
      tags:
      - Definitions
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      responses:
        '200':
          description: List of tax codes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchResult_TaxCodeModel'
      security:
      - basicAuth: []
      - bearerAuth: []
  /api/v2/definitions/nexus/{country}:
    servers:
    - url: https://rest.avatax.com
      description: AvaTax Production
    - url: https://sandbox-rest.avatax.com
      description: AvaTax Sandbox
    get:
      operationId: listNexusByCountry
      summary: Avalara List Nexus Options for a Country
      tags:
      - Definitions
      parameters:
      - name: country
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Nexus options for country
      security:
      - basicAuth: []
      - bearerAuth: []
  /api/v2/definitions/jurisdictions:
    servers:
    - url: https://rest.avatax.com
      description: AvaTax Production
    - url: https://sandbox-rest.avatax.com
      description: AvaTax Sandbox
    get:
      operationId: listJurisdictions
      summary: Avalara List All Jurisdictions
      tags:
      - Definitions
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      responses:
        '200':
          description: List of jurisdictions
      security:
      - basicAuth: []
      - bearerAuth: []
  /api/v2/definitions/countries:
    servers:
    - url: https://rest.avatax.com
      description: AvaTax Production
    - url: https://sandbox-rest.avatax.com
      description: AvaTax Sandbox
    get:
      operationId: listCountries
      summary: Avalara List All Countries Supported by AvaTax
      tags:
      - Definitions
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      responses:
        '200':
          description: List of countries
      security:
      - basicAuth: []
      - bearerAuth: []
  /api/v2/definitions/entityusecodes:
    servers:
    - url: https://rest.avatax.com
      description: AvaTax Production
    - url: https://sandbox-rest.avatax.com
      description: AvaTax Sandbox
    get:
      operationId: listEntityUseCodes
      summary: Avalara List All Entity Use Codes
      description: Returns the full list of entity use codes that can be applied to transactions to indicate exemptions or special tax handling.
      tags:
      - Definitions
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      responses:
        '200':
          description: List of entity use codes
      security:
      - basicAuth: []
      - bearerAuth: []
  /api/v2/definitions/crossborder/{country}/{hsCode}/hierarchy:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara GetCrossBorderCode
      description: "Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings\n            \na list of HS Codes that are the parents and information branches of the HS Code for the given\ndestination country, if lower detail is available.\n            \nThis API will include information branches if applicable. These do not have HS Codes and cannot be referenced,\nbut can contain information relevant to deciding the correct HS Code.\n            \nThis API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful\nwhen HS Codes can have multiple levels of generic descriptions.\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all):  AvaTaxGlobal.\n"
      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: country
        in: path
        schema:
          type: string
        required: true
      - name: hsCode
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      security:
      - basicAuth: []
  /api/v2/definitions/filingcalendars/loginverifiers/{form}:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara GetLoginVerifierByForm
      description: 'This API is intended to be useful to identify whether the user should be allowed

        to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.'
      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: form
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      security:
      - basicAuth: []
  /api/v2/definitions/listallmarketplacelocations:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListAllMarketplaceLocations
      description: List all market place locations.
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/avafileforms:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListAvaFileForms
      description: "This API is deprecated.\n            \nPlease use the ListTaxForms API.\n            \nReturns the full list of Avalara-supported AvaFile Forms\nThis API is intended to be useful to identify all the different AvaFile Forms"
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/certificateattributes:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCertificateAttributes
      description: "List the certificate attributes defined by a company either specified by the user or the user's default company.\n            \nA certificate may have multiple attributes that control its behavior.  You may apply or remove attributes to a\ncertificate at any time.\n            \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account."
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/certificateexemptreasons:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCertificateExemptReasons
      description: "List the certificate exempt reasons defined by a company.\n            \nAn exemption reason defines why a certificate allows a customer to be exempt\nfor purposes of tax calculation.\n            \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account."
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/certificateexposurezones:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCertificateExposureZones
      description: "List the certificate exposure zones defined by a company.\n            \nAn exposure zone is a location where a certificate can be valid.  Exposure zones may indicate a taxing\nauthority or other legal entity to which a certificate may apply.\n            \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account."
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/classification/parametersusage:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListClassificationParametersUsage
      description: 'Returns the full list of Avalara-supported usage of extra parameters for item classification.

        The list of parameters is available for use with Item Classification.

        Some parameters are only available for use if you have subscribed to certain features of AvaTax.'
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/communications/transactiontypes/{id}/servicetypes:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCommunicationsServiceTypes
      description: Returns full list of service types for a given transaction type ID.
      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: id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      security:
      - basicAuth: []
  /api/v2/definitions/communications/tspairs:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCommunicationsTSPairs
      description: 'Returns full list of communications transaction/service type pairs which

        are accepted in communication tax calculation requests.'
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/communications/transactiontypes:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCommunicationsTransactionTypes
      description: 'Returns full list of communications transaction types which

        are accepted in communication tax calculation requests.'
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/coverletters:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCoverLetters
      description: "List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.\n            \nThe CoverLetter model represents a message sent along with an invitation to use CertExpress to\nupload certificates.  An invitation allows customers to use CertExpress to upload their exemption\ncertificates directly; this cover letter explains why the invitation was sent.\n            \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account."
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/crossborder/{country}/{hsCode}:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCrossBorderCodes
      description: "Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if\nadditional children are available.\n            \nHS Code is interchangeable with \"tariff code\" and definitions are generally unique to a destination country.\nAn HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by\nSection/Chapter/Heading/Subheading/Classification.\n            \nThis API is intended to be useful to identify the correct HS Code to use for your item.\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all):  AvaTaxGlobal.\n"
      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: country
        in: path
        schema:
          type: string
        required: true
      - name: hsCode
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      security:
      - basicAuth: []
  /api/v2/definitions/crossborder/sections:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCrossBorderSections
      description: "Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for\nclassifying tariff codes and the items to which they apply. HS Codes are organized\nby Section/Chapter/Heading/Subheading/Classification.\n            \nThis API is intended to be useful to identify the top level Sections for\nfurther LandedCost HS Code lookups.\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all):  AvaTaxGlobal.\n"
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/currencies:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListCurrencies
      description: "Lists all ISO 4217 currencies supported by AvaTax.\n            \nThis API produces a list of currency codes that can be used when calling AvaTax.  The values from this API can be used to fill out the\n`currencyCode` field in a `CreateTransactionModel`."
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/filingfrequencies:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListFilingFrequencies
      description: 'Returns the full list of Avalara-supported filing frequencies.

        This API is intended to be useful to identify all the different filing frequencies that can be used in notices.'
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/jurisdictionTypes/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListJurisdictionTypesByRateTypeTaxTypeMapping
      description: Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId
      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: country
        in: path
        schema:
          type: string
        required: true
      - name: taxTypeId
        in: path
        schema:
          type: string
        required: true
      - name: taxSubTypeId
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      security:
      - basicAuth: []
  /api/v2/definitions/jurisdictionsnearaddress:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListJurisdictionsByAddress
      description: "Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.\n            \nThis API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.\nIt is intended to allow you to create a \"Jurisdiction Override\", which allows an address to be configured as belonging to a nearby\njurisdiction in AvaTax.\n            \nThe results of this API call can be passed to the `CreateJurisdictionOverride` API call."
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/jurisdictions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListJurisdictionsByRateTypeTaxTypeMapping
      description: "Returns a list of all Avalara-supported taxing jurisdictions filtered by taxTypeId, taxSubTypeId, country, and rateTypeId.\n            \nYou can optionally pass region as a query parameter to retrieve jurisdictions that are under that region.\n            \nThis API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying\nSQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'\n            \nThe jurisdictionType, effectiveDate, and endDate are filterable fields available on the JurisdictionRateTypeTaxTypeMappingModels returned by this API."
      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: country
        in: path
        schema:
          type: string
        required: true
      - name: taxTypeId
        in: path
        schema:
          type: string
        required: true
      - name: taxSubTypeId
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      security:
      - basicAuth: []
  /api/v2/definitions/locationquestions:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListLocationQuestionsByAddress
      description: 'Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.

        Some tax jurisdictions require that you register or provide additional information to configure each physical place where

        your company does business.

        This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.

        You can call this API call for any address and obtain information about what questions must be answered in order to properly

        file tax in that location.'
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/filingcalendars/loginverifiers:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListLoginVerifiers
      description: 'List all forms where logins can be verified automatically.

        This API is intended to be useful to identify whether the user should be allowed

        to automatically verify their login and password.'
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/marketplacelocations:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListMarketplaceLocations
      description: Retrieves the list of suggested locations for a marketplace.
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/nexus:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListNexus
      description: "Returns the full list of all Avalara-supported nexus for all countries and regions.\n            \nThis API is intended to be useful if your user interface needs to display a selectable list of nexus."
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/nexus/byaddress:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListNexusByAddress
      description: 'Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.

        This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.

        In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address

        where the company does business.

        The results of this API call can be passed to the ''Create Nexus'' API call to declare nexus for this address.'
      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: {}
      security:
      - basicAuth: []
  /api/v2/definitions/nexus/{country}/{region}:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListNexusByCountryAndRegion
      description: "Returns all Avalara-supported nexus for the specified country and region.\n            \nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region."
      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: country
        in: path
        schema:
          type: string
        required: true
      - name: region
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      security:
      - basicAuth: []
  /api/v2/definitions/nexus/byform/{formCode}:
    servers:
    - url: http://{{baseurl}}
    get:
      tags:
      - Definitions
      summary: Avalara ListNexusByFormCode
      description: "Retrieves a list of nexus related to a tax form.\n            \nThe concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated\nto collect and remit transaction-based taxes.\n            \nWhen defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax\nin all jurisdictions affected by your transactions.\n            \nThis API is intended to provide useful information when examining a tax form.  If you are about to begin filing\na tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax\nform in order to better understand how the form will be filled out.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAd

# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/openapi/avalara-definitions-api-openapi.yml