How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightspeed FinancialV2 API

V2 endpoints (`/f/v2/...`) for retrieving sales and financial data.### Endpoint Mapping| V1 Endpoint | V2 Endpoint ||-------------|-------------|| `getFinancials` (`/f/finance/{id}/financials/{from}/{to}`) | `getSales` (`/f/v2/business-location/{id}/sales`) || `getDailyFinancials` (`/f/finance/{id}/dailyFinancials`) | `getBusinessDaySales` (`/f/v2/business-location/{id}/sales-daily`) |Response DTOs are nearly identical to V1 with the exceptions noted below### V2 behaviour- **Sorting**: Explicitly sorted by `timeClosed`- **Transitory Accounts / Unsettled Sales**: Returns closed transactions and ensures no transitory (unclosed) transactions are included in reporting- **Pagination**: `pageSize` max of 100. No HATEOAS `_links`; uses `nextPageToken` string for pagination instead- **Daily endpoints** (`getBusinessDaySales`): No pagination, no hard cap on results. May have slower response times for larger data sets- **Backoffice transactions**: Historical dating not currently supported — transactions appear as if created at current time. Transactions can only be found by the date/time they were actually created. *Historical dating support is planned for a future release.*- **Backoffice modifications** (payment method change and canceling): Modifications appear on the date the modification was performed, not the original transaction dateIf you need to query transactions by their original business date (e.g. for historical reporting or reconciliation); The V1 endpoints may be more suitable until backwards compatibility is added to V2 for this aspect.

Lightspeed FinancialV2 API is one of 27 APIs that Lightspeed publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include FinancialV2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and code examples.

This API exposes 4 operations across 4 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.trial.lsk.lightspeed.app, https://api.lsk.lightspeed.app.

4 operations 4 paths 20 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://x-series-api.lightspeedhq.com/api/2.0
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Lightspeed FinancialV2 API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 8 scopes.

  • OAuth2 — The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization code grant flow](https://www.oauth.com/oauth2-servers/server-sid…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

FinancialV2 4

V2 endpoints (/f/v2/...) for retrieving sales and financial data. Endpoint Mapping | V1 Endpoint | V2 Endpoint | |-------------|-------------| | getFinancials (/f/finance/{id}/fin…

GET
/f/v2/business-location/{businessLocationId}/sales
Lightspeed Get Sales
financial-apiGetBusinessLocationSales 6 params → 200400500
GET
/f/v2/business-location/{businessLocationId}/sales-daily
Lightspeed Get Business Day Sales
financial-apiGetBusinessLocationSalesOfABusinessDay 3 params → 200400500
GET
/f/v2/business-location/{businessLocationId}/lightspeed-payments
Lightspeed Payments Data
financial-apiGetLightspeedPayments 8 params → 200400
GET
/f/v2/beta/business-location/{businessLocationId}/aborted-orders
Lightspeed BETA - Get Aborted Orders
financial-apiGetBusinessLocationAbortedOrdersOfABusinessDay 2 params → 200400500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are financial-apiLine (40 properties), financial-apiSale (22 properties), financial-apiPayment (20 properties), financial-apiConsumer (17 properties). Each schema is shown below with its type and property counts.

financial-apiServiceChargeType
string
The type of service charge applied to the sale line.
financial-apiDateType
string
The date used when querying and sorting results.
financial-apiLSPaymentStatus
string
The statuses for a Lightspeed Payments transaction.
financial-apiLSPayment
object
10 properties
financial-apiConsumer
object
17 properties
financial-apiAccountLink
object
2 properties
financial-apiSale
object
22 properties
financial-apiPayment
object
20 properties
financial-apiAbortedOrderLineItemDto
object
5 properties
financial-apiLine
object
40 properties
financial-apiCategory
object
2 properties
financial-apiCurrencyAmount
object
2 properties
financial-apiErrorResponse
object
5 properties 5 required
financial-apiSalesExportDto
object
2 properties
financial-apiAbortedOrderDto
object
Represents an unpaid, non-committed order that has been fully aborted.
4 properties
financial-apiTaxLine
object
5 properties
financial-apiSalesDailyExportDto
object
3 properties
financial-apiAccountingGroup
object
4 properties
financial-apiSortDirection
string
The direction to sort the results.
financial-apiLSPaymentsDto
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-pos-financialv2-api-openapi.yml Raw ↑

Other APIs Lightspeed publishes across the network.

Lightspeed eCom C-Series API
Lightspeed eCom E-Series API (Ecwid)
Lightspeed Restaurant L-Series API
Lightspeed Restaurant O-Series API (Kounta)
Lightspeed Restaurant G-Series API (Gastrofix)
Lightspeed ChronoGolf Partner API
Lightspeed Account API
Lightspeed Brands API
Lightspeed Catalog API
Lightspeed Customer API
Lightspeed Customers API
Lightspeed Financial API
Where this information came from

This is an independent, third-party profile of Lightspeed FinancialV2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.