Merge pull request #328 from ej2/0.9.5

0.9.5

Author: ej2

CHANGELOG.rst

@@ -1,5 +1,11 @@
 Changelog
 =========
+* 0.9.5 (November 1, 2023)
+    * Added the ability to void all voidable QB types
+    * Added to_ref to CreditMemo object
+    * Added ProjectRef and ShipFromAddr to Estimate
+    * Added missing initialization for objects on DiscountLineDetail, Estimate, Employee, and Invoice
+
 * 0.9.4 (August 29, 2023)
     * Removed python 2 compatible decorators
     * Removed python 2 dependencies

Pipfile

@@ -15,6 +15,3 @@ simplejson = ">=3.19.1"
 nose = "*"
 coverage = "*"
 twine = "*"
-
-[requires]
-python_version = "3.8"

Pipfile.lock

@@ -119,21 +119,66 @@ def send(self, qb=None, send_to=None):
 
 
 class VoidMixin(object):
+
+    def get_void_params(self):
+        qb_object_params_map = {
+            "Payment": {
+                "operation": "update",
+                "include": "void"
+            },
+            "SalesReceipt": {
+                "operation": "update",
+                "include": "void"
+            },
+            "BillPayment": {
+                "operation": "update",
+                "include": "void"
+            },
+            "Invoice": {
+                "operation": "void",
+            },
+        }
+        # setting the default operation to void (the original behavior)
+        return qb_object_params_map.get(self.qbo_object_name, {"operation": "void"})
+
+    def get_void_data(self):
+        qb_object_params_map = {
+            "Payment": {
+                "Id": self.Id,
+                "SyncToken": self.SyncToken,
+                "sparse": True
+            },
+            "SalesReceipt": {
+                "Id": self.Id,
+                "SyncToken": self.SyncToken,
+                "sparse": True
+            },
+            "BillPayment": {
+                "Id": self.Id,
+                "SyncToken": self.SyncToken,
+                "sparse": True
+            },
+            "Invoice": {
+                "Id": self.Id,
+                "SyncToken": self.SyncToken,
+            },
+        }
+        # setting the default operation to void (the original behavior)
+        return qb_object_params_map.get(self.qbo_object_name, {"operation": "void"})
+
     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'})
+
+        data = self.get_void_data()
+        params = self.get_void_params()
+        results = qb.post(url, json.dumps(data), params=params)
 
         return results
 

quickbooks/mixins.py

@@ -58,7 +58,7 @@ def save(self, qb=None):
         else:
             json_data = qb.create_object(self.qbo_object_name, self.to_json(), _file_path=self._FilePath)
 
-        if self.FileName:
+        if self.Id is None and self.FileName:
             obj = type(self).from_json(json_data['AttachableResponse'][0]['Attachable'])
         else:
             obj = type(self).from_json(json_data['Attachable'])

quickbooks/objects/attachable.py

@@ -1,6 +1,6 @@
 from .base import QuickbooksBaseObject, Ref, LinkedTxn, QuickbooksManagedObject, LinkedTxnMixin, \
     QuickbooksTransactionEntity
-from ..mixins import DeleteMixin
+from ..mixins import DeleteMixin, VoidMixin
 
 
 class CheckPayment(QuickbooksBaseObject):
@@ -47,7 +47,7 @@ def __str__(self):
         return str(self.Amount)
 
 
-class BillPayment(DeleteMixin, QuickbooksManagedObject, QuickbooksTransactionEntity, LinkedTxnMixin):
+class BillPayment(DeleteMixin, QuickbooksManagedObject, QuickbooksTransactionEntity, LinkedTxnMixin, VoidMixin):
     """
     QBO definition: A BillPayment entity represents the financial transaction of payment
     of bills that the business owner receives from a vendor for goods or services purchased

quickbooks/objects/billpayment.py

@@ -70,3 +70,11 @@ def __init__(self):
 
     def __str__(self):
         return str(self.TotalAmt)
+
+    def to_ref(self):
+        ref = Ref()
+
+        ref.type = self.qbo_object_name
+        ref.value = self.Id
+
+        return ref

quickbooks/objects/creditmemo.py

@@ -51,6 +51,7 @@ def __init__(self):
         self.Discount = None
         self.ClassRef = None
         self.TaxCodeRef = None
+        self.DiscountAccountRef = None
         self.PercentBased = False
         self.DiscountPercent = 0
 

quickbooks/objects/detailline.py

@@ -35,6 +35,7 @@ def __init__(self):
         self.BillableTime = False
 
         self.PrimaryAddr = None
+        self.PrimaryPhone = None
 
     def __str__(self):
         return self.DisplayName

quickbooks/objects/employee.py

@@ -19,7 +19,9 @@ class Estimate(DeleteMixin,
     class_dict = {
         "BillAddr": Address,
         "ShipAddr": Address,
+        "ShipFromAddr": Address,
         "CustomerRef": Ref,
+        "ProjectRef": Ref,
         "TxnTaxDetail": TxnTaxDetail,
         "CustomerMemo": CustomerMemo,
         "BillEmail": EmailAddress,
@@ -64,9 +66,12 @@ def __init__(self):
         self.AcceptedDate = None
         self.GlobalTaxCalculation = "TaxExcluded"
         self.BillAddr = None
+        self.DepartmentRef = None
         self.ShipAddr = None
+        self.ShipFromAddr = None
         self.BillEmail = None
         self.CustomerRef = None
+        self.ProjectRef = None
         self.TxnTaxDetail = None
         self.CustomerMemo = None
         self.ClassRef = None