-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
CreditmemoRepositoryInterface.php
60 lines (55 loc) · 2.16 KB
/
CreditmemoRepositoryInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<?php
/**
* Copyright © 2013-2017 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
*/
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 http://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\SearchCriteria $searchCriteria The search criteria.
* @return \Magento\Sales\Api\Data\CreditmemoSearchResultInterface Credit memo search result interface.
*/
public function getList(\Magento\Framework\Api\SearchCriteria $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);
}