openapi: 3.2.0
info:
  title: Avalara AvaTax Tax Codes API
  description: Welcome to the AvaTax API Postman Collection!
  version: 1.0.0
servers:
- url: http://{{baseurl}}
security:
- basicAuth: []
tags:
- name: Tax Codes
paths:
  /api/v2/companies/{companyId}/taxcodes:
    post:
      tags:
      - Tax Codes
      summary: Avalara CreateTaxCodes
      description: 'Create one or more new taxcode objects attached to this company.

        A ''TaxCode'' represents a uniquely identified type of product, good, or service.

        Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.

        If you identify your products by tax code in your ''Create Transaction'' API calls, Avalara will correctly calculate tax rates and

        taxability rules for this product in all supported jurisdictions.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: 56789
                companyId: 12345
                taxCode: PS081282
                taxCodeTypeId: P
                description: Yarn
                parentTaxCode: PS080100
                isPhysical: true
                goodsServiceCode: 0
                entityUseCode: ''
                isActive: true
                isSSTCertified: false
      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: postApiV2CompaniesByCompanyIdTaxcodes
      x-operation-id-source: derived
    get:
      tags:
      - Tax Codes
      summary: Avalara ListTaxCodesByCompany
      description: 'List all taxcode objects attached to this company.

        A ''TaxCode'' represents a uniquely identified type of product, good, or service.

        Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.

        If you identify your products by tax code in your ''Create Transaction'' API calls, Avalara will correctly calculate tax rates and

        taxability rules for this product in all supported jurisdictions.


        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, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.'
      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: getApiV2CompaniesByCompanyIdTaxcodes
      x-operation-id-source: derived
  /api/v2/companies/{companyId}/taxcodes/{id}:
    delete:
      tags:
      - Tax Codes
      summary: Avalara DeleteTaxCode
      description: 'Marks the existing TaxCode object at this URL as deleted.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.'
      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: deleteApiV2CompaniesByCompanyIdTaxcodesById
      x-operation-id-source: derived
    get:
      tags:
      - Tax Codes
      summary: Avalara GetTaxCode
      description: 'Get the taxcode object identified by this URL.

        A ''TaxCode'' represents a uniquely identified type of product, good, or service.

        Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.

        If you identify your products by tax code in your ''Create Transaction'' API calls, Avalara will correctly calculate tax rates and

        taxability rules for this product in all supported jurisdictions.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.'
      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: getApiV2CompaniesByCompanyIdTaxcodesById
      x-operation-id-source: derived
    put:
      tags:
      - Tax Codes
      summary: Avalara UpdateTaxCode
      description: 'Replace the existing taxcode object at this URL with an updated object.

        A ''TaxCode'' represents a uniquely identified type of product, good, or service.

        Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.

        If you identify your products by tax code in your ''Create Transaction'' API calls, Avalara will correctly calculate tax rates and

        taxability rules for this product in all supported jurisdictions.

        All data from the existing object will be replaced with data in the object you PUT.

        To set a field''s value to null, you may either set its value to null or omit that field from the object you post.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: 56789
                companyId: 12345
                taxCode: PS081282
                taxCodeTypeId: P
                description: Yarn
                parentTaxCode: PS080100
                isPhysical: true
                goodsServiceCode: 0
                entityUseCode: ''
                isActive: true
                isSSTCertified: false
      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: putApiV2CompaniesByCompanyIdTaxcodesById
      x-operation-id-source: derived
  /api/v2/taxcodes:
    get:
      tags:
      - Tax Codes
      summary: Avalara QueryTaxCodes
      description: 'Get multiple taxcode objects across all companies.

        A ''TaxCode'' represents a uniquely identified type of product, good, or service.

        Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.

        If you identify your products by tax code in your ''Create Transaction'' API calls, Avalara will correctly calculate tax rates and

        taxability rules for this product in all supported jurisdictions.


        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, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.'
      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: getApiV2Taxcodes
      x-operation-id-source: derived
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic