Class Mage_Sales_Model_Order_Invoice_Api

Invoice API

Mage_Sales_Model_Order_Invoice_Api

Direct known subclasses

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/Api.php

Methods summary
`public`	# `__construct( )` Initialize attributes map Initialize attributes map
`public array`	# `items( null\|object\|array $filters = null )` Retrive invoices list. Filtration could be applied Retrive invoices list. Filtration could be applied Parameters `$filters` `null\|object\|array` $filters Returns `array`
`public array`	# `info( string $invoiceIncrementId )` Retrieve invoice information Retrieve invoice information Parameters `$invoiceIncrementId` `string` $invoiceIncrementId Returns `array`
`public string`	# `create( string $orderIncrementId, array $itemsQty, string $comment = null, booleam $email = false, boolean $includeComment = false )` Create new invoice for order Create new invoice for order Parameters `$orderIncrementId` `string` $orderIncrementId `$itemsQty` `array` $itemsQty `$comment` `string` $comment `$email` `booleam` $email `$includeComment` `boolean` $includeComment Returns `string`
`public boolean`	# `addComment( string $invoiceIncrementId, string $comment, boolean $email = false, boolean $includeComment = false )` Add comment to invoice Add comment to invoice Parameters `$invoiceIncrementId` `string` $invoiceIncrementId `$comment` `string` $comment `$email` `boolean` $email `$includeComment` `boolean` $includeComment Returns `boolean`
`public boolean`	# `capture( string $invoiceIncrementId )` Capture invoice Capture invoice Parameters `$invoiceIncrementId` `string` $invoiceIncrementId Returns `boolean`
`public unknown`	# `void( unknown_type $invoiceIncrementId )` Void invoice Void invoice Parameters `$invoiceIncrementId` `unknown_type` $invoiceIncrementId Returns `unknown`
`public boolean`	# `cancel( string $invoiceIncrementId )` Cancel invoice Cancel invoice Parameters `$invoiceIncrementId` `string` $invoiceIncrementId Returns `boolean`

Methods inherited from Mage_Sales_Model_Api_Resource
`_getAttributes(), _isAllowedAttribute(), _updateAttributes()`

Methods inherited from Mage_Api_Model_Resource_Abstract
`_fault(), _getConfig(), _getServer(), _getSession(), getResourceConfig(), setResourceConfig()`

Properties inherited from Mage_Sales_Model_Api_Resource
`$_attributesMap, $_ignoredAttributeCodes`

Properties inherited from Mage_Api_Model_Resource_Abstract
`$_resourceConfig`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Invoice_Api

Direct known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns