# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Excise Platform Business Entities API
  version: 1.0.0
extends: openapi/avalara-business-entities-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: 5
- target: $.paths['/BusinessEntities'].get
  update:
    x-apievangelist-phrasing:
      intent: List excise business entities
      effect: read
      questions:
      - Which business entities are set up in my excise account?
      - Can I see all the trading partners and entities I've registered for excise?
      instructions:
      - text: List all business entities.
      - text: Show every excise business entity on file.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/BusinessEntities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an excise business entity
      effect: write
      questions:
      - Can I add a new business entity with its federal ID number?
      - What do I need to register a new entity for excise tax?
      instructions:
      - text: Create a business entity named {entityName} of type {entityType}.
        slots:
          entityName: requestBody.entityName
          entityType: requestBody.entityType
      - text: Add entity {entityName} with federal ID {federalIdNumber}.
        slots:
          entityName: requestBody.entityName
          federalIdNumber: requestBody.federalIdNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/BusinessEntities/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business entity by ID
      effect: read
      questions:
      - Can I look up one business entity's address and federal ID?
      - Is a particular business entity still marked active?
      instructions:
      - text: Get business entity {entityId}.
        slots:
          entityId: path.entityId
      - text: Show the details of entity {entityId}.
        slots:
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/BusinessEntities/{entityId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a business entity
      effect: write
      questions:
      - Can I change the address on an existing business entity?
      - Is it possible to deactivate a business entity without deleting it?
      instructions:
      - text: Update business entity {entityId} with name {entityName}.
        slots:
          entityId: path.entityId
          entityName: requestBody.entityName
      - text: Set entity {entityId} active flag to {isActive}.
        slots:
          entityId: path.entityId
          isActive: requestBody.isActive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/BusinessEntities/{entityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a business entity
      effect: destructive
      questions:
      - Can I permanently remove a business entity I no longer trade with?
      - What happens when a business entity is deleted?
      instructions:
      - text: Delete business entity {entityId}.
        slots:
          entityId: path.entityId
      - text: Remove entity {entityId} from my excise setup.
        slots:
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'