API Evangelist conversational phrasing for Avalara VAT Reporting Returns API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara VAT Reporting Returns API
  version: 1.0.0
extends: openapi/avalara-returns-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/returns'].get
  update:
    x-apievangelist-phrasing:
      intent: List VAT returns
      effect: read
      questions:
      - Which VAT returns are still waiting to be filed?
      - Can I list VAT returns for one country and period?
      instructions:
      - text: List VAT returns with status {status}.
        slots:
          status: query.status
      - text: Show VAT returns for {countryCode} from {periodStart} to {periodEnd}.
        slots:
          countryCode: query.countryCode
          periodStart: query.periodStart
          periodEnd: query.periodEnd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/returns/{returnId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VAT return
      effect: read
      questions:
      - Can I review a VAT return before it is filed?
      - What amounts are on a specific VAT return?
      instructions:
      - text: Get VAT return {returnId}.
        slots:
          returnId: path.returnId
      - text: Show the details of VAT return {returnId}.
        slots:
          returnId: path.returnId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/returns/{returnId}/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: File a VAT return with the tax authority
      effect: destructive
      questions:
      - How do I file a finalized VAT return with the tax authority?
      - Can I submit a VAT return once it's been finalized?
      instructions:
      - text: Submit VAT return {returnId} for filing.
        slots:
          returnId: path.returnId
      - text: File return {returnId} with the tax authority.
        slots:
          returnId: path.returnId
      method: generated
      generated: '2026-09-26'