Invoice Cancel

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:

Returns:

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
);