Merge pull request #592 from maykinmedia/feature/529-subidentificator-filter

✨ [#529] Add filtering by subIdentificatorVan in partijen en…

Author: OlhaZahoruiko

src/openklant/components/klantinteracties/api/filterset/partijen.py

@@ -60,6 +60,46 @@ class PartijFilterSet(FilterSet):
         help_text=_("Zoek partij object op basis van categorie namen."),
         method="filter_categorierelatie_categorie_naam",
     )
+    sub_identificator_van__object_id = filters.CharFilter(
+        help_text=_(
+            "Zoek partij object op basis van het ``subIdentificatorVan`` object ID. "
+            "Deze parameter kan gecombineerd worden met de ``partijIdentificator__`` "
+            "parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__`` "
+            "de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__`` "
+            "de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is."
+        ),
+        method="filter_sub_identificator_object_id",
+    )
+    sub_identificator_van__code_objecttype = filters.CharFilter(
+        help_text=_(
+            "Zoek partij object op basis van het ``subIdentificatorVan`` objecttype. "
+            "Deze parameter kan gecombineerd worden met de ``partijIdentificator__`` "
+            "parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__`` "
+            "de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__`` "
+            "de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is."
+        ),
+        method="filter_sub_identificator_code_objecttype",
+    )
+    sub_identificator_van__code_soort_object_id = filters.CharFilter(
+        help_text=_(
+            "Zoek partij object op basis van het ``subIdentificatorVan`` soort object ID. "
+            "Deze parameter kan gecombineerd worden met de ``partijIdentificator__`` "
+            "parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__`` "
+            "de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__`` "
+            "de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is."
+        ),
+        method="filter_sub_identificator_code_soort_object_id",
+    )
+    sub_identificator_van__code_register = filters.CharFilter(
+        help_text=_(
+            "Zoek partij object op basis van het ``subIdentificatorVan`` register. "
+            "Deze parameter kan gecombineerd worden met de ``partijIdentificator__`` "
+            "parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__`` "
+            "de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__`` "
+            "de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is."
+        ),
+        method="filter_sub_identificator_code_register",
+    )
 
     expand = ExpandFilter(serializer_class=PartijSerializer)
 
@@ -72,6 +112,10 @@ class Meta:
             "partij_identificator__code_soort_object_id",
             "partij_identificator__object_id",
             "partij_identificator__code_register",
+            "sub_identificator_van__code_objecttype",
+            "sub_identificator_van__code_soort_object_id",
+            "sub_identificator_van__object_id",
+            "sub_identificator_van__code_register",
             "categorierelatie__categorie__naam",
             "nummer",
             "indicatie_geheimhouding",
@@ -130,6 +174,38 @@ def filter_categorierelatie_categorie_naam(self, queryset, name, value):
         except ValueError:
             return queryset.none()
 
