# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara AvaTax Tax Codes API
  version: 1.0.0
extends: openapi/avalara-tax-codes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/v2/companies/{companyId}/taxcodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's custom tax codes
      effect: read
      questions:
      - Which custom tax codes has my company defined?
      - Can I see the product tax codes attached to one company?
      instructions:
      - text: List tax codes for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show every custom tax code of company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxcodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create custom tax codes
      effect: write
      questions:
      - How do I add my own tax code for a product type?
      - Can I create several tax codes at once for a company?
      instructions:
      - text: Create tax codes for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Add a new custom product tax code to company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxcodes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tax code
      effect: read
      questions:
      - Can I look up a single custom tax code by ID?
      - What product type does a particular tax code represent?
      instructions:
      - text: Get tax code {id} of company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Show details of tax code {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxcodes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom tax code
      effect: write
      questions:
      - How do I change the description of a custom tax code?
      - Does updating a tax code replace all its fields?
      instructions:
      - text: Update tax code {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Replace custom tax code {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxcodes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom tax code
      effect: destructive
      questions:
      - How do I remove a custom tax code I no longer use?
      - Is a deleted tax code marked deleted rather than erased?
      instructions:
      - text: Delete tax code {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark custom tax code {id} of company {companyId} as deleted.
        slots:
          id: path.id
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/taxcodes'].get
  update:
    x-apievangelist-phrasing:
      intent: Query tax codes across all companies
      effect: read
      questions:
      - Can I search custom tax codes across every company?
      - Which companies use a particular tax code?
      instructions:
      - text: Query tax codes across all companies.
      - text: Search every company's custom tax codes.
      method: generated
      generated: '2026-10-01'