Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Get Financials

GET /f/finance/{businessLocationId}/financials/{from}/{to}
OAuth2

Returns financial data for a business location for a specified date range.

Path parameters

  • businessLocationId integer(int64) Required

    ID of the business location

  • from string(date-time) Required

    Start of requested results, in ISO 8601 format

    Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00

  • to string(date-time) Required

    End of requested results, in ISO 8601 format

    Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00

Query parameters

  • include string

    Objects to be included in the response.

    The allowed values are: staff, table, consumer, payments, revenue_center, account_profile, payment_authorization.

    Default value is empty.

  • pageSize integer(int32)

    Number of entries to return

    Default value is 1000.

  • nextPageToken string

    The account id where the results should begin

    Example: A65315.18

Responses

GET /f/finance/{businessLocationId}/financials/{from}/{to} 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/f/finance/45454565682155/financials/2022-09-21T10:11:56Z/2022-09-21T10:11:56Z \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "businessName": "My Business",
  "nextStartOfDayAsIso8601": "2023-07-28T05:30:00-05:00",
  "businessLocationId": 123456789,
  "sales": [
    {
      "accountReference": "57X0j3hzTZ2oo9sdVWiUog==",
      "accountFiscId": "A65315.17",
      "receiptId": "R65315.13",
      "source": {
        "initialAccountId": "A65315.13",
        "previousAccountId": "A65315.15"
      },
      "salesLines": [
        {
          "id": "S65315.33",
          "parentLineId": "S65315.32",
          "totalNetAmountWithTax": "11.00",
          "totalNetAmountWithoutTax": "8.33",
          "menuListPrice": "10.00",
          "unitCostPrice": "5.00",
          "serviceCharge": "1.00",
          "serviceChargeRate": "10.00",
          "discountAmount": "0.00",
          "taxCode": "VAT20",
          "taxAmount": "1.6667",
          "taxRatePercentage": "20.00",
          "taxLines": [
            {
              "taxId": "41910290874374",
              "taxCode": "VAT20",
              "taxRate": "1.2",
              "taxAmount": "1.666667",
              "taxIncluded": true
            }
          ],
          "discountType": "DISCOUNT",
          "discountCode": "10PCT",
          "discountName": "10% Discount",
          "accountDiscountAmount": "1.00",
          "totalDiscountAmount": "1.00",
          "sku": "52",
          "name": "Burger",
          "statisticGroup": "Food",
          "quantity": "1",
          "accountingGroup": {
            "accountingGroupId": 141948669132845,
            "name": "Food",
            "statisticGroup": "Food",
            "code": "123"
          },
          "currency": "GBP",
          "tags": [
            "string"
          ],
          "revenueCenter": "Fixed POS",
          "revenueCenterId": 141948669132822,
          "categories": [
            {
              "category": "default",
              "value": "Food"
            }
          ],
          "timeofSale": "2023-07-27T19:58:22.474Z",
          "staffId": 14670,
          "staffName": "Manager",
          "deviceId": 75125,
          "deviceName": "iPad9",
          "voidReason": "Unhappy Client",
          "accountProfileCode": "AAP"
        }
      ],
      "payments": [
        {
          "code": "CASH",
          "description": "Cash",
          "paymentMethodId": 141948669132824,
          "netAmountWithTax": "11.00",
          "currency": "GBP",
          "tip": "0.00",
          "consumer": {
            "id": "ec021fb0-4c12-425e-b30f-320ab720448b",
            "customerId": 120913,
            "title": "Mr",
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber1": "555-555-5555",
            "phoneNumber2": "555-555-5556",
            "companyName": "Company Name",
            "addressLine1": "123 Street st.",
            "addressLine2": "Unit 123",
            "zipCode": "12345",
            "city": "Some City",
            "state": "Some State",
            "email": "customer@email.com",
            "taxIdentifier": "123456789",
            "fiscalCode": "123456789",
            "destinationCode": "123456789"
          },
          "type": "NORMAL",
          "deviceId": "72676",
          "deviceName": "ipad9",
          "staffId": 180480,
          "staffName": "Manager",
          "authorization": "001",
          "externalReference": "1000",
          "revenueCenter": "Fixed POS",
          "revenueCenterId": 141948669132822,
          "fiscId": "T72691.8",
          "uuid": "bc7i2X_CTkeg8qlec66wmg==",
          "fiscDate": "2023-02-14T20:04:08.665Z",
          "surcharge": "0.00"
        }
      ],
      "timeofOpening": "2023-02-14T19:58:48.224Z",
      "timeofCloseAndPaid": "2023-02-14T20:04:08.734Z",
      "cancelled": true,
      "externalFiscalNumber": "string",
      "tableNumber": "1",
      "tableName": "Dining Room, Table 1",
      "accountProfileCode": "AAP",
      "ownerName": "Manager",
      "ownerId": 14670,
      "type": "SALE",
      "externalReferences": [
        "[\"TASK:OO-141948669132802-UNIQUEORDERREFERENCEE\", \"TASK:OO-141948669132802-UNIQUEORDERREFERENCEF\"]"
      ],
      "nbCovers": 2.0,
      "dineIn": true,
      "deviceId": 75125,
      "deviceName": "ipad9",
      "voidReason": "Unhappy Client"
    }
  ],
  "dataComplete": false,
  "_links": {
    "self": {
      "href": "https://api.ikentoo.com/f/finance/141948669132802/financials/2021-08-30T14:00:00Z/2023-09-03T15:30:00Z?pageSize=10&include=payments",
      "templated": true
    },
    "nextPage": {
      "href": "https://api.ikentoo.com/f/finance/141948669132802/financials/2021-08-30T14:00:00Z/2023-09-03T15:30:00Z?pageSize=10&include=payments&nextPageToken=A65315.18",
      "templated": true
    }
  }
}
Response examples (400) 
{
  "key": {}
}