# 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 Brazil Electronic Invoices API
  version: 1.0.0
extends: openapi/avalara-electronic-invoices-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['/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List Brazilian electronic invoices
      effect: read
      questions:
      - Which NF-e invoices did I issue this month?
      - Can I list electronic invoices by status and date range?
      instructions:
      - text: List electronic invoices from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Show electronic invoices with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invoices'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a Brazilian electronic invoice
      effect: write
      questions:
      - How do I issue an NF-e to SEFAZ?
      - Can I issue an NFS-e or NFC-e instead of an NF-e?
      instructions:
      - text: Issue a {invoiceType} invoice for company {companyId} to buyer {buyer}.
        slots:
          invoiceType: requestBody.invoiceType
          companyId: requestBody.companyId
          buyer: requestBody.buyer
      - text: Create an electronic fiscal document dated {transactionDate} with lines {lines}.
        slots:
          transactionDate: requestBody.transactionDate
          lines: requestBody.lines
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invoices/{invoiceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an electronic invoice
      effect: read
      questions:
      - Can I check whether a specific NF-e was authorized?
      - Where do I see the details of one electronic invoice?
      instructions:
      - text: Get electronic invoice {invoiceId}.
        slots:
          invoiceId: path.invoiceId
      - text: Show the status of invoice {invoiceId}.
        slots:
          invoiceId: path.invoiceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invoices/{invoiceId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an authorized electronic invoice
      effect: destructive
      questions:
      - Can I cancel an NF-e that was already authorized?
      - What reason do I give when cancelling an electronic invoice?
      instructions:
      - text: Cancel electronic invoice {invoiceId}.
        slots:
          invoiceId: path.invoiceId
      - text: Request cancellation of invoice {invoiceId} because {reason}.
        slots:
          invoiceId: path.invoiceId
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'