# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Definitions API
  version: 1.0.0
extends: openapi/avalara-definitions-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: 73
- target: $.paths['/api/v2/definitions/taxcodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax codes
      effect: read
      questions:
      - What tax code should I assign to digital goods?
      - Can I search the list of product and service tax codes?
      instructions:
      - text: List all tax codes.
      - text: Find tax codes matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/definitions/nexus/{country}'].get
  update:
    x-apievangelist-phrasing:
      intent: List nexus options for a country
      effect: read
      questions:
      - Which jurisdictions can I declare nexus in for a given country?
      - What nexus choices are available in Canada?
      instructions:
      - text: List nexus options for {country}.
        slots:
          country: path.country
      - text: Show available nexus jurisdictions in country {country}.
        slots:
          country: path.country
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/definitions/jurisdictions'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax jurisdictions
      effect: read
      questions:
      - What tax jurisdictions does the system know about?
      - Can I filter jurisdictions by state or type?
      instructions:
      - text: List all tax jurisdictions.
      - text: List jurisdictions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/definitions/countries'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported countries
      effect: read
      questions:
      - Which countries does AvaTax support?
      - Is a particular country supported for tax calculation?
      instructions:
      - text: List supported countries.
      - text: Show supported countries matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/definitions/entityusecodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List entity use codes for exemptions
      effect: read
      questions:
      - Which entity use code marks a buyer as a nonprofit or government?
      - What codes can I put on a transaction to flag special tax handling?
      instructions:
      - text: List all entity use codes.
      - text: Find entity use codes matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/definitions/crossborder/{country}/{hsCode}/hierarchy'].get
  update:
    x-apievangelist-phrasing:
      intent: Trace an HS code up its tariff hierarchy
      effect: read
      questions:
      - What section, chapter and heading does a given HS code sit under?
      - Can I see the parent tariff codes of an HS code for one destination country?
      instructions:
      - text: Show the full parent hierarchy of HS code {hsCode} for imports into {country}.
        slots:
          hsCode: path.hsCode
          country: path.country
      - text: Trace tariff code {hsCode} back to its section and chapter in {country}.
        slots:
          hsCode: path.hsCode
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/filingcalendars/loginverifiers/{form}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if one tax form supports login verification
      effect: read
      questions:
      - Does a specific tax form let me verify my state portal login automatically?
      - Can my filing credentials for one form be checked online before filing?
      instructions:
      - text: Check whether form {form} supports automatic online login verification.
        slots:
          form: path.form
      - text: Get the login verifier for tax form {form}.
        slots:
          form: path.form
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/listallmarketplacelocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List every marketplace location
      effect: read
      questions:
      - What is the complete set of marketplace locations on record?
      - Can I pull all market place locations at once rather than just the suggested ones?
      instructions:
      - text: List all marketplace locations, not only the suggested ones.
      - text: Pull the complete marketplace location list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/avafileforms'].get
  update:
    x-apievangelist-phrasing:
      intent: List AvaFile forms (deprecated)
      effect: read
      questions:
      - Which AvaFile forms are available on the older deprecated forms endpoint?
      - Is there still a way to list AvaFile forms the legacy way?
      instructions:
      - text: List AvaFile forms using the deprecated AvaFile forms endpoint.
      - text: Show the legacy AvaFile form list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/certificateattributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List exemption certificate attributes
      effect: read
      questions:
      - What attributes can I apply to an exemption certificate to control its behavior?
      - Which certificate attributes has my company defined?
      instructions:
      - text: List the certificate attributes defined for my company.
      - text: Show which attributes I can put on an exemption certificate.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/certificateexemptreasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate exemption reasons
      effect: read
      questions:
      - What reasons can an exemption certificate give for a customer being tax exempt?
      - Which exempt reasons are set up for certificates in my company?
      instructions:
      - text: List the exempt reasons available for exemption certificates.
      - text: Show why a certificate can make a customer exempt, as defined reasons.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/certificateexposurezones'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate exposure zones
      effect: read
      questions:
      - In which exposure zones can an exemption certificate be valid?
      - What taxing authorities can a certificate apply to as exposure zones?
      instructions:
      - text: List the certificate exposure zones for my company.
      - text: Show the locations where an exemption certificate can be valid.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/classification/parametersusage'].get
  update:
    x-apievangelist-phrasing:
      intent: List parameter usage for item classification
      effect: read
      questions:
      - Which extra parameters can I use when classifying items?
      - What parameters does item classification accept beyond the basics?
      instructions:
      - text: List the extra parameters supported for item classification.
      - text: Show parameter usage for item classification.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/communications/transactiontypes/{id}/servicetypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List service types for a telecom transaction type
      effect: read
      questions:
      - Which communications service types go with a particular transaction type?
      - Can I see the telecom service types allowed for one transaction type ID?
      instructions:
      - text: List the communications service types for transaction type {id}.
        slots:
          id: path.id
      - text: Show which telecom service types pair with transaction type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/communications/tspairs'].get
  update:
    x-apievangelist-phrasing:
      intent: List communications transaction/service pairs
      effect: read
      questions:
      - Which transaction and service type combinations are accepted for communications tax?
      - What TS pairs can I send in a telecom tax calculation?
      instructions:
      - text: List all accepted communications transaction/service type pairs.
      - text: Show the valid TS pairs for communications tax requests.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/communications/transactiontypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List communications transaction types
      effect: read
      questions:
      - What transaction types does communications tax calculation accept?
      - Which telecom transaction types exist before I pick a service type?
      instructions:
      - text: List all communications transaction types.
      - text: Show the telecom transaction types accepted in tax calculation.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/coverletters'].get
  update:
    x-apievangelist-phrasing:
      intent: List CertExpress invitation cover letters
      effect: read
      questions:
      - Which cover letters can I send with a CertExpress invitation?
      - What message templates exist for asking customers to upload certificates?
      instructions:
      - text: List the available cover letters for CertExpress invitations.
      - text: Show the cover letter templates I can attach to a certificate upload invite.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/crossborder/{country}/{hsCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: List child HS codes under a prefix
      effect: read
      questions:
      - What more detailed tariff codes sit below an HS code prefix for a destination country?
      - Can I drill down from a chapter to its subheadings for one country?
      instructions:
      - text: List the child HS codes under prefix {hsCode} for {country}.
        slots:
          hsCode: path.hsCode
          country: path.country
      - text: Drill into tariff code {hsCode} for destination {country} to see more detailed codes.
        slots:
          hsCode: path.hsCode
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/crossborder/sections'].get
  update:
    x-apievangelist-phrasing:
      intent: List top-level HS code sections
      effect: read
      questions:
      - What are the broadest sections of the HS tariff classification?
      - Where do I start when browsing HS codes from the top?
      instructions:
      - text: List all top-level HS code sections.
      - text: Show the tariff classification sections to start browsing from.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/currencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported currencies
      effect: read
      questions:
      - Which ISO 4217 currency codes does AvaTax accept on a transaction?
      - Can I bill in a given currency code?
      instructions:
      - text: List all supported currency codes.
      - text: Show the currencies I can use for a transaction's currency code.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/filingfrequencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List filing frequencies
      effect: read
      questions:
      - What filing frequencies can be used on tax notices?
      - Which return filing frequencies are recognized, like monthly or quarterly?
      instructions:
      - text: List all supported filing frequencies.
      - text: Show the filing frequency options used in notices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/jurisdictionTypes/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List jurisdiction types for a tax type mapping
      effect: read
      questions:
      - Which jurisdiction types apply to a given country, tax type and tax sub-type?
      - What kinds of jurisdictions, like state or county, exist for a tax sub-type?
      instructions:
      - text: List jurisdiction types for {country}, tax type {taxTypeId} and sub-type {taxSubTypeId}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      - text: Show which kinds of jurisdiction apply to sub-type {taxSubTypeId} of tax type {taxTypeId} in {country}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/jurisdictionsnearaddress'].get
  update:
    x-apievangelist-phrasing:
      intent: List jurisdictions near an address
      effect: read
      questions:
      - Which taxing jurisdictions are near a specific address?
      - Can I find the jurisdictions around a location to set up custom rules?
      instructions:
      - text: List the taxing jurisdictions near an address.
      - text: Find jurisdictions close to a location based on geocoding.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/jurisdictions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List jurisdictions for a tax type and sub-type
      effect: read
      questions:
      - Which actual jurisdictions levy a given tax type and sub-type in a country?
      - Can I list the jurisdictions for one tax sub-type, optionally within a region?
      instructions:
      - text: List jurisdictions in {country} for tax type {taxTypeId} and sub-type {taxSubTypeId}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      - text: Find the taxing jurisdictions that levy sub-type {taxSubTypeId} in {country} under tax type {taxTypeId}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/locationquestions'].get
  update:
    x-apievangelist-phrasing:
      intent: List extra questions for declaring a location
      effect: read
      questions:
      - What additional questions must I answer when I declare a business location?
      - Do some jurisdictions need more information about my physical store locations?
      instructions:
      - text: List the location questions required for declaring a place of business.
      - text: Show what extra information jurisdictions ask for about a location.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/filingcalendars/loginverifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List forms that support login verification
      effect: read
      questions:
      - Which tax forms allow automatic verification of my portal login?
      - For what forms can my filing logins be checked online?
      instructions:
      - text: List all forms where logins can be verified automatically.
      - text: Show every form that supports online login verification.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/marketplacelocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List suggested marketplace locations
      effect: read
      questions:
      - Which locations are suggested for a marketplace?
      - What marketplace locations does the system recommend?
      instructions:
      - text: List the suggested locations for a marketplace.
      - text: Show recommended marketplace locations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/nexus'].get
  update:
    x-apievangelist-phrasing:
      intent: List all nexus across all countries
      effect: read
      questions:
      - What nexus can I declare anywhere in the world?
      - Can I get every supported nexus for all countries and regions in one list?
      instructions:
      - text: List all supported nexus for every country and region.
      - text: Show the complete selectable nexus list worldwide.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/nexus/byaddress'].get
  update:
    x-apievangelist-phrasing:
      intent: List nexus that applies to an address
      effect: read
      questions:
      - Which tax authorities apply to a physical location or point of sale?
      - Where would I need nexus based on a salesperson's address?
      instructions:
      - text: List the nexus that applies to an address.
      - text: Find which tax authorities a point of sale address falls under for nexus.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/nexus/{country}/{region}'].get
  update:
    x-apievangelist-phrasing:
      intent: List nexus for a country and region
      effect: read
      questions:
      - What nexus options exist within one state or province?
      - Can I narrow the nexus list to a single region of a country?
      instructions:
      - text: List nexus for region {region} in {country}.
        slots:
          region: path.region
          country: path.country
      - text: Show selectable nexus in {country} limited to {region}.
        slots:
          region: path.region
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/nexus/byform/{formCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: List nexus related to a tax form
      effect: read
      questions:
      - Have I declared nexus in every jurisdiction a tax form covers?
      - Which nexus jurisdictions relate to a specific tax form?
      instructions:
      - text: List the nexus related to tax form {formCode}.
        slots:
          formCode: path.formCode
      - text: Before filing {formCode}, show the jurisdictions where nexus is needed.
        slots:
          formCode: path.formCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/nexus/bytaxtypegroup/{taxTypeGroup}'].get
  update:
    x-apievangelist-phrasing:
      intent: List nexus for a tax type group
      effect: read
      questions:
      - Which nexus options exist for one tax type group, like sales and use?
      - Can I filter the nexus list by tax type group?
      instructions:
      - text: List nexus for tax type group {taxTypeGroup}.
        slots:
          taxTypeGroup: path.taxTypeGroup
      - text: Show selectable nexus filtered to the {taxTypeGroup} group.
        slots:
          taxTypeGroup: path.taxTypeGroup
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/nexustaxtypegroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List nexus tax type groups
      effect: read
      questions:
      - What tax type groups can nexus be declared under?
      - Which nexus tax type groups are supported?
      instructions:
      - text: List all nexus tax type groups.
      - text: Show the tax type groups used for nexus.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticecustomerfundingoptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice customer funding options
      effect: read
      questions:
      - What funding options can a customer choose for paying a tax notice?
      - Which customer funding options are available on notices?
      instructions:
      - text: List the customer funding options for tax notices.
      - text: Show how a customer can fund a tax notice payment.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticecustomertypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice customer types
      effect: read
      questions:
      - What customer types can be set on a tax notice?
      - Which kinds of customer are recognized on notices?
      instructions:
      - text: List all tax notice customer types.
      - text: Show the customer type values for notices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticefilingtypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice filing types
      effect: read
      questions:
      - Which filing types can a tax notice be tied to?
      - What notice filing type values exist?
      instructions:
      - text: List all tax notice filing types.
      - text: Show the filing type options I can use on a notice.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticepriorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice priorities
      effect: read
      questions:
      - What priority levels can a tax notice have?
      - How urgent can a notice be marked?
      instructions:
      - text: List all tax notice priorities.
      - text: Show the priority levels for notices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticereasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice reasons
      effect: read
      questions:
      - Why might a tax authority send a notice, as recognized reasons?
      - Which notice reason codes exist?
      instructions:
      - text: List all tax notice reasons.
      - text: Show the reasons a tax notice can be issued for.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticeresponsibilities'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice responsibilities
      effect: read
      questions:
      - Who can be responsible for resolving a tax notice?
      - What responsibility IDs can be assigned on a notice?
      instructions:
      - text: List all tax notice responsibilities.
      - text: Show the responsibility options for assigning a notice.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticerootcauses'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice root causes
      effect: read
      questions:
      - What root causes can explain why a tax notice happened?
      - Which root cause values can I record on a notice?
      instructions:
      - text: List all tax notice root causes.
      - text: Show the root cause options for notices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticestatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice statuses
      effect: read
      questions:
      - What statuses can a tax notice move through?
      - Which notice status values mean open or closed?
      instructions:
      - text: List all tax notice statuses.
      - text: Show the status values a notice can have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/noticetypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notice types
      effect: read
      questions:
      - What types of tax notices are recognized?
      - Which notice type should I pick when logging a letter from a tax authority?
      instructions:
      - text: List all tax notice types.
      - text: Show the type values for tax notices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: List extra parameters for creating transactions
      effect: read
      questions:
      - Which extra parameters can I add when creating a transaction?
      - What optional transaction parameters exist across all features?
      instructions:
      - text: List every extra parameter supported on Create Transaction.
      - text: Show all optional parameters I can configure on a transaction.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/accounts/{accountId}/parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: List parameters available to an account
      effect: read
      questions:
      - Which transaction parameters can my account use based on its subscriptions?
      - What parameters are unlocked for a specific account?
      instructions:
      - text: List the parameters available to account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show which parameters account {accountId} gets from its subscriptions.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/parameters/byitem/{companyCode}/{itemCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: List parameters for an item
      effect: read
      questions:
      - Which parameters apply to a specific item in my company?
      - What extra fields does an item need given my company's service types?
      instructions:
      - text: List the parameters for item {itemCode} in company {companyCode}.
        slots:
          itemCode: path.itemCode
          companyCode: path.companyCode
      - text: Show which parameters apply to {itemCode} for company {companyCode}.
        slots:
          itemCode: path.itemCode
          companyCode: path.companyCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/parametersusage'].get
  update:
    x-apievangelist-phrasing:
      intent: List parameter usage for transactions
      effect: read
      questions:
      - How are the extra Create Transaction parameters used, and on what?
      - Where does each transaction parameter apply, such as line or header?
      instructions:
      - text: List parameter usage for Create Transaction.
      - text: Show how each extra transaction parameter is used.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List permission types
      effect: read
      questions:
      - What permissions can a user logon have?
      - Which permission types define what a user is allowed to do?
      instructions:
      - text: List all permission types.
      - text: Show the permissions a user logon can be granted.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/postalcodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported postal codes
      effect: read
      questions:
      - Which postal codes are supported?
      - Can I check whether a ZIP code is on the supported postal code list?
      instructions:
      - text: List supported postal codes.
      - text: Show the postal code list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/preferredprograms'].get
  update:
    x-apievangelist-phrasing:
      intent: List preferred customs duty programs
      effect: read
      questions:
      - Which preferential customs duty programs, like NAFTA, are recognized?
      - Can I get favorable duty treatment through a preferred program?
      instructions:
      - text: List all preferred customs duty programs.
      - text: Show the duty programs that give preferential rates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/productclassificationsystems'].get
  update:
    x-apievangelist-phrasing:
      intent: List product classification systems
      effect: read
      questions:
      - What product classification systems do tax authorities use?
      - Which classification systems exist for mapping products to tax rates?
      instructions:
      - text: List all product classification systems.
      - text: Show every system tax authorities use to classify products.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/productclassificationsystems/bycompany/{companyCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: List classification systems for a company
      effect: read
      questions:
      - Which product classification systems apply to my company based on its nexus?
      - What classification systems does one company need to use?
      instructions:
      - text: List product classification systems for company {companyCode}.
        slots:
          companyCode: path.companyCode
      - text: Show which classification systems apply to {companyCode} given its nexus.
        slots:
          companyCode: path.companyCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/countries/{country}/ratetypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List rate types for a country
      effect: read
      questions:
      - What tax rate types exist in a particular country?
      - Which rate types, like standard or reduced, apply in one country?
      instructions:
      - text: List rate types for {country}.
        slots:
          country: path.country
      - text: Show all tax rate types used in {country}.
        slots:
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}/ratetypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List rate types for a tax type and sub-type
      effect: read
      questions:
      - Which rate types apply to a specific tax type and sub-type in a country?
      - Can I narrow a country's rate types to one tax sub-type?
      instructions:
      - text: Narrow the {country} rate type list to tax type {taxTypeId} and sub-type {taxSubTypeId}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      - text: Show the rate types for sub-type {taxSubTypeId} of {taxTypeId} in {country}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all regions worldwide
      effect: read
      questions:
      - What ISO 3166 region codes exist across all countries?
      - Can I build a state or province dropdown for every country at once?
      instructions:
      - text: List all ISO 3166 region codes with their names.
      - text: Show every region code worldwide for a shipping address dropdown.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/countries/{country}/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List regions within a country
      effect: read
      questions:
      - What are the states or provinces of one country?
      - Which region codes should my address form show for a chosen country?
      instructions:
      - text: List the regions in {country}.
        slots:
          country: path.country
      - text: Show the state and province codes for {country}.
        slots:
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/companies/{companyId}/countries/{country}/regions/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}/rateTypeId/{rateTypeId}/jurisdictionTypeId/{jurisdictionTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List regions for a company's tax and rate type
      effect: read
      questions:
      - Which regions in a country match a given tax type, sub-type, rate type and jurisdiction type?
      - Can I list regions for one company filtered by rate type and jurisdiction type?
      instructions:
      - text: For company {companyId}, list {country} regions for tax {taxTypeId}/{taxSubTypeId}, rate type {rateTypeId}, jurisdiction type {jurisdictionTypeId}.
        slots:
          companyId: path.companyId
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
          rateTypeId: path.rateTypeId
          jurisdictionTypeId: path.jurisdictionTypeId
      - text: Show which {country} regions company {companyId} can pick for rate type {rateTypeId} and jurisdiction type {jurisdictionTypeId} of {taxTypeId}/{taxSubTypeId}.
        slots:
          companyId: path.companyId
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
          rateTypeId: path.rateTypeId
          jurisdictionTypeId: path.jurisdictionTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/resourcefiletypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource file types
      effect: read
      questions:
      - What types of resource files are supported?
      - Which resource file type values exist?
      instructions:
      - text: List all resource file types.
      - text: Show the supported resource file type values.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/returns/parametersusage'].get
  update:
    x-apievangelist-phrasing:
      intent: List parameter usage for returns
      effect: read
      questions:
      - Which extra parameters can be used with tax returns?
      - What parameters does the returns feature accept?
      instructions:
      - text: List parameter usage for returns.
      - text: Show the extra parameters supported when working with returns.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/securityroles'].get
  update:
    x-apievangelist-phrasing:
      intent: List security roles
      effect: read
      questions:
      - What security roles can I assign to a user account?
      - Which roles are available when choosing a user's access level?
      instructions:
      - text: List all security roles.
      - text: Show the security roles I can pick for a user account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/subscriptiontypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription types
      effect: read
      questions:
      - Which subscription types can be added to an account?
      - What features exist as subscriptions I could have on my account?
      instructions:
      - text: List all subscription types.
      - text: Show the feature subscriptions that exist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag definitions
      effect: read
      questions:
      - What tags are defined?
      - Which tag definitions are available?
      instructions:
      - text: List the tag definitions.
      - text: Show all defined tags.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxauthorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax authorities
      effect: read
      questions:
      - Which tax authorities receive tax?
      - What agencies are on the supported tax authority list?
      instructions:
      - text: List all tax authorities.
      - text: Show every authority that collects tax.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxauthorityforms'].get
  update:
    x-apievangelist-phrasing:
      intent: List forms for each tax authority
      effect: read
      questions:
      - Which forms does each tax authority require?
      - What forms can managed returns file for a given authority?
      instructions:
      - text: List the tax forms for each tax authority.
      - text: Show forms grouped by the authority that requires them.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxauthoritytypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax authority types
      effect: read
      questions:
      - What types of tax authority are there?
      - Which authority type values classify a tax authority?
      instructions:
      - text: List all tax authority types.
      - text: Show the kinds of tax authority recognized.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxcodetypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax code types
      effect: read
      questions:
      - What broad categories of tax codes exist?
      - Can I browse tax codes by their category type first?
      instructions:
      - text: List all tax code types.
      - text: Show the broad categories that group tax codes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxforms'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax forms
      effect: read
      questions:
      - What tax forms are supported, using the current forms list?
      - Which tax forms can I identify for filing?
      instructions:
      - text: List all supported tax forms.
      - text: Show the current tax form list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxsubtypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tax sub-types
      effect: read
      questions:
      - What tax sub-types exist across all countries?
      - Which tax sub-types are supported overall?
      instructions:
      - text: List all tax sub-types.
      - text: Show every supported tax sub-type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxsubtypes/countries/{country}/taxtypes/{taxTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax sub-types for a country and tax type
      effect: read
      questions:
      - Which sub-types does a given tax type have in a particular country?
      - Can I narrow tax sub-types to one country and tax type?
      instructions:
      - text: List tax sub-types for tax type {taxTypeId} in {country}.
        slots:
          taxTypeId: path.taxTypeId
          country: path.country
      - text: Show the sub-types of {taxTypeId} that apply in {country}.
        slots:
          taxTypeId: path.taxTypeId
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxsubtypes/{jurisdictionCode}/{region}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax sub-types for a jurisdiction
      effect: read
      questions:
      - Which tax sub-types apply in a specific jurisdiction and region?
      - Can I see the sub-types one jurisdiction code levies?
      instructions:
      - text: List tax sub-types for jurisdiction {jurisdictionCode} in region {region}.
        slots:
          jurisdictionCode: path.jurisdictionCode
          region: path.region
      - text: Show the sub-types levied by jurisdiction {jurisdictionCode}, {region}.
        slots:
          jurisdictionCode: path.jurisdictionCode
          region: path.region
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxtypegroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax type groups
      effect: read
      questions:
      - What tax type groups are supported?
      - Which groupings of tax types exist, independent of nexus?
      instructions:
      - text: List all tax type groups.
      - text: Show every supported grouping of tax types.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/taxtypes/countries/{country}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax types for my nexus in a country
      effect: read
      questions:
      - Which tax types apply to my company in a country based on its nexus?
      - What tax types should I expect in a country where I have nexus?
      instructions:
      - text: List tax types applicable to my nexus in {country}.
        slots:
          country: path.country
      - text: Show which tax types my company owes in {country} given its nexus.
        slots:
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/unitofbasis/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List units of basis for a tax sub-type
      effect: read
      questions:
      - What unit of basis is a given tax type and sub-type measured on in a country?
      - What basis is one tax sub-type charged on in a country?
      instructions:
      - text: List units of basis in {country} for tax type {taxTypeId} and sub-type {taxSubTypeId}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      - text: Show what sub-type {taxSubTypeId} of {taxTypeId} is measured on in {country}.
        slots:
          country: path.country
          taxTypeId: path.taxTypeId
          taxSubTypeId: path.taxSubTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/definitions/unitofmeasurements'].get
  update:
    x-apievangelist-phrasing:
      intent: List units of measurement
      effect: read
      questions:
      - What units of measurement, like mass or distance, are defined?
      - Which measurement units can I use for quantities?
      instructions:
      - text: List all units of measurement.
      - text: Show the defined measurement units for quantities.
      method: generated
      generated: '2026-10-01'