Bill Webhooks

Bill Requested

bill.requested A bill has been requested

Name	Type	Description
billRequest	BillRequest	The bill request detail this event is related to.

{
  "event": "bill.requested",
  "billRequest": {
    "...": "..."
  }
}

bill.payment-completed A bill payment has been completed

Name	Type	Description
billPaymentDetail	BillPaymentDetail	The payment this event is related to.

{
  "event": "bill.payment-completed",
  "billPaymentDetail": {
    "...": "..."
  }
}

Name	Type	Description
locationId	string	The location Id the bill belongs to.
organizationId	string	The organization Id the bill belongs to.
billRef	string	Bill Id from non LOKE system.
placeRef	string	The place reference(table number, room number, QR code, etc) used to pull bill.

Name	Type	Description
id	string	Payment ID
locationId	string	The location Id the bill belongs to.
organizationId	string	The organization Id the bill belongs to.
completedAt	string	When the payment was completed
billRef	string	Bill Id from non LOKE system.
chargedAmount	integer	Portion covered by credit card
creditAmount	integer	Portion covered by customer credit
currency	string
discountAmount	integer	Portion discounted by user promotion
feeAmount	integer
payoutAmount	integer
tipAmount	integer
total	integer	Total amount covered by payment
customer	CustomerTiny
items	PaymentLineItem[]

Name	Type	Description
id	string	Unique ID of the Customer
email	string	(optional) The Customers email address
firstName	string	Customer first name or given name
lastName	string	Customer last name or surname
phoneNumber	string	(optional) The Customers mobile phone number

Name	Type	Description
id	string	Product identifier for the item. Depending on the source this could be a SKU, PLU, a database identifier, or something composite.
name	string	Item name
amount	integer	The amount in the lowest denomination (e.g., cents). This will be the price of a single quantity of the item.
quantity	integer	The quantity of identical items purchased on this line.
type	string	The type of line item (e.g., item, discount, surcharge)
options	PaymentLineItemOption[]	(optional) options chosen for this item

Name	Type	Description
id	string	Identifier for the option (group of choices)
name	string	Option name (e.g., 'size', 'milk', 'sugar')
choices	PaymentLineItemOptionChoice[]	Choices made for this option

Name	Type	Description
id	string	Product identifier for the choice. Depending on the source this could be a SKU, PLU, a database identifier, or something composite.
name	string	Choice name (e.g., 'small', 'medium', 'large')
amount	integer	The amount of this choice in the lowest denomination (e.g., cents).