InvoiceManagementInterface.php 1019 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Sales\Api;
  7. /**
  8. * Invoice management interface.
  9. *
  10. * An invoice is a record of the receipt of payment for an order.
  11. * @api
  12. * @since 100.0.2
  13. */
  14. interface InvoiceManagementInterface
  15. {
  16. /**
  17. * Sets invoice capture.
  18. *
  19. * @param int $id
  20. * @return string
  21. */
  22. public function setCapture($id);
  23. /**
  24. * Lists comments for a specified invoice.
  25. *
  26. * @param int $id The invoice ID.
  27. * @return \Magento\Sales\Api\Data\InvoiceCommentSearchResultInterface Invoice comment search result interface.
  28. */
  29. public function getCommentsList($id);
  30. /**
  31. * Emails a user a specified invoice.
  32. *
  33. * @param int $id The invoice ID.
  34. * @return bool
  35. */
  36. public function notify($id);
  37. /**
  38. * Voids a specified invoice.
  39. *
  40. * @param int $id The invoice ID.
  41. * @return bool
  42. */
  43. public function setVoid($id);
  44. }