# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Tax Rules API
  version: 1.0.0
extends: openapi/avalara-tax-rules-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: 8
- target: $.paths['/api/v2/companies/{companyId}/taxrules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's custom tax rules
      effect: read
      questions:
      - Which custom tax rules have I set up for my company?
      - Can I filter a company's tax rules?
      instructions:
      - text: List tax rules for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show tax rules for company {companyId} matching {filter}.
        slots:
          companyId: path.companyId
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxrules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create custom tax rules for a company
      effect: write
      questions:
      - Can I add a custom tax rule to override a rate for my company?
      - Is it possible to create several tax rules for one company?
      instructions:
      - text: Create tax rules for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Add custom tax rule overrides to company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/countryCoefficients'].put
  update:
    x-apievangelist-phrasing:
      intent: Create cross-border country coefficients
      effect: write
      questions:
      - How do I nudge cross-border tax calculations up or down for a destination country?
      - Can I set country coefficients by tax subtype?
      instructions:
      - text: Create country coefficients for cross-border calculations.
      - text: Add a coefficient adjustment for a destination country.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxrules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single custom tax rule
      effect: read
      questions:
      - What does one specific custom tax rule override?
      - Can I look up a tax rule by its ID?
      instructions:
      - text: Get tax rule {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Show custom tax rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxrules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom tax rule
      effect: write
      questions:
      - How do I change the rate or taxability in an existing tax rule?
      - Can I edit a custom tax rule instead of creating a new one?
      instructions:
      - text: Update tax rule {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Replace custom tax rule {id} with new settings.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/taxrules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom tax rule
      effect: destructive
      questions:
      - How do I remove a tax rule override so default behavior applies again?
      - Can I delete a custom tax rule?
      instructions:
      - text: Delete tax rule {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark custom tax rule {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/{country}/CountryCoefficients'].get
  update:
    x-apievangelist-phrasing:
      intent: List country coefficients for a country
      effect: read
      questions:
      - Which cross-border coefficients are set for a given country?
      - Can I filter a country's coefficient records?
      instructions:
      - text: List country coefficients for {country}.
        slots:
          country: path.country
      - text: Show the cross-border coefficients defined for {country}.
        slots:
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/taxrules'].get
  update:
    x-apievangelist-phrasing:
      intent: Search tax rules across all companies
      effect: read
      questions:
      - Which custom tax rules exist across every company in my account?
      - Can I query tax rules without choosing a single company?
      instructions:
      - text: List tax rules across all my companies.
      - text: Query every company's custom tax rules in the account.
      method: generated
      generated: '2026-10-01'