12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Sales\Api;
- /**
- * Credit memo repository 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 CreditmemoRepositoryInterface
- {
- /**
- * Lists credit memos that match specified search criteria.
- *
- * This call returns an array of objects, but detailed information about each object’s attributes might not be
- * included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to
- * determine which call to use to get detailed information about all attributes for an object.
- *
- * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria The search criteria.
- * @return \Magento\Sales\Api\Data\CreditmemoSearchResultInterface Credit memo search result interface.
- */
- public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
- /**
- * Loads a specified credit memo.
- *
- * @param int $id The credit memo ID.
- * @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface.
- */
- public function get($id);
- /**
- * Create credit memo instance
- *
- * @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface.
- */
- public function create();
- /**
- * Deletes a specified credit memo.
- *
- * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo.
- * @return bool
- */
- public function delete(\Magento\Sales\Api\Data\CreditmemoInterface $entity);
- /**
- * Performs persist operations for a specified credit memo.
- *
- * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo.
- * @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface.
- */
- public function save(\Magento\Sales\Api\Data\CreditmemoInterface $entity);
- }
|