Merge pull request #145 from mlebreuil/develop

v2.2.0

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
     rev: 23.11.0
     hooks:
     - id: black
-      language_version: python3.12
+      language_version: python3
 -   repo: https://github.com/PyCQA/isort
     rev: 5.12.0
     hooks:

CHANGELOG.md

@@ -5,6 +5,10 @@
 
 ## Version 2
 
+### Version 2.2.0
+
+* [140](https://github.com/mlebreuil/netbox-contract/issues/140) Add the "Invoice line" and "Accounting dimension" models. In order to simplify invoices creation, it is possible to selsct one invoice as the template for each contract; Its accounting lines will automatically be copied to the new invoices for the contract. The amount of the first line will be updated so that the sum of the amount for each invoice line match the invoice amount.
+
 ### Version 2.1.2
 
 * [127](https://github.com/mlebreuil/netbox-contract/issues/135) Fix service provider creation issue

docs/accounting_dimensions.md

@@ -0,0 +1,5 @@
+# Accounting dimensions
+
+![Accounting dimensions](img/accrounting_dimensions.png "accounting dimensions")
+
+

docs/contract.md

@@ -0,0 +1,7 @@
+# Contract
+
+![Contract](img/contract.png "contract")
+
+Linked objects:  
+
+![Contract linked objects](img/contract_linked_objects.png "contract linked objects")

docs/invoice.md

@@ -0,0 +1,7 @@
+# Invoice
+
+![Invoice](img/invoice.png "invoice")
+
+Linked objects:  
+
+![Invoice linked objects](img/invoice_linked_objects.png "invoice linked objects")

docs/invoice_line.md

@@ -0,0 +1,5 @@
+# Invoice line
+
+![Invoice line](img/invoice_line.png "invoice line")
+
+

mkdocs.yml

@@ -4,6 +4,10 @@ repo_url: https://github.com/mlebreuil/netbox-contract
 repo_name: netbox-contract
 nav:
   - Home: index.md
+  - Contract: contract.md
+  - Invoice: invoice.md
+  - Invoice line: invoice_line.md
+  - Accounting dimensions: accounting_dimensions.md
   - Contributing: contributing.md
   - Changelog: changelog.md
 theme:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "netbox-contract"
-version = "2.1.2"
+version = "2.2.0"
 authors = [
   { name="Marc Lebreuil", email="[email protected]" },
 ]
@@ -9,6 +9,7 @@ readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
     'python-dateutil',
+    'drf_yasg',
 ]
 classifiers = [
     "Programming Language :: Python :: 3",

src/netbox_contract/__init__.py

@@ -5,7 +5,7 @@ class ContractsConfig(PluginConfig):
     name = 'netbox_contract'
     verbose_name = 'Netbox contract'
     description = 'Contract management plugin for Netbox'
-    version = '2.1.2'
+    version = '2.2.0'
     author = 'Marc Lebreuil'
     author_email = '[email protected]'
     base_url = 'contracts'

src/netbox_contract/api/serializers.py

@@ -7,7 +7,14 @@
 from tenancy.api.nested_serializers import NestedTenantSerializer
 from utilities.api import get_serializer_for_model
 
-from ..models import Contract, ContractAssignment, Invoice, ServiceProvider
+from ..models import (
+    AccountingDimension,
+    Contract,
+    ContractAssignment,
+    Invoice,
+    InvoiceLine,
+    ServiceProvider,
+)
 
 
 class NestedServiceProviderSerializer(WritableNestedSerializer):
@@ -52,6 +59,28 @@ class Meta:
         brief_fields = ('id', 'url', 'display', 'contract', 'content_object')
 
 
+class NestedInvoicelineSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_contract-api:InvoiceLine-detail'
+    )
+
+    class Meta:
+        model = InvoiceLine
+        fields = ('id', 'url', 'display', 'invoice', 'amount')
+        brief_fields = ('id', 'url', 'display', 'invoice', 'amount')
+
+
+class NestedAccountingDimensionSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_contract-api:AccountingDimension-detail'
+    )
+
+    class Meta:
+        model = AccountingDimension
+        fields = ('id', 'url', 'display', 'name', 'value')
+        brief_fields = ('id', 'url', 'display', 'name', 'value')
+
+
 class ContractSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name='plugins-api:netbox_contract-api:contract-detail'
