| Property | Description | Returns |
|---|---|---|
| currency | Get the currency | Currency |
| itemTotalAsMoney | Gets the item total as a Money object. Represents the sum of all items' Amount values. | Money |
| shippingTotalAsMoney | 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 |
| handlingTotalAsMoney | 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 |
| insuranceTotalAsMoney | 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 |
| discountTotalAsMoney | Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc. | Money |
| taxTotalAsMoney | Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc. | Money |
| surchargeTotalAsMoney | Gets the surcharge total as a Money object. Represents the surcharge total. | Money |
| adjustmentTotalAsMoney | Gets the adjustment total as a Money object. Represents a manual financial adjustment (positive or negative). | Money |
| totalExcludingAdjustmentAsMoney | Gets the total excluding adjustment as a Money object. Represents the grand total minus the adjustment total. | Money |
| totalAsMoney | 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 |
| fullRefund | Returns whether the refund is a full refund | bool |
| errorMessage | Get the error message if the refund failed | string |
| id | int | |
| status | string | |
| itemTotal | Represents the sum of all items' Amount values. | string |
| shippingTotal | Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. | string |
| handlingTotal | Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. | string |
| insuranceTotal | Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. | string |
| discountTotal | Represents the sum of discount values across all line items, including shipping, handling, etc. | string |
| taxTotal | Represents the sum of tax values across all line items, including shipping, handling, etc. | string |
| surchargeTotal | Represents the surcharge total. | string |
| adjustmentTotal | Represents a manual financial adjustment (positive or negative). | string |
| total | Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total + Adjustment Total`. | string |
| reason | string | |
| externalId | string | |
| created | Date the record was created. | DateTime |
| modified | Last modification date for the record. | DateTime |
| refunded | DateTime | |
| transaction | Transaction | |
| invoice | Invoice | |
| createdBy | User | |
| refundItems | Collection (RefundItem) |
Invoices\Models\Api\Refund
Refund