Overview
- API URLs
- Creating a Kounta by Lightspeed Add-on
- Authentication
- Content Type
- Data Types
- Response Patterns
- Pagination
- Caching
- Errors
- PUT vs PATCH
- Testing
Authentication
- Basic Access Authorization
- OAuth 2.0
- Rate Limiting
Libraries

Addresses
- Get addresses
Billing
- Get add-on subscription info
- Get add-on subscription payments info
- Create an add-on subscription
- Update an add-on subscription
- Cancel an add-on subscription
- List of Webhooks
Categories
- Get all categories
- Get a category
- Create a category
- Update a category
- Add/remove a product to/from a category
- List of Webhooks
Checkins
- Get all customers' valid checkins for a site
- Get a customer's valid checkin
- Create a Checkin
- Checkout (Delete a Checkin Record)
Companies
- Get a company
- Check the statuses of all sites
Customers
- Get all customers
- Get a customer
- Create a customer
- Update a customer
- List of Webhooks
Images
- Direct Assignment
- Delete an image
Inventory
- Get stock levels
- List of Webhooks
Lines
- Add a line to an order
- Update a line
- Delete a line
Notifications
- Add a notification
- Update a notification
- Get all notifications
- Get a notification
Option Sets
- Get all option sets
- Get an option set
- Get an option set with site-level pricing
- Create an option set
- List of Webhooks
Orders
- Get orders
- Get an order
- Get PDF invoice
- Create an order
- Create with Option Sets
- Update an order
- Refund an order
- Option sets
- Get an option set
- Add an option set
- Delete an option set
- Pass Thru Printing
- List of Webhooks
Payment Methods
- Get payment methods
- Get a payment method
- List of Webhooks
Payments
- Add a payment to an order
- Update a payment
Price Lists
- Get all price lists
- Get a price list
- List of Webhooks
Products
- List products
- Get a product
- Create a product
- Update a product
- List of Webhooks
- Units
Purchase Orders
- Get purchase orders
- Get a purchase order
- List of Webhooks
Reconciliations
- Get reconciliations
- Get a reconciliation
- Update a reconciliation
- List of Webhooks
Registers
- Get registers
- Get a register
- List of Webhooks
Reporting Groups
- Get all reporting groups
- Get a reporting group
- Create a reporting group
- Update a reporting group
- Delete a reporting group
- Add products to a reporting group
- Remove a product from a reporting group
Shifts
- Get shifts
- List of Webhooks
Sites
- Get all sites
- Get a site
- Update an existing site
- Check the status of a site
- Check status of all authorised sites
- List of Webhooks
Staff
- Get all staff
- Get a staff member
- Permissions
- Create a staff member
- Update a staff member
- Delete a staff member
- List of Webhooks
Suppliers
- Get all suppliers
Tables
- Get all tables for a site
- Get orders on a table
- List of Webhooks
Taxes
- Get all taxes
- Get a tax
- Create a tax
- Get all tax groups
- Get a tax group
- List of Webhooks
Webhooks
- Get webhooks
- Create a webhook
- Update a webhook
- Delete a webhook
- Testing a webhook
- Supported topics
- Filtering
- Exponential backoff
- Verifying webhooks
- Dynamic headers

Price Lists

Each site will be assigned a price list that determines ex tax unit prices of each item on sale.

Price lists work by overriding prices in their parent lists (just like subclassing in object-oriented programming). The base price list has a parent_id of null.

Get all price lists

GET /v1/companies/5678/price_lists Get all price lists

Get a price list

`GET /v1/companies/5678/price_lists/base`	Get the base price list
`GET /v1/companies/5678/price_lists/236`	Get a price list by ID

The unit_price returned is always the ex tax price for that product and the unit_price_inc_tax is tax inclusive price
The list_type has a value of fixed if products in the price list have individual fixed prices, and dynamic if the products are priced based on a percentage adjustment of the base price list.
The adjustment_percentage is returned for dynamic price lists. It is the percentage increase or decrease from the base price. As per the example above, the base price of a Cappuccino is $2.00, so with an adjustment_percentage of -10 the price is reduced by 10% percent, being $1.80. Note that there are additional rules around which products are dynamically adjusted. It does not apply to every base product.

Only products explicitly priced in the requested price list will be included. To get all products, including those inherited from parent lists, use the products sub-endpoint:

GET /v1/companies/5678/price_lists/236/products Get products for a price list, including all inherited products

The unit_price returned is always the ex tax price for that product and the unit_price_inc_tax is tax inclusive price
All products will have false as inherited value if price list is dynamic as it can/will override any products price.
In addition, the products that satisfy the dynamic price list rule will be priced based on a percentage adjustment of the base price list. adjustment_percentage will be shown for products with adjustment for us to determine which products have been adjusted.

List of Webhooks

Here is a list of the supported webhook topics.

price_lists/created

When a price list is created. You will receive the complete price list.

price_lists/updated

When a price list is updated or the product prices on it have been changed. You will receive the complete price list after the modifications have been applied.

You also may provide the following attribute filters:

name

price_lists/deleted

When a price list is deleted. You will receive the complete price list.