Bill Webhooks

Bill Requested

Events

bill.requestedA bill has been requested

Fields

NameTypeDescription
billRequestBillRequest The bill request detail this event is related to.

Example

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

Bill Payment Completed

Events

bill.payment-completedA bill payment has been completed

Fields

NameTypeDescription
billPaymentDetailBillPaymentDetail The payment this event is related to.

Example

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

Models

BillRequest

NameTypeDescription
locationIdstring The location Id the bill belongs to.
organizationIdstring The organization Id the bill belongs to.
billRefstring Bill Id from non LOKE system.
placeRefstring The place reference(table number, room number, QR code, etc) used to pull bill.

BillPaymentDetail

NameTypeDescription
idstring Payment ID
locationIdstring The location Id the bill belongs to.
organizationIdstring The organization Id the bill belongs to.
completedAtstring When the payment was completed
billRefstring Bill Id from non LOKE system.
chargedAmountinteger Portion covered by credit card
creditAmountinteger Portion covered by customer credit
currencystring
discountAmountinteger Portion discounted by user promotion
feeAmountinteger
payoutAmountinteger
tipAmountinteger
totalinteger Total amount covered by payment
customerCustomerTiny
itemsPaymentLineItem[]

CustomerTiny

NameTypeDescription
idstring Unique ID of the Customer
emailstring(optional) The Customers email address
firstNamestring Customer first name or given name
lastNamestring Customer last name or surname
phoneNumberstring(optional) The Customers mobile phone number

PaymentLineItem

NameTypeDescription
idstring Unique identifier for the item
namestring Item name
amountinteger Item per unit amount
quantityinteger Quantity of units of item
typestring item, discount, surcharge
optionsPaymentLineItemOption[](optional) options chosen for this item

PaymentLineItemOption

NameTypeDescription
idstring Unique identifier for the option
namestring Option name, eg 'size'
choicesPaymentLineItemOptionChoice[] Choices made for this option

PaymentLineItemOptionChoice

NameTypeDescription
idstring Unique identifier for the choice
namestring Choice name, eg 'small'
amountinteger Choice per unit amount

In this article