123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Sales\Api;
- /**
- * Credit memo add comment interface.
- *
- * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo
- * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the
- * customer account so that the customer can make future purchases.
- * @api
- * @since 100.0.2
- */
- interface CreditmemoManagementInterface
- {
- /**
- * Cancels a specified credit memo.
- *
- * @param int $id The credit memo ID.
- * @return bool
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function cancel($id);
- /**
- * Lists comments for a specified credit memo.
- *
- * @param int $id The credit memo ID.
- * @return \Magento\Sales\Api\Data\CreditmemoCommentSearchResultInterface Credit memo comment search
- * results interface.
- */
- public function getCommentsList($id);
- /**
- * Emails a user a specified credit memo.
- *
- * @param int $id The credit memo ID.
- * @return bool
- */
- public function notify($id);
- /**
- * Prepare creditmemo to refund and save it.
- *
- * @param \Magento\Sales\Api\Data\CreditmemoInterface $creditmemo
- * @param bool $offlineRequested
- * @return \Magento\Sales\Api\Data\CreditmemoInterface
- */
- public function refund(
- \Magento\Sales\Api\Data\CreditmemoInterface $creditmemo,
- $offlineRequested = false
- );
- }
|