wbaccounting 2.2.1__py2.py3-none-any.whl

wbaccounting/viewsets/display/entry_accounting_information.py

@@ -0,0 +1,91 @@
+from typing import Optional
+
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import Display, default
+from wbcore.metadata.configs.display.instance_display.utils import repeat_field
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+
+
+class EntryAccountingInformationDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="entry", label="CRM", width=400),
+                dp.Field(key="tax_id", label="Tax ID"),
+                dp.Field(key="vat", label="VAT", width=100),
+                dp.Field(key="default_currency", label="Currency", width=100),
+                dp.Field(key="send_mail", label="Send Mail", width=100),
+            ],
+            formatting=[
+                dp.Formatting(
+                    column="counterparty_is_private",
+                    formatting_rules=[dp.FormattingRule(condition=("==", True), style={"backgroundColor": "#708090"})],
+                )
+            ],
+            legends=[
+                dp.Legend(
+                    key="counterparty_is_private",
+                    items=[dp.LegendItem(icon="#708090", label="Private Counterparty", value=True)],
+                )
+            ],
+        )
+
+    def get_instance_display(self) -> Display:
+        return dp.Display(
+            pages=[
+                dp.Page(
+                    title="General Information",
+                    layouts={
+                        default(): dp.Layout(
+                            grid_template_areas=[
+                                ["entry", "booking_entry_generator"],
+                                ["counterparty_is_private", "exempt_users"],
+                                ["default_currency", "tax_id"],
+                                ["vat", "default_invoice_type"],
+                                ["external_invoice_users", "."],
+                            ],
+                        )
+                    },
+                ),
+                dp.Page(
+                    title="E-Mail Settings",
+                    layouts={
+                        dp.default(): dp.Layout(
+                            grid_template_areas=[
+                                ["send_mail", "."],
+                                ["email_to", "."],
+                                ["email_cc", "."],
+                                ["email_bcc", "."],
+                                ["email_subject", "."],
+                                [repeat_field(2, "email_body")],
+                            ],
+                            grid_template_columns=["600px", "1fr"],
+                        )
+                    },
+                ),
+                dp.Page(
+                    title="Invoices",
+                    layouts={
+                        default(): dp.Layout(
+                            grid_template_areas=[
+                                ["invoices"],
+                            ],
+                            grid_template_rows=["600px"],
+                            inlines=[dp.Inline(key="invoices", endpoint="invoices")],
+                        )
+                    },
+                ),
+                dp.Page(
+                    title="Bookings",
+                    layouts={
+                        default(): dp.Layout(
+                            grid_template_areas=[
+                                ["bookingentries"],
+                            ],
+                            grid_template_rows=["600px"],
+                            inlines=[dp.Inline(key="bookingentries", endpoint="bookingentries")],
+                        )
+                    },
+                ),
+            ]
+        )

wbaccounting/viewsets/display/invoice.py