@@ -192,3 +221,48 @@ def get_content_object(self, instance):
         )
         context = {'request': self.context['request']}
         return serializer(instance.content_object, context=context).data
+
+
+class InvoiceLineSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_contract-api:invoiceline-detail'
+    )
+
+    class Meta:
+        model = InvoiceLine
+        fields = (
+            'id',
+            'url',
+            'display',
+            'invoice',
+            'amount',
+            'currency',
+            'comments',
+            'tags',
+            'custom_fields',
+            'created',
+            'last_updated',
+        )
+        brief_fields = ('invoice', 'amount', 'url', 'display', 'name')
+
+
+class AccountingDimensionSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_contract-api:accountingdimension-detail'
+    )
+
+    class Meta:
+        model = AccountingDimension
+        fields = (
+            'id',
+            'url',
+            'display',
+            'name',
+            'value',
+            'comments',
+            'tags',
+            'custom_fields',
+            'created',
+            'last_updated',
+        )
+        brief_fields = ('name', 'value', 'url', 'display')

src/netbox_contract/api/urls.py

@@ -9,5 +9,7 @@
 router.register('invoices', views.InvoiceViewSet)
 router.register('serviceproviders', views.ServiceProviderViewSet)
 router.register('contractassignment', views.ContractAssignmentViewSet)
+router.register('invoiceline', views.InvoiceLineViewSet)
+router.register('accountingdimension', views.AccountingDimensionViewSet)
 
 urlpatterns = router.urls

src/netbox_contract/api/views.py

@@ -3,8 +3,10 @@
 
 from .. import filtersets, models
 from .serializers import (
+    AccountingDimensionSerializer,
     ContractAssignmentSerializer,
     ContractSerializer,
+    InvoiceLineSerializer,
     InvoiceSerializer,
     ServiceProviderSerializer,
 )
@@ -31,3 +33,13 @@ class ServiceProviderViewSet(NetBoxModelViewSet):
 class ContractAssignmentViewSet(NetBoxModelViewSet):
     queryset = models.ContractAssignment.objects.prefetch_related('contract', 'tags')
     serializer_class = ContractAssignmentSerializer
+
+
+class InvoiceLineViewSet(NetBoxModelViewSet):
+    queryset = models.InvoiceLine.objects.prefetch_related('invoice', 'tags')
+    serializer_class = InvoiceLineSerializer
+
+
+class AccountingDimensionViewSet(NetBoxModelViewSet):
+    queryset = models.AccountingDimension.objects.prefetch_related('tags')
+    serializer_class = AccountingDimensionSerializer

src/netbox_contract/filtersets.py

@@ -1,7 +1,14 @@
 from django.db.models import Q
 from netbox.filtersets import NetBoxModelFilterSet
 
-from .models import Contract, ContractAssignment, Invoice, ServiceProvider
+from .models import (
+    AccountingDimension,
+    Contract,
+    ContractAssignment,
+    Invoice,
+    InvoiceLine,
+    ServiceProvider,
+)
 
 
 class ContractFilterSet(NetBoxModelFilterSet):
@@ -14,7 +21,7 @@ def search(self, queryset, name, value):
             Q(name__icontains=value)
             | Q(external_reference__icontains=value)
             | Q(comments__icontains=value),
-            Q(status__iexact='Active')
+            Q(status__iexact='Active'),
         )
 
 
@@ -25,8 +32,7 @@ class Meta:
 
     def search(self, queryset, name, value):
         return queryset.filter(
-            Q(number__icontains=value) 
-            | Q(contracts__name__icontains=value)
+            Q(number__icontains=value) | Q(contracts__name__icontains=value)
         )
 
 
@@ -46,3 +52,25 @@ class Meta:
 
     def search(self, queryset, name, value):
         return queryset.filter(Q(contract__name__icontains=value))
+
+
+class InvoiceLineFilterSet(NetBoxModelFilterSet):
+    class Meta:
+        model = InvoiceLine
+        fields = ('id', 'invoice')
+
+    def search(self, queryset, name, value):
+        return queryset.filter(
+            Q(comments__icontains=value) | Q(invoice__name__icontains=value)
+        )
+
+
+class AccountingDimensionFilterSet(NetBoxModelFilterSet):
+    class Meta:
+        model = AccountingDimension
+        fields = ('name', 'value')
+
+    def search(self, queryset, name, value):
+        return queryset.filter(
+            Q(comments__icontains=value) | Q(invoice__name__icontains=value)
+        )