# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Multi Document API
  version: 1.0.0
extends: openapi/avalara-multidocument-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: 11
- target: $.paths['/api/v2/multidocument/transactions/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a multi-company transaction
      effect: write
      questions:
      - How do I calculate tax on a sale that spans several companies?
      - Can I group related documents across jurisdictions into one transaction?
      instructions:
      - text: Create a multi-document transaction {code} with lines {lines}.
        slots:
          code: requestBody.code
          lines: requestBody.lines
      - text: Record a multi-company transaction with lines {lines}.
        slots:
          lines: requestBody.lines
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/transactions/multidocument/{code}/type/{type}/adjust'].post
  update:
    x-apievangelist-phrasing:
      intent: Adjust a MultiDocument transaction
      effect: write
      questions:
      - How do I change a MultiDocument transaction after it was recorded?
      - Can I correct the lines on a marketplace MultiDocument sale?
      instructions:
      - text: Adjust MultiDocument transaction {code} of type {type}.
        slots:
          code: path.code
          type: path.type
      - text: Correct the MultiDocument sale {code} ({type}) with new lines.
        slots:
          code: path.code
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument/{code}/type/{type}/audit'].get
  update:
    x-apievangelist-phrasing:
      intent: Audit a MultiDocument transaction
      effect: read
      questions:
      - Can I see the original API request and response behind a MultiDocument transaction?
      - What audit trail is kept for a MultiDocument transaction?
      instructions:
      - text: Get audit information for MultiDocument transaction {code} of type {type}.
        slots:
          code: path.code
          type: path.type
      - text: Show the audit trail for MultiDocument {code} ({type}).
        slots:
          code: path.code
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument/commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a MultiDocument transaction
      effect: write
      questions:
      - How do I mark a MultiDocument transaction as committed so it gets reported?
      - Can committed MultiDocument transactions be picked up by Managed Returns?
      instructions:
      - text: Commit a MultiDocument transaction so it can be reported to tax authorities.
      - text: Mark my MultiDocument transaction as committed for filing.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument'].get
  update:
    x-apievangelist-phrasing:
      intent: List MultiDocument transactions in the account
      effect: read
      questions:
      - Which MultiDocument transactions have been recorded in my account?
      - Is there a cap on how many MultiDocument transactions come back per page?
      instructions:
      - text: List all MultiDocument transactions in my account.
      - text: Show the latest MultiDocument transactions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a marketplace MultiDocument transaction
      effect: write
      questions:
      - How do I record one sale where several marketplace vendors each sell part of the order?
      - Can each vendor in a marketplace order get its own tax document?
      instructions:
      - text: Record a new MultiDocument transaction for a marketplace order.
      - text: Create a MultiDocument sale split across several vendors.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument/{code}/type/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a MultiDocument transaction by code
      effect: read
      questions:
      - Can I look up the current version of a MultiDocument transaction by its code and type?
      - If a MultiDocument transaction was adjusted, which version do I get back?
      instructions:
      - text: Get MultiDocument transaction {code} of type {type}.
        slots:
          code: path.code
          type: path.type
      - text: Show the current MultiDocument transaction with code {code}.
        slots:
          code: path.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a MultiDocument transaction by ID
      effect: read
      questions:
      - Can I fetch one exact MultiDocument transaction by its unique numeric ID?
      - How do I get a specific MultiDocument version rather than the latest by code?
      instructions:
      - text: Get MultiDocument transaction with ID {id}.
        slots:
          id: path.id
      - text: Show the MultiDocument transaction whose unique ID is {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument/{code}/type/{type}/refund'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a MultiDocument transaction
      effect: write
      questions:
      - How do I issue a refund against a marketplace MultiDocument sale?
      - Can I create a return for a MultiDocument transaction?
      instructions:
      - text: Refund MultiDocument transaction {code} of type {type}.
        slots:
          code: path.code
          type: path.type
      - text: Create a refund for the MultiDocument sale {code} ({type}).
        slots:
          code: path.code
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a MultiDocument transaction's values
      effect: read
      questions:
      - Can I confirm a MultiDocument transaction matches the totals in my ledger?
      - Which value mismatched when a MultiDocument verification fails?
      instructions:
      - text: Verify a MultiDocument transaction against my expected totals.
      - text: Check that my MultiDocument transaction matches expected values.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/transactions/multidocument/{code}/type/{type}/void'].post
  update:
    x-apievangelist-phrasing:
      intent: Void a MultiDocument transaction
      effect: destructive
      questions:
      - How do I cancel a MultiDocument transaction so it is not reported?
      - What happens to a MultiDocument transaction when it is voided?
      instructions:
      - text: Void MultiDocument transaction {code} of type {type}.
        slots:
          code: path.code
          type: path.type
      - text: Cancel the MultiDocument sale {code} ({type}).
        slots:
          code: path.code
          type: path.type
      method: generated
      generated: '2026-10-01'