@@ -0,0 +1,218 @@
+from typing import Optional
+
+from rest_framework.reverse import reverse
+from wbaccounting.models import Invoice
+from wbcore.contrib.color.enums import WBColor
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    Display,
+    create_simple_display,
+    create_simple_section,
+)
+from wbcore.metadata.configs.display.instance_display.utils import repeat_field
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+
+COLOR_DRAFT = "rgb(255,249,196)"
+COLOR_SUBMITTED = "rgb(51, 204, 255)"
+COLOR_SENT = "rgb(255, 153, 102)"
+COLOR_PAID = "rgb(214, 229, 145)"
+
+
+class InvoiceDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="status", label="Status"),
+                dp.Field(key="type", label="Type"),
+                dp.Field(key="counterparty", label="Counterparty"),
+                dp.Field(key="title", label="Title"),
+                dp.Field(key="invoice_date", label="Invoice Date"),
+                dp.Field(key="reference_date", label="Reference Date"),
+                dp.Field(key="gross_value", label="Gross Value"),
+                dp.Field(key="net_value", label="Net Value"),
+            ],
+            legends=[
+                dp.Legend(
+                    key="status",
+                    items=[
+                        dp.LegendItem(
+                            icon=COLOR_DRAFT,
+                            label=Invoice.Status.DRAFT.label,
+                            value=Invoice.Status.DRAFT.name,
+                        ),
+                        dp.LegendItem(
+                            icon=COLOR_SUBMITTED,
+                            label=Invoice.Status.SUBMITTED.label,
+                            value=Invoice.Status.SUBMITTED.name,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.BLUE_LIGHT.value,
+                            label=Invoice.Status.APPROVED.label,
+                            value=Invoice.Status.APPROVED.name,
+                        ),
+                        dp.LegendItem(
+                            icon=COLOR_SENT,
+                            label=Invoice.Status.SENT.label,
+                            value=Invoice.Status.SENT.name,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.GREEN_LIGHT.value,
+                            label=Invoice.Status.PAID.label,
+                            value=Invoice.Status.PAID.name,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.GREY.value,
+                            label=Invoice.Status.CANCELLED.label,
+                            value=Invoice.Status.CANCELLED.name,
+                        ),
+                    ],
+                )
+            ],
+            formatting=[
+                dp.Formatting(
+                    column="status",
+                    formatting_rules=[
+                        dp.FormattingRule(
+                            style={"backgroundColor": COLOR_DRAFT},
+                            condition=("==", Invoice.Status.DRAFT.name),
+                        ),
+                        dp.FormattingRule(
+                            style={"backgroundColor": COLOR_SUBMITTED},
+                            condition=("==", Invoice.Status.SUBMITTED.name),
+                        ),
+                        dp.FormattingRule(
+                            style={"backgroundColor": WBColor.BLUE_LIGHT.value},
+                            condition=("==", Invoice.Status.APPROVED.name),
+                        ),
+                        dp.FormattingRule(
+                            style={"backgroundColor": COLOR_SENT},
+                            condition=("==", Invoice.Status.SENT.name),
+                        ),
+                        dp.FormattingRule(
+                            style={"backgroundColor": WBColor.GREEN_LIGHT.value},
+                            condition=("==", Invoice.Status.PAID.name),
+                        ),
+                        dp.FormattingRule(
+                            style={"backgroundColor": WBColor.GREY.value},
+                            condition=("==", Invoice.Status.CANCELLED.name),
+                        ),
+                    ],
+                ),
+            ],
+        )
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [
+                [repeat_field(2, "status")],
+                ["title", "invoice_type"],
+                ["counterparty", "reference_date"],
+                ["invoice_date", "invoice_currency"],
+                ["text_above", "text_below"],
+                [repeat_field(2, "booking_entry_section")],
+            ],
+            [
+                create_simple_section(
+                    "booking_entry_section", "Booking Entries", [["bookingentries"]], "bookingentries", collapsed=True
+                )
+            ],
+        )
+
+
+class ConsolidatedInvoiceDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> dp.ListDisplay:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="value", label="Value"),
+            ],
+            tree=True,
+            tree_group_pinned="left",
+            tree_group_field="group",
+            tree_group_label="Group",
+            tree_group_level_options=[
+                dp.TreeGroupLevelOption(
+                    filter_key="lookup",
+                    list_endpoint=reverse(
+                        "wbaccounting:consolidated-invoice-list",
+                        args=[],
+                        request=self.request,
+                    ),
+                )
+            ],
+            legends=[
+                dp.Legend(
+                    key="status",
+                    label="Lowest Status",
+                    items=[
+                        dp.LegendItem(
+                            icon=COLOR_DRAFT,
+                            label=Invoice.Status.DRAFT.label,
+                            value=Invoice.Status.DRAFT.name,
+                        ),
+                        dp.LegendItem(
+                            icon=COLOR_SUBMITTED,
+                            label=Invoice.Status.SUBMITTED.label,
+                            value=Invoice.Status.SUBMITTED.name,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.BLUE_LIGHT.value,
+                            label=Invoice.Status.APPROVED.label,
+                            value=Invoice.Status.APPROVED.name,
+                        ),
+                        dp.LegendItem(
+                            icon=COLOR_SENT,
+                            label=Invoice.Status.SENT.label,
+                            value=Invoice.Status.SENT.name,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.GREEN_LIGHT.value,
+                            label=Invoice.Status.PAID.label,
+                            value=Invoice.Status.PAID.name,
+                        ),
+                        dp.LegendItem(
+                            icon=WBColor.GREY.value,
+                            label=Invoice.Status.CANCELLED.label,
+                            value=Invoice.Status.CANCELLED.name,
+                        ),
+                    ],
+                ),
+            ],
+            formatting=[
+                dp.Formatting(
+                    column="num_paid",
+                    formatting_rules=[
+                        dp.FormattingRule(
+                            style={"backgroundColor": COLOR_PAID},
+                            condition=(">", 0),
+                        )
+                    ],
+                ),
+                dp.Formatting(
+                    column="num_sent",
+                    formatting_rules=[
+                        dp.FormattingRule(
+                            style={"backgroundColor": COLOR_SENT},
+                            condition=(">", 0),
+                        )
+                    ],
+                ),
+                dp.Formatting(
+                    column="num_submitted",
+                    formatting_rules=[
+                        dp.FormattingRule(
+                            style={"backgroundColor": COLOR_SUBMITTED},
+                            condition=(">", 0),
+                        )
+                    ],
+                ),
+                dp.Formatting(
+                    column="num_draft",
+                    formatting_rules=[
+                        dp.FormattingRule(
+                            style={"backgroundColor": COLOR_DRAFT},
+                            condition=(">", 0),
+                        )
+                    ],
+                ),
+            ],
+        )

wbaccounting/viewsets/display/invoice_type.py

@@ -0,0 +1,19 @@
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    Display,
+    create_simple_display,
+)
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+
+
+class InvoiceTypeDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> dp.ListDisplay:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="name", label="Name"),
+                dp.Field(key="processor", label="Processor"),
+            ]
+        )
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display([["name", "processor"]])

wbaccounting/viewsets/display/transactions.py

@@ -0,0 +1,35 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    Display,
+    create_simple_display,
+)
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+
+
+class TransactionDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> dp.ListDisplay:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="booking_date", label=_("Booking Date"), width=150),
+                dp.Field(key="value_date", label=_("Value Date"), width=150),
+                dp.Field(key="bank_account", label=_("Bank Account"), width=450),
+                # dp.Field(key="from_bank_account", label=_("Source"), width=300),
+                # dp.Field(key="to_bank_account", label=_("Target"), width=300),
+                dp.Field(key="value_local_ccy", label=_("Value (Local)"), width=150),
+                dp.Field(key="value", label=_("Value"), width=150),
+                dp.Field(key="description", label=_("Description"), width=450),
+            ]
+        )
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [
+                ["booking_date", "value_date"],
+                ["bank_account", "."],
+                ["from_bank_account", "to_bank_account"],
+                ["value", "currency"],
+                ["value_local_ccy", "fx_rate"],
+                ["description", "description"],
+            ]
+        )

wbaccounting/viewsets/endpoints/__init__.py

@@ -0,0 +1 @@
+from .invoice import ConsolidatedInvoiceEndpointConfig

wbaccounting/viewsets/endpoints/invoice.py

@@ -0,0 +1,6 @@
+from wbcore.metadata.configs.endpoints import EndpointViewConfig
+
+
+class ConsolidatedInvoiceEndpointConfig(EndpointViewConfig):
+    def _get_instance_endpoint(self, **kwargs):
+        return "{{casted_endpoint}}"

wbaccounting/viewsets/entry_accounting_information.py

