wbaccounting 2.2.1__py2.py3-none-any.whl

wbaccounting/migrations/0009_invoicetype_alter_bookingentry_options_and_more.py

@@ -0,0 +1,366 @@
+# Generated by Django 5.0.3 on 2024-04-15 09:05
+
+import django.db.models.deletion
+import django_fsm
+import wbaccounting.models.entry_accounting_information
+from django.conf import settings
+from django.db import migrations, models
+from django.db.models import Max
+from django.utils.html import strip_tags
+
+
+def swap_net_and_gross(apps, schema_editor):
+    # We are using the wrong notion for net and gross, we need to swap them
+    BookingEntry = apps.get_model("wbaccounting", "BookingEntry")
+    for bookingentry in BookingEntry.objects.all():
+        bookingentry.net_value, bookingentry.gross_value = bookingentry.gross_value, bookingentry.net_value
+        bookingentry.save()
+
+
+def migrate_dates(apps, schema_editor):
+    # We are migrating from/to date from fields to parameters, as they are getting removed
+    # Also we are setting the reference date to to date, as it is the last date of the accounting period
+    BookingEntry = apps.get_model("wbaccounting", "BookingEntry")
+    for bookingentry in BookingEntry.objects.filter(from_date__isnull=False, to_date__isnull=False):
+        bookingentry.parameters = {
+            "from_date": bookingentry.from_date.strftime("%d.%m.%Y"),
+            "to_date": bookingentry.to_date.strftime("%d.%m.%Y"),
+        }
+        bookingentry.reference_date = bookingentry.to_date
+        bookingentry.save()
+
+    # As the reference date is set for the bookings entries, the
+    Invoice = apps.get_model("wbaccounting", "Invoice")
+    for invoice in Invoice.objects.filter(booking_entries__isnull=False):
+        invoice.reference_date = invoice.booking_entries.aggregate(mv=Max("reference_date")).get("mv")
+        invoice.save()
+
+
+def strip_html_from_subject(apps, schema_editor):
+    EntryAccountingInformation = apps.get_model("wbaccounting", "EntryAccountingInformation")
+
+    for eai in EntryAccountingInformation.objects.all():
+        eai.email_subject = strip_tags(eai.email_subject)
+        eai.save()
+
+
+def save_models(apps, schema_editor):
+    from wbaccounting.models import BookingEntry
+
+    for bookingentry in BookingEntry.objects.all():
+        bookingentry.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("currency", "0001_initial"),
+        ("directory", "0007_alter_bankingcontact_options"),
+        ("wbaccounting", "0008_alter_invoice_options"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="InvoiceType",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("name", models.CharField(max_length=100, unique=True, verbose_name="Name")),
+                ("processor", models.CharField(blank=True, max_length=128, null=True, verbose_name="Processor")),
+            ],
+            options={
+                "verbose_name": "Invoice Type",
+                "verbose_name_plural": "Invoice Types",
+            },
+        ),
+        migrations.AlterModelOptions(
+            name="bookingentry",
+            options={"verbose_name": "Booking", "verbose_name_plural": "Bookings"},
+        ),
+        migrations.AlterModelOptions(
+            name="entryaccountinginformation",
+            options={"verbose_name": "Accounting Information", "verbose_name_plural": "Accounting Information"},
+        ),
+        migrations.AlterModelOptions(
+            name="invoice",
+            options={
+                "permissions": (
+                    ("can_generate_invoice", "Can Generate Invoice"),
+                    ("administrate_invoice", "Can administer Invoice"),
+                ),
+                "verbose_name": "Invoice",
+                "verbose_name_plural": "Invoices",
+            },
+        ),
+        migrations.RemoveField(
+            model_name="bookingentry",
+            name="accrual_date",
+        ),
+        migrations.RemoveField(
+            model_name="bookingentry",
+            name="calculated_value",
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="parameters",
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="reference_date",
+            field=models.DateField(blank=True, null=True, verbose_name="Reference Date"),
+        ),
+        migrations.AddField(
+            model_name="invoice",
+            name="reference_date",
+            field=models.DateField(blank=True, null=True, verbose_name="Reference Date"),
+        ),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL IMMEDIATE;"),
+        migrations.RunPython(
+            swap_net_and_gross,
+            reverse_code=migrations.RunPython.noop,
+        ),
+        migrations.RunPython(
+            migrate_dates,
+            reverse_code=migrations.RunPython.noop,
+        ),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL DEFERRED;"),
+        migrations.RemoveField(
+            model_name="bookingentry",
+            name="from_date",
+        ),
+        migrations.RemoveField(
+            model_name="bookingentry",
+            name="to_date",
+        ),
+        migrations.RemoveField(
+            model_name="bookingentry",
+            name="main_booking_entry",
+        ),
+        migrations.RemoveField(
+            model_name="bookingentry",
+            name="related_data",
+        ),
+        migrations.RemoveField(
+            model_name="bookingentry",
+            name="resolved",
+        ),
+        migrations.RemoveField(
+            model_name="entryaccountinginformation",
+            name="label_mapping",
+        ),
+        migrations.RemoveField(
+            model_name="entryaccountinginformation",
+            name="social_charges",
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="backlinks",
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="due_date",
+            field=models.DateField(blank=True, null=True, verbose_name="Due Date"),
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="generator",
+            field=models.CharField(blank=True, max_length=256, null=True),
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="invoice_fx_rate",
+            field=models.DecimalField(
+                blank=True, decimal_places=6, max_digits=20, null=True, verbose_name="Invoice FX Rate"
+            ),
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="invoice_gross_value",
+            field=models.DecimalField(
+                blank=True, decimal_places=4, max_digits=16, null=True, verbose_name="Invoice Gross Value"
+            ),
+        ),
+        migrations.AddField(
+            model_name="bookingentry",
+            name="invoice_net_value",
+            field=models.DecimalField(
+                blank=True, decimal_places=4, max_digits=16, null=True, verbose_name="Invoice Net Value"
+            ),
+        ),
+        migrations.AddField(
+            model_name="entryaccountinginformation",
+            name="booking_entry_generator",
+            field=models.CharField(blank=True, max_length=256, null=True),
+        ),
+        migrations.AddField(
+            model_name="entryaccountinginformation",
+            name="counterparty_is_private",
+            field=models.BooleanField(
+                default=False,
+                help_text="Hides all of the counterparty's invoices from non-eligible users",
+                verbose_name="Counterparty Is Private",
+            ),
+        ),
+        migrations.AddField(
+            model_name="entryaccountinginformation",
+            name="exempt_users",
+            field=models.ManyToManyField(
+                blank=True,
+                help_text="Exclusion list of users who are able to see private invoices for the counterparty",
+                related_name="private_accounting_information",
+                to=settings.AUTH_USER_MODEL,
+                verbose_name="Exempt Users",
+            ),
+        ),
+        migrations.AddField(
+            model_name="entryaccountinginformation",
+            name="send_mail",
+            field=models.BooleanField(default=True, verbose_name="Send Mail"),
+        ),
+        migrations.AddField(
+            model_name="invoice",
+            name="backlinks",
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="invoice",
+            name="gross_value",
+            field=models.DecimalField(
+                blank=True, decimal_places=4, max_digits=16, null=True, verbose_name="Gross Value"
+            ),
+        ),
+        migrations.AddField(
+            model_name="invoice",
+            name="net_value",
+            field=models.DecimalField(
+                blank=True, decimal_places=4, max_digits=16, null=True, verbose_name="Net Value"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="entryaccountinginformation",
+            name="default_currency",
+            field=models.ForeignKey(
+                blank=True,
+                default=wbaccounting.models.entry_accounting_information.default_currency,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="entry_accounting_informations",
+                to="currency.currency",
+                verbose_name="Default Currency",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="entryaccountinginformation",
+            name="email_body",
+            field=models.TextField(
+                default=wbaccounting.models.entry_accounting_information.default_email_body, verbose_name="Body"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="entryaccountinginformation",
+            name="entry",
+            field=models.OneToOneField(
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="entry_accounting_information",
+                to="directory.entry",
+                verbose_name="Counterparty",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="invoice",
+            name="status",
+            field=django_fsm.FSMField(
+                choices=[
+                    ("DRAFT", "Draft"),
+                    ("SUBMITTED", "Submitted"),
+                    ("APPROVED", "Approved"),
+                    ("CANCELLED", "Cancelled"),
+                    ("SENT", "Sent"),
+                    ("PAID", "Paid"),
+                ],
+                default="DRAFT",
+                max_length=50,
+                verbose_name="Status",
+            ),
+        ),
+        migrations.AddField(
+            model_name="entryaccountinginformation",
+            name="default_invoice_type",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="When invoicinging outstanding booking entries, this invoice type will be assigned to the corresponding invoice",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="booking_entries",
+                to="wbaccounting.invoicetype",
+                verbose_name="Default Invoice Type",
+            ),
+        ),
+        migrations.AddField(
+            model_name="invoice",
+            name="invoice_type",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="invoices",
+                to="wbaccounting.invoicetype",
+                verbose_name="Type",
+            ),
+        ),
+        migrations.RenameField(
+            model_name="bookingentry",
+            old_name="resolved_date",
+            new_name="payment_date",
+        ),
+        migrations.AlterField(
+            model_name="bookingentry",
+            name="payment_date",
+            field=models.DateField(blank=True, null=True, verbose_name="Payment Date"),
+        ),
+        migrations.RemoveField(
+            model_name="invoice",
+            name="is_counterparty_invoice",
+        ),
+        migrations.AddField(
+            model_name="invoice",
+            name="payment_date",
+            field=models.DateField(blank=True, null=True, verbose_name="Payment Date"),
+        ),
+        migrations.AlterField(
+            model_name="invoice",
+            name="invoice_date",
+            field=models.DateField(verbose_name="Invoice Date"),
+        ),
+        migrations.AlterModelOptions(
+            name="entryaccountinginformation",
+            options={"verbose_name": "Counterparty", "verbose_name_plural": "Counterparties"},
+        ),
+        migrations.AlterField(
+            model_name="entryaccountinginformation",
+            name="email_subject",
+            field=models.CharField(default="{{invoice.title}}", max_length=1024, verbose_name="Subject"),
+        ),
+        migrations.AlterField(
+            model_name="entryaccountinginformation",
+            name="entry",
+            field=models.OneToOneField(
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="entry_accounting_information",
+                to="directory.entry",
+                verbose_name="Linked Counterparty",
+            ),
+        ),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL IMMEDIATE;"),
+        migrations.RunPython(
+            strip_html_from_subject,
+            reverse_code=migrations.RunPython.noop,
+        ),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL DEFERRED;"),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL IMMEDIATE;"),
+        migrations.RunPython(
+            save_models,
+            reverse_code=migrations.RunPython.noop,
+        ),
+        migrations.RunSQL(sql="SET CONSTRAINTS ALL DEFERRED;"),
+    ]

