netbox-contract 2.1.2__tar.gz → 2.2.1__tar.gz

{netbox_contract-2.1.2/src/netbox_contract.egg-info → netbox_contract-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-contract
-Version: 2.1.2
+Version: 2.2.1
 Summary: Contract management plugin for Netbox
 Author-email: Marc Lebreuil <marc@famillelebreuil.net>
 Project-URL: Homepage, https://github.com/mlebreuil/netbox-contract
@@ -12,6 +12,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: python-dateutil
+Requires-Dist: drf_yasg
 
 # Contract pluggin
 ## Overview

{netbox_contract-2.1.2 → netbox_contract-2.2.1}/pyproject.toml

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

{netbox_contract-2.1.2 → netbox_contract-2.2.1}/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.1'
     author = 'Marc Lebreuil'
     author_email = 'marc@famillelebreuil.net'
     base_url = 'contracts'

{netbox_contract-2.1.2 → netbox_contract-2.2.1}/src/netbox_contract/api/serializers.py

@@ -7,7 +7,14 @@ from rest_framework import serializers
 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 NestedContractAssignmentSerializer(WritableNestedSerializer):
         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 @@ class ContractAssignmentSerializer(NetBoxModelSerializer):
         )
         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')

{netbox_contract-2.1.2 → netbox_contract-2.2.1}/src/netbox_contract/api/urls.py

@@ -9,5 +9,7 @@ router.register('contracts', views.ContractViewSet)
 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

{netbox_contract-2.1.2 → netbox_contract-2.2.1}/src/netbox_contract/api/views.py

@@ -1,10 +1,13 @@
-from django.db.models import F
+from django.db.models import Case, F, When
+from django.db.models.functions import Round
 from netbox.api.viewsets import NetBoxModelViewSet
 
 from .. import filtersets, models
 from .serializers import (
+    AccountingDimensionSerializer,
     ContractAssignmentSerializer,
     ContractSerializer,
+    InvoiceLineSerializer,
     InvoiceSerializer,
     ServiceProviderSerializer,
 )
@@ -12,7 +15,10 @@ from .serializers import (
 
 class ContractViewSet(NetBoxModelViewSet):
     queryset = models.Contract.objects.prefetch_related('parent', 'tags').annotate(
-        yrc=F('mrc') * 12
+        calculated_rc=Round(
+            Case(When(yrc__gt=0, then=F('yrc') / 12), default=F('mrc') * 12),
+            precision=2,
+        )
     )
     serializer_class = ContractSerializer
 
@@ -31,3 +37,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

{netbox_contract-2.1.2 → netbox_contract-2.2.1}/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 @@ class ContractFilterSet(NetBoxModelFilterSet):
             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 InvoiceFilterSet(NetBoxModelFilterSet):
 
     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 ContractAssignmentFilterSet(NetBoxModelFilterSet):
 
     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)
+        )

{netbox_contract-2.1.2 → netbox_contract-2.2.1}/src/netbox_contract/forms.py

@@ -1,6 +1,7 @@
 from django import forms
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from extras.filters import TagFilter
 from netbox.forms import (
     NetBoxModelBulkEditForm,
@@ -24,10 +25,12 @@ from utilities.forms.widgets import DatePicker, HTMXSelect
 
 from .constants import SERVICE_PROVIDER_MODELS
 from .models import (
+    AccountingDimension,
     Contract,
     ContractAssignment,
     InternalEntityChoices,
     Invoice,
+    InvoiceLine,
     ServiceProvider,
     StatusChoices,
 )
@@ -46,6 +49,9 @@ class Dimensions(JSONField):
         self.widget.attrs['placeholder'] = str(default_dimensions)
 
 
+# Contract
+
+
 class ContractForm(NetBoxModelForm):
     comments = CommentField()
 
@@ -98,11 +104,6 @@ class ContractForm(NetBoxModelForm):
             ].queryset = ServiceProvider.objects.all()
             self.fields['external_partie_object'].initial = None
 
-        # initialize accounting dimentsions widget
-        # self.fields[
-        #         'accounting_dimensions'
-        #     ].widget.attrs['placeholder'] = '{"key": "value"}'
-
         # Initialise fields settings
         mandatory_fields = plugin_settings.get('mandatory_contract_fields')
         for field in mandatory_fields:
@@ -128,6 +129,7 @@ class ContractForm(NetBoxModelForm):
             'renewal_term',
             'currency',
             'accounting_dimensions',
+            'yrc',
             'mrc',
             'nrc',
             'invoice_frequency',
@@ -142,45 +144,13 @@ class ContractForm(NetBoxModelForm):
             'end_date': DatePicker(),
         }
 
+    def clean(self):
+        super().clean()
 
-class InvoiceForm(NetBoxModelForm):
-    contracts = DynamicModelMultipleChoiceField(
-        queryset=Contract.objects.all(), required=False
-    )
-    accounting_dimensions = Dimensions(required=False)
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-        # Initialise fields settings
-        mandatory_fields = plugin_settings.get('mandatory_invoice_fields')
-        for field in mandatory_fields:
-            self.fields[field].required = True
-        hidden_fields = plugin_settings.get('hidden_invoice_fields')
-        for field in hidden_fields:
-            if not self.fields[field].required:
-                self.fields[field].widget = forms.HiddenInput()
-
-    class Meta:
-        model = Invoice
-        fields = (
-            'number',
-            'date',
-            'contracts',
-            'period_start',
-            'period_end',
-            'currency',
-            'accounting_dimensions',
-            'amount',
-            'documents',
-            'comments',
-            'tags',
-        )
-        widgets = {
-            'date': DatePicker(),
-            'period_start': DatePicker(),
-            'period_end': DatePicker(),
-        }
+        if self.cleaned_data['mrc'] and self.cleaned_data['mrc']:
+            raise ValidationError(
+                'you should set monthly OR yearly recuring costs not both'
+            )
 
 
 class ContractFilterSetForm(NetBoxModelFilterSetForm):
@@ -193,13 +163,6 @@ class ContractFilterSetForm(NetBoxModelFilterSetForm):
     parent = DynamicModelChoiceField(queryset=Contract.objects.all(), required=False)
 
 
