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 Receipt by External Reference

GET /f/finance/{businessLocationId}/saleByExternalReference

OAuth2

Returns a single receipt matching the external reference supplied in the request.

Path parameters

businessLocationId integer(int64) Required

ID of the business location

Query parameters

externalReferenceId string Required

The external reference of the receipt

Responses

• 200 application/json

Receipt returned
Hide response attributes Show response attributes object
- accountReference string
  
  Unique reference id of the account
- accountFiscId string
  
  The account identifier
- receiptId string
  
  The id of the receipt attached to this account
- source object
  
  Hide source attributes Show source attributes
  
  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 array[object]
  
  Hide salesLines attributes Show salesLines attributes 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
  
  Price listed on the menu
  
  unitCostPrice string
  
  Unit cost price
  
  serviceCharge string
  
  Service charge
  
  serviceChargeRate string
  
  Service charge rate, as a percentage
  
  discountAmount string
  
  Discount amount
  
  taxCode string
  
  System code for the tax rate
  
  taxAmount string
  
  Tax total
  
  taxRatePercentage string
  
  Tax rate, as a percentage
  
  taxLines array[object]
  
  Hide taxLines attributes Show taxLines attributes object
  
  taxId string
  
  Unique identifier for the tax
  
  taxCode string
  
  System code for the tax rate
  
  taxRate string
  
  Tax rate, as a multiplier
  
  taxAmount string
  
  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
  
  totalDiscountAmount string
  
  The total discount amount
  
  sku string
  
  The item SKU
  
  name string
  
  The item name
  
  statisticGroup string
  
  The item's statistic group
  
  quantity string
  
  The item quantity
  
  accountingGroup object
  
  Hide accountingGroup attributes Show accountingGroup attributes
  
  accountingGroupId number
  
  The unique identifier of 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 array[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 of the revenue center where the sale line was created
  
  categories array[object]
  
  Hide categories attributes Show categories attributes 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 of the user who created the line item
  
  staffName string
  
  The name of the user who created the line item
  
  deviceId number
  
  The unique identifier of the device where the sale line was created
  
  deviceName string
  
  The name of the device where the sale line was created
  
  voidReason string
  
  The void reason, if applicable
  
  Values are Broken, Cooking, Other, Taste, Unhappy Client, User Mistake, or Waited too long.
  
  accountProfileCode string
  
  The code of the account profile used
- payments array[object]
  
  Hide payments attributes Show payments attributes object
  
  code string
  
  The code of the payment method
  
  description string
  
  The name of the payment method
  
  paymentMethodId number
  
  The unique identifier of the payment method
  
  netAmountWithTax string
  
  The net payment amount, including tax
  
  currency string
  
  The payment currency
  
  tip string
  
  The tip amount
  
  consumer object
  
  Hide consumer attributes Show consumer attributes
  
  id string
  
  The UUID of the customer associated with the payment, if applicable
  
  customerId number
  
  The unique identifier for the customer
  
  title string
  
  firstName string
  
  lastName string
  
  phoneNumber1 string
  
  phoneNumber2 string
  
  companyName string
  
  addressLine1 string
  
  addressLine2 string
  
  zipCode string
  
  city string
  
  state string
  
  email string
  
  taxIdentifier string
  
  fiscalCode string
  
  destinationCode string
  
  type string
  
  The type of payment
  
  Values are NORMAL or ACCOUNTS_RECEIVABLE.
  
  deviceId string
  
  The unique identifier of the device where the payment was processed
  
  deviceName string
  
  The name of the device where the payment was processed
  
  staffId number
  
  The unique identifier of 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 of the revenue center where the payment was processed
  
  fiscId string
  
  The id of 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 of the user associated with the account
- type string
  
  The sale type
  
  Values are SALE, VOID, RECALL, REFUND, SPLIT, UPDATE, TRANSFER, FLOAT, or TRANSITORY.
- externalReferences array[string]
  
  List of order reference identifiers
- nbCovers number
  
  The number of covers
- dineIn boolean
  
  Whether the order is dine-in
- deviceId number
- deviceName string
- voidReason string
  
  The void reason, if applicable
  
  Values are Broken, Cooking, Other, Taste, Unhappy Client, User Mistake, or Waited too long.