feat: add taxJurisdictionCode field to business partner's physical ad…

…dress

- changed API models
- added database column
- adapted the mappings
- enhanced the test data
- updated the api documentation

implements to #955

CHANGELOG.md

@@ -12,6 +12,7 @@ For changes to the BPDM Helm charts please consult the [changelog](charts/bpdm/C
 
 - BPDM Gate: Post endpoint to upload business partner input data using csv file.(#700)
 - BPDM Gate: GET endpoint to download the csv file template for business partner upload. (#700)
+- Apps: Tax Jurisdiction Code to the physical address of a business partner (#955)
 
 ## [6.0.1] - [2024-05-27]
 

bpdm-common-test/src/main/kotlin/org/eclipse/tractusx/bpdm/test/testdata/gate/BusinessPartnerGenericCommonValues.kt

@@ -57,7 +57,8 @@ object BusinessPartnerGenericCommonValues {
             industrialZone = "industrial-zone",
             building = "building",
             floor = "floor",
-            door = "door"
+            door = "door",
+            taxJurisdictionCode = "123"
         ),
         alternativeAddress = AlternativeAddress(
             geographicCoordinates = GeoCoordinate(0.6f, 0.6f, 0.6f),

bpdm-common-test/src/main/kotlin/org/eclipse/tractusx/bpdm/test/testdata/orchestrator/BusinessPartnerTestDataFactory.kt

@@ -132,7 +132,8 @@ class BusinessPartnerTestDataFactory(
                 industrialZone = "Industrial Zone $seed",
                 building = "Building $seed",
                 floor = "Floor $seed",
-                door = "Door $seed"
+                door = "Door $seed",
+                taxJurisdictionCode = "123"
             ),
             alternativeAddress = AlternativeAddress(
                 geographicCoordinates = GeoCoordinate(longitude = random.nextFloat(), latitude = random.nextFloat(), altitude = random.nextFloat()),

bpdm-common-test/src/main/kotlin/org/eclipse/tractusx/bpdm/test/testdata/pool/BusinessPartnerNonVerboseValues.kt

@@ -175,6 +175,7 @@ object BusinessPartnerNonVerboseValues {
         floor = BusinessPartnerVerboseValues.address1.floor,
         door = BusinessPartnerVerboseValues.address1.door,
         street = BusinessPartnerVerboseValues.address1.street,
+        taxJurisdictionCode = BusinessPartnerVerboseValues.address1.taxJurisdictionCode
     )
 
     private val postalAddress2 = PhysicalPostalAddressDto(
@@ -192,6 +193,7 @@ object BusinessPartnerNonVerboseValues {
         floor = BusinessPartnerVerboseValues.address2.floor,
         door = BusinessPartnerVerboseValues.address2.door,
         street = BusinessPartnerVerboseValues.address2.street,
+        taxJurisdictionCode = BusinessPartnerVerboseValues.address2.taxJurisdictionCode
     )
 
     private val postalAddress3 = PhysicalPostalAddressDto(
@@ -209,6 +211,7 @@ object BusinessPartnerNonVerboseValues {
         floor = BusinessPartnerVerboseValues.address3.floor,
         door = BusinessPartnerVerboseValues.address3.door,
         street = BusinessPartnerVerboseValues.address3.street,
+        taxJurisdictionCode = BusinessPartnerVerboseValues.address3.taxJurisdictionCode
     )
 
     val logisticAddress1 = LogisticAddressDto(

bpdm-common-test/src/main/kotlin/org/eclipse/tractusx/bpdm/test/testdata/pool/BusinessPartnerRequestFactory.kt

@@ -180,7 +180,8 @@ class BusinessPartnerRequestFactory(
                 industrialZone = "Industrial Zone $seed",
                 building = "Building $seed",
                 floor = "Floor $seed",
-                door = "Door $seed"
+                door = "Door $seed",
+                taxJurisdictionCode = "Tax Jurisdiction Code $seed"
             ),
             alternativePostalAddress = AlternativePostalAddressDto(
                 geographicCoordinates = GeoCoordinateDto(longitude = random.nextFloat(), latitude = random.nextFloat(), altitude = random.nextFloat()),

bpdm-common-test/src/main/kotlin/org/eclipse/tractusx/bpdm/test/testdata/pool/BusinessPartnerVerboseValues.kt

@@ -163,6 +163,7 @@ object BusinessPartnerVerboseValues {
             additionalNameSuffix = "add name suffix 1",
             additionalNamePrefix = "add name prefix 1"
         ),
+        taxJurisdictionCode = "123"
     )
 
     val address2 = PhysicalPostalAddressVerboseDto(
@@ -189,7 +190,8 @@ object BusinessPartnerVerboseValues {
             namePrefix = "name prefix 2",
             additionalNameSuffix = "add name suffix 2",
             additionalNamePrefix = "add name prefix 2"
-        )
+        ),
+        taxJurisdictionCode = "456"
     )
 
     val address3 = PhysicalPostalAddressVerboseDto(
@@ -217,6 +219,7 @@ object BusinessPartnerVerboseValues {
             additionalNameSuffix = "add name suffix 3",
             additionalNamePrefix = "add name prefix 3"
         ),
+        taxJurisdictionCode = "789"
     )
 
     val addressPartner1 = LogisticAddressVerboseDto(
@@ -361,6 +364,7 @@ object BusinessPartnerVerboseValues {
                 floor = null,
                 door = null,
                 street = null,
+                taxJurisdictionCode = null
             ),
             bpnLegalEntity = null,
             bpnSite = null,
@@ -401,6 +405,7 @@ object BusinessPartnerVerboseValues {
                 floor = null,
                 door = null,
                 street = null,
+                taxJurisdictionCode = null
             ),
             bpnLegalEntity = null,
             bpnSite = null,
@@ -441,6 +446,7 @@ object BusinessPartnerVerboseValues {
                 floor = null,
                 door = null,
                 street = null,
+                taxJurisdictionCode = null
             ),
             bpnLegalEntity = null,
             bpnSite = null,

bpdm-common-test/src/main/kotlin/org/eclipse/tractusx/bpdm/test/testdata/pool/ExpectedBusinessPartnerResultFactory.kt

@@ -264,7 +264,18 @@ class ExpectedBusinessPartnerResultFactory(
                 geographicCoordinates = geographicCoordinates,
                 countryVerbose = TypeKeyNameVerboseDto(country, country.getName()),
                 administrativeAreaLevel1Verbose = administrativeAreaLevel1?.let { mapToExpectedResult(it) },
-                administrativeAreaLevel2, administrativeAreaLevel3, postalCode, city, district, street, companyPostalCode, industrialZone, building, floor, door
+                administrativeAreaLevel2,
+                administrativeAreaLevel3,
+                postalCode,
+                city,
+                district,
+                street,
+                companyPostalCode,
+                industrialZone,
+                building,
+                floor,
+                door,
+                taxJurisdictionCode
             )
         }
     }

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/IBasePhysicalPostalAddressDto.kt

@@ -69,4 +69,7 @@ interface IBasePhysicalPostalAddressDto {
 
     @get:Schema(description = PostalAddressDescription.door)
     val door: String?
+
+    @get:Schema(description = PostalAddressDescription.taxJurisdictionCode)
+    val taxJurisdictionCode: String?
 }

bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/openapidescription/PostalAddressDescription.kt

@@ -50,4 +50,7 @@ object PostalAddressDescription {
             "is assigned multiple times in some cities."
     const val deliveryServiceNumber = "The number indicating the delivery service endpoint of the alternative postal address to which the delivery is " +
             "to be delivered, such as a P.O. box number or a private bag number."
+
+    const val taxJurisdictionCode =
+        "Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."
 }

bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/PhysicalPostalAddressDto.kt

@@ -44,6 +44,7 @@ data class PhysicalPostalAddressDto(
     override val industrialZone: String? = null,
     override val building: String? = null,
     override val floor: String? = null,
-    override val door: String? = null
+    override val door: String? = null,
+    override val taxJurisdictionCode: String? = null
 
 ) : IBasePhysicalPostalAddressDto

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/entity/PhysicalPostalAddressDb.kt

@@ -113,5 +113,11 @@ data class PhysicalPostalAddressDb(
      * Describes the door/room/suite on the respective floor the delivery shall take place
      */
     @Column(name = "phy_door")
-    val door: String?
+    val door: String?,
+
+    /**
+     * The tax jurisdiction code defines the tax authority to which taxes must be paid
+     */
+    @Column(name = "phy_tax_jurisdiction")
+    val taxJurisdictionCode: String? = null
 )

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/model/upsert/output/PhysicalPostalAddress.kt

@@ -35,5 +35,6 @@ data class PhysicalPostalAddress(
     val industrialZone: String?,
     val building: String?,
     val floor: String?,
-    val door: String?
+    val door: String?,
+    val taxJurisdictionCode: String?
 )

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/service/BusinessPartnerMappings.kt

@@ -221,7 +221,8 @@ class BusinessPartnerMappings {
             industrialZone = dto.industrialZone,
             building = dto.building,
             floor = dto.floor,
-            door = dto.door
+            door = dto.door,
+            taxJurisdictionCode = dto.taxJurisdictionCode
         )
 
     private fun toAlternativePostalAddress(dto: AlternativePostalAddressDto) =

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/service/GoldenRecordUpdateService.kt

@@ -218,7 +218,8 @@ class GoldenRecordUpdateService(
             building = building,
             floor = floor,
             door = door,
-            street = street?.toUpsertData()
+            street = street?.toUpsertData(),
+            taxJurisdictionCode = taxJurisdictionCode
         )
     }
 
@@ -345,7 +346,8 @@ class GoldenRecordUpdateService(
             industrialZone = industrialZone,
             building = building,
             floor = floor,
-            door = door
+            door = door,
+            taxJurisdictionCode = taxJurisdictionCode
         )
 
     private fun StreetDto.toEntity() =

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/service/OrchestratorMappings.kt

@@ -116,7 +116,8 @@ class OrchestratorMappings(
                         industrialZone = industrialZone,
                         building = building,
                         floor = floor,
-                        door = door
+                        door = door,
+                        taxJurisdictionCode = taxJurisdictionCode
                     )
                 }
             } ?: PhysicalAddress.empty,
@@ -272,7 +273,8 @@ class OrchestratorMappings(
             industrialZone = dto.industrialZone,
             building = dto.building,
             floor = dto.floor,
-            door = dto.door
+            door = dto.door,
+            taxJurisdictionCode = dto.taxJurisdictionCode
         )
 
     private fun toAlternativePostalAddress(dto: AlternativeAddress) =

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/service/ResponseMappings.kt

@@ -54,7 +54,8 @@ fun PhysicalPostalAddressDb.toPhysicalPostalAddress(): PhysicalPostalAddressDto
         building = building,
         floor = floor,
         door = door,
-        street = street?.toStreetDto()
+        street = street?.toStreetDto(),
+        taxJurisdictionCode = taxJurisdictionCode
     )
 
 fun GeographicCoordinateDb.toGeographicCoordinateDto(): GeoCoordinateDto {

bpdm-gate/src/main/resources/db/migration/V6_1_0_3__add_tax_jurisdiction_code.sql

@@ -0,0 +1,2 @@
+ALTER TABLE postal_addresses
+ADD COLUMN phy_tax_jurisdiction VARCHAR(255);

bpdm-orchestrator-api/src/main/kotlin/org/eclipse/tractusx/orchestrator/api/model/BusinessPartner.kt

@@ -116,13 +116,15 @@ data class PhysicalAddress(
     val industrialZone: String?,
     val building: String?,
     val floor: String?,
-    val door: String?
+    val door: String?,
+    val taxJurisdictionCode: String?
 ){
     companion object {
         val empty: PhysicalAddress = PhysicalAddress(
             GeoCoordinate.empty, null, null, null,
             null, null, null, null, Street.empty, null, null,
-            null, null, null )
+            null, null, null, null
+        )
     }
 }
 

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/PhysicalPostalAddressDto.kt

@@ -44,6 +44,7 @@ data class PhysicalPostalAddressDto(
     override val industrialZone: String?,
     override val building: String?,
     override val floor: String?,
-    override val door: String?
+    override val door: String?,
+    override val taxJurisdictionCode: String?
 
 ) : IBasePhysicalPostalAddressDto

bpdm-pool-api/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/api/model/PhysicalPostalAddressVerboseDto.kt

@@ -54,7 +54,8 @@ data class PhysicalPostalAddressVerboseDto(
     override val industrialZone: String?,
     override val building: String?,
     override val floor: String?,
-    override val door: String?
+    override val door: String?,
+    override val taxJurisdictionCode: String?
 
 ) : IBasePhysicalPostalAddressDto {
 

bpdm-pool/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/entity/PhysicalPostalAddressDb.kt

@@ -127,4 +127,9 @@ class PhysicalPostalAddressDb(
     @Column(name = "phy_door")
     val door: String? = null,
 
-    )
+    /**
+     * The tax jurisdiction code defines the tax authority to which taxes must be paid
+     */
+    @Column(name = "phy_tax_jurisdiction")
+    val taxJurisdictionCode: String? = null
+)

bpdm-pool/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/service/BusinessPartnerBuildService.kt

@@ -634,7 +634,8 @@ class BusinessPartnerBuildService(
                 industrialZone = physicalAddress.industrialZone,
                 building = physicalAddress.building,
                 floor = physicalAddress.floor,
-                door = physicalAddress.door
+                door = physicalAddress.door,
+                taxJurisdictionCode = physicalAddress.taxJurisdictionCode
             )
         }
 

bpdm-pool/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/service/BusinessPartnerEquivalenceMapper.kt

@@ -94,7 +94,8 @@ class BusinessPartnerEquivalenceMapper {
                                 additionalNameSuffix
                             )
                         }
-                    }
+                    },
+                    taxJurisdictionCode = taxJurisdictionCode
                 )
             },
             alternativePostalAddress = with(logisticAddress.alternativePostalAddress) {
@@ -198,7 +199,8 @@ class BusinessPartnerEquivalenceMapper {
         override val industrialZone: String?,
         override val building: String?,
         override val floor: String?,
-        override val door: String?
+        override val door: String?,
+        override val taxJurisdictionCode: String?
     ) : IBasePhysicalPostalAddressDto
 
     data class AlternativeEquivalenceDto(

bpdm-pool/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/service/ResponseMappings.kt

@@ -165,7 +165,8 @@ fun PhysicalPostalAddressDb.toDto(): PhysicalPostalAddressVerboseDto {
         building = building,
         floor = floor,
         door = door,
-        street = street?.toDto()
+        street = street?.toDto(),
+        taxJurisdictionCode = taxJurisdictionCode
     )
 }