v1.0.3

.gitignore

@@ -9,3 +9,7 @@ coverage.xml
 # Ignore Scratch files
 scratch/*
 !/scratch/README.md
+
+# Ignore virtualenv
+.venv
+venv

.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

.idea/akaunting-py.iml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/venv" />
+      <excludeFolder url="file://$MODULE_DIR$/.pytest_cache" />
+      <excludeFolder url="file://$MODULE_DIR$/.venv" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PyDocumentationSettings">
+    <option name="format" value="PLAIN" />
+    <option name="myDocStringFormat" value="Plain" />
+  </component>
+</module>

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.9 (akaunting-py)" project-jdk-type="Python SDK" />
+</project>

.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/akaunting-py.iml" filepath="$PROJECT_DIR$/.idea/akaunting-py.iml" />
+    </modules>
+  </component>
+</project>

.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

akauntingpy/api.py

@@ -1,49 +1,59 @@
 import requests
-import json
 from requests.auth import HTTPBasicAuth
-from akauntingpy import exceptions, __version__
+
+from akauntingpy import exceptions
 from akauntingpy.helpers import *
 
+__version__ = "1.0.3"
+
 
 class Client(object):
     """
     Akaunting interface.
     """
+
     def __init__(
             self,
             url,
             username,
             password,
-            company_id):
+            company_id,
+            ssl_verify=True,
+            currency_code="NZD",
+            currency_rate="1.0"):
         """
         Create a new instance.
         Args:
-            url (str): The URL to the Akaunting api.
-            username (str): The username of the Akaunting credentials.
-            password (str): The password of the Akaunting credentials.
+            url (str): The URL to the Akaunting api. ** required **
+            username (str): The username of the Akaunting credentials. ** required **
+            password (str): The password of the Akaunting credentials. ** required **
+            company_id (str): The company ID from Akaunting
+            currency_code (str): The currency code.  default is NZD
+            currency_rate (str): The currency rate. default is "1.0"
         """
         self.url = url
+        self.ssl_verify = ssl_verify
         self.authentication = HTTPBasicAuth(username, password)
         self.headers = {
             'User-Agent': 'AkauntingPy v' + __version__,
         }
         self.company_id = company_id
         self.default_params = {'company_id': company_id}
+        self.currency_code = currency_code
+        self.currency_rate = currency_rate
 
     def call(self, method="get", endpoint=None,
-             **params) -> dict():
-        response = None
+             **params) -> dict:
 
         response = requests.request(method=method,
                                     url=self.url + "/" + endpoint,
                                     headers=self.headers,
                                     auth=self.authentication,
-                                    params=MergeDict(self.default_params, params)
+                                    params=MergeDict(self.default_params, params),
+                                    verify=self.ssl_verify
                                     )
 
-        print(response)
         response_ = response.json()
-        print(response_)
 
         if response.status_code == 401:
             raise exceptions.MissingPermission(response_['message'])
@@ -65,13 +75,49 @@ class Client(object):
         return data
 
     def get_accounts(self, **params):
-        data = self.call(endpoint="accounts")
+        data = self.call(endpoint="accounts", **params)
+
+        if params.get('search', False):
+            # Check if there is an account returned
+            try:
+                if data['meta']['pagination'].get('count') == 0:
+                    # No account found
+                    raise exceptions.AccountNotFound("Sorry, account not found matching search parameters: %s".format(
+                        params.get('search')
+                    ))
+            except KeyError as e:
+                # New API 3.0
+                if data['meta']['total'] == 0:
+                    raise exceptions.AccountNotFound("Sorry, account not found matching search parameters: %s".format(
+                        params.get('search')
+                    ))
+
+        return data['data']
+
+    def get_contact(self, **params):
+        data = self.call(endpoint="contacts", **params)
+        print(data)
+        if params.get('search', False):
+            try:
+                # Check if there is an account returned
+                if data['meta']['pagination'].get('count') == 0:
+                    # No account found
+                    raise exceptions.AccountNotFound("Sorry, contact not found matching search parameters: %s".format(
+                        params.get('search')
+                    ))
+            except KeyError as e:
+                # New API 3.0
+                if data['meta']['total'] == 0:
+                    raise exceptions.AccountNotFound("Sorry, contact not found matching search parameters: %s".format(
+                        params.get('search')
+                    ))
 
         return data['data']
 
     def create_transaction(self,
-                       type='income', # Payment method type
+                           transaction_type='income',  # Payment method type
                            account_id=None,  # Account ID to assign
+                           number="NULL",  # Transaction number
                            category_id=None,  # Category ID to assign
                            contact_id=None,  # Contact ID/Client to assign
                            description=None,  # Description
@@ -84,11 +130,18 @@ class Client(object):
                            **params  # Any additional parameters
                            ):
 
+        if currency_code is None:
+            # Set default value from class
+            currency_code = self.currency_code
+        if currency_rate is None:
+            # Set default value from class
+            currency_rate = self.currency_rate
 
         data = self.call(endpoint="transactions",
                          method="POST",
-                         search="type:" + type,
-                         type=type,
+                         search="type:" + transaction_type,
+                         number=number,
+                         type=transaction_type,
                          account_id=account_id,
                          category_id=category_id,
                          paid_at=paid_at,
@@ -97,8 +150,28 @@ class Client(object):
                          reference=reference,
                          currency_code=currency_code,
                          currency_rate=currency_rate,
-                         amount=amount,
+                         amount=EnsurePositiveInteger(amount),
                          description=description,
                          **params
                          )
         return data
+
+    def create_transfer(self,
+                        from_account_id=None,  # Account ID to create transfer from
+                        to_account_id=None,  # Account ID to create transfer to
+                        transferred_at=None,  # Date of expense/transfer or income
+                        payment_method="Bank Transfer",  # Payment method
+                        amount=None,  # Amount received/paid
+                        **params  # Any additional parameters
+                        ):
+
+        data = self.call(endpoint="transfers",
+                         method="POST",
+                         from_account_id=from_account_id,
+                         to_account_id=to_account_id,
+                         transferred_at=transferred_at,
+                         payment_method=payment_method,
+                         amount=EnsurePositiveInteger(amount),
+                         **params
+                         )
+        return data

akauntingpy/exceptions.py

@@ -18,3 +18,19 @@ class InvalidData(Error):
     Args:
         Error (_type_): _description_
     """
+
+class AccountNotFound(Error):
+    """
+    Account not found
+
+    Args:
+        Error (_type_): _description_
+    """
+    
+class ContactNotFound(Error):
+    """
+    Account not found
+
+    Args:
+        Error (_type_): _description_
+    """

akauntingpy/helpers.py

@@ -7,3 +7,6 @@ def RemoveFromString(items, string):
     for item in items:
         string = string.replace(item, '')
     return string
+
+def EnsurePositiveInteger(number):
+    return float(number) if float(number) > 0 else (float(number) * -1)

data/CreateTransferSuccess.json

@@ -0,0 +1,17 @@
+{
+    "data":{
+       "id":2,
+       "company_id":1,
+       "from_account":"Some Account",
+       "from_account_id":1,
+       "to_account":"Some Account New",
+       "to_account_id":2,
+       "paid_at":"2022-05-16T11:57:51+12:00",
+       "amount":100,
+       "amount_formatted":"$100.00",
+       "currency_code":"NZD",
+       "created_by":1,
+       "created_at":"2022-05-16T11:57:51+12:00",
+       "updated_at":"2022-05-16T11:57:51+12:00"
+    }
+ }

data/GetAccountsSearch.json

@@ -0,0 +1,34 @@
+{
+    "data":[
+       {
+          "id":2,
+          "company_id":1,
+          "name":"Some Account",
+          "number":"**-9011-*******-03",
+          "currency_code":"NZD",
+          "opening_balance":0,
+          "opening_balance_formatted":"$0.00",
+          "current_balance":100,
+          "current_balance_formatted":"$100.00",
+          "bank_name":"A Bank",
+          "bank_phone":"None",
+          "bank_address":"None",
+          "enabled":true,
+          "created_by":1,
+          "created_at":"2022-05-13T16:16:16+12:00",
+          "updated_at":"2022-05-13T16:16:16+12:00"
+       }
+    ],
+    "meta":{
+       "pagination":{
+          "total":1,
+          "count":1,
+          "per_page":25,
+          "current_page":1,
+          "total_pages":1,
+          "links":{
+             
+          }
+       }
+    }
+ }

data/GetAccountsSearchNotFound.json

@@ -0,0 +1,15 @@
+{
+    "data":[],
+    "meta":{
+       "pagination":{
+          "total":0,
+          "count":0,
+          "per_page":25,
+          "current_page":0,
+          "total_pages":0,
+          "links":{
+             
+          }
+       }
+    }
+ }

requirements.txt

@@ -1,2 +1,5 @@
-requests >= 2.21.0
-pytest
+requests ~= 2.27.0
+requests-mock ~= 1.9.3
+pytest ~= 7.1.2
+pytest-cov ~= 3.0
+setuptools-scm ~= 6.4.2

setup.py

@@ -20,6 +20,7 @@ setup(
     packages=find_packages(),
     install_requires=[
         'requests >= 2.21.0',
+        'setuptools-scm >= 6.4.2'
     ],
     classifiers=[
         'Programming Language :: Python :: 3',

tests/api_test.py

@@ -1,33 +1,34 @@
 import sys
-from this import d
+
 sys.path.insert(1, '.')
-import pytest
+from helpers import RetrieveJSONFromFile
 import akauntingpy
 from akauntingpy.exceptions import *
-from helpers import RetrieveJSONFromFile
+import pytest
 from requests.auth import HTTPBasicAuth
 
+
 class TestAPI:
     @pytest.fixture()
     def setUp(self):
-        c = akauntingpy.Client("https://akaunting.guise.net.nz/api",
-                              "aaron@guise.net.nz",
-                              "L3Tm31N0w",
+        c = akauntingpy.Client("https://someakaunting-url/api",
+                               "some-emailaddress@somewhere.com",
+                               "aPassWord",
                                1)
         yield c
 
     @pytest.fixture()
     def setUpFailed(self):
-        c = akauntingpy.Client("https://akaunting.guise.net.nz/api",
-                              "aaron@guise.net.nz",
-                              "L3Tm31N0w1",
+        c = akauntingpy.Client("https://someakaunting-url/api",
+                               "some-emailaddress@somewhere.com",
+                               "aWrongPassWord",
                                1)
         yield c
 
     def test_init(self, setUp):
         c = setUp
         assert isinstance(c, akauntingpy.Client)
-        assert c.url == "https://akaunting.guise.net.nz/api"
+        assert c.url == "https://someakaunting-url/api"
         assert isinstance(c.authentication, HTTPBasicAuth)
 
     def test_ping_success(self, setUp, requests_mock):
@@ -45,7 +46,6 @@ class TestAPI:
                           json=RetrieveJSONFromFile("data/pingFailure.json"),
                           status_code=401)
         with pytest.raises(MissingPermission, match="Invalid credentials."):
-            
             data = c.ping()
             assert data['status_code'] == 401
 
@@ -55,8 +55,34 @@ class TestAPI:
                           json=RetrieveJSONFromFile("data/GetAccountsList.json"))
         data = c.get_accounts(params={'page': 1, 'limit': 200})
 
+    def test_get_account_search_v2(self, setUp, requests_mock):
+        c = setUp
+        requests_mock.get(c.url + "/accounts?search=number%3A00-0000-0000000-00&params=page&params=limit&company_id=1",
+                          json=RetrieveJSONFromFile("data/v2/GetAccountsSearch.json"))
+        data = c.get_accounts(search="number:00-0000-0000000-00", params={'page': 1, 'limit': 200})
+
+    def test_get_account_search_v3(self, setUp, requests_mock):
+        c = setUp
+        requests_mock.get(c.url + "/accounts?search=number%3A00-0000-0000000-00&params=page&params=limit&company_id=1",
+                          json=RetrieveJSONFromFile("data/v3/GetAccountsSearch.json"))
+        data = c.get_accounts(search="number:00-0000-0000000-00", params={'page': 1, 'limit': 200})
+        
+    def test_get_account_search_not_found_v2(self, setUp, requests_mock):
+        c = setUp
+        requests_mock.get(c.url + "/accounts?search=number%3Aarandomvalue&company_id=1",
+                          json=RetrieveJSONFromFile("data/v2/GetAccountsSearchNotFound.json"))
+        with pytest.raises(AccountNotFound):
+            data = c.get_accounts(search="number:arandomvalue")
+
+    def test_get_account_search_not_found_v3(self, setUp, requests_mock):
+        c = setUp
+        requests_mock.get(c.url + "/accounts?search=number%3Aarandomvalue&company_id=1",
+                          json=RetrieveJSONFromFile("data/v3/GetAccountsSearchNotFound.json"))
+        with pytest.raises(AccountNotFound):
+            data = c.get_accounts(search="number:arandomvalue")
+            
     def test_create_transaction_income_success(self, setUp, requests_mock,
-                            type='income', # Payment method type
+                                               transaction_type='income',  # Payment method type
                                                account_id=2,  # Account ID to assign
                                                category_id=3,  # Category ID to assign
                                                contact_id=None,  # Contact ID/Client to assign
@@ -71,7 +97,7 @@ class TestAPI:
         requests_mock.post(c.url + "/transactions",
                            json=RetrieveJSONFromFile("data/CreateTransactionIncomeSuccess.json"),
                            status_code=201)
-        data = c.create_transaction(type=type,
+        data = c.create_transaction(transaction_type=transaction_type,
                                     account_id=account_id,
                                     category_id=category_id,
                                     paid_at=paid_at,
@@ -84,6 +110,32 @@ class TestAPI:
                                     description="Some description of the transaction"
                                     )
 
+    def test_create_transaction_income_default_currency_success(self, setUp, requests_mock,
+                                                                transaction_type='income',  # Payment method type
+                                                                account_id=2,  # Account ID to assign
+                                                                category_id=3,  # Category ID to assign
+                                                                contact_id=None,  # Contact ID/Client to assign
+                                                                paid_at="2022-05-15",
+                                                                # Date of expense/transfer or income
+                                                                reference=None,  # Reference for the payment
+                                                                payment_method="bank_transfer",  # Payment method
+                                                                amount="25.00",  # Amount received/paid
+                                                                ):
+        c = setUp
+        requests_mock.post(c.url + "/transactions",
+                           json=RetrieveJSONFromFile("data/CreateTransactionIncomeSuccess.json"),
+                           status_code=201)
+        data = c.create_transaction(transaction_type=transaction_type,
+                                    account_id=account_id,
+                                    category_id=category_id,
+                                    paid_at=paid_at,
+                                    contact_id=contact_id,
+                                    payment_method=payment_method,
+                                    reference=reference,
+                                    amount=amount,
+                                    description="Some description of the transaction"
+                                    )
+
     def test_create_transaction_income_failed(self, setUp, requests_mock,
                                               contact_id=None,  # Contact ID/Client to assign
                                               reference=None,  # Reference for the payment
@@ -106,10 +158,10 @@ class TestAPI:
 
     def test_create_transaction_expense_success(self, setUp, requests_mock):
         c = setUp
-        requests_mock.post(c.url + "/transactions",
+        requests_mock.post(c.url + "/transactions?search=type%3Aexpense&type=expense&account_id=3&category_id=4&paid_at=2022-05-16&payment_method=Bank+Transfer&currency_code=NZD&currency_rate=1&amount=100.0&description=Some+expenditures&company_id=1",
                            json=RetrieveJSONFromFile("data/CreateTransactionExpenseSuccess.json"),
                            status_code=201)
-        data = c.create_transaction(type="expense",
+        data = c.create_transaction(transaction_type="expense",
                                     amount=100.00,
                                     account_id=3,
                                     paid_at="2022-05-16",
@@ -120,3 +172,18 @@ class TestAPI:
                                     description="Some expenditures"
                                     )
 
+
+    def test_create_transfer_success(self, setUp, requests_mock):
+        c = setUp
+        requests_mock.post(c.url + "/transfers",
+                           json=RetrieveJSONFromFile("data/CreateTransferSuccess.json"),
+                           status_code=201)
+        data = c.create_transfer(   amount=100.00,
+                                    account_id=3,
+                                    paid_at="2022-05-16",
+                                    currency_rate=1,
+                                    currency_code="NZD",
+                                    payment_method="Bank Transfer",
+                                    category_id="4",
+                                    description="Some expenditures"
+                                    )