-class InvoiceFilterSetForm(NetBoxModelFilterSetForm):
-    model = Invoice
-    contracts = DynamicModelMultipleChoiceField(
-        queryset=Contract.objects.all(), required=False
-    )
-
-
 class ContractCSVForm(NetBoxModelImportForm):
     external_partie_object_type = CSVContentTypeField(
         queryset=ContentType.objects.all(),
@@ -239,6 +202,7 @@ class ContractCSVForm(NetBoxModelImportForm):
             'renewal_term',
             'currency',
             'accounting_dimensions',
+            'yrc',
             'mrc',
             'nrc',
             'invoice_frequency',
@@ -271,6 +235,124 @@ class ContractBulkEditForm(NetBoxModelBulkEditForm):
     model = Contract
 
 
+# Invoice
+
+
+class InvoiceForm(NetBoxModelForm):
+    contracts = DynamicModelMultipleChoiceField(
+        queryset=Contract.objects.all(), required=False
+    )
+    accounting_dimensions = Dimensions(required=False)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # Initialise fields settings
+        mandatory_fields = plugin_settings.get('mandatory_invoice_fields')
+        for field in mandatory_fields:
+            self.fields[field].required = True
+        hidden_fields = plugin_settings.get('hidden_invoice_fields')
+        for field in hidden_fields:
+            if not self.fields[field].required:
+                self.fields[field].widget = forms.HiddenInput()
+
+    def clean(self):
+        super().clean()
+
+        # template checks
+        if self.cleaned_data['template']:
+            # Check that there is only one invoice template per contract
+            contracts = self.cleaned_data['contracts']
+            for contract in contracts:
+                for invoice in contract.invoices.all():
+                    if invoice.template and invoice.pk != self.instance.pk:
+                        raise ValidationError(
+                            'Only one invoice template allowed per contract'
+                        )
+
+            # Prefix the invoice name with _template
+            self.cleaned_data['number'] = '_invoice_template_' + contract.name
+
+            # set the periode start and end date to null
+            self.cleaned_data['period_start'] = None
+            self.cleaned_data['period_end'] = None
+
+    def save(self, *args, **kwargs):
+        is_new = not bool(self.instance.pk)
+
+        instance = super().save(*args, **kwargs)
+
+        if is_new and not self.cleaned_data['template']:
+            contracts = self.cleaned_data['contracts']
+
+            for contract in contracts:
+                try:
+                    template_exists = True
+                    invoice_template = Invoice.objects.get(
+                        template=True, contracts=contract
+                    )
+                except ObjectDoesNotExist:
+                    template_exists = False
+
+                if template_exists:
+                    first = True
+                    for line in invoice_template.invoicelines.all():
+                        dimensions = line.accounting_dimensions.all()
+                        line.pk = None
+                        line.id = None
+                        line._state.adding = True
+                        line.invoice = self.instance
+
+                        # adjust the first invoice line amount
+                        amount = self.cleaned_data['amount']
+                        if (
+                            first
+                            and amount != invoice_template.total_invoicelines_amount
+                        ):
+                            line.amount = (
+                                line.amount
+                                + amount
+                                - invoice_template.total_invoicelines_amount
+                            )
+
+                        line.save()
+
+                        for dimension in dimensions:
+                            line.accounting_dimensions.add(dimension)
+                        first = False
+
+        return instance
+
+    class Meta:
+        model = Invoice
+        fields = (
+            'number',
+            'date',
+            'contracts',
+            'template',
+            'period_start',
+            'period_end',
+            'currency',
+            'accounting_dimensions',
+            'amount',
+            'documents',
+            'comments',
+            'tags',
+        )
+        widgets = {
+            'date': DatePicker(),
+            'period_start': DatePicker(),
+            'period_end': DatePicker(),
+        }
+
+
+class InvoiceFilterSetForm(NetBoxModelFilterSetForm):
+    model = Invoice
+    contracts = DynamicModelMultipleChoiceField(
+        queryset=Contract.objects.all(), required=False
+    )
+
+
 class InvoiceCSVForm(NetBoxModelImportForm):
     contracts = CSVModelChoiceField(
         queryset=Contract.objects.all(),
@@ -284,6 +366,7 @@ class InvoiceCSVForm(NetBoxModelImportForm):
             'number',
             'date',
             'contracts',
+            'template',
             'period_start',
             'period_end',
             'currency',
@@ -368,3 +451,108 @@ class ContractAssignmentImportForm(NetBoxModelImportForm):
     class Meta:
         model = ContractAssignment
         fields = ['content_type', 'object_id', 'contract', 'tags']
+
+
+# InvoiceLine
+
+
+class InvoiceLineForm(NetBoxModelForm):
+    invoice = DynamicModelChoiceField(queryset=Invoice.objects.all())
+    accounting_dimensions = forms.ModelMultipleChoiceField(
+        queryset=AccountingDimension.objects.all(), required=False
+    )
+
+    def clean(self):
+        super().clean()
+
+        # check for duplicate dimensions
+        accounting_dimensions = self.cleaned_data['accounting_dimensions']
+        dimensions_names = []
+        for dimension in accounting_dimensions:
+            if dimension.name in dimensions_names:
+                raise ValidationError('duplicate accounting dimension')
+            else:
+                dimensions_names.append(dimension.name)
+
+    class Meta:
+        model = InvoiceLine
+        fields = [
+            'invoice',
+            'currency',
+            'amount',
+            'accounting_dimensions',
+            'comments',
+            'tags',
+        ]
+
+
+class InvoiceLineFilterSetForm(NetBoxModelFilterSetForm):
+    model = InvoiceLine
+    invoice = DynamicModelChoiceField(queryset=Invoice.objects.all())
+    accounting_dimensions = DynamicModelMultipleChoiceField(
+        queryset=AccountingDimension.objects.all()
+    )
+
+
+class InvoiceLineImportForm(NetBoxModelImportForm):
+    invoice = CSVModelChoiceField(
+        queryset=Invoice.objects.all(),
+        to_field_name='number',
+        help_text='Invoice number',
+    )
+    accounting_dimensions = CSVModelChoiceField(
+        queryset=AccountingDimension.objects.all(),
+        help_text='accounting dimention in the form name, value',
+    )
+
+    class Meta:
+        model = InvoiceLine
+        fields = [
+            'invoice',
+            'currency',
+            'amount',
+            'accounting_dimensions',
+            'comments',
+            'tags',
+        ]
+
+
+class InvoiceLineBulkEditForm(NetBoxModelBulkEditForm):
+    invoice = DynamicModelChoiceField(queryset=Invoice.objects.all(), required=False)
+    accounting_dimensions = DynamicModelMultipleChoiceField(
+        queryset=AccountingDimension.objects.all(), required=False
+    )
+    model = InvoiceLine
+
+
+# AccountingDimension
+
+
+class AccountingDimensionForm(NetBoxModelForm):
+    class Meta:
+        model = AccountingDimension
+        fields = [
+            'name',
+            'value',
+            'comments',
+            'tags',
+        ]
+
+
+class AccountingDimensionFilterSetForm(NetBoxModelFilterSetForm):
+    model = AccountingDimension
+
+
+class AccountingDimensionImportForm(NetBoxModelImportForm):
+    class Meta:
+        model = AccountingDimension
+        fields = [
+            'name',
+            'value',
+            'comments',
+            'tags',
+        ]
+
+
+class AccountingDimensionBulkEditForm(NetBoxModelBulkEditForm):
+    model = AccountingDimension

netbox_contract-2.2.1/src/netbox_contract/migrations/0027_invoiceline.py

@@ -0,0 +1,57 @@
+# Generated by Django 5.0.6 on 2024-06-23 13:12
+
+import django.db.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('extras', '0115_convert_dashboard_widgets'),
+        ('netbox_contract', '0026_auto_20240421_1550'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='InvoiceLine',
+            fields=[
+                (
+                    'id',
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                (
+                    'custom_field_data',
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        encoder=utilities.json.CustomFieldJSONEncoder,
+                    ),
+                ),
+                ('currency', models.CharField(default='usd', max_length=3)),
+                ('amount', models.DecimalField(decimal_places=2, max_digits=10)),
+                ('comments', models.TextField(blank=True)),
+                (
+                    'invoice',
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name='invoicelines',
+                        to='netbox_contract.invoice',
+                    ),
+                ),
+                (
+                    'tags',
+                    taggit.managers.TaggableManager(
+                        through='extras.TaggedItem', to='extras.Tag'
+                    ),
+                ),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

netbox_contract-2.2.1/src/netbox_contract/migrations/0028_invoiceline_accounting_dimensions.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.6 on 2024-06-30 20:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('netbox_contract', '0027_invoiceline'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='invoiceline',
+            name='accounting_dimensions',
+            field=models.JSONField(null=True),
+        ),
+    ]