How to Get Invoice Comments List Programmatically in Magento 2

Hello Magento Friends,

In this blog post, we will explore how to retrieve the invoice comments list in Magento 2 programmatically.

In Magento 2, managing invoices is essential to running an e-commerce store. Invoice comments are crucial in documenting important information and interactions related to an invoice. You can automate processes, generate reports, or integrate with external systems by retrieving invoice comments programmatically.

To programmatically retrieve the comments list for an invoice in Magento 2, you can follow these steps:

Steps to Get Invoice Comments List Programmatically in Magento 2:

Step 1: First, create an Invoicecomments.php file inside the Model folder.

app\code\Vendor\Extension\Model

Now, add the code as follows

<?php
namespace Vendor\Extension\Model;

use Magento\Sales\Api\InvoiceManagementInterface;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Sales\Api\Data\InvoiceCommentSearchResultInterface;
class Invoicecomments
{
    private $invoice;
    public function __construct(
        InvoiceManagementInterface $invoice
    ) {
        $this->invoice = $invoice;
    }
    
    public function getInvoiceComments($invoiceId): ?InvoiceCommentSearchResultInterface
    {
           $invoiceComments = null;
        try {
            $invoiceComments = $this->invoice->getCommentsList($invoiceId);
        } catch (NoSuchEntityException $exception) {
            throw new Exception($exception->getMessage());
        }
        return $invoiceComments;
    }
}

Step 2: Call the method with a required parameter in the second step.

$invoiceId = 1; // Invoice id
$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$invoicecommentObj = $objectManager->create('Vendor\Extension\Model\Invoicecomments')
$invoiceComments = $invoicecommentObj->getInvoiceComments($invoiceId);
if ($invoiceComments->getTotalCount())
{
       foreach($invoiceComment as $comment)
       {
            echo "<pre>";
            print_r($comment);
       }
}

Conclusion:

After completing the above steps, you should be able to programmatically retrieve the comments list for an invoice in Magento 2. You can also Show Order Comments on the Invoice in Magento 2.

If you need any help about retrieving the Invoice Comments List Programmatically in Magento 2, let me know through the comment box. I will be happy to help you.

Share the solution with your friends, and stay in touch with us for more Magento 2 informative guides.

Happy Coding!