# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara E-Invoicing REST Documents API
  version: 1.0.0
extends: openapi/avalara-documents-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: 4
- target: $.paths['/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List submitted e-invoice documents
      effect: read
      questions:
      - Which e-invoices did I submit last month?
      - Can I filter submitted e-invoice documents by status or inbound versus outbound flow?
      instructions:
      - text: List e-invoice documents submitted between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Show {flow} documents with status {status}.
        slots:
          flow: query.flow
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an e-invoice document
      effect: write
      questions:
      - How do I send an electronic invoice to the tax authority?
      - Which data formats can an e-invoice document be submitted in?
      instructions:
      - text: Submit e-invoice {data} in format {dataFormat}.
        slots:
          data: requestBody.data
          dataFormat: requestBody.dataFormat
      - text: Send this {dataFormat} version {dataFormatVersion} invoice {data} with metadata {metadata}.
        slots:
          dataFormat: requestBody.dataFormat
          dataFormatVersion: requestBody.dataFormatVersion
          data: requestBody.data
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a submitted e-invoice document
      effect: read
      questions:
      - Can I see the full details of an e-invoice I submitted?
      - Where can I retrieve a submitted document record by its ID?
      instructions:
      - text: Retrieve e-invoice document {documentId}.
        slots:
          documentId: path.documentId
      - text: Show all details of submitted document {documentId}.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documents/{documentId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an e-invoice processing status
      effect: read
      questions:
      - Was my e-invoice accepted or is it still processing?
      - Can I check just the current processing status of a document?
      instructions:
      - text: Get the processing status of document {documentId}.
        slots:
          documentId: path.documentId
      - text: Check whether document {documentId} has been delivered yet.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-09-26'