v1
latestOpenAPI 3.1.02026-08-06911,228852.2 KBFinancial
Get Financials
Returns financial data for a business location for a specified date range.
Note: Will only return sales created after migration from iKentoo 2.0 to Lightspeed K-Series.
get/f/finance/{businessLocationId}/financials/{from}/{to}
Path parameters
businessLocationIdinteger required
The unique identifier for the business location.
fromstring date-time required
Example:2022-09-21T10:11:56Z
Start of requested results, in ISO 8601 format.
The date range between 'from' and 'to' cannot exceed 365 days (1 year).
Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00
tostring date-time required
Example:2022-09-21T10:11:56Z
End of requested results, in ISO 8601 format.
Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00
Query parameters
includestring
Objects to be included in the response.
The allowed values are: staff, table, consumer, payments, revenue_center, account_profile, payment_authorization.
pageSizeinteger
Number of entries to return.
nextPageTokenstring
The accountId where the results should begin.
Example: A65315.18
Response
Financials returned
Example response
{
"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",
"serviceChargeType": "APPORTIONED",
"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",
"accountDiscountType": "DISCOUNT",
"accountDiscountCode": "Staff 20%",
"accountDiscountName": "Staff Discount",
"totalDiscountAmount": "1.00",
"sku": "52",
"name": "Burger",
"nameOverride": "Burger Double Cheese",
"statisticGroup": "Food",
"quantity": "1",
"accountingGroup": {
"accountingGroupId": 141948669132845,
"name": "Food",
"statisticGroup": "Food",
"code": "123"
},
"currency": "GBP",
"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",
"tableNumber": "1",
"tableName": "Dining Room, Table 1",
"accountProfileCode": "AAP",
"ownerName": "Manager",
"ownerId": 14670,
"type": "SALE",
"externalReferences": [
"\"TASK:OO-{businessLocationId}-{unique-reference-code}\", \"TASK:OO-{businessLocationId}-(another-unique-reference-code)\""
],
"nbCovers": 2,
"dineIn": true,
"deviceId": 75125,
"deviceName": "ipad9",
"voidReason": "Unhappy Client"
}
],
"_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
}
}
}