CreditmemoInterface

What it does

This interface defines the data structure for credit memos in Magento 2.

Developers use it to retrieve and manipulate credit memo information when processing refunds for returned or undelivered items, including amounts, taxes, discounts, and associated items.

It's commonly used in custom refund logic, payment integrations, and order management extensions.

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()