@@ -0,0 +1,143 @@
+from datetime import date
+
+from django.db.models import Exists, OuterRef, QuerySet
+from rest_framework import status
+from rest_framework.decorators import action
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
+from wbaccounting.models import EntryAccountingInformation, Invoice
+from wbaccounting.models.booking_entry import BookingEntry
+from wbaccounting.serializers import (
+    EntryAccountingInformationModelSerializer,
+    EntryAccountingInformationRepresentationSerializer,
+)
+from wbaccounting.viewsets.buttons import EntryAccountingInformationButtonConfig
+from wbaccounting.viewsets.display import EntryAccountingInformationDisplayConfig
+from wbaccounting.viewsets.titles import EntryAccountingInformationTitleConfig
+from wbcore import viewsets
+from wbcore.utils.date import get_date_interval_from_request
+
+
+class EntryAccountingInformationRepresentationViewSet(viewsets.RepresentationViewSet):
+    search_fields = ("entry__computed_str",)
+    queryset = EntryAccountingInformation.objects.all()
+    serializer_class = EntryAccountingInformationRepresentationSerializer
+
+    def get_queryset(self):
+        return EntryAccountingInformation.objects.filter_for_user(self.request.user)
+
+
+class EntryAccountingInformationModelViewSet(viewsets.ModelViewSet):
+    IDENTIFIER = "wbaccounting:entryaccountinginformation"
+    filterset_fields = {
+        "entry": ["exact"],
+        "tax_id": ["exact", "icontains"],
+        "vat": ["gte", "exact", "lte"],
+        "default_currency": ["gte", "exact", "lte"],
+        "send_mail": ["exact"],
+        "counterparty_is_private": ["exact"],
+        "exempt_users": ["exact"],
+    }
+
+    serializer_class = EntryAccountingInformationModelSerializer
+    queryset = EntryAccountingInformation.objects.all()
+
+    search_fields = ["entry__computed_str"]
+    ordering_fields = ["tax_id", "vat", "send_mail", "counterparty_is_private"]
+    ordering = ["id"]
+
+    display_config_class = EntryAccountingInformationDisplayConfig
+    title_config_class = EntryAccountingInformationTitleConfig
+    button_config_class = EntryAccountingInformationButtonConfig
+
+    def get_queryset(self) -> QuerySet[EntryAccountingInformation]:
+        return (
+            EntryAccountingInformation.objects.filter_for_user(self.request.user)
+            .select_related(
+                "entry",
+                "default_currency",
+                "default_invoice_type",
+            )
+            .prefetch_related(
+                "exempt_users",
+                "email_to",
+                "email_cc",
+                "email_bcc",
+            )
+        )
+
+    @action(detail=True, methods=["POST"], permission_classes=[IsAuthenticated])
+    def generate_booking_entries(self, request, pk):
+        if (
+            (user := request.user)
+            and (user.is_superuser or user.has_perm("wbaccounting.can_generate_booking_entries"))
+            and (eai := self.get_object())
+            and eai is not None
+        ):
+            start, end = get_date_interval_from_request(request, request_type="POST")
+            eai.generate_booking_entries(start, end)  # type: ignore
+        return Response(
+            {"__notification": {"title": "Booking Entries are being generated in the background."}},
+            status=status.HTTP_200_OK,
+        )
+
+    @action(detail=False, methods=["POST"], permission_classes=[IsAuthenticated])
+    def generate_booking_entries_for_counterparties(self, request, pk=None):
+        eais = EntryAccountingInformation.objects.filter(entry__id__in=request.POST.get("counterparties").split(","))
+
+        if (
+            (user := request.user)
+            and (user.is_superuser or user.has_perm("wbaccounting.can_generate_booking_entries"))
+            and eais.exists()
+        ):
+            for eai in eais:
+                start, end = get_date_interval_from_request(request, request_type="POST")
+                eai.generate_booking_entries(start, end)  # type: ignore
+        return Response(
+            {"__notification": {"title": "Booking Entries are being generated in the background."}},
+            status=status.HTTP_200_OK,
+        )
+
+    @action(detail=False, methods=["POST"], permission_classes=[IsAuthenticated])
+    def generate_invoices_for_counterparties(self, request, pk=None):
+        try:
+            eais = EntryAccountingInformation.objects.filter(
+                entry__id__in=request.POST.get("counterparties").split(",")
+            )
+        except AttributeError:
+            eais = EntryAccountingInformation.objects.all()
+
+        if (
+            (user := request.user)
+            and (user.is_superuser or user.has_perm("wbaccounting.can_generate_invoice"))
+            and eais.exists()
+        ):
+            eais = eais.annotate(
+                has_open_bookings=Exists(
+                    BookingEntry.objects.filter(
+                        counterparty=OuterRef("entry"),
+                        invoice__isnull=True,
+                        payment_date__isnull=True,
+                    )
+                )
+            ).filter(has_open_bookings=True)
+            for eai in eais:
+                Invoice.objects.create_for_counterparty(eai.entry, invoice_date=date.today())
+        return Response(
+            {"__notification": {"title": "Invoices are being generated in the background."}},
+            status=status.HTTP_200_OK,
+        )
+
+    @action(detail=True, methods=["POST"], permission_classes=[IsAuthenticated])
+    def invoice_booking_entries(self, request, pk):
+        if (
+            (user := request.user)
+            and (user.is_superuser or user.has_perm("wbaccounting.can_generate_invoice"))
+            and (eai := self.get_object())
+            and eai is not None
+        ):
+            Invoice.objects.create_for_counterparty(eai.entry, invoice_date=date.today())
+        return Response(
+            {"__notification": {"title": "Booking Entries are being generated in the background."}},
+            status=status.HTTP_200_OK,
+        )