Glossary
Introduction
This article provides definitions for terminology used when discussing the Lightspeed Restaurant K-Series APIs. It also provides links to useful resources.
General Lightspeed Restaurant Terms
| Term | Description |
|---|---|
| Business | A business unit that can have one or more locations (Business Locations) attached to it. The business is country-specific, with associated currency and taxes. |
| Business Location | Part of a business, it might represent a single restaurant location, or a separate location within the same property. See Business Locations |
| Accounting Group | Accounting groups contain the items and tax rates. Different tax rates can be used for the same items, even on the same bill. Accounting groups have a unique ID within a business and all connected Business Locations. See About Accounting Groups |
| Order Profile | (Also known as Account Profile) A feature that allows users to specify a set of settings to be applied to a transaction. See Order Profiles |
| Tips/Gratuity | Tips are part of the payment, and are shown tax-free in a separate line. Tips are not linked to an accounting group and are not listed as an item. See Service Charges and Tips |
| Service Charge Item | A special type of item, which allows a percentage surcharge to be added to an order. See Service Charges and Tips |
Gift Card Terms
| Term | Description |
|---|---|
| Realtime Notification (RTN) | A type of notification, configured in the back office, that allows integrators to receive updates when changes are made to sales in the POS. See RTN Examples. |
| Web Extension | A feature of the POS that allows integrators to interact with a register sale by launching a browser window inside of the POS app and providing a JavaScript context to the page so that a web application can modify the current sale. See Web Extensions. |
| Gift Card Redemption | Applying a gift card payment to a sale. See Redeem/Pay With Gift Card. |
| Void Sale | When a sale is cancelled in the POS. It is important for gift card integrations to listen for these types of changes to sales. See RTN Examples. |
| Refund Sale | When a payment is refunded in the POS. It is important for gift card integrations to listen for these types of changes to sales. See RTN Examples. |
| Top-up | Adding additional funds to an existing gift card. Not currently supported within the POS for third party integrations. |
| Reload | Adding funds to an exisitng gift card that currently has a 0 balance. Not currently supported within the POS for third party integrations. |
| External Reference | A configurable reference string that allows for future identification of a transaction. |
| Liability | Represents an amount owed by the business. In the context of gift cards, a negative payment created to represent the gift card amount, to be redeemed at a later date. See Understanding Gift Cards. |