Inheritance diagram for CreditmemoManagementInterface:
Public Member Functions | |
| cancel ($id) | |
| getCommentsList ($id) | |
| notify ($id) | |
| refund (\Magento\Sales\Api\Data\CreditmemoInterface $creditmemo, $offlineRequested=false) | |
Detailed Description
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
Definition at line 18 of file CreditmemoManagementInterface.php.
Member Function Documentation
◆ cancel()
| cancel | ( | $id | ) |
Cancels a specified credit memo.
- Parameters
-
int $id The credit memo ID.
- Returns
- bool
- Exceptions
-
Implemented in CreditmemoService.
◆ getCommentsList()
| getCommentsList | ( | $id | ) |
Lists comments for a specified credit memo.
- Parameters
-
int $id The credit memo ID.
- Returns
- \Magento\Sales\Api\Data\CreditmemoCommentSearchResultInterface Credit memo comment search results interface.
Implemented in CreditmemoService.
◆ notify()
| notify | ( | $id | ) |
Emails a user a specified credit memo.
- Parameters
-
int $id The credit memo ID.
- Returns
- bool
Implemented in CreditmemoService.
◆ refund()
| refund | ( | \Magento\Sales\Api\Data\CreditmemoInterface | $creditmemo, |
$offlineRequested = false |
|||
| ) |
Prepare creditmemo to refund and save it.
- Parameters
-
\Magento\Sales\Api\Data\CreditmemoInterface $creditmemo bool $offlineRequested
- Returns
- \Magento\Sales\Api\Data\CreditmemoInterface
Implemented in CreditmemoService.
The documentation for this interface was generated from the following file:
- vendor/magento/module-sales/Api/CreditmemoManagementInterface.php