wbaccounting/migrations/0010_alter_bookingentry_options.py

@@ -0,0 +1,20 @@
+# Generated by Django 5.0.3 on 2024-04-29 11:33
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbaccounting", "0009_invoicetype_alter_bookingentry_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="bookingentry",
+            options={
+                "permissions": (("can_generate_booking_entries", "Can Generate Bookings"),),
+                "verbose_name": "Booking",
+                "verbose_name_plural": "Bookings",
+            },
+        ),
+    ]

wbaccounting/migrations/0011_transaction.py

@@ -0,0 +1,103 @@
+# Generated by Django 5.0.6 on 2024-06-05 08:07
+
+from decimal import Decimal
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("currency", "0001_initial"),
+        ("directory", "0007_alter_bankingcontact_options"),
+        ("io", "0007_alter_exportsource_query_params"),
+        ("wbaccounting", "0010_alter_bookingentry_options"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Transaction",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("booking_date", models.DateField(verbose_name="Booking Date")),
+                ("value_date", models.DateField(verbose_name="Value Date")),
+                (
+                    "fx_rate",
+                    models.DecimalField(decimal_places=4, default=Decimal("1"), max_digits=10, verbose_name="FX Rate"),
+                ),
+                (
+                    "value_local_ccy",
+                    models.DecimalField(
+                        blank=True, decimal_places=2, max_digits=19, null=True, verbose_name="Value (Local Currency)"
+                    ),
+                ),
+                (
+                    "value",
+                    models.DecimalField(blank=True, decimal_places=2, max_digits=19, null=True, verbose_name="Value"),
+                ),
+                ("description", models.TextField(default="")),
+                (
+                    "prenotification",
+                    models.BooleanField(
+                        default=False,
+                        help_text="This field indicates that this transaction will happen sometime in the future.",
+                        verbose_name="Prenotification",
+                    ),
+                ),
+                ("_hash", models.CharField(blank=True, max_length=64, null=True)),
+                (
+                    "bank_account",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="wbaccounting_transactions",
+                        to="directory.bankingcontact",
+                        verbose_name="Linked Bank Account",
+                    ),
+                ),
+                (
+                    "currency",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="+",
+                        to="currency.currency",
+                        verbose_name="Currency",
+                    ),
+                ),
+                (
+                    "from_bank_account",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="+",
+                        to="directory.bankingcontact",
+                        verbose_name="Source Bank Account",
+                    ),
+                ),
+                (
+                    "import_source",
+                    models.ForeignKey(
+                        blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to="io.importsource"
+                    ),
+                ),
+                (
+                    "to_bank_account",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="+",
+                        to="directory.bankingcontact",
+                        verbose_name="Target Bank Account",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Transaction",
+                "verbose_name_plural": "Transactions",
+                "default_related_name": "transactions",
+            },
+        ),
+    ]

