sales_order_invoice.md

Sales Order Invoice

addComment

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

magento.salesOrderInvoice.addComment({
  invoiceIncrementId: val,
  comment:            val,  /* optional */
  email:              val,  /* optional */
  includeComment:     val   /* optional */
}, callback);

cancel

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

magento.salesOrderInvoice.cancel({
  invoiceIncrementId: val
}, callback);

capture

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

magento.salesOrderInvoice.capture({
  invoiceIncrementId: val
}, callback);

create

Allows you to create a new invoice for an order.

magento.salesOrderInvoice.create({
  orderIncrementId: val,
  itemsQty:         val,
  comment:          val,  /* optional */
  email:            val,  /* optional */
  includeComment:   val   /* optional */
}, callback);

info

Allows you to retrieve information about the required invoice.

magento.salesOrderInvoice.info({
  invoiceIncrementId: val
}, callback);

list

Allows you to retrieve the list of order invoices. Additional filters can also be applied.

magento.salesOrderInvoice.list(callback);

// or 

magento.salesOrderInvoice.list({
  filters: [ val, val, val ]
}, callback);

// or a single filter

magento.salesOrderInvoice.list({
  filters: val
}, callback);