PHP Class Smalot\Magento\Order\OrderInvoice

Inheritance: extends Smalot\Magento\MagentoModuleAbstract

Show file Open project: smalot/magento-client

Public Methods

Method	Description
addComment ( string $invoiceIncrementId, string $comment = null, integer $email = null, integer $includeComment = null ) : Smalot\Magento\ActionInterface	Allows you to add a new comment to the order invoice.
cancel ( string $invoiceIncrementId ) : Smalot\Magento\ActionInterface	Allows you to cancel the required invoice.
capture ( string $invoiceIncrementId ) : Smalot\Magento\ActionInterface	Allows you to capture the required invoice.
create ( string $orderIncrementId, array $itemsQty, string $comment, string $email, string $includeComment ) : Smalot\Magento\ActionInterface	Allows you to create a new invoice for an order.
getInfo ( string $invoiceIncrementId ) : Smalot\Magento\ActionInterface
getList ( array $filters = null ) : Smalot\Magento\ActionInterface

Method Details

addComment() public method

Allows you to add a new comment to the order invoice.

public addComment ( string $invoiceIncrementId, string $comment = null, integer $email = null, integer $includeComment = null ) : Smalot\Magento\ActionInterface
$invoiceIncrementId	string
$comment	string
$email	integer
$includeComment	integer
return	Smalot\Magento\ActionInterface

cancel() public method

Note that not all order invoices can be canceled. Only some payment methods support canceling the order invoice (e.g., Google Checkout, PayPal Pro, PayPal Express Checkout).

public cancel ( string $invoiceIncrementId ) : Smalot\Magento\ActionInterface
$invoiceIncrementId	string
return	Smalot\Magento\ActionInterface

capture() public method

Note that not all order invoices can be captured. Only some payment methods support capturing the order invoice (e.g., PayPal Pro).

public capture ( string $invoiceIncrementId ) : Smalot\Magento\ActionInterface
$invoiceIncrementId	string
return	Smalot\Magento\ActionInterface

create() public method

Allows you to create a new invoice for an order.

public create ( string $orderIncrementId, array $itemsQty, string $comment, string $email, string $includeComment ) : Smalot\Magento\ActionInterface
$orderIncrementId	string
$itemsQty	array
$comment	string
$email	string
$includeComment	string
return	Smalot\Magento\ActionInterface

getInfo() public method

public getInfo ( string $invoiceIncrementId ) : Smalot\Magento\ActionInterface
$invoiceIncrementId	string
return	Smalot\Magento\ActionInterface

getList() public method

public getList ( array $filters = null ) : Smalot\Magento\ActionInterface
$filters	array
return	Smalot\Magento\ActionInterface