Lightspeed Commerce

Lightspeed Commerce Financial API

V1 endpoints (`/f/finance/...`) for retrieving sales and financial data. For the newer V2 versions of these endpoints see FinancialV2 ### V1 behaviour - **Sorting**: No guaranteed sorting order; internal transformations may alter order unpredictably - **Transitory Accounts / Unsettled Sales**: Returns closed transactions only - **Pagination**: `pageSize` max of 1000. Uses HATEOAS `_links` with `self` and `nextPage` URLs - **Daily endpoints** (`getDailyFinancials`): No pagination, no hard cap on results. May have slower response times for larger data sets - **Backoffice transactions**: Historical dating supported. Transactions will be dated to a past date if the action impacts past reports. Can query transactions by original business date - **Backoffice modifications** (payment method change and canceling): Modifications appear on the original transaction date

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /f/data/businesses List businesses and their locations · Get Businesses #
Ask an LLM
“Which businesses and restaurant locations can my API token see?”
“Can I page through businesses if my group has many locations?”
Tell an agent
List every business my token has access to.
Show page {page} of accessible businesses with {size} per page.
GET /f/finance/{businessLocationId}/tax-rates Get tax rates for a location · Get Tax Rates #
Ask an LLM
“What tax rates are configured for my restaurant?”
“Can I see which VAT or sales tax percentages a venue applies?”
Tell an agent
Get the tax rates for business location {location}.
Show the configured tax percentages at location {location}.
GET /f/finance/{businessLocationId}/paymentMethods List payment methods for a location · Get Payment Methods #
Ask an LLM
“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?”
Tell an agent
List payment methods at business location {location}.
Show how customers can pay at location {location}.
GET /f/finance/{businessLocationId}/accountingGroups List accounting groups for a location · Get Accounting Groups #
Ask an LLM
“What accounting groups are items assigned to at my restaurant?”
“Can I pull the accounting groups to map sales to ledger accounts?”
Tell an agent
List the accounting groups for business location {location}.
Show revenue accounting groups defined at location {location}.
GET /f/finance/{businessLocationId}/financials/{from}/{to} Get financial data for a date range · Get Financials #
Ask an LLM
“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?”
Tell an agent
Get financials for location {location} from {from} to {to}.
Export financials for location {location} between {from} and {to} including {include}.
GET /f/finance/{businessLocationId}/dailyFinancials Get financial data for one business day · Get Daily Financials #
Ask an LLM
“What did my restaurant take today so far?”
“Can I pull the financial totals for a single past business day?”
Tell an agent
Get today's financials for business location {location}.
Show the daily financials for location {location} on {date}.
GET /f/finance/{businessLocationId}/saleByExternalReference Find a receipt by external reference · Get Receipt by External Reference #
Ask an LLM
“Can I look up a receipt using the reference my ordering system attached to it?”
“Which sale corresponds to a given external reference ID?”
Tell an agent
Find the receipt at location {location} with external reference {ref}.
Look up sale {ref} by its external reference at location {location}.
GET /f/finance/{businessLocationId}/aggregatedSales Get sales totals grouped by a dimension · Get Aggregated Sales #
Ask an LLM
“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?”
Tell an agent
Aggregate today's sales at location {location} grouped by {group}.
Total sales at location {location} on {date} grouped by {group}.

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/docs/introduction
📖
APIReference
https://x-series-api.lightspeedhq.com/reference
📖
GettingStarted
https://x-series-api.lightspeedhq.com/docs/quick_start
📖
Documentation
https://api-portal.lsk.lightspeed.app/
📖
APIReference
https://api-docs.lsk.lightspeed.app/
📖
GettingStarted
https://api-portal.lsk.lightspeed.app/quick-start/intro

Specifications

⚙
OpenAPI
https://artifacts.apis.io/lightspeed/openapi/lightspeed-financial-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-financial-api-sale-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-financial-api-financial-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-financial-api-resources-tax-rate-schema.json

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://artifacts.apis.io/lightspeed/llms/lightspeed-llms.txt
🔗
SignUp
https://developers.retail.lightspeed.app/register
🔗
ChangeLog
https://api-docs.lsk.lightspeed.app/changes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightspeed:lightspeed-financial-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightspeed-financial-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightspeed Financial API
  version: 1.0.0
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
  description: 'Operations tagged Financial across 2 of this provider''s published API definitions: lightspeed-k-series-openapi.json, lightspeed-k-series-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:


# --- truncated at 32 KB (47 KB total) ---
# Full source: https://artifacts.apis.io/lightspeed/openapi/lightspeed-financial-api-openapi.yml