# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lightspeed Restaurant K Series Financial API
  version: 1.0.0
extends: openapi/lightspeed-financial-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: 8
- target: $.paths['/f/data/businesses'].get
  update:
    x-apievangelist-phrasing:
      intent: List businesses and their locations
      effect: read
      questions:
      - Which businesses and restaurant locations can my API token see?
      - Can I page through businesses if my group has many locations?
      instructions:
      - text: List every business my token has access to.
      - text: Show page {page} of accessible businesses with {size} per page.
        slots:
          page: query.page
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/finance/{businessLocationId}/tax-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tax rates for a location
      effect: read
      questions:
      - What tax rates are configured for my restaurant?
      - Can I see which VAT or sales tax percentages a venue applies?
      instructions:
      - text: Get the tax rates for business location {location}.
        slots:
          location: path.businessLocationId
      - text: Show the configured tax percentages at location {location}.
        slots:
          location: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/finance/{businessLocationId}/paymentMethods'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment methods for a location
      effect: read
      questions:
      - Which payment methods, like card or cash, are set up at a venue?
      - Can I map the payment methods a location accepts into my accounting system?
      instructions:
      - text: List payment methods at business location {location}.
        slots:
          location: path.businessLocationId
      - text: Show how customers can pay at location {location}.
        slots:
          location: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/finance/{businessLocationId}/accountingGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounting groups for a location
      effect: read
      questions:
      - What accounting groups are items assigned to at my restaurant?
      - Can I pull the accounting groups to map sales to ledger accounts?
      instructions:
      - text: List the accounting groups for business location {location}.
        slots:
          location: path.businessLocationId
      - text: Show revenue accounting groups defined at location {location}.
        slots:
          location: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/finance/{businessLocationId}/financials/{from}/{to}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get financial data for a date range
      effect: read
      questions:
      - How do I export every receipt and payment for a location over a period?
      - What is the longest date range I can request financial data for?
      - Can I include staff, table and payment details in the financial export?
      instructions:
      - text: Get financials for location {location} from {from} to {to}.
        slots:
          location: path.businessLocationId
          from: path.from
          to: path.to
      - text: Export financials for location {location} between {from} and {to} including {include}.
        slots:
          location: path.businessLocationId
          from: path.from
          to: path.to
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/finance/{businessLocationId}/dailyFinancials'].get
  update:
    x-apievangelist-phrasing:
      intent: Get financial data for one business day
      effect: read
      questions:
      - What did my restaurant take today so far?
      - Can I pull the financial totals for a single past business day?
      instructions:
      - text: Get today's financials for business location {location}.
        slots:
          location: path.businessLocationId
      - text: Show the daily financials for location {location} on {date}.
        slots:
          location: path.businessLocationId
          date: query.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/finance/{businessLocationId}/saleByExternalReference'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a receipt by external reference
      effect: read
      questions:
      - Can I look up a receipt using the reference my ordering system attached to it?
      - Which sale corresponds to a given external reference ID?
      instructions:
      - text: Find the receipt at location {location} with external reference {ref}.
        slots:
          location: path.businessLocationId
          ref: query.externalReferenceId
      - text: Look up sale {ref} by its external reference at location {location}.
        slots:
          ref: query.externalReferenceId
          location: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/finance/{businessLocationId}/aggregatedSales'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sales totals grouped by a dimension
      effect: read
      questions:
      - How much did each staff member or device sell today?
      - Can I total sales by accounting group across a date range of up to a year?
      instructions:
      - text: Aggregate today's sales at location {location} grouped by {group}.
        slots:
          location: path.businessLocationId
          group: query.groupBy
      - text: Total sales at location {location} on {date} grouped by {group}.
        slots:
          location: path.businessLocationId
          date: query.date
          group: query.groupBy
      - text: Group sales at location {location} by {group} from {from} to {to}.
        slots:
          location: path.businessLocationId
          group: query.groupBy
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'