wbaccounting/migrations/0012_entryaccountinginformation_external_invoice_users.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.0.8 on 2024-09-18 08:57
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbaccounting", "0011_transaction"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="entryaccountinginformation",
+            name="external_invoice_users",
+            field=models.ManyToManyField(
+                blank=True,
+                help_text="External users who are able to see the invoices generated for this counterparty",
+                related_name="external_accounting_information",
+                to=settings.AUTH_USER_MODEL,
+                verbose_name="External User",
+            ),
+        ),
+    ]

wbaccounting/models/__init__.py

@@ -0,0 +1,6 @@
+from .booking_entry import BookingEntry
+from .invoice import Invoice
+from .invoice_type import InvoiceType
+from .entry_accounting_information import EntryAccountingInformation
+from .transactions import Transaction
+from .model_tasks import submit_invoices_as_task

wbaccounting/models/booking_entry.py

@@ -0,0 +1,167 @@
+from decimal import Decimal
+
+from django.db import models
+from django.db.models.signals import post_delete, post_save
+from django.dispatch import receiver
+from wbcore.contrib.authentication.models import User
+from wbcore.models import WBModel
+
+
+class BookingEntryDefaultQuerySet(models.QuerySet):
+    def filter_for_user(self, user: User) -> models.QuerySet:
+        """
+        Filters booking entries based on if the current user can see the invoice.
+
+        Args:
+            user (User): The user for whom booking entries need to be filtered.
+
+        Returns:
+            QuerySet: A filtered queryset.
+        """
+
+        # Superuser and users with the admin permission can see all booking entries
+        if user.is_superuser or user.has_perm("wbaccounting.administrate_invoice"):
+            return self
+
+        # If the user doesn't have the view permission, nothing can be seen
+        if not user.has_perm("wbaccounting.view_bookingentry"):
+            return self.none()
+
+        # The user can see all booking entries where the counterparty is not private
+        # or where the user is part of the exempt users list
+        return self.filter(
+            models.Q(counterparty__entry_accounting_information__counterparty_is_private=False)
+            | models.Q(counterparty__entry_accounting_information__exempt_users=user)
+        )
+
+
+class BookingEntry(WBModel):
+    class Meta:
+        verbose_name = "Booking"
+        verbose_name_plural = "Bookings"
+
+        permissions = (
+            (
+                "can_generate_booking_entries",
+                "Can Generate Bookings",
+            ),
+        )
+
+    def __str__(self):
+        return self.title
+
+    def save(self, *args, **kwargs):
+        # Reference date defaults to booking date if not specified
+        if not self.reference_date:
+            self.reference_date = self.booking_date
+
+        # If net value is specified, then gross value is determined based on VAT
+        if self.net_value:
+            self.gross_value = self.net_value + (self.net_value * self.vat)
+        # If net value is not specified, but gross value is, then net value is determined based on VAT
+        elif self.gross_value:
+            self.net_value = self.gross_value / (Decimal(1 + self.vat))
+        # If neither is defined the both are 0
+        else:
+            self.net_value, self.gross_value = 0, 0
+
+        # If an invoice is attached we need to compute net and gross value in the invoice currency
+        if self.invoice:
+            # We get the fx rate (If it is the same currency, then it will be 1)
+            self.invoice_fx_rate = self.currency.convert(self.booking_date, self.invoice.invoice_currency)
+            self.invoice_net_value = self.net_value * self.invoice_fx_rate
+            self.invoice_gross_value = self.gross_value * self.invoice_fx_rate
+
+        super().save(*args, **kwargs)
+
+    objects = BookingEntryDefaultQuerySet.as_manager()
+
+    # The title of the booking entry which describes what was booked
+    title = models.CharField(max_length=255, verbose_name="Title")
+
+    # The date when this booking entry is booked. Most likely the current date
+    booking_date = models.DateField(verbose_name="Booking Date")
+
+    # The date when this booking entry has to be paid / received. If None, this date is not important.
+    due_date = models.DateField(null=True, blank=True, verbose_name="Due Date")
+
+    # The date when this booking entry was paid / received. If None, this booking entry is still "open"
+    payment_date = models.DateField(null=True, blank=True, verbose_name="Payment Date")
+
+    # The reference date represents a date to which accounting period a booking entry belongs
+    reference_date = models.DateField(verbose_name="Reference Date", null=True, blank=True)
+
+    # Either Gross or Net has to be specified. If both are specifying then net is preferred.
+    # If only one is specified the other one is determined based on the given VAT. The default
+    # VAT is 0%. If the value of net/gross is negative, then money is paid.
+    gross_value = models.DecimalField(
+        max_digits=16, decimal_places=4, null=True, blank=True, verbose_name="Gross Value"
+    )
+    net_value = models.DecimalField(max_digits=16, decimal_places=4, null=True, blank=True, verbose_name="Net Value")
+    invoice_gross_value = models.DecimalField(
+        max_digits=16, decimal_places=4, null=True, blank=True, verbose_name="Invoice Gross Value"
+    )
+    invoice_net_value = models.DecimalField(
+        max_digits=16, decimal_places=4, null=True, blank=True, verbose_name="Invoice Net Value"
+    )
+    invoice_fx_rate = models.DecimalField(
+        max_digits=20, decimal_places=6, null=True, blank=True, verbose_name="Invoice FX Rate"
+    )
+    vat = models.DecimalField(max_digits=4, decimal_places=4, default=Decimal(0), verbose_name="VAT")
+
+    # The currency of the booking entry
+    currency = models.ForeignKey(
+        "currency.Currency", related_name="booking_entries", on_delete=models.PROTECT, verbose_name="Currency"
+    )
+
+    invoice = models.ForeignKey(
+        "Invoice",
+        related_name="booking_entries",
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+        verbose_name="Invoice",
+    )
+
+    # The entry who has to pay / receive money
+    counterparty = models.ForeignKey(
+        "directory.Entry", related_name="booking_entries", on_delete=models.PROTECT, verbose_name="Counterparty"
+    )
+
+    # The backlinks stores information and the destination where to find the underlying data
+    # The backlinks is rendered in lists and instances as a button
+    backlinks = models.JSONField(null=True, blank=True)
+
+    # Extra parameters for rendering on an invoice
+    parameters = models.JSONField(null=True, blank=True)
+
+    # Generator that produced this Booking Entry
+    generator = models.CharField(max_length=256, null=True, blank=True)
+
+    @classmethod
+    def get_endpoint_basename(cls):
+        return "wbaccounting:bookingentry"
+
+    @classmethod
+    def get_representation_value_key(cls):
+        return "id"
+
+    @classmethod
+    def get_representation_label_key(cls):
+        return "{{title}}"
+
+    @classmethod
+    def get_representation_endpoint(cls):
+        return "wbaccounting:bookingentryrepresentation-list"
+
+
+@receiver(post_save, sender=BookingEntry)
+def booking_entry_changed(sender, instance: BookingEntry, created: bool, raw: bool, **kwargs):
+    if not raw and (invoice := instance.invoice):
+        invoice.save()
+
+
+@receiver(post_delete, sender=BookingEntry)
+def booking_entry_deleted(sender, instance, **kwargs):
+    if instance.invoice:
+        instance.invoice.save()