ModelOrders module

Refund

A model in the Orders module, with 35 members for templates, 34 API properties and 36 members for admin templates.

Orders\Models\Frontend\Refund Orders\Models\Api\Refund Orders\Models\Backend\Refund Also in Orders: MetadataField MetadataFieldValue Order RefundItem

Templates view

Properties 35

Take no arguments.

# getItemTotalAsMoney(): Money; Gets the item total as a Money object. Represents the sum of all refund items' Amount values.
# getShippingTotalAsMoney(): Money; 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.
# getHandlingTotalAsMoney(): Money; 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.
# getInsuranceTotalAsMoney(): Money; 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.
# getDiscountTotalAsMoney(): Money; Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotalAsMoney(): Money; Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotalAsMoney(): Money; Gets the surcharge total as a Money object. Represents the surcharge total.
# getAdjustmentTotalAsMoney(): Money; Gets the adjustment total as a Money object. Represents the manual adjustment applied to this refund (positive or negative).
# getTotalAsMoney(): Money; 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.
# isFullRefund(): bool; Returns whether the refund is a full refund
# getId(): ?int
# getStatus(): ?string
# getItemTotal(): ?string; Represents the sum of all refund items' Amount values.
# getShippingTotal(): ?string; Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# getHandlingTotal(): ?string; Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# getInsuranceTotal(): ?string; Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# getDiscountTotal(): ?string; Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotal(): ?string; Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotal(): ?string; Represents the surcharge total.
# getAdjustmentTotal(): ?string; Returns the manual adjustment applied to this refund.
# getTotal(): ?string; Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total + Adjustment Total.
# getReason(): ?string
# getErrorMessage(): ?string
# getExternalReference(): ?string
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getRefunded(): ?DateTime
# getCurrency(): ?Currency
# getCreatedBy(): ?User
# getModifiedBy(): ?User
# getOrder(): ?Order
# getRefundItems(): ?Collection<RefundItem>
# isNewRecord() Not in API & Jobs: bool; Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs: bool; Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs: bool; Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 34

Read-only values on the record.

# itemTotalAsMoney: Money; Gets the item total as a Money object. Represents the sum of all refund items' Amount values.
# shippingTotalAsMoney: Money; 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.
# handlingTotalAsMoney: Money; 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.
# insuranceTotalAsMoney: Money; 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.
# discountTotalAsMoney: Money; Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# taxTotalAsMoney: Money; Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# surchargeTotalAsMoney: Money; Gets the surcharge total as a Money object. Represents the surcharge total.
# adjustmentTotalAsMoney: Money; Gets the adjustment total as a Money object. Represents the manual adjustment applied to this refund (positive or negative).
# totalAsMoney: Money; 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.
# fullRefund: bool; Returns whether the refund is a full refund
# id: ?int
# status: ?string
# itemTotal: ?string; Represents the sum of all refund items' Amount values.
# shippingTotal: ?string; Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# handlingTotal: ?string; Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# insuranceTotal: ?string; Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# discountTotal: ?string; Represents the sum of discount values across all line items, including shipping, handling, etc.
# taxTotal: ?string; Represents the sum of tax values across all line items, including shipping, handling, etc.
# surchargeTotal: ?string; Represents the surcharge total.
# adjustmentTotal: ?string; Returns the manual adjustment applied to this refund.
# total: ?string; Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total + Adjustment Total.
# reason: ?string
# errorMessage: ?string
# externalReference: ?string
# created: ?DateTime; Date the record was created.
# modified: ?DateTime; Last modification date for the record.
# refunded: ?DateTime
# currency: ?Currency
# invoiceTransaction Not in Templates: ?Transaction
# createdBy: ?User
# modifiedBy: ?User
# order: ?Order
# refundItems: ?Collection<RefundItem>
# totalExcludingAdjustmentAsMoney API & Jobs only: Money; Gets the total excluding adjustment as a Money object. Represents the grand total minus the adjustment total.

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 36