Merge pull request routablehq#132 from bendavis78/void-invoice

ej2 · web-flow · commit 6496f343b7c2 · 2019-06-25T10:44:00.000-05:00
Added support for voiding invoices
diff --git a/README.rst b/README.rst
@@ -426,6 +426,16 @@ Attaching a file to customer:
     attachment.ContentType = 'application/pdf'
     attachment.save(qb=client)
 
+Other operations
+----------------
+Void an invoice:
+
+.. code-block:: python
+
+   invoice = Invoice()
+   invoice.Id = 7
+   invoice.void(qb=client)
+
 Working with JSON data
 ----------------
 All objects include ``to_json`` and ``from_json`` methods.
diff --git a/quickbooks/mixins.py b/quickbooks/mixins.py
@@ -114,6 +114,26 @@ def send(self, qb=None, send_to=None):
         return results
 
 
+class VoidMixin(object):
+    def void(self, qb=None):
+        if not qb:
+            qb = QuickBooks()
+
+        if not self.Id:
+            raise QuickbooksException('Cannot void unsaved object')
+
+        data = {
+            'Id': self.Id,
+            'SyncToken': self.SyncToken,
+        }
+
+        endpoint = self.qbo_object_name.lower()
+        url = "{0}/company/{1}/{2}".format(qb.api_url, qb.company_id, endpoint)
+        results = qb.post(url, json.dumps(data), params={'operation': 'void'})
+
+        return results
+
+
 class UpdateMixin(object):
     qbo_object_name = ""
 
diff --git a/quickbooks/objects/invoice.py b/quickbooks/objects/invoice.py
@@ -3,7 +3,7 @@
     QuickbooksTransactionEntity, LinkedTxn, LinkedTxnMixin
 from .tax import TxnTaxDetail
 from .detailline import DetailLine, SalesItemLine, SubtotalLine, DiscountLine, GroupLine, DescriptionOnlyLine
-from ..mixins import QuickbooksPdfDownloadable, DeleteMixin, SendMixin
+from ..mixins import QuickbooksPdfDownloadable, DeleteMixin, SendMixin, VoidMixin
 
 
 class DeliveryInfo(QuickbooksBaseObject):
@@ -15,7 +15,7 @@ def __init__(self):
 
 @python_2_unicode_compatible
 class Invoice(DeleteMixin, QuickbooksPdfDownloadable, QuickbooksManagedObject, QuickbooksTransactionEntity,
-              LinkedTxnMixin, SendMixin):
+              LinkedTxnMixin, SendMixin, VoidMixin):
     """
     QBO definition: An Invoice represents a sales form where the customer pays for a product or service later.
 
diff --git a/tests/unit/test_mixins.py b/tests/unit/test_mixins.py
@@ -425,3 +425,29 @@ def test_send_with_send_to_email(self, mock_misc_op):
         invoice.send(qb=self.qb_client, send_to="test@email.com")
 
         mock_misc_op.assert_called_with("invoice/2/send?sendTo=test@email.com", None, 'application/octet-stream')
+
+
+class VoidMixinTest(unittest.TestCase):
+    def setUp(self):
+        self.qb_client = client.QuickBooks(
+            sandbox=True,
+            consumer_key="update_consumer_key",
+            consumer_secret="update_consumer_secret",
+            access_token="update_access_token",
+            access_token_secret="update_access_token_secret",
+            company_id="update_company_id",
+            callback_url="update_callback_url"
+        )
+
+    @patch('quickbooks.mixins.QuickBooks.post')
+    def test_void(self, post):
+        invoice = Invoice()
+        invoice.Id = 2
+        invoice.void(qb=self.qb_client)
+        self.assertTrue(post.called)
+
+    def test_delete_unsaved_exception(self):
+        from quickbooks.exceptions import QuickbooksException
+
+        invoice = Invoice()
+        self.assertRaises(QuickbooksException, invoice.void, qb=self.qb_client)
