Log in
Interface

InvoiceInterface

Magento\Sales\Api\Data\InvoiceInterface

What it does

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

Developers use this interface when working with invoices programmatically, such as creating, retrieving, or manipulating invoice data through service contracts and API operations.

It provides getter and setter methods for all invoice properties including totals, tax amounts, currency codes, billing/shipping information, and related items and comments.

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