Create cancel method on API

Author: crissanclick

app/code/Magento/Sales/Api/InvoiceCancelInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Sales\Api;
+
+/**
+ * Interface InvoiceCancelInterface
+ *
+ * @package Magento\Sales\Api
+ */
+interface InvoiceCancelInterface
+{
+
+    /**
+     * Cancel invoice
+     *
+     * @param int $invoiceId
+     * @return bool
+     */
+    public function cancel($invoiceId);
+}

app/code/Magento/Sales/Model/Order/InvoiceCancel.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Sales\Model\Order;
+
+use Magento\Sales\Api\InvoiceCancelInterface;
+use Magento\Sales\Api\InvoiceRepositoryInterface;
+
+/**
+ * Class InvoiceCancel
+ */
+class InvoiceCancel implements InvoiceCancelInterface
+{
+
+    /**
+     * @var InvoiceRepositoryInterface
+     */
+    protected $invoiceRepository;
+
+    /**
+     * InvoiceCancel constructor.
+     * @param InvoiceRepositoryInterface $invoiceRepository
+     */
+    public function __construct(
+        InvoiceRepositoryInterface $invoiceRepository
+    ) {
+        $this->invoiceRepository = $invoiceRepository;
+    }
+
+    /**
+     * Cancel invoice
+     *
+     * @param int $invoiceId
+     * @return bool
+     */
+    public function cancel($invoiceId)
+    {
+        /** @var \Magento\Sales\Api\Data\InvoiceInterface $invoice */
+        $invoice = $this->invoiceRepository->get($invoiceId);
+        if ($invoice && $invoice->canCancel()) {
+            $invoice->cancel();
+            $this->invoiceRepository->save($invoice);
+            return true;
+        }
+
+        return false;
+    }
+}

app/code/Magento/Sales/Test/Unit/Model/Service/InvoiceServiceTest.php

@@ -19,6 +19,13 @@ class InvoiceServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected $repositoryMock;
 
+    /**
+     * Invoice Cancel
+     *
+     * @var \Magento\Sales\Api\InvoiceCancelInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $invoiceCancelMock;
+
     /**
      * Repository
      *
@@ -52,6 +59,11 @@ class InvoiceServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected $invoiceService;
 
+    /**
+     * @var \Magento\Sales\Model\Order\Invoice
+     */
+    protected $invoiceMock;
+
     /**
      * SetUp
      */
@@ -84,6 +96,16 @@ protected function setUp()
             ['notify']
         );
 
+        $this->invoiceCancelMock = new \Magento\Sales\Model\Order\InvoiceCancel(
+            $this->repositoryMock
+        );
+
+        $this->invoiceMock = $this->getMockBuilder(
+            \Magento\Sales\Model\Order\Invoice::class
+        )
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->invoiceService = $objectManager->getObject(
             \Magento\Sales\Model\Service\InvoiceService::class,
             [
@@ -204,4 +226,40 @@ public function testSetVoid()
 
         $this->assertTrue($this->invoiceService->setVoid($id));
     }
+
+    /**
+     * Run test for Invoice::cancel()
+     */
+    public function testCancel()
+    {
+        $this->repositoryMock->expects($this->once())
+            ->method('get')
+            ->with(123)
+            ->willReturn($this->invoiceMock);
+        $this->invoiceMock->expects($this->once())
+            ->method('cancel')
+            ->willReturn($this->invoiceMock);
+        $this->invoiceMock->expects($this->once())
+            ->method('canCancel')
+            ->willReturn(true);
+        $this->assertTrue($this->invoiceCancelMock->cancel(123));
+    }
+
+    /**
+     * test for Invoice::cancel() fail case
+     */
+    public function testCancelFailed()
+    {
+        $this->repositoryMock->expects($this->once())
+            ->method('get')
+            ->with(123)
+            ->willReturn($this->invoiceMock);
+        $this->invoiceMock->expects($this->never())
+            ->method('cancel')
+            ->willReturn($this->invoiceMock);
+        $this->invoiceMock->expects($this->once())
+            ->method('canCancel')
+            ->willReturn(false);
+        $this->assertFalse($this->invoiceCancelMock->cancel(123));
+    }
 }

app/code/Magento/Sales/etc/di.xml

@@ -56,6 +56,7 @@
     <preference for="Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface" type="Magento\Sales\Model\Order\Invoice\CreationArguments"/>
     <preference for="Magento\Sales\Api\Data\InvoiceItemCreationInterface" type="Magento\Sales\Model\Order\Invoice\ItemCreation"/>
     <preference for="Magento\Sales\Api\Data\InvoiceCommentCreationInterface" type="Magento\Sales\Model\Order\Invoice\CommentCreation"/>
+    <preference for="Magento\Sales\Api\InvoiceCancelInterface" type="Magento\Sales\Model\Order\InvoiceCancel"/>
     <preference for="Magento\Sales\Api\Data\ShipmentCommentCreationInterface" type="Magento\Sales\Model\Order\Shipment\CommentCreation"/>
     <preference for="Magento\Sales\Api\Data\CreditmemoCommentCreationInterface" type="Magento\Sales\Model\Order\Creditmemo\CommentCreation"/>
     <preference for="Magento\Sales\Api\OrderAddressRepositoryInterface" type="Magento\Sales\Model\Order\AddressRepository"/>
@@ -982,4 +983,4 @@
             </argument>
         </arguments>
     </type>
-</config>
+</config>

app/code/Magento/Sales/etc/webapi.xml

@@ -139,6 +139,12 @@
             <resource ref="Magento_Sales::sales" />
         </resources>
     </route>
+    <route url="/V1/invoice/:invoiceId/cancel" method="POST">
+        <service class="Magento\Sales\Api\InvoiceCancelInterface" method="cancel"/>
+        <resources>
+            <resource ref="Magento_Sales::sales" />
+        </resources>
+    </route>
     <route url="/V1/creditmemo/:id/comments" method="GET">
         <service class="Magento\Sales\Api\CreditmemoManagementInterface" method="getCommentsList"/>
         <resources>
@@ -277,4 +283,4 @@
             <resource ref="Magento_Sales::sales" />
         </resources>
     </route>
-</routes>
+</routes>