sales | Array of sale objects. | |
sales[].accountReference | Lightspeed internal account reference. | The unit amount for a single item |
sales[].accountFiscId | IKentoo internal account human readable identifier. | Quantity of items |
sales[].receiptId | Receipt identifier. | The total amount of this entry including Tax. |
sales[].source | Account at the source of the current account. | Name of the item |
sales[].source.initialAccountId | First account that generated the current account (can be the same). | Staff ID owning this account/receipt |
sales[].source.previousAccountId | Account that is directly linked to the current account (may be not set). | Staff Name owning this account/receipt. |
sales[].salesLines | Sales items. | The internal ID for the accounting group where the item is part of |
sales[].salesLines[].id | Line identifier. | The name for the accounting group where the item is part of |
sales[].salesLines[].parentLineId | Parent line identifier (if any). | The internal ID for the applied tax |
sales[].salesLines[].totalNetAmountWithTax | Total amount for this line including discounts and tax. | The internal Name for the applied tax |
sales[].salesLines[].totalNetAmountWithoutTax | Total amount for this line excluding tax. | The applied rate rate in digits |
sales[].salesLines[].menuListPrice | Total amount for this line before service charge and discount if any. | False = tax exclusive (the amounts are net amounts) True = tax inclusive (the amounts contain the taxes) |
sales[].salesLines[].unitCostPrice | Cost price of a single item (set to 0 if not provided). | SKU business wide unique product identifier as defined by the customer. |
sales[].salesLines[].serviceCharge | Service charge. | |
sales[].salesLines[].serviceChargeRate | Service charge rate. | Date/Time in UTC of this payment. |
sales[].salesLines[].discountAmount | Line discount amount (if any). | Staff ID owning this account/receipt |
sales[].salesLines[].taxAmount | Tax amount. | Staff name owning this account/receipt |
sales[].salesLines[].discountType | Line discount type (if any). | Tip which is applied without revenue and tax. The tip is not assigned to an accounting group in Lightspeed. |
sales[].salesLines[].discountCode | Line discount code (if any). | Total amount of the used payment method (pls note, more than one payment method can be applied) |
sales[].salesLines[].discountName | Line discount name (if any). | Name of the applied payment method. |
sales[].salesLines[].accountDiscountAmount | Account discount amount (if any). | This parameter is only attached, if the post is a room charge. For all other posts, it will be blank. |
sales[].salesLines[].accountDiscountType | Account discount type (if any). | Business wide unique payment method identifier |
sales[].salesLines[].accountDiscountCode | Account discount code (if any). | Unique identifier for the account/receipt, the uuid’s will match the lines in the PMS API as well the financial API. |
sales[].salesLines[].accountDiscountName | Account discount name (if any). | |
sales[].salesLines[].totalDiscountAmount | Total discount amount (if any): sum of line level and account level. | |
sales[].salesLines[].sku | SKU for this line item, this value is mutable. | |
sales[].salesLines[].name | Item name. | |
sales[].salesLines[].statisticGroup | Statistic group. | |
sales[].salesLines[].quantity | Quantity sold, this value can be a fraction when item is sold by weight for example. | |
sales[].salesLines[].taxRatePercentage | Tax rate for this line item as a percentage. | |
sales[].salesLines[].accountingGroup | Accounting group this item belongs to, this value is mutable. | |
sales[].salesLines[].accountingGroup.accountingGroupId | Internal immutable ID for this accounting Group. | |
sales[].salesLines[].accountingGroup.name | Name of this accounting group. | |
sales[].salesLines[].accountingGroup.statisticGroup | Statistic group (can be null). | |
sales[].salesLines[].accountingGroup.code | Optional accounting code as configured by the merchant for this accounting group. | |
sales[].salesLines[].currency | Currency code as an ISO 3 character CODE. | |
sales[].salesLines[].tags | Transaction tags (optional). | |
sales[].salesLines[].revenueCenter | V3 only: revenue center name (revenue_center include param). | |
sales[].salesLines[].revenueCenterId | V3 only: revenue center id (revenue_center include param). | |
sales[].salesLines[].categories | Transaction categories (V3 only). | |
sales[].salesLines[].categories[].category | | |
sales[].salesLines[].categories[].value | | |
sales[].salesLines[].timeOfSale | The time in ISO8601 when this sale was made. | |
sales[].salesLines[].staffId | Staff identifier (with param include=staff). | |
sales[].salesLines[].staffName | Staff name (with param include=staff). | |
sales[].salesLines[].deviceId | Device identifier which produced this transaction line. | |
sales[].salesLines[].deviceName | Device name which produced this transaction line. | |
sales[].salesLines[].voidReason | Void reason (if the line is voided). | |
sales[].salesLines[].accountProfileCode | Order profile code (with param include=account_profile). | |
sales[].payments | Array of payment objects. | |
sales[].payments[].code | Payment method code used to settle this payment line. | |
sales[].payments[].description | Payment method friendly name used to settle this payment line. | |
sales[].payments[].paymentMethodId | Payment method internal identifier. | |
sales[].payments[].netAmountWithTax | Net paid amount including discounts and tax. | |
sales[].payments[].currency | Payment currency code as an ISO 3 character CODE. | |
sales[].payments[].tip | Tip amount if any. | |
sales[].payments[].consumer | The consumer. | |
sales[].payments[].type | - NORMAL: normal payment - ACCOUNTS_RECEIVABLE: Payment is due but not received . Must be one of [NORMAL, ACCOUNTS_RECEIVABLE]. | |
sales[].payments[].deviceId | Device identifier. | |
sales[].payments[].deviceName | Device name. | |
sales[].payments[].staffId | Tender staff identifier (with param include=staff). | |
sales[].payments[].staffName | Tender staff name (with param include=staff). | |
sales[].payments[].authorization | Payment authorization. | |
sales[].payments[].revenueCenter | Revenue center name (with param include=revenue_center). | |
sales[].payments[].revenueCenterId | Revenue center id (with param include=revenue_center). | |
sales[].timeOfOpening | The date on which this account has been opened. | |
sales[].timeOfCloseAndPaid | The date on which this sales was made in ISO8601. | |
sales[].externalFiscalNumber | External fiscal number (if used). | |
sales[].tableNumber | Table number. | |
sales[].tableName | Table name. | |
sales[].accountProfileCode | Order profile code (with param include=account_profile). | |
sales[].ownerName | Account owner name (with param include=staff). | |
sales[].ownerId | Account owner id (with param include=staff). | |
sales[].type | Sale types: - SALE: normal sale - VOID: sale that voids another sale - RECALL: sale that recalled another sale - REFUND: sale that refunded another sale - SPLIT: sale that has been splitted from another sale - UPDATE: sale that is used to store payment updates - TRANSFER: sale that is used to store transfers - FLOAT: sale that is used to store cash lifts/drops - TRANSITORY: sale that is carry payments across periods - CROSS_BL: Transfer of a sale that arrives in the target location with negative values | |
sales[].externalReferences | External references, allowing partners to identify the origin of the sale. The format of these references is [type]:[ID in origin system]. | |
sales[].nbCovers | Number of covers for the current account. In some rare cases of split accounts, the number might be decimal. | |
sales[].dineIn | Indicates whether the sale is for dine in or take away/delivery/online orders. | |
sales[].deviceId | Device identifier. | |
sales[].deviceName | Device name. | |
sales[].voidReason | Void reason (if the sale is voided). | |
dataComplete | Whether the day is closed. | |
nextPageToken | Token to use to get the next page if any (only with /financials endpoint). | |