Inheritance diagram for Invoice:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Sales\Model\Order\Invoice\Config $invoiceConfig, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Framework\Math\CalculatorFactory $calculatorFactory, \Magento\Sales\Model\ResourceModel\Order\Invoice\Item\CollectionFactory $invoiceItemCollectionFactory, \Magento\Sales\Model\Order\Invoice\CommentFactory $invoiceCommentFactory, \Magento\Sales\Model\ResourceModel\Order\Invoice\Comment\CollectionFactory $commentCollectionFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	loadByIncrementId ($incrementId)

	getConfig ()

	getStore ()

	setOrder (\Magento\Sales\Model\Order $order)

	getOrder ()

	getEntityType ()

	getBillingAddress ()

	getShippingAddress ()

	isCanceled ()

	canCapture ()

	canVoid ()

	canCancel ()

	canRefund ()

	capture ()

	pay ()

	wasPayCalled ()

	void ()

	cancel ()

	collectTotals ()

	roundPrice ($price, $type='regular', $negative=false)

	getItemsCollection ()

	getAllItems ()

	getItemById ($itemId)

	addItem (\Magento\Sales\Model\Order\Invoice\Item $item)

	getStateName ($stateId=null)

	register ()

	isLast ()

	addComment ($comment, $notify=false, $visibleOnFront=false)

	getCommentsCollection ($reload=false)

	reset ()

	getItems ()

	getComments ()

	getIncrementId ()

	getBaseTotalRefunded ()

	getDiscountDescription ()

	setItems ($items)

	getBaseCurrencyCode ()

	getBaseDiscountAmount ()

	getBaseGrandTotal ()

	getBaseDiscountTaxCompensationAmount ()

	getBaseShippingAmount ()

	getBaseShippingDiscountTaxCompensationAmnt ()

	getBaseShippingInclTax ()

	getBaseShippingTaxAmount ()

	getBaseSubtotal ()

	getBaseSubtotalInclTax ()

	getBaseTaxAmount ()

	getBaseToGlobalRate ()

	getBaseToOrderRate ()

	getBillingAddressId ()

	getCanVoidFlag ()

	getCreatedAt ()

	setCreatedAt ($createdAt)

	getDiscountAmount ()

	getEmailSent ()

	getGlobalCurrencyCode ()

	getGrandTotal ()

	getDiscountTaxCompensationAmount ()

	getIsUsedForRefund ()

	getOrderCurrencyCode ()

	getOrderId ()

	getShippingAddressId ()

	getShippingAmount ()

	getShippingDiscountTaxCompensationAmount ()

	getShippingInclTax ()

	getShippingTaxAmount ()

	getState ()

	getStoreCurrencyCode ()

	getStoreId ()

	getStoreToBaseRate ()

	getStoreToOrderRate ()

	getSubtotal ()

	getSubtotalInclTax ()

	getTaxAmount ()

	getTotalQty ()

	getTransactionId ()

	setTransactionId ($transactionId)

	getUpdatedAt ()

	setComments ($comments)

	setUpdatedAt ($timestamp)

	setStoreId ($id)

	setBaseGrandTotal ($amount)

	setShippingTaxAmount ($amount)

	setTaxAmount ($amount)

	setBaseTaxAmount ($amount)

	setStoreToOrderRate ($rate)

	setBaseShippingTaxAmount ($amount)

	setBaseDiscountAmount ($amount)

	setBaseToOrderRate ($rate)

	setGrandTotal ($amount)

	setShippingAmount ($amount)

	setSubtotalInclTax ($amount)

	setBaseSubtotalInclTax ($amount)

	setStoreToBaseRate ($rate)

	setBaseShippingAmount ($amount)

	setTotalQty ($qty)

	setBaseToGlobalRate ($rate)

	setSubtotal ($amount)

	setBaseSubtotal ($amount)

	setDiscountAmount ($amount)

	setBillingAddressId ($id)

	setIsUsedForRefund ($isUsedForRefund)

	setOrderId ($id)

	setEmailSent ($emailSent)

	setCanVoidFlag ($canVoidFlag)

	setState ($state)

	setShippingAddressId ($id)

	setStoreCurrencyCode ($code)

	setOrderCurrencyCode ($code)

	setBaseCurrencyCode ($code)

	setGlobalCurrencyCode ($code)

	setIncrementId ($id)

	setDiscountTaxCompensationAmount ($amount)

	setBaseDiscountTaxCompensationAmount ($amount)

	setShippingDiscountTaxCompensationAmount ($amount)

	setBaseShippingDiscountTaxCompensationAmnt ($amnt)

	setShippingInclTax ($amount)

	setBaseShippingInclTax ($amount)

	setBaseTotalRefunded ($amount)

	setDiscountDescription ($description)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Sales\Api\Data\InvoiceExtensionInterface $extensionAttributes)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getEventObject ()

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from InvoiceInterface
	getEntityId ()

	setEntityId ($entityId)

	setExtensionAttributes (\Magento\Sales\Api\Data\InvoiceExtensionInterface $extensionAttributes)

Static Public Member Functions
static	getStates ()

Data Fields
const	STATE_OPEN = 1

const	STATE_PAID = 2

const	STATE_CANCELED = 3

const	CAPTURE_ONLINE = 'online'

const	CAPTURE_OFFLINE = 'offline'

const	NOT_CAPTURE = 'not_capture'

const	REPORT_DATE_TYPE_ORDER_CREATED = 'order_created'

const	REPORT_DATE_TYPE_INVOICE_CREATED = 'invoice_created'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from InvoiceInterface
const	ENTITY_ID = 'entity_id'

const	STORE_ID = 'store_id'

const	BASE_GRAND_TOTAL = 'base_grand_total'

const	SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'

const	TAX_AMOUNT = 'tax_amount'

const	BASE_TAX_AMOUNT = 'base_tax_amount'

const	STORE_TO_ORDER_RATE = 'store_to_order_rate'

const	BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'

const	BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

const	BASE_TO_ORDER_RATE = 'base_to_order_rate'

const	GRAND_TOTAL = 'grand_total'

const	SHIPPING_AMOUNT = 'shipping_amount'

const	SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'

const	BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'

const	STORE_TO_BASE_RATE = 'store_to_base_rate'

const	BASE_SHIPPING_AMOUNT = 'base_shipping_amount'

const	TOTAL_QTY = 'total_qty'

const	BASE_TO_GLOBAL_RATE = 'base_to_global_rate'

const	SUBTOTAL = 'subtotal'

const	BASE_SUBTOTAL = 'base_subtotal'

const	DISCOUNT_AMOUNT = 'discount_amount'

const	BILLING_ADDRESS_ID = 'billing_address_id'

const	IS_USED_FOR_REFUND = 'is_used_for_refund'

const	ORDER_ID = 'order_id'

const	EMAIL_SENT = 'email_sent'

const	CAN_VOID_FLAG = 'can_void_flag'

const	STATE = 'state'

const	SHIPPING_ADDRESS_ID = 'shipping_address_id'

const	STORE_CURRENCY_CODE = 'store_currency_code'

const	TRANSACTION_ID = 'transaction_id'

const	ORDER_CURRENCY_CODE = 'order_currency_code'

const	BASE_CURRENCY_CODE = 'base_currency_code'

const	GLOBAL_CURRENCY_CODE = 'global_currency_code'

const	INCREMENT_ID = 'increment_id'

const	CREATED_AT = 'created_at'

const	UPDATED_AT = 'updated_at'

const	DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'

const	BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'

const	SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount'

const	BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt'

const	SHIPPING_INCL_TAX = 'shipping_incl_tax'

const	BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'

const	BASE_TOTAL_REFUNDED = 'base_total_refunded'

const	DISCOUNT_DESCRIPTION = 'discount_description'

const	ITEMS = 'items'

const	COMMENTS = 'comments'

Protected Member Functions
	_construct ()

	_beforeSave ()

	_afterSave ()

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$entityType = 'invoice'

	$_order

	$_rounders = []

	$_saveBeforeDestruct = false

	$_eventPrefix = 'sales_order_invoice'

	$_eventObject = 'invoice'

	$_wasPayCalled = false

	$_invoiceConfig

	$_orderFactory

	$_calculatorFactory

	$_invoiceItemCollectionFactory

	$_invoiceCommentFactory

	$_commentCollectionFactory

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes
static	$_states

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@api @method \Magento\Sales\Model\Order\Invoice setSendEmail(bool $value) @method \Magento\Sales\Model\Order\Invoice setCustomerNote(string $value) @method string getCustomerNote() @method \Magento\Sales\Model\Order\Invoice setCustomerNoteNotify(bool $value) @method bool getCustomerNoteNotify() @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 25 of file Invoice.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Sales\Model\Order\Invoice\Config	$invoiceConfig,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Framework\Math\CalculatorFactory	$calculatorFactory,
		\Magento\Sales\Model\ResourceModel\Order\Invoice\Item\CollectionFactory	$invoiceItemCollectionFactory,
		\Magento\Sales\Model\Order\Invoice\CommentFactory	$invoiceCommentFactory,
		\Magento\Sales\Model\ResourceModel\Order\Invoice\Comment\CollectionFactory	$commentCollectionFactory,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
Invoice\Config	$invoiceConfig
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Framework\Math\CalculatorFactory	$calculatorFactory
\Magento\Sales\Model\ResourceModel\Order\Invoice\Item\CollectionFactory	$invoiceItemCollectionFactory
Invoice\CommentFactory	$invoiceCommentFactory
\Magento\Sales\Model\ResourceModel\Order\Invoice\Comment\CollectionFactory	$commentCollectionFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 139 of file Invoice.php.

       {
         $this->_invoiceConfig = $invoiceConfig;
         $this->_orderFactory = $orderFactory;
         $this->_calculatorFactory = $calculatorFactory;
         $this->_invoiceItemCollectionFactory = $invoiceItemCollectionFactory;
         $this->_invoiceCommentFactory = $invoiceCommentFactory;
         $this->_commentCollectionFactory = $commentCollectionFactory;
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ _afterSave()

_afterSave ( )

protected

After object save manipulation

Returns: $this

Definition at line 770 of file Invoice.php.

     {
         return parent::_afterSave();
     }

◆ _beforeSave()

_beforeSave ( )

protected

Before object save manipulations

Returns: $this

Perform actions before object save

Parameters

\Magento\Framework\Model\AbstractModel | \Magento\Framework\DataObject $object

Returns: $this

Definition at line 760 of file Invoice.php.

     {
         return parent::_beforeSave();
     }

◆ _construct()

_construct ( )

protected

Initialize invoice resource model

Returns: void

Definition at line 176 of file Invoice.php.

     {
         $this->_init(\Magento\Sales\Model\ResourceModel\Order\Invoice::class);
     }

◆ addComment()

addComment	(	$comment,
		$notify = `false`,
		$visibleOnFront = `false`
	)

Adds comment to invoice with additional possibility to send it to customer via email and show it in customer account

Parameters

string	$comment
bool	$notify
bool	$visibleOnFront

Returns: $this

Definition at line 693 of file Invoice.php.

     {
         if (!$comment instanceof \Magento\Sales\Model\Order\Invoice\Comment) {
             $comment = $this->_invoiceCommentFactory->create()->setComment(
                 $comment
             )->setIsCustomerNotified(
                 $notify
             )->setIsVisibleOnFront(
                 $visibleOnFront
             );
         }
         $comment->setInvoice($this)->setStoreId($this->getStoreId())->setParentId($this->getId());
         if (!$comment->getId()) {
             $this->getCommentsCollection()->addItem($comment);
         }
         $this->_hasDataChanges = true;
         return $this;
     }

◆ addItem()

addItem ( \Magento\Sales\Model\Order\Invoice\Item $item )

Parameters

\Magento\Sales\Model\Order\Invoice\Item $item

Returns: $this

Definition at line 542 of file Invoice.php.

     {
         $item->setInvoice($this)->setParentId($this->getId())->setStoreId($this->getStoreId());
 
         if (!$item->getId()) {
             $this->getItemsCollection()->addItem($item);
         }
         return $this;
     }

◆ canCancel()

canCancel ( )

Check invoice cancel action availability

Returns: bool

Definition at line 316 of file Invoice.php.

     {
         return $this->getState() == self::STATE_OPEN;
     }

◆ canCapture()

canCapture ( )

Check invoice capture action availability

Returns: bool

Definition at line 289 of file Invoice.php.

     {
         return $this->getState() != self::STATE_CANCELED &&
             $this->getState() != self::STATE_PAID &&
             $this->getOrder()->getPayment()->canCapture();
     }

◆ cancel()

cancel ( )

Cancel invoice action

Returns: $this

Unregister order totals only for invoices in state PAID

Definition at line 408 of file Invoice.php.

     {
         if (!$this->canCancel()) {
             return $this;
         }
         $order = $this->getOrder();
         $order->getPayment()->cancelInvoice($this);
         foreach ($this->getAllItems() as $item) {
             $item->cancel();
         }
 
         $order->setTotalInvoiced($order->getTotalInvoiced() - $this->getGrandTotal());
         $order->setBaseTotalInvoiced($order->getBaseTotalInvoiced() - $this->getBaseGrandTotal());
 
         $order->setSubtotalInvoiced($order->getSubtotalInvoiced() - $this->getSubtotal());
         $order->setBaseSubtotalInvoiced($order->getBaseSubtotalInvoiced() - $this->getBaseSubtotal());
 
         $order->setTaxInvoiced($order->getTaxInvoiced() - $this->getTaxAmount());
         $order->setBaseTaxInvoiced($order->getBaseTaxInvoiced() - $this->getBaseTaxAmount());
 
         $order->setDiscountTaxCompensationInvoiced(
             $order->getDiscountTaxCompensationInvoiced() - $this->getDiscountTaxCompensationAmount()
         );
         $order->setBaseDiscountTaxCompensationInvoiced(
             $order->getBaseDiscountTaxCompensationInvoiced() - $this->getBaseDiscountTaxCompensationAmount()
         );
 
         $order->setShippingTaxInvoiced($order->getShippingTaxInvoiced() - $this->getShippingTaxAmount());
         $order->setBaseShippingTaxInvoiced($order->getBaseShippingTaxInvoiced() - $this->getBaseShippingTaxAmount());
 
         $order->setShippingInvoiced($order->getShippingInvoiced() - $this->getShippingAmount());
         $order->setBaseShippingInvoiced($order->getBaseShippingInvoiced() - $this->getBaseShippingAmount());
 
         $order->setDiscountInvoiced($order->getDiscountInvoiced() - $this->getDiscountAmount());
         $order->setBaseDiscountInvoiced($order->getBaseDiscountInvoiced() - $this->getBaseDiscountAmount());
         $order->setBaseTotalInvoicedCost($order->getBaseTotalInvoicedCost() - $this->getBaseCost());
 
         if ($this->getState() == self::STATE_PAID) {
             $order->setTotalPaid($order->getTotalPaid() - $this->getGrandTotal());
             $order->setBaseTotalPaid($order->getBaseTotalPaid() - $this->getBaseGrandTotal());
         }
         $this->setState(self::STATE_CANCELED);
         $order->setState(\Magento\Sales\Model\Order::STATE_PROCESSING)
             ->setStatus($order->getConfig()->getStateDefaultStatus(\Magento\Sales\Model\Order::STATE_PROCESSING));
         $this->_eventManager->dispatch('sales_order_invoice_cancel', [$this->_eventObject => $this]);
         return $this;
     }

◆ canRefund()

canRefund ( )

Check invoice refund action availability

Returns: bool

Definition at line 326 of file Invoice.php.

     {
         if ($this->getState() != self::STATE_PAID) {
             return false;
         }
         if (abs($this->getBaseGrandTotal() - $this->getBaseTotalRefunded()) < .0001) {
             return false;
         }
         return true;
     }

◆ canVoid()

canVoid ( )

Check invoice void action availability

Returns: bool

Definition at line 301 of file Invoice.php.

     {
         if ($this->getState() == self::STATE_PAID) {
             if ($this->getCanVoidFlag() === null) {
                 return (bool)$this->getOrder()->getPayment()->canVoid();
             }
         }
         return (bool)$this->getCanVoidFlag();
     }

◆ capture()

capture ( )

Capture invoice

Returns: $this

Definition at line 342 of file Invoice.php.

     {
         $this->getOrder()->getPayment()->capture($this);
         if ($this->getIsPaid()) {
             $this->pay();
         }
         return $this;
     }

◆ collectTotals()

collectTotals ( )

Invoice totals collecting

Returns: $this

Definition at line 464 of file Invoice.php.

     {
         foreach ($this->getConfig()->getTotalModels() as $model) {
             $model->collect($this);
         }
         return $this;
     }

◆ getAllItems()

getAllItems ( )

Returns: array

Definition at line 513 of file Invoice.php.

     {
         $items = [];
         foreach ($this->getItemsCollection() as $item) {
             if (!$item->isDeleted()) {
                 $items[] = $item;
             }
         }
         return $items;
     }

◆ getBaseCurrencyCode()

getBaseCurrencyCode ( )

Returns base_currency_code

Returns: string|null

roundPrice	(	$price,
		$type = `'regular'`,
		$negative = `false`
	)

float	$price
string	$type
bool	$negative	Indicates if we perform addition (true) or subtraction (false) of rounded value

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _afterSave()

◆ _beforeSave()

◆ _construct()

◆ addComment()

◆ addItem()

◆ canCancel()

◆ canCapture()

◆ cancel()

◆ canRefund()

◆ canVoid()

◆ capture()

◆ collectTotals()

◆ getAllItems()

◆ getBaseCurrencyCode()

◆ getBaseDiscountAmount()

◆ getBaseDiscountTaxCompensationAmount()

◆ getBaseGrandTotal()

◆ getBaseShippingAmount()

◆ getBaseShippingDiscountTaxCompensationAmnt()

◆ getBaseShippingInclTax()

◆ getBaseShippingTaxAmount()

◆ getBaseSubtotal()

◆ getBaseSubtotalInclTax()

◆ getBaseTaxAmount()

◆ getBaseToGlobalRate()

◆ getBaseToOrderRate()

◆ getBaseTotalRefunded()

◆ getBillingAddress()

◆ getBillingAddressId()

◆ getCanVoidFlag()

◆ getComments()

◆ getCommentsCollection()

◆ getConfig()

◆ getCreatedAt()

◆ getDiscountAmount()

◆ getDiscountDescription()

◆ getDiscountTaxCompensationAmount()

◆ getEmailSent()

◆ getEntityType()

◆ getExtensionAttributes()

◆ getGlobalCurrencyCode()

◆ getGrandTotal()

◆ getIncrementId()

◆ getIsUsedForRefund()

◆ getItemById()

◆ getItems()

◆ getItemsCollection()

◆ getOrder()

◆ getOrderCurrencyCode()

◆ getOrderId()

◆ getShippingAddress()

◆ getShippingAddressId()

◆ getShippingAmount()

◆ getShippingDiscountTaxCompensationAmount()

◆ getShippingInclTax()

◆ getShippingTaxAmount()

◆ getState()

◆ getStateName()

◆ getStates()

◆ getStore()

◆ getStoreCurrencyCode()

◆ getStoreId()

◆ getStoreToBaseRate()

◆ getStoreToOrderRate()

◆ getSubtotal()

◆ getSubtotalInclTax()

◆ getTaxAmount()

◆ getTotalQty()

◆ getTransactionId()

◆ getUpdatedAt()