Class Mage_Sales_Model_Order_Invoice

Enter description here ...

Varien_Object

Mage_Sales_Model_Order_Invoice

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Order/Invoice.php

Methods summary
`public`	# `__destruct( )`
`protected`	# `_construct( )` Initialize invoice resource model Initialize invoice resource model
`protected Mage_Sales_Model_Order_Invoice`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order_Invoice`	# `loadByIncrementId( string $incrementId )` Load invoice by increment id Load invoice by increment id Parameters `$incrementId` `string` $incrementId Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order_Invoice_Config`	# `getConfig( )` Retrieve invoice configuration model Retrieve invoice configuration model Returns `Mage_Sales_Model_Order_Invoice_Config`
`public Mage_Core_Model_Store`	# `getStore( )` Retrieve store model instance Retrieve store model instance Returns `Mage_Core_Model_Store`
`public Mage_Sales_Model_Order_Invoice`	# `setOrder( Mage_Sales_Model_Order $order )` Declare order for invoice Declare order for invoice Parameters `$order` `Mage_Sales_Model_Order` $order Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order`	# `getOrder( )` Retrieve the order the invoice for created for Retrieve the order the invoice for created for Returns `Mage_Sales_Model_Order`
`public string`	# `getOrderIncrementId( )` Retrieve the increment_id of the order Retrieve the increment_id of the order Returns `string`
`public Mage_Sales_Model_Order_Address`	# `getBillingAddress( )` Retrieve billing address Retrieve billing address Returns `Mage_Sales_Model_Order_Address`
`public Mage_Sales_Model_Order_Address`	# `getShippingAddress( )` Retrieve shipping address Retrieve shipping address Returns `Mage_Sales_Model_Order_Address`
`public boolean`	# `isCanceled( )` Check invoice cancel state Check invoice cancel state Returns `boolean`
`public boolean`	# `canCapture( )` Check invice capture action availability Check invice capture action availability Returns `boolean`
`public boolean`	# `canVoid( )` Check invice void action availability Check invice void action availability Returns `boolean`
`public boolean`	# `canCancel( )` Check invoice cancel action availability Check invoice cancel action availability Returns `boolean`
`public boolean`	# `canRefund( )` Check invoice refund action availability Check invoice refund action availability Returns `boolean`
`public Mage_Sales_Model_Order_Invoice`	# `capture( )` Capture invoice Capture invoice Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order_Invoice`	# `pay( )` Pay invoice Pay invoice Returns `Mage_Sales_Model_Order_Invoice`
`public boolean`	# `wasPayCalled( )` Whether pay() method was called (whether order and payment totals were updated) Whether pay() method was called (whether order and payment totals were updated) Returns `boolean`
`public Mage_Sales_Model_Order_Invoice`	# `void( )` Void invoice Void invoice Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order_Invoice`	# `cancel( )` Cancel invoice action Cancel invoice action Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order_Invoice`	# `collectTotals( )` Invoice totals collecting Invoice totals collecting Returns `Mage_Sales_Model_Order_Invoice`
`public float`	# `roundPrice( float $price, string $type = 'regular', boolean $negative = false )` Round price considering delta Round price considering delta Parameters `$price` `float` $price `$type` `string` $type `$negative` `boolean` $negative Indicates if we perform addition (true) or subtraction (false) of rounded value Returns `float`
`public Mage_Sales_Model_Mysql4_Order_Invoice_Item_Collection`	# `getItemsCollection( )` Get invoice items collection Get invoice items collection Returns `Mage_Sales_Model_Mysql4_Order_Invoice_Item_Collection`
`public`	# `getAllItems( )`
`public`	# `getItemById( mixed $itemId )`
`public`	# `addItem( Mage_Sales_Model_Order_Invoice_Item $item )`
`public static array`	# `getStates( )` Retrieve invoice states array Retrieve invoice states array Returns `array`
`public string`	# `getStateName( integer $stateId = null )` Retrieve invoice state name by state identifier Retrieve invoice state name by state identifier Parameters `$stateId` `integer` $stateId Returns `string`
`public unknown`	# `register( )` Register invoice Register invoice Apply to order, order items etc. Returns `unknown`
`public boolean`	# `isLast( )` Checking if the invoice is last Checking if the invoice is last Returns `boolean`
`public Mage_Sales_Model_Order_Invoice`	# `addComment( boolean $comment, boolean $notify = false, mixed $visibleOnFront = false )` Adds comment to invoice with additional possibility to send it to customer via email and show it in customer account Adds comment to invoice with additional possibility to send it to customer via email and show it in customer account Parameters `$comment` `boolean` $notify `$notify` `boolean` $visibleOnFront `$visibleOnFront` Returns `Mage_Sales_Model_Order_Invoice`
`public`	# `getCommentsCollection( mixed $reload = false )`
`public Mage_Sales_Model_Order_Invoice`	# `sendEmail( boolean $notifyCustomer = true, string $comment = '' )` Send email with invoice data Send email with invoice data Parameters `$notifyCustomer` `boolean` $notifyCustomer `$comment` `string` $comment Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order_Invoice`	# `sendUpdateEmail( boolean $notifyCustomer = true, string $comment = '' )` Send email with invoice update information Send email with invoice update information Parameters `$notifyCustomer` `boolean` $notifyCustomer `$comment` `string` $comment Returns `Mage_Sales_Model_Order_Invoice`
`protected`	# `_getEmails( mixed $configPath )`
`protected Mage_Core_Model_Abstract`	# `_beforeDelete( )` Processing object before delete data Processing object before delete data Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::_beforeDelete()`
`public Mage_Sales_Model_Order_Invoice`	# `reset( )` Reset invoice object Reset invoice object Returns `Mage_Sales_Model_Order_Invoice`
`protected Mage_Sales_Model_Order_Shipment`	# `_beforeSave( )` Before object save manipulations Before object save manipulations Returns `Mage_Sales_Model_Order_Shipment` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`protected Mage_Sales_Model_Order_Shipment`	# `_afterSave( )` After object save manipulation After object save manipulation Returns `Mage_Sales_Model_Order_Shipment` Overrides `Mage_Sales_Model_Abstract::_afterSave()`

