Frontend | Backend | Api

Orders\Models\Backend\RefundItem

RefundItem

Method Description Returns
getCurrency() Gets the currency of the item (from its refund). Currency
getUnitAmountAsMoney() Gets the amount for a single unit (quantity = 1) as a Money object. Represents the value per unit before tax and discount are applied. Money
getUnitTaxAsMoney() Gets the tax for a single unit (quantity = 1) as a Money object. Represents the tax value per unit. Money
getUnitDiscountAsMoney() Gets the discount for a single unit (quantity = 1) as a Money object. Represents the discount value per unit. Money
getUnitTotalAsMoney() Gets the total for a single unit (quantity = 1) as a Money object. Represents the final value per unit calculated as `Unit Amount + Unit Tax - Unit Discount`. Money
getAmountAsMoney() Gets the amount for the entire quantity as a Money object. Represents the value before applying tax and discount (`Unit Amount × Quantity`). Money
getTaxAsMoney() Gets the tax for the entire quantity as a Money object. Represents the total tax calculated (`Unit Tax × Quantity`). Money
getDiscountAsMoney() Gets the discount for the entire quantity as a Money object. Represents the total discount applied (`Unit Discount × Quantity`). Money
getTotalAsMoney() Gets the total for the entire quantity as a Money object. Represents the final value calculated as `Amount + Tax - Discount`. Money
getType() Returns the type of the refund item. string
getId() int
getQuantity() The number of units purchased. Quantity of the item. Integer positive (not 0) number. int
getAmount() Represents the value before applying tax and discount (`Unit Amount × Quantity`). string
getTax() Represents the total tax calculated (`Unit Tax × Quantity`). string
getDiscount() Represents the total discount applied (`Unit Discount × Quantity`). string
getCreated() Date the record was created. DateTime
getInvoiceItem() Item
getRefund() Refund
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
isVersionedModel() Check whether a model is versioned bool