+    def filter_sub_identificator_object_id(self, queryset, name, value):
+        try:
+            return queryset.filter(
+                partijidentificator__sub_identificator_van__partij_identificator_object_id=value
+            ).distinct()
+        except ValueError:
+            return queryset.none()
+
+    def filter_sub_identificator_code_objecttype(self, queryset, name, value):
+        try:
+            return queryset.filter(
+                partijidentificator__sub_identificator_van__partij_identificator_code_objecttype=value
+            ).distinct()
+        except ValueError:
+            return queryset.none()
+
+    def filter_sub_identificator_code_soort_object_id(self, queryset, name, value):
+        try:
+            return queryset.filter(
+                partijidentificator__sub_identificator_van__partij_identificator_code_soort_object_id=value
+            ).distinct()
+        except ValueError:
+            return queryset.none()
+
+    def filter_sub_identificator_code_register(self, queryset, name, value):
+        try:
+            return queryset.filter(
+                partijidentificator__sub_identificator_van__partij_identificator_code_register=value
+            ).distinct()
+        except ValueError:
+            return queryset.none()
+
 
 class VertegenwoordigdenFilterSet(FilterSet):
     vertegenwoordigende_partij__url = URLViewFilter(

src/openklant/components/klantinteracties/api/tests/test_filters.py

@@ -1321,6 +1321,202 @@ def test_invalid_filters(self):
         self.assertEqual(error["code"], UNKNOWN_PARAMETERS_CODE)
         self.assertEqual(error["reason"], ("Onbekende query parameters: invalid"))
 
+    def test_filter_by_vestigingsnummer_and_kvk_returns_correct_partij(self):
+        company_a, company_b = PartijFactory.create_batch(2)
+
+        kvk_a = PartijIdentificatorFactory.create(
+            partij=company_a,
+            partij_identificator_code_objecttype="niet_natuurlijk_persoon",
+            partij_identificator_code_soort_object_id="kvk_nummer",
+            partij_identificator_object_id="12345678",
+        )
+
+        kvk_b = PartijIdentificatorFactory.create(
+            partij=company_b,
+            partij_identificator_code_objecttype="niet_natuurlijk_persoon",
+            partij_identificator_code_soort_object_id="kvk_nummer",
+            partij_identificator_object_id="87654321",
+        )
+
+        vestiging_a = PartijFactory.create()
+        vestiging_b = PartijFactory.create()
+
+        PartijIdentificatorFactory.create(
+            partij=vestiging_a,
+            sub_identificator_van=kvk_a,
+            partij_identificator_code_objecttype="vestiging",
+            partij_identificator_code_soort_object_id="vestigingsnummer",
+            partij_identificator_object_id="000012345678",
+        )
+
+        PartijIdentificatorFactory.create(
+            partij=vestiging_b,
+            sub_identificator_van=kvk_b,
+            partij_identificator_code_objecttype="vestiging",
+            partij_identificator_code_soort_object_id="vestigingsnummer",
+            partij_identificator_object_id="000012345678",
+        )
+
+        response = self.client.get(
+            self.url,
+            {
+                "subIdentificatorVan__objectId": "12345678",
+                "partijIdentificator__objectId": "000012345678",
+            },
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()["results"]
+
+        self.assertEqual(1, len(data))
+        self.assertEqual(str(vestiging_a.uuid), data[0]["uuid"])
+
+    def test_filter_only_by_vestigingsnummer_returns_multiple(self):
+        company_a, company_b = PartijFactory.create_batch(2)
+
+        kvk_a = PartijIdentificatorFactory.create(
+            partij=company_a,
+            partij_identificator_code_objecttype="niet_natuurlijk_persoon",
+            partij_identificator_code_soort_object_id="kvk_nummer",
+            partij_identificator_object_id="12345678",
+        )
+
+        kvk_b = PartijIdentificatorFactory.create(
+            partij=company_b,
+            partij_identificator_code_objecttype="niet_natuurlijk_persoon",
+            partij_identificator_code_soort_object_id="kvk_nummer",
+            partij_identificator_object_id="87654321",
+        )
+
+        vestiging_a = PartijFactory.create()
+        vestiging_b = PartijFactory.create()
+
+        PartijIdentificatorFactory.create(
+            partij=vestiging_a,
+            sub_identificator_van=kvk_a,
+            partij_identificator_code_objecttype="vestiging",
+            partij_identificator_code_soort_object_id="vestigingsnummer",
+            partij_identificator_object_id="000012345678",
+        )
+
+        PartijIdentificatorFactory.create(
+            partij=vestiging_b,
+            sub_identificator_van=kvk_b,
+            partij_identificator_code_objecttype="vestiging",
+            partij_identificator_code_soort_object_id="vestigingsnummer",
+            partij_identificator_object_id="000012345678",
+        )
+
+        response = self.client.get(
+            self.url,
+            {"partijIdentificator__objectId": "000012345678"},
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()["results"]
+
+        self.assertEqual(2, len(data))
+        self.assertEqual(data[0]["uuid"], str(vestiging_b.uuid))
+        self.assertEqual(data[1]["uuid"], str(vestiging_a.uuid))
+
+    def test_filter_by_sub_identificator_code_objecttype(self):
+        company = PartijFactory.create()
+
+        kvk = PartijIdentificatorFactory.create(
+            partij=company,
+            partij_identificator_code_objecttype="niet_natuurlijk_persoon",
+            partij_identificator_code_soort_object_id="kvk_nummer",
+            partij_identificator_object_id="12345678",
+        )
+
+        vestiging = PartijFactory.create()
+
+        PartijIdentificatorFactory.create(
+            partij=vestiging,
+            sub_identificator_van=kvk,
+            partij_identificator_code_objecttype="vestiging",
+            partij_identificator_code_soort_object_id="vestigingsnummer",
+            partij_identificator_object_id="000012345678",
+        )
+
+        response = self.client.get(
+            self.url, {"subIdentificatorVan__codeObjecttype": "niet_natuurlijk_persoon"}
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()["results"]
+
+        self.assertEqual(1, len(data))
+        self.assertEqual(str(vestiging.uuid), data[0]["uuid"])
+
+    def test_filter_by_sub_identificator_code_soort_object_id(self):
+        company = PartijFactory.create()
+
+        kvk = PartijIdentificatorFactory.create(
+            partij=company,
+            partij_identificator_code_objecttype="niet_natuurlijk_persoon",
+            partij_identificator_code_soort_object_id="kvk_nummer",
+            partij_identificator_object_id="12345678",
+        )
+
+        vestiging = PartijFactory.create()
+
+        PartijIdentificatorFactory.create(
+            partij=vestiging,
+            sub_identificator_van=kvk,
+            partij_identificator_code_objecttype="vestiging",
+            partij_identificator_code_soort_object_id="vestigingsnummer",
+            partij_identificator_object_id="000012345678",
+        )
+
+        response = self.client.get(
+            self.url, {"subIdentificatorVan__codeSoortObjectId": "kvk_nummer"}
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()["results"]
+
+        self.assertEqual(1, len(data))
+        self.assertEqual(str(vestiging.uuid), data[0]["uuid"])
+
+    def test_filter_by_sub_identificator_code_register(self):
+        company = PartijFactory.create()
+
+        kvk = PartijIdentificatorFactory.create(
+            partij=company,
+            partij_identificator_code_objecttype="niet_natuurlijk_persoon",
+            partij_identificator_code_soort_object_id="kvk_nummer",
+            partij_identificator_object_id="12345678",
+            partij_identificator_code_register="hr",
+        )
+
+        vestiging = PartijFactory.create()
+
+        PartijIdentificatorFactory.create(
+            partij=vestiging,
+            sub_identificator_van=kvk,
+            partij_identificator_code_objecttype="vestiging",
+            partij_identificator_code_soort_object_id="vestigingsnummer",
+            partij_identificator_object_id="000012345678",
+            partij_identificator_code_register="hr",
+        )
+
+        response = self.client.get(
+            self.url,
+            {"subIdentificatorVan__codeRegister": "hr"},
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()["results"]
+
+        self.assertEqual(1, len(data))
+        self.assertEqual(str(vestiging.uuid), data[0]["uuid"])
+
 
 class CategorieRelatieFiltersetTests(APITestCase):
     url = reverse("klantinteracties:categorierelatie-list")

src/openklant/components/klantinteracties/migrations/0043_alter_partijidentificator_sub_identificator_van.py

@@ -0,0 +1,27 @@
+# Generated by Django 5.2.12 on 2026-04-09 10:18
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("klantinteracties", "0042_klantcontact_reactie_alter_klantcontact_inhoud"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="partijidentificator",
+            name="sub_identificator_van",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="The parent PartijIdentificator under which this PartijIdentificator is unique (e.g. the parent identificator could specify a KVK number and the child identificator could specify a vestigingsnummer that is unique for the KVK number).",
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="sub_partij_identificatoren",
+                to="klantinteracties.partijidentificator",
+                verbose_name="sub identificator van",
+            ),
+        ),
+    ]

src/openklant/components/klantinteracties/models/partijen.py

@@ -316,7 +316,7 @@ class PartijIdentificator(models.Model):
         ),
         blank=True,
         null=True,
-        related_name="parent_partij_identificator",
+        related_name="sub_partij_identificatoren",
     )
     partij = models.ForeignKey(
         Partij,

src/openklant/components/klantinteracties/models/validators.py

@@ -77,7 +77,7 @@ def check_related_partij_identificatoren(self):
         Checking the case where the `partij_identificator` with a specific codeSoortObjectId
         doesn't have any other `partij_identificatoren` attached to it
         """
-        if self.instance.parent_partij_identificator.exists():
+        if self.instance.sub_partij_identificatoren.exists():
             raise ValidationError(
                 {
                     "partij_identificator_code_soort_object_id": _(

src/openklant/components/klantinteracties/openapi.yaml

@@ -3118,6 +3118,42 @@ paths:
         description: |+
           Geeft aan van welke specifieke soort partij sprake is.
 
+      - in: query
+        name: subIdentificatorVan__codeObjecttype
+        schema:
+          type: string
+        description: Zoek partij object op basis van het ``subIdentificatorVan`` objecttype.
+          Deze parameter kan gecombineerd worden met de ``partijIdentificator__``
+          parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__``
+          de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__``
+          de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is.
+      - in: query
+        name: subIdentificatorVan__codeRegister
+        schema:
+          type: string
+        description: Zoek partij object op basis van het ``subIdentificatorVan`` register.
+          Deze parameter kan gecombineerd worden met de ``partijIdentificator__``
+          parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__``
+          de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__``
+          de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is.
+      - in: query
+        name: subIdentificatorVan__codeSoortObjectId
+        schema:
+          type: string
+        description: Zoek partij object op basis van het ``subIdentificatorVan`` soort
+          object ID. Deze parameter kan gecombineerd worden met de ``partijIdentificator__``
+          parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__``
+          de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__``
+          de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is.
+      - in: query
+        name: subIdentificatorVan__objectId
+        schema:
+          type: string
+        description: Zoek partij object op basis van het ``subIdentificatorVan`` object
+          ID. Deze parameter kan gecombineerd worden met de ``partijIdentificator__``
+          parameters om een specifieke vestiging te vinden, door bij ``partijIdentificator__``
+          de vestigingspecifieke informatie mee te geven en bij ``subIdentificatorVan__``
+          de informatie van de rechtspersoon waaraan deze vestiging gekoppeld is.
       - in: query
         name: vertegenwoordigdePartij__url
         schema: