--- title: "Get Financials" method: GET path: "/f/finance/{businessLocationId}/financials/{from}/{to}" tags: ["Financial"] --- # Get Financials `GET /f/finance/{businessLocationId}/financials/{from}/{to}` ## Request - Base URL: `https://api.trial.lsk.lightspeed.app` - URL: `https://api.trial.lsk.lightspeed.app/f/finance/{businessLocationId}/financials/{from}/{to}` - Auth: OAuth 2 - Authorization code: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth` - Token URL: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token` scopes: `financial-api` 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. ## Path parameters - `businessLocationId` integer, required - `from` string, date-time, required - `to` string, date-time, required ## Query parameters - `include` string - `pageSize` integer - `nextPageToken` string ## Response `200` Financials returned - FinancialApiFinancialDto - `businessName` string: Name of the business - `nextStartOfDayAsIso8601` string: Start of next business day, in the merchant's local time. - `businessLocationId` number: The unique identifier for the business location. - `sales` FinancialApiSaleDto[] - `accountReference` string: Unique reference code for the account. - `accountFiscId` string: The account identifier - `receiptId` string: The unique identifier for the receipt associated with this account. - `source` object - `initialAccountId` string: The `accountFiscId` of the initial transaction associated with the current account, if applicable. For example, in the case of a refund. This will match the `accountFiscId` of the sale if there is no associated account. - `previousAccountId` string: The `accountFiscId` of the previous transaction associated with the current account, if applicable. For example, in the case of a refund. This may be different from `initialAccountId` if there is more than one associated account. It will not be displayed if there is no associated account. - `salesLines` object[] - `id` string: The sale line identifier - `parentLineId` string: The sale line this item is associated with, if applicable. - `totalNetAmountWithTax` string: Total amount of sale line, including tax. **Important Note:** This field is for use with tax inclusive businesses. For tax exclusive businesses, see `taxAmount` and `taxLines` for tax calculations. - `totalNetAmountWithoutTax` string: Total amount of the sale line, before tax. - `menuListPrice` string: The price listed on the menu. - `unitCostPrice` string: The unit cost price. - `serviceCharge` string: The service charge amount. - `serviceChargeType` 'UNTAXED' | 'APPORTIONED' | 'NO_SERVICE_CHARGE': The type of service charge applied to the sale line. - `serviceChargeRate` string: The service charge rate, as a percentage. - `discountAmount` string: The discount amount. - `taxCode` string: The system code for the tax rate. - `taxAmount` string: The tax total. - `taxRatePercentage` string: The tax rate, as a percentage. - `taxLines` object[] - `taxId` string: The unique identifier for the tax. - `taxCode` string: The system code for the tax rate. - `taxRate` string: The tax rate, as a multiplier. - `taxAmount` string: The tax total. - `taxIncluded` boolean: Whether or not the business is tax inclusive. - `discountType` string: The type of discount. - `discountCode` string: The discount code. - `discountName` string: The name of the discount. - `accountDiscountAmount` string: The account discount amount. - `accountDiscountType` string: The account discount type (if any). - `accountDiscountCode` string: The account discount code (if any). - `accountDiscountName` string: The account discount name (if any). - `totalDiscountAmount` string: The total discount amount. - `sku` string: The item SKU - `name` string: The item name. - `nameOverride` string: Item name entered manually by the POS user upon item selection. - `statisticGroup` string: The item's statistic group. - `quantity` string: The item quantity. - `accountingGroup` object - `accountingGroupId` number: The unique identifier for the item's accounting group. - `name` string: The name of the accounting group. - `statisticGroup` string: The accounting group's statistic group. - `code` string: The code assigned to the accounting group. - `currency` string: The currency for the sale line. - `tags` string[]: The tags attached to the line item. - `revenueCenter` string: The name of the revenue center where the sale line was created. - `revenueCenterId` number: The unique identifier for the revenue center where the sale line was created. - `categories` object[] - `category` string: The line item's category. - `value` string: The category value. - `timeofSale` string: The timestamp of when the line item was created. - `staffId` number: The unique identifier for the user who created the line item. - `staffName` string: The name of the user who created the line item. - `deviceId` number: The unique identifier for the device where the sale line was created. - `deviceName` string: The name of the device where the sale line was created. - `voidReason` 'Broken' | 'Cooking' | 'Other' | 'Taste' | 'Unhappy Client' | 'User Mistake' | 'Waited too long': The void reason, if applicable. - `accountProfileCode` string: The code of the account profile used. - `payments` object[] - `code` string: The code of the payment method. - `description` string: The name of the payment method. - `paymentMethodId` number: The unique identifier for the payment method. - `netAmountWithTax` string: The net payment amount, including tax. - `currency` string: The payment currency. - `tip` string: The tip amount. - `consumer` object - `id` string: The UUID of the customer associated with the payment, if applicable. - `customerId` number: The unique identifier for the customer. - `title` string: The title of the customer. - `firstName` string: The first name of the customer. - `lastName` string: The last name of the customer. - `phoneNumber1` string: The primary phone number of the customer. - `phoneNumber2` string: The secondary phone number of the customer. - `companyName` string: The company name of the customer. - `addressLine1` string: The first line of the customer's address. - `addressLine2` string: The second line of the customer's address. - `zipCode` string: The postal code of the customer's address. - `city` string: The city of the customer's address. - `state` string: The state of the customer's address. - `email` string: The email address of the customer. - `taxIdentifier` string: The tax identifier of the customer. - `fiscalCode` string: The fiscal code of the customer. - `destinationCode` string: The destination code of the customer. - `type` 'NORMAL' | 'ACCOUNTS_RECEIVABLE': The type of payment. - `deviceId` string: The unique identifier for the device where the payment was processed. - `deviceName` string: The name of the device where the payment was processed. - `staffId` number: The unique identifier for the user who processed the payment. - `staffName` string: The name of the user who processed the payment. - `authorization` string: The authorization code for the payment. - `externalReference` string: The external reference code for the payment. - `revenueCenter` string: The name of the revenue center where the payment was processed. - `revenueCenterId` number: The unique identifier for the revenue center where the payment was processed. - `fiscId` string: The unique identifier for the payment. - `uuid` string: The base64url encoded UUID of the payment. - `fiscDate` string: The time stamp of the payment. - `surcharge` string: The surcharge amount. - `timeofOpening` string: The account creation timestamp. - `timeofCloseAndPaid` string: The account close timestamp. - `cancelled` boolean - `externalFiscalNumber` string - `tableNumber` string: The table number. - `tableName` string: The name of the table. - `accountProfileCode` string: The account profile associated with the account. - `ownerName` string: The name of the user associated with the account. - `ownerId` number: The unique identifier for the user associated with the account. - `type` 'SALE' | 'VOID' | 'RECALL' | 'REFUND' | 'SPLIT' | 'UPDATE' | 'TRANSFER' | 'FLOAT' | 'TRANSITORY' | 'CROSS_BL' | 'CANCEL': The sale type. - `externalReferences` string[] - `nbCovers` number: The number of covers. - `dineIn` boolean: Whether the order is dine-in. - `deviceId` number: The unique identifier for the device where the account was created. - `deviceName` string: The name of the device where the account was created. - `voidReason` 'Broken' | 'Cooking' | 'Other' | 'Taste' | 'Unhappy Client' | 'User Mistake' | 'Waited too long': The void reason, if applicable. - `dataComplete` boolean - `_links` object - `self` object - `href` string - `templated` boolean - `nextPage` object - `href` string: The URL for the next set of results. - `templated` boolean ## Other responses - `400`: Bad Request ## Changes > 31 revisions in range; 1 not diffed. - **2026-02-12** `33472358c1ed`: 1 warning, 1 info - for the `query` request parameter `pageSize`, the max was set to `1000.00` - added the optional property `sales/items/salesLines/items/serviceChargeType` to the response with the `200` status - **2025-06-22** `12c833108f68`: 1 warning, 4 info - for the `path` request parameter `businessLocationId`, the min was set to `1.00` - added the optional property `sales/items/salesLines/items/accountDiscountCode` to the response with the `200` status - added the optional property `sales/items/salesLines/items/accountDiscountName` to the response with the `200` status - added the optional property `sales/items/salesLines/items/accountDiscountType` to the response with the `200` status - …1 more - **2024-07-22** `f0328406dcdb`: 2 warning - added the new `CANCEL` enum value to the `sales/items/type` response property for the response status `200` - added the new `CROSS_BL` enum value to the `sales/items/type` response property for the response status `200` [Operation history](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/changes/f/finance/:businessLocationId/financials/:from/:to/get.md) --- [API](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api.md) - [All operations](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/revisions/af001485cf2b?raw)