# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Locations API
  version: 1.0.0
extends: openapi/avalara-locations-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: 14
- target: $.paths['/api/v2/companies/{companyId}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an AvaTax company's locations
      effect: read
      questions:
      - Which business locations are set up under my AvaTax company?
      - Can I filter a company's locations by address?
      instructions:
      - text: List locations for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show locations for company {companyId} matching {filter}.
        slots:
          companyId: path.companyId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add locations to an AvaTax company
      effect: write
      questions:
      - Can I add a new store location to my AvaTax company?
      - Is it possible to register several locations for a company at once?
      instructions:
      - text: Create locations for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Add new business locations to AvaTax company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List excise locations and terminals
      effect: read
      questions:
      - Which excise locations and terminals are on file?
      - Can I see all the locations I've set up for excise tax?
      instructions:
      - text: List my excise locations.
      - text: Show every excise terminal and location.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an excise location
      effect: write
      questions:
      - Can I add a terminal location with its IRS terminal code?
      - What do I need to create a new excise location?
      instructions:
      - text: Create excise location {locationName} of type {locationType}.
        slots:
          locationName: requestBody.locationName
          locationType: requestBody.locationType
      - text: Add terminal {locationName} with IRS terminal code {irsTerminalCode}.
        slots:
          locationName: requestBody.locationName
          irsTerminalCode: requestBody.irsTerminalCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyId}/locations/{locationId}/parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: List the parameters set on a location
      effect: read
      questions:
      - Which tax-affecting parameters are attached to one of my locations?
      - Can I see every parameter defined on a business location?
      instructions:
      - text: List parameters for location {locationId} in company {companyId}.
        slots:
          locationId: path.locationId
          companyId: path.companyId
      - text: Show all parameters on location {locationId}.
        slots:
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{locationId}/parameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Add parameters to a location
      effect: write
      questions:
      - How do I add a property that changes how a location is taxed?
      - Can I attach several parameters to a location in one call?
      instructions:
      - text: Add parameters to location {locationId} in company {companyId}.
        slots:
          locationId: path.locationId
          companyId: path.companyId
      - text: Attach tax-affecting parameters to location {locationId}.
        slots:
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single company location
      effect: read
      questions:
      - What address and settings are stored for one of my company's locations?
      - Can I fetch an AvaTax company location by its ID?
      instructions:
      - text: Get location {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Show the details of AvaTax location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a company location
      effect: write
      questions:
      - How do I change the address of a business location I set up?
      - Does replacing a location null out fields I leave off?
      instructions:
      - text: Update location {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Replace AvaTax location {id} with a corrected address.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company location
      effect: destructive
      questions:
      - How do I remove a store location I no longer operate?
      - Can I delete a business location from my AvaTax company?
      instructions:
      - text: Delete location {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark AvaTax location {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{locationId}/parameters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one location parameter
      effect: read
      questions:
      - What value is set on a single parameter of a location?
      - Can I fetch one location parameter by its own ID?
      instructions:
      - text: Get parameter {id} on location {locationId} for company {companyId}.
        slots:
          id: path.id
          locationId: path.locationId
          companyId: path.companyId
      - text: Show location parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{locationId}/parameters/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one location parameter
      effect: write
      questions:
      - Can I change the value of a single parameter on a location?
      - How do I correct one location parameter without touching the others?
      instructions:
      - text: Update parameter {id} on location {locationId} in company {companyId}.
        slots:
          id: path.id
          locationId: path.locationId
          companyId: path.companyId
      - text: Change the value of location parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{locationId}/parameters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one location parameter
      effect: destructive
      questions:
      - How do I remove a single parameter from a location?
      - Can I drop one tax-affecting property from a location and keep the rest?
      instructions:
      - text: Delete parameter {id} from location {locationId} in company {companyId}.
        slots:
          id: path.id
          locationId: path.locationId
          companyId: path.companyId
      - text: Remove location parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: Search locations across all companies
      effect: read
      questions:
      - Which business locations exist across every company in my account?
      - Can I query locations without choosing a single company?
      instructions:
      - text: List locations across all my AvaTax companies.
      - text: Query every company's business locations in the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/locations/{id}/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a location against taxing authority rules
      effect: read
      questions:
      - What else do I need to set up for a location to meet taxing authority rules?
      - Is my business location fully configured for local registration requirements?
      instructions:
      - text: Validate location {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Check what setup is still missing for location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'