Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lightspeed Restaurant K Series Tax Breakdown API

2 actions 2 updates phrasing extends openapi/lightspeed-tax-breakdown-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lightspeed Commerce's API. It is a proposal applied on top of the contract, not a document Lightspeed Commerce publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/tp/v1/business-locations/{businessLocationId}/tax-breakdown'].post

OpenAPI Overlay

# 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 Tax Breakdown API
  version: 1.0.0
extends: openapi/lightspeed-tax-breakdown-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: 1
- target: $.paths['/tp/v1/business-locations/{businessLocationId}/tax-breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview the tax breakdown of an order
      effect: read
      questions:
      - How much tax will a proposed order carry before I submit it?
      - Can I preview taxes for an order under a specific order profile?
      instructions:
      - text: Preview the tax breakdown for items {items} at location {businessLocationId}.
        slots:
          items: requestBody.items
          businessLocationId: path.businessLocationId
      - text: Calculate taxes on a proposed order at location {businessLocationId} using order profile {accountProfileCode}.
        slots:
          businessLocationId: path.businessLocationId
          accountProfileCode: requestBody.accountProfileCode
      method: generated
      generated: '2026-09-26'