# 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 V2 API
  version: 1.0.0
extends: openapi/lightspeed-financialv2-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: 4
- target: $.paths['/f/v2/business-location/{businessLocationId}/sales'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sales for a location over a date range
      effect: read
      questions:
      - How do I pull all closed sales for a restaurant over a date range?
      - Can I page through financial sales data with a page token?
      instructions:
      - text: Get sales for location {businessLocationId} from {from} to {to}.
        slots:
          businessLocationId: path.businessLocationId
          from: query.from
          to: query.to
      - text: Fetch the next page of sales for location {businessLocationId} since {from} using token {nextPageToken}.
        slots:
          businessLocationId: path.businessLocationId
          from: query.from
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/v2/business-location/{businessLocationId}/sales-daily'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sales for a single business day
      effect: read
      questions:
      - What were a location's sales for one business day?
      - Can I get end-of-day financial data for a specific date?
      instructions:
      - text: Get the business day sales for location {businessLocationId} on {date}.
        slots:
          businessLocationId: path.businessLocationId
          date: query.date
      - text: Show daily financials for location {businessLocationId} for business day {date}.
        slots:
          businessLocationId: path.businessLocationId
          date: query.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/v2/business-location/{businessLocationId}/lightspeed-payments'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Lightspeed Payments fees and surcharges
      effect: read
      questions:
      - How much did I pay in Lightspeed Payments fees over a period?
      - Does the payments fee report include standalone non-integrated payments?
      instructions:
      - text: Get Lightspeed Payments fee and surcharge data for location {businessLocationId} from {from} to {to}.
        slots:
          businessLocationId: path.businessLocationId
          from: query.from
          to: query.to
      - text: List Lightspeed Payments transactions with status {status} at location {businessLocationId} since {from}.
        slots:
          status: query.status
          businessLocationId: path.businessLocationId
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/f/v2/beta/business-location/{businessLocationId}/aborted-orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List aborted orders for a business day
      effect: read
      questions:
      - Which orders had all items removed before being committed on a given day?
      - Can I audit abandoned orders for possible staff misuse?
      instructions:
      - text: Get the aborted orders at location {businessLocationId} for business day {date}.
        slots:
          businessLocationId: path.businessLocationId
          date: query.date
      - text: Show orders where every item was removed without commit at location {businessLocationId} on {date}.
        slots:
          businessLocationId: path.businessLocationId
          date: query.date
      method: generated
      generated: '2026-09-26'