InvoiceInterface

What it does

This interface defines the contract for invoice data objects in Magento 2.

Developers use this when working with invoice records that represent payment receipts for orders, including financial totals, tax calculations, currency conversions, shipping costs, and invoice items.

It's commonly used in order processing, payment collection, and refund workflows to read or manipulate invoice data.

Public Methods

• getBaseCurrencyCode()
• getBaseDiscountAmount()
• getBaseGrandTotal()
• getBaseDiscountTaxCompensationAmount()
• getBaseShippingAmount()
• getBaseShippingDiscountTaxCompensationAmnt()
• getBaseShippingInclTax()
• getBaseShippingTaxAmount()
• getBaseSubtotal()
• getBaseSubtotalInclTax()
• getBaseTaxAmount()
• getBaseTotalRefunded()
• getBaseToGlobalRate()
• getBaseToOrderRate()
• getBillingAddressId()
• getCanVoidFlag()
• getCreatedAt()
• setCreatedAt()
• getDiscountAmount()
• getDiscountDescription()
• getEmailSent()
• getEntityId()
• setEntityId()
• getGlobalCurrencyCode()
• getGrandTotal()
• getDiscountTaxCompensationAmount()
• getIncrementId()
• getIsUsedForRefund()
• getOrderCurrencyCode()
• getOrderId()
• getShippingAddressId()
• getShippingAmount()
• getShippingDiscountTaxCompensationAmount()
• getShippingInclTax()
• getShippingTaxAmount()
• getState()
• getStoreCurrencyCode()
• getStoreId()
• getStoreToBaseRate()
• getStoreToOrderRate()
• getSubtotal()
• getSubtotalInclTax()
• getTaxAmount()
• getTotalQty()
• getTransactionId()
• setTransactionId()
• getUpdatedAt()
• getItems()
• setItems()
• getComments()
• setComments()
• setUpdatedAt()
• setStoreId()
• setBaseGrandTotal()
• setShippingTaxAmount()
• setTaxAmount()
• setBaseTaxAmount()
• setStoreToOrderRate()
• setBaseShippingTaxAmount()
• setBaseDiscountAmount()
• setBaseToOrderRate()
• setGrandTotal()
• setShippingAmount()
• setSubtotalInclTax()
• setBaseSubtotalInclTax()
• setStoreToBaseRate()
• setBaseShippingAmount()
• setTotalQty()
• setBaseToGlobalRate()
• setSubtotal()
• setBaseSubtotal()
• setDiscountAmount()
• setBillingAddressId()
• setIsUsedForRefund()
• setOrderId()
• setEmailSent()
• setCanVoidFlag()
• setState()
• setShippingAddressId()
• setStoreCurrencyCode()
• setOrderCurrencyCode()
• setBaseCurrencyCode()
• setGlobalCurrencyCode()
• setIncrementId()
• setDiscountTaxCompensationAmount()
• setBaseDiscountTaxCompensationAmount()
• setShippingDiscountTaxCompensationAmount()
• setBaseShippingDiscountTaxCompensationAmnt()
• setShippingInclTax()
• setBaseShippingInclTax()
• setBaseTotalRefunded()
• setDiscountDescription()
• getExtensionAttributes()
• setExtensionAttributes()