AmountsReq class abstract

Various amounts related to the payment request from the Sale System.

Properties:

  • currency - Currency of a monetary amount.
  • requestedAmount - Amount requested by the Sale for the payment.
  • cashBackAmount - The cash-back part of the amount requested by the Sale for the payment.
  • tipAmount - Amount paid for a tip. Allow the printing of the tip on the receipt, and to qualify the tip part of the amount.
  • paidAmount - Amount already paid in case of split payment. Depending on the context, a split payment is either a split amount, or a split basket (required by some payment means as fleet cards). The PaidAmount is present when the split payment is a split of the amount. Split of the basket involves two Sale Transactions, and does not have to be recognised by the POI.
  • minimumAmountToDeliver - Minimum amount the Sale System is allowed to deliver for this payment. For the OneTimeReservation, when the maximum amount is unknown, the Sale System indicates the minimum amount it allows.
  • maximumCashBackAmount - Maximum amount which could be requested for cash-back to the Sale System. Allows the Cashier to limit the amount value of cash-back to deliver to the Customer.
  • minimumSplitAmount - Minimum amount of a split, which could be requested by a Customer.Allows the Merchant to limit the number of split requested by the Customer.
Annotations
  • @BuiltValue.new()

Constructors

AmountsReq([void updates(AmountsReqBuilder b)])
factory

Properties

cashBackAmount → num?
The cash-back part of the amount requested by the Sale for the payment.
no setter
currency → String
Currency of a monetary amount.
no setter
hashCode → int
The hash code for this object.
no setterinherited
maximumCashBackAmount → num?
Maximum amount which could be requested for cash-back to the Sale System. Allows the Cashier to limit the amount value of cash-back to deliver to the Customer.
no setter
minimumAmountToDeliver → num?
Minimum amount the Sale System is allowed to deliver for this payment. For the OneTimeReservation, when the maximum amount is unknown, the Sale System indicates the minimum amount it allows.
no setter
minimumSplitAmount → num?
Minimum amount of a split, which could be requested by a Customer.Allows the Merchant to limit the number of split requested by the Customer.
no setter
paidAmount → num?
Amount already paid in case of split payment. Depending on the context, a split payment is either a split amount, or a split basket (required by some payment means as fleet cards). The PaidAmount is present when the split payment is a split of the amount. Split of the basket involves two Sale Transactions, and does not have to be recognised by the POI.
no setter
requestedAmount → num
Amount requested by the Sale for the payment.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tipAmount → num?
Amount paid for a tip. Allow the printing of the tip on the receipt, and to qualify the tip part of the amount.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(AmountsReqBuilder)) → AmountsReq
Rebuilds the instance.
inherited
toBuilder() → AmountsReqBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<AmountsReq>
no setter