Class Mage_Sales_Model_Order_Invoice_Api

Description
Description | Descendents | Vars | Methods (details)

Invoice API

Located in /Sales/Model/Order/Invoice/Api.php (line 34) 

Mage_Api_Model_Resource_Abstract
   |
   --Mage_Sales_Model_Api_Resource
      |
      --Mage_Sales_Model_Order_Invoice_Api
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
Mage_Sales_Model_Order_Invoice_Api_V2 Invoice API V2
Method Summary
Description | Descendents | Vars | Methods (details)
Mage_Sales_Model_Order_Invoice_Api __construct ()
boolean addComment (string $invoiceIncrementId, string $comment, [boolean $email = false], [boolean $includeComment = false])
boolean cancel (string $invoiceIncrementId)
boolean capture (string $invoiceIncrementId)
string create (string $orderIncrementId, array $itemsQty, [string $comment = null], [booleam $email = false], [boolean $includeComment = false])
array info (string $invoiceIncrementId)
array items ([array $filters = null])
unknown void (unknown_type $invoiceIncrementId)
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from Mage_Sales_Model_Api_Resource

Mage_Sales_Model_Api_Resource::$_attributesMap
 Mage_Sales_Model_Api_Resource::$_ignoredAttributeCodes

Inherited from Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::$_resourceConfig
Methods
Description | Descendents | Vars Methods (details)
Constructor __construct (line 36)
  • access: public
Mage_Sales_Model_Order_Invoice_Api __construct ()
addComment (line 193)

Add comment to invoice

  • access: public
boolean addComment (string $invoiceIncrementId, string $comment, [boolean $email = false], [boolean $includeComment = false])
  • string $invoiceIncrementId
  • string $comment
  • boolean $email
  • boolean $includeComment
cancel (line 293)

Cancel invoice

  • access: public
boolean cancel (string $invoiceIncrementId)
  • string $invoiceIncrementId
capture (line 221)

Capture invoice

  • access: public
boolean capture (string $invoiceIncrementId)
  • string $invoiceIncrementId
create (line 137)

Create new invoice for order

  • access: public
string create (string $orderIncrementId, array $itemsQty, [string $comment = null], [booleam $email = false], [boolean $includeComment = false])
  • string $orderIncrementId
  • array $itemsQty
  • string $comment
  • booleam $email
  • boolean $includeComment
Redefined in descendants as:
info (line 101)

Retrieve invoice information

  • access: public
array info (string $invoiceIncrementId)
  • string $invoiceIncrementId
items (line 57)

Retrive invoices by filters

  • access: public
array items ([array $filters = null])
  • array $filters
Redefined in descendants as:
void (line 257)

Void invoice

  • access: public
unknown void (unknown_type $invoiceIncrementId)
  • unknown_type $invoiceIncrementId

Inherited Methods

Inherited From Mage_Sales_Model_Api_Resource

Mage_Sales_Model_Api_Resource::_getAttributes()
Mage_Sales_Model_Api_Resource::_isAllowedAttribute()
Mage_Sales_Model_Api_Resource::_updateAttributes()

Inherited From Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::getResourceConfig()
Mage_Api_Model_Resource_Abstract::setResourceConfig()
Mage_Api_Model_Resource_Abstract::_fault()
Mage_Api_Model_Resource_Abstract::_getConfig()
Mage_Api_Model_Resource_Abstract::_getServer()
Mage_Api_Model_Resource_Abstract::_getSession()

Documentation generated on Fri, 11 Feb 2011 16:56:37 +0200 by phpDocumentor 1.4.3