sales_order_credit_memo.md

Sales Order Credit Memo

addComment

Allows you to add a new comment to an existing credit memo. Email notification can be sent to the user email.

magento.salesOrderCreditMemo.addComment({
  creditmemoIncrementId:  val,
  comment:                val,  /* optional */
  notifyCustomer:         val,  /* optional */
  includeComment:         val   /* optional */
}, callback);

cancel

Allows you to cancel an existing credit memo.

magento.salesOrderCreditMemo.cancel({
  creditmemoIncrementId: val
}, callback);

create

Allows you to create a new credit memo for the invoiced order.

Comments can be added and an email notification can be sent to the user email.

magento.salesOrderCreditMemo.create({
  orderIncrementId:           val,
  creditmemoData:             val,  /* optional */
  comment:                    val,  /* optional */
  notifyCustomer:             val,  /* optional */
  includeComment:             val,  /* optional */
  refundToStoreCreditAmount:  val   /* optional */
}, callback);

info

Allows you to retrieve full information about the specified credit memo.

magento.salesOrderCreditMemo.info({
  creditmemoIncrementId: val
}, callback);

list

Allows you to retrieve the list of orders. Additional filters can be applied.

magento.salesOrderCreditMemo.list(callback);

// or 

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

// or a single filter

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