Invoice API
This is an old revision of the document!
Table of Contents
Allows create/export order invoices
Module: Mage_Sales
Resource: sales_order_invoice
Aliases:
- order_invoice
Methods |
sales_order_invoice.list |
Retrieve list of invoices by filters
Return: array Arguments:
- array filters - filters for invoices list (optional)
Aliases:
- order_invoice.list
sales_order_invoice.info |
Retrieve invoice information
Return: array
Arguments:
- string invoiceIncrementId - invoice increment id
Aliases:
- order_invoice.info
sales_order_invoice.create |
Create new invoice for order
Return: string
Arguments:
- string orderIncrementId - order increment id
- array itemsQty - items qty to invoice
- string comment - invoice comment (optional)
- boolean email - send invoice on e-mail (optional)
- boolean includeComment - include comments in e-mail (optional)
Aliases:
- order_invoice.create
sales_order_invoice.addComment |
Add new comment to shipment
Arguments:
- string invoiceIncrementId - invoice increment id
- string comment - invoice comment
- boolean email - send invoice on e-mail (optional)
- boolean includeComment - include comments in e-mail (optional)
Aliases:
- order_invoice.addComment
sales_order_invoice.capture |
Capture invoice
Return: boolean
Arguments:
- string invoiceIncrementId - invoice increment id
Aliases:
- order_invoice.capture
sales_order_invoice.void |
Void invoice
Return: boolean
Arguments:
- string invoiceIncrementId - invoice increment id
Aliases:
- order_invoice.void
sales_order_invoice.cancel |
Cancel invoice
Return: boolean
Arguments:
- string invoiceIncrementId - invoice increment id
Aliases:
- order_invoice.cancel
Faults |
| Fault Code | Fault Message |
|---|---|
| 100 | Requested shipment does not exists. |
| 101 | Invalid filters given. Details in error message. |
| 102 | Invalid data given. Details in error message. |
| 103 | Requested order does not exists |
| 104 | Invoice status not changed. |
Examples |
Example 1. Basic working with invoices. |
- $proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
- $sessionId = $proxy->login('apiUser', 'apiKey');
- $notInvoicedOrderId = '100000003';
- // Create new invoice
- $newInvoiceId = $proxy->call($sessionId, 'sales_order_invoice.create', array($notInvoicedOrderId, array(), 'Invoice Created', true, true));
- // View new invoice
- $invoice = $proxy->call($sessionId, 'sales_order_invoice.info', $newInvoiceId);
- var_dump($invoice);
- // Add Comment
- $proxy->call($sessionId, 'sales_order_invoice.addComment', array($newInvoiceId, 'Invoice comment, some text', true, false));
- // View invoice with new comment
- $invoice = $proxy->call($sessionId, 'sales_order_invoice.info', $newInvoiceId);
- var_dump($invoice);
- $proxy->call($sessionId, 'sales_order_invoice.capture', $newInvoiceId);
- // View captured invoice
- $invoice = $proxy->call($sessionId, 'sales_order_invoice.info', $newInvoiceId);
- var_dump($invoice);