Methods inherited from Mage_Sales_Model_Abstract
`getCreatedAtDate(), getCreatedAtStoreDate()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()`

Constants summary
`integer`	`STATE_OPEN`	`1`	# Invoice states Invoice states
`integer`	`STATE_PAID`	`2`	#
`integer`	`STATE_CANCELED`	`3`	#
`string`	`CAPTURE_ONLINE`	`'online'`	#
`string`	`CAPTURE_OFFLINE`	`'offline'`	#
`string`	`NOT_CAPTURE`	`'not_capture'`	#
`string`	`XML_PATH_EMAIL_TEMPLATE`	`'sales_email/invoice/template'`	#
`string`	`XML_PATH_EMAIL_GUEST_TEMPLATE`	`'sales_email/invoice/guest_template'`	#
`string`	`XML_PATH_EMAIL_IDENTITY`	`'sales_email/invoice/identity'`	#
`string`	`XML_PATH_EMAIL_COPY_TO`	`'sales_email/invoice/copy_to'`	#
`string`	`XML_PATH_EMAIL_COPY_METHOD`	`'sales_email/invoice/copy_method'`	#
`string`	`XML_PATH_EMAIL_ENABLED`	`'sales_email/invoice/enabled'`	#
`string`	`XML_PATH_UPDATE_EMAIL_TEMPLATE`	`'sales_email/invoice_comment/template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE`	`'sales_email/invoice_comment/guest_template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_IDENTITY`	`'sales_email/invoice_comment/identity'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_TO`	`'sales_email/invoice_comment/copy_to'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_METHOD`	`'sales_email/invoice_comment/copy_method'`	#
`string`	`XML_PATH_UPDATE_EMAIL_ENABLED`	`'sales_email/invoice_comment/enabled'`	#
`string`	`REPORT_DATE_TYPE_ORDER_CREATED`	`'order_created'`	#
`string`	`REPORT_DATE_TYPE_INVOICE_CREATED`	`'invoice_created'`	#
`string`	`HISTORY_ENTITY_NAME`	`'invoice'`	#

Properties summary
`protected static mixed`	`$_states`		#
`protected mixed`	`$_items`		#
`protected mixed`	`$_comments`		#
`protected mixed`	`$_order`		#
`protected array`	`$_rounders`	`array()`	# Calculator instances for delta rounding of prices Calculator instances for delta rounding of prices
`protected boolean`	`$_saveBeforeDestruct`	`false`	#
`protected string`	`$_eventPrefix`	`'sales_order_invoice'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'invoice'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case
`protected boolean`	`$_wasPayCalled`	`false`	# Whether the pay() was called Whether the pay() was called

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Invoice

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Returns

Returns

Overrides

Returns

Overrides