# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Reports API
  version: 1.0.0
extends: openapi/avalara-reports-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: 5
- target: $.paths['/api/v2/companies/{companyId}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's reports
      effect: read
      questions:
      - Which reports have been generated for my company?
      - Can I see all tax reports for a company?
      instructions:
      - text: List reports for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show every report generated for company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/reports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a report
      effect: read
      questions:
      - Can I fetch one report by its ID?
      - Is my requested report ready yet?
      instructions:
      - text: Get report {id}.
        slots:
          id: path.id
      - text: Retrieve the status of report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/reports/{id}/attachment'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a finished report file
      effect: read
      questions:
      - How do I download the file for a report that has finished running?
      - What happens if I try to download a report that is not complete yet?
      instructions:
      - text: Download the file for report {id}.
        slots:
          id: path.id
      - text: Fetch the attachment of completed report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/reports/exportdocumentline/initiate'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a document line export report
      effect: write
      questions:
      - Can I export every transaction line for a company as a report?
      - How long is an exported document line report kept for download?
      instructions:
      - text: Start an ExportDocumentLine report for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Kick off a transaction line export for company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List all report tasks on my account
      effect: read
      questions:
      - Which report tasks are running or finished across my whole account?
      - Can I see every report my account has requested, not just one company's?
      instructions:
      - text: List all report tasks for my account.
      - text: Show every report requested across my account.
      method: generated
      generated: '2026-10-01'