Inheritance diagram for InvoiceManagementInterface:
Public Member Functions | |
| setCapture ($id) | |
| getCommentsList ($id) | |
| notify ($id) | |
| setVoid ($id) | |
Detailed Description
Invoice management interface.
An invoice is a record of the receipt of payment for an order. @api
- Since
- 100.0.2
Definition at line 15 of file InvoiceManagementInterface.php.
Member Function Documentation
◆ getCommentsList()
| getCommentsList | ( | $id | ) |
Lists comments for a specified invoice.
- Parameters
-
int $id The invoice ID.
- Returns
- \Magento\Sales\Api\Data\InvoiceCommentSearchResultInterface Invoice comment search result interface.
Implemented in InvoiceService.
◆ notify()
| notify | ( | $id | ) |
Emails a user a specified invoice.
- Parameters
-
int $id The invoice ID.
- Returns
- bool
Implemented in InvoiceService.
◆ setCapture()
| setCapture | ( | $id | ) |
◆ setVoid()
| setVoid | ( | $id | ) |
Voids a specified invoice.
- Parameters
-
int $id The invoice ID.
- Returns
- bool
Implemented in InvoiceService.
The documentation for this interface was generated from the following file:
- vendor/magento/module-sales/Api/InvoiceManagementInterface.php