Log in
Interface

CreditmemoInterface

Magento\Sales\Api\Data\CreditmemoInterface

What it does

This interface defines the data structure and operations for credit memos (refund documents) in Magento 2.

Developers use this when creating, reading, or modifying credit memos programmatically, such as processing refunds for returned products or cancelled orders.

It provides getter and setter methods for all credit memo properties including amounts, taxes, adjustments, and associated items and comments.

Public Methods

  • getAdjustment()
  • getAdjustmentNegative()
  • getAdjustmentPositive()
  • getBaseAdjustment()
  • getBaseAdjustmentNegative()
  • setBaseAdjustmentNegative()
  • getBaseAdjustmentPositive()
  • setBaseAdjustmentPositive()
  • getBaseCurrencyCode()
  • getBaseDiscountAmount()
  • getBaseGrandTotal()
  • getBaseDiscountTaxCompensationAmount()
  • getBaseShippingAmount()
  • getBaseShippingDiscountTaxCompensationAmnt()
  • getBaseShippingInclTax()
  • getBaseShippingTaxAmount()
  • getBaseSubtotal()
  • getBaseSubtotalInclTax()
  • getBaseTaxAmount()
  • getBaseToGlobalRate()
  • getBaseToOrderRate()
  • getBillingAddressId()
  • getCreatedAt()
  • setCreatedAt()
  • getCreditmemoStatus()
  • getDiscountAmount()
  • getDiscountDescription()
  • getEmailSent()
  • getEntityId()
  • setEntityId()
  • getGlobalCurrencyCode()
  • getGrandTotal()
  • getDiscountTaxCompensationAmount()
  • getIncrementId()
  • getInvoiceId()
  • getOrderCurrencyCode()
  • getOrderId()
  • getShippingAddressId()
  • getShippingAmount()
  • getShippingDiscountTaxCompensationAmount()
  • getShippingInclTax()
  • getShippingTaxAmount()
  • getState()
  • getStoreCurrencyCode()
  • getStoreId()
  • getStoreToBaseRate()
  • getStoreToOrderRate()
  • getSubtotal()
  • getSubtotalInclTax()
  • getTaxAmount()
  • getTransactionId()
  • setTransactionId()
  • getUpdatedAt()
  • getItems()
  • setItems()
  • getComments()
  • setComments()
  • setStoreId()
  • setAdjustmentPositive()
  • setBaseShippingTaxAmount()
  • setStoreToOrderRate()
  • setBaseDiscountAmount()
  • setBaseToOrderRate()
  • setGrandTotal()
  • setBaseSubtotalInclTax()
  • setShippingAmount()
  • setSubtotalInclTax()
  • setAdjustmentNegative()
  • setBaseShippingAmount()
  • setStoreToBaseRate()
  • setBaseToGlobalRate()
  • setBaseAdjustment()
  • setBaseSubtotal()
  • setDiscountAmount()
  • setSubtotal()
  • setAdjustment()
  • setBaseGrandTotal()
  • setBaseTaxAmount()
  • setShippingTaxAmount()
  • setTaxAmount()
  • setOrderId()
  • setEmailSent()
  • setCreditmemoStatus()
  • setState()
  • setShippingAddressId()
  • setBillingAddressId()
  • setInvoiceId()
  • setStoreCurrencyCode()
  • setOrderCurrencyCode()
  • setBaseCurrencyCode()
  • setGlobalCurrencyCode()
  • setIncrementId()
  • setUpdatedAt()
  • setDiscountTaxCompensationAmount()
  • setBaseDiscountTaxCompensationAmount()
  • setShippingDiscountTaxCompensationAmount()
  • setBaseShippingDiscountTaxCompensationAmnt()
  • setShippingInclTax()
  • setBaseShippingInclTax()
  • setDiscountDescription()
  • getExtensionAttributes()
  • setExtensionAttributes()