| Method | Description | Returns |
|---|---|---|
| getItemTotalAsMoney() | Gets the item total as a Money object. Represents the sum of all refund items' Amount values. | Money |
| getShippingTotalAsMoney() | Gets the shipping total as a Money object. Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. | Money |
| getHandlingTotalAsMoney() | Gets the handling total as a Money object. Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. | Money |
| getInsuranceTotalAsMoney() | Gets the insurance total as a Money object. Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. | Money |
| getDiscountTotalAsMoney() | Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc. | Money |
| getTaxTotalAsMoney() | Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc. | Money |
| getSurchargeTotalAsMoney() | Gets the surcharge total as a Money object. Represents the surcharge total. | Money |
| getAdjustmentTotalAsMoney() | Gets the adjustment total as a Money object. Represents the manual adjustment applied to this refund (positive or negative). | Money |
| getTotalAsMoney() | Gets the grand total as a Money object. Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total + Adjustment Total`. | Money |
| isFullRefund() | Returns whether the refund is a full refund | bool |
| getId() | int | |
| getStatus() | string | |
| getItemTotal() | Represents the sum of all refund items' Amount values. | string |
| getShippingTotal() | Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. | string |
| getHandlingTotal() | Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. | string |
| getInsuranceTotal() | Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. | string |
| getDiscountTotal() | Represents the sum of discount values across all line items, including shipping, handling, etc. | string |
| getTaxTotal() | Represents the sum of tax values across all line items, including shipping, handling, etc. | string |
| getSurchargeTotal() | Represents the surcharge total. | string |
| getAdjustmentTotal() | Returns the manual adjustment applied to this refund. | string |
| getTotal() | Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total + Adjustment Total`. | string |
| getReason() | string | |
| getErrorMessage() | string | |
| getExternalReference() | string | |
| getCreated() | Date the record was created. | DateTime |
| getModified() | Last modification date for the record. | DateTime |
| getRefunded() | DateTime | |
| getCurrency() | Currency | |
| getInvoiceTransaction() | Transaction | |
| getCreatedBy() | User | |
| getModifiedBy() | User | |
| getOrder() | Order | |
| getRefundItems() | Collection (RefundItem) | |
| 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 |
Orders\Models\Backend\Refund
Refund