- Introduction
-
Catalog
-
Catalog Category
- catalog_category.assignedProducts
- catalog_category.assignProduct
- catalog_category.create
- catalog_category.currentStore
- catalog_category.delete
- catalog_category.info
- catalog_category.level
- catalog_category.move
- catalog_category.removeProduct
- catalog_category.tree
- catalog_category.update
- catalog_category.updateProduct
- Catalog Category Attributes
- Catalog Product
- Catalog Product Attribute
-
Catalog Product Attribute
Media - Catalog Product Attribute Set
-
Catalog Product Custom
Option - Catalog Product Custom Option Value
- Catalog Product Downloadable Link
- Catalog Product Link
- Catalog Product Tag
- Catalog Product Tier Price
- Catalog Product Types
-
Catalog Category
- Catalog Inventory
- Checkout
- Create Your Own API
- Customer
- Directory
- Sales
- Enterprise Customer Balance
- Enterprise Gift Card
- Enterprise Gift Message
- Miscellaneous
- WS-I Compliance
Module: Mage_Sales
Resource: sales_order_invoice
Aliases:
- order_invoice
Method:
- sales_order_invoice.cancel (SOAP V1)
- salesOrderInvoiceCancel (SOAP V2)
Allows you to cancel the required invoice. 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).
Aliases:
- order_invoice.cancel
Arguments:
| Type | Name | Description |
|---|---|---|
| string | sessionId |
Session ID |
| string | invoiceIncrementId |
Invoice increment ID |
Returns:
| Type | Description |
|---|---|
| boolean | True if the order invoice is canceled. |
Examples
Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$invoiceIncrementId = '100000013';
$result = $proxy->call(
$session,
'sales_order_invoice.cancel',
$invoiceIncrementId
);