Class: DisplayOrder

order.DisplayOrder()

new DisplayOrder()

Source:

Methods

(static) DisplayOrder#getAmountRemaining() → {String}

Get the field value Formatted amount remaining
Source:
Returns:
Type
String

(static) DisplayOrder#getCurrency() → {String}

Get the field value Currency of this order
Source:
Returns:
Type
String

(static) DisplayOrder#getDiscounts() → {Array.<order.DisplayDiscount>}

Get the field value
Source:
Returns:
An array of
Type
Array.<order.DisplayDiscount>

(static) DisplayOrder#getEmployee() → {String}

Get the field value The employee associated with this order
Source:
Returns:
Type
String

(static) DisplayOrder#getId() → {String}

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) DisplayOrder#getIsVat() → {Boolean}

Get the field value This order was created by merchant with VAT enabled.
Source:
Returns:
Type
Boolean

(static) DisplayOrder#getLineItems() → {Array.<order.DisplayLineItem>}

Get the field value
Source:
Returns:
An array of
Type
Array.<order.DisplayLineItem>

(static) DisplayOrder#getNote() → {Null|String}

Get the field value
Source:
Returns:
Type
Null | String

(static) DisplayOrder#getPayments() → {Array.<order.DisplayPayment>}

Get the field value Payments that were made for this order
Source:
Returns:
An array of
Type
Array.<order.DisplayPayment>

(static) DisplayOrder#getServiceChargeAmount() → {Null|String}

Get the field value Optional service charge amount (gratuity) applied to this order
Source:
Returns:
Type
Null | String

(static) DisplayOrder#getServiceChargeName() → {Null|String}

Get the field value Optional service charge name (gratuity) applied to this order
Source:
Returns:
Type
Null | String

(static) DisplayOrder#getSubtotal() → {String}

Get the field value Formatted subtotal of the order
Source:
Returns:
Type
String

(static) DisplayOrder#getTax() → {String}

Get the field value Formatted tax of the order
Source:
Returns:
Type
String

(static) DisplayOrder#getTitle() → {Null|String}

Get the field value
Source:
Returns:
Type
Null | String

(static) DisplayOrder#getTotal() → {String}

Get the field value Formatted total of the order
Source:
Returns:
Type
String

(static) DisplayOrder#setAmountRemaining(amountRemaining)

Set the field value Formatted amount remaining
Parameters:
Name Type Description
amountRemaining String
Source:

(static) DisplayOrder#setCurrency(currency)

Set the field value Currency of this order
Parameters:
Name Type Description
currency String
Source:

(static) DisplayOrder#setDiscounts(discounts)

Set the field value
Parameters:
Name Type Description
discounts Array.<order.DisplayDiscount> An array of
Source:

(static) DisplayOrder#setEmployee(employee)

Set the field value The employee associated with this order
Parameters:
Name Type Description
employee String
Source:

(static) DisplayOrder#setId(id)

Set the field value Unique identifier
Parameters:
Name Type Description
id String
Source:

(static) DisplayOrder#setIsVat(isVat)

Set the field value This order was created by merchant with VAT enabled.
Parameters:
Name Type Description
isVat Boolean
Source:

(static) DisplayOrder#setLineItems(lineItems)

Set the field value
Parameters:
Name Type Description
lineItems Array.<order.DisplayLineItem> An array of
Source:

(static) DisplayOrder#setNote(note)

Set the field value
Parameters:
Name Type Description
note Null | String
Source:

(static) DisplayOrder#setPayments(payments)

Set the field value Payments that were made for this order
Parameters:
Name Type Description
payments Array.<order.DisplayPayment> An array of
Source:

(static) DisplayOrder#setServiceChargeAmount(serviceChargeAmount)

Set the field value Optional service charge amount (gratuity) applied to this order
Parameters:
Name Type Description
serviceChargeAmount Null | String
Source:

(static) DisplayOrder#setServiceChargeName(serviceChargeName)

Set the field value Optional service charge name (gratuity) applied to this order
Parameters:
Name Type Description
serviceChargeName Null | String
Source:

(static) DisplayOrder#setSubtotal(subtotal)

Set the field value Formatted subtotal of the order
Parameters:
Name Type Description
subtotal String
Source:

(static) DisplayOrder#setTax(tax)

Set the field value Formatted tax of the order
Parameters:
Name Type Description
tax String
Source:

(static) DisplayOrder#setTitle(title)

Set the field value
Parameters:
Name Type Description
title Null | String
Source:

(static) DisplayOrder#setTotal(total)

Set the field value Formatted total of the order
Parameters:
Name Type Description
total String
Source: