OVPAY-2473 - Fixed HATEOAS in example.

Reviewed-on: #55

src/java/ABTProductsPUTGenerator/.idea/misc.xml

@@ -8,7 +8,7 @@
       </list>
     </option>
   </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="temurin-21" project-jdk-type="JavaSDK">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="17" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
 </project>

src/java/ABTProductsPUTGenerator/bin/README.md

@@ -1,7 +1,9 @@
 # ABTProducts PUT request body generator
 Simple tool to quickly edit HTM products via ABTProducts REST API.
 
-- Requires JRE 21
+- Requires JRE 17
+
+## Generating a PUT output (that you need to supply to PUT API yourself):
 - Run via: `java -jar ABTProductsPUTGenerator.jar`
   - Specify custom input/output path via: `java -jar ABTProductsPUTGenerator.jar <inputPath> <outputPath>`
 - Takes a ABTProducts GET response body in JSON format (product details)
@@ -10,3 +12,14 @@ Simple tool to quickly edit HTM products via ABTProducts REST API.
   - `curl -X PUT -H 'Content-Type: application/json' {baseUrl}/abt/abtproducts/1.0/38 --data @output.json`
 - Default input path: /input.json
 - Default output path: /output.json (output is overwritten if it exists)
+  
+## Bulk clearing (set to null) of a certain product attribute for all productIds in a product-tree (SE product reponse)
+- Run via: `java -jar ABTProductsPUTGenerator.jar clearAttribute <inputPath> <attributeToClear> <environment> <wso2BearerToken>`
+- Takes a SE GET product tree response body or ABTProducts GET response body in JSON format
+- Also needs the attribute to clear and the WSO2 environment and valid WSO2 bearer token for that environment
+- Performs the following operations:
+  - Finds all productId's in the given product(tree) and for each productId found:
+    - GETs productdetails via ABTProducts API
+    - Converts it to PUT request body using the functionality in the previous section
+    - Replaces <attributeToClear> with `null`
+    - Actually sends the modified PUT request body to ABTProducts PUT API

src/java/ABTProductsPUTGenerator/pom.xml

@@ -58,8 +58,8 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <configuration>
-          <source>21</source>
-          <target>21</target>
+          <source>17</source>
+          <target>17</target>
         </configuration>
       </plugin>
     </plugins>

src/java/ABTProductsPUTGenerator/src/main/java/nl/htm/ovpay/abt/ABTProductsPUTGenerator.java

@@ -3,8 +3,11 @@ package nl.htm.ovpay.abt;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
+import java.util.Scanner;
+import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -19,6 +22,15 @@ public class ABTProductsPUTGenerator {
     private static final Logger LOGGER = LoggerFactory.getLogger(ABTProductsPUTGenerator.class);
 
     public static void main(String[] args) throws Exception {
+        LOGGER.info("Starting ABTProductsPUTGenerator with arguments {}", Arrays.stream(args).toList());
+        if (args.length > 0 && args[0].equalsIgnoreCase("clearAttribute")) {
+            clearAttribute(args);
+        } else {
+            generateOutput(args);
+        }
+    }
+
+    private static void generateOutput(String[] args) throws Exception {
         if (args.length != 2) {
             LOGGER.info("To modify input/output path, use: java -jar ABTProductsPUTGenerator.jar <inputPath> <outputPath>");
         }
@@ -40,6 +52,49 @@ public class ABTProductsPUTGenerator {
         }
     }
 
+    private static void clearAttribute(String[] args) throws Exception {
+        if (args.length != 5) {
+            LOGGER.error("Incorrect input parameters!");
+            LOGGER.error("To clear attribute, use: java -jar ABTProductsPUTGenerator.jar clearAttribute <inputPath> <attributeToClear> <environment> <wso2BearerToken>");
+            return;
+        }
+
+        var inputFile = args[1];
+        var attributeToClear = args[2];
+        var environment = args[3];
+        var wso2BearerToken = args[4];
+
+        try (InputStream is = getInputStream(inputFile)) {
+            ObjectMapper mapper = new ObjectMapper();
+            JsonNode jsonNode = mapper.readTree(is);
+            var productIds = jsonNode.findValues("productId").stream().filter(JsonNode::isValueNode).map(JsonNode::asText).toList();
+
+            LOGGER.info("Found productIds to process: {}", productIds);
+            LOGGER.warn("Are you SURE you want to set attribute \"{}\" for all these productIds on environment {} to NULL?", attributeToClear, environment);
+            LOGGER.warn("Type 'yes' to continue...");
+            var input = new Scanner(System.in).nextLine();
+            if (!input.equalsIgnoreCase("yes")) {
+                LOGGER.info("Aborting...");
+                return;
+            }
+
+            for (var productId : productIds) {
+                LOGGER.info("Getting product details for product {}...", productId);
+                var productJsonString = APIHelper.getProductDetails(environment, productId, wso2BearerToken);
+                var productJsonNode = mapper.readTree(productJsonString);
+                var putJsonNode = processJsonNode(productJsonNode);
+                LOGGER.info("Clearing attribute \"{}\" from product with productId {}...", attributeToClear, productId);
+                ((ObjectNode)putJsonNode).putRawValue(attributeToClear, null);
+
+                LOGGER.info("PUT product details for product with productId {} with cleared attribute \"{}\"...", productId, attributeToClear);
+                LOGGER.info("PUT product details with JSON body: {}", putJsonNode.toPrettyString());
+                APIHelper.putProductDetails(environment, productId, putJsonNode.toString(), wso2BearerToken);
+            }
+
+            LOGGER.info("DONE clearing attribute \"{}\" for productIds {}!", attributeToClear, productIds);
+        }
+    }
+
     private static InputStream getInputStream(String filePath) throws IOException {
         var externalResource = new File(filePath);
         if (externalResource.exists()) {

src/java/ABTProductsPUTGenerator/src/main/java/nl/htm/ovpay/abt/APIHelper.java

@@ -0,0 +1,89 @@
+package nl.htm.ovpay.abt;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.net.URLConnection;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import java.security.KeyManagementException;
+import java.security.NoSuchAlgorithmException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.StringJoiner;
+import javax.net.ssl.HttpsURLConnection;
+import javax.net.ssl.SSLContext;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class APIHelper {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(APIHelper.class);
+    private static final String PRODUCT_DETAILS_URI = "https://services.<ENV>.api.htm.nl/abt/abtproducts/1.0/products/<PRODUCTID>";
+
+
+    public static String envToUriPart(String environment) {
+        return switch (environment) {
+            case "DEV" -> "dev";
+            case "ACC" -> "acc";
+            case "PRD" -> "";
+            default -> throw new IllegalArgumentException("Invalid environment: " + environment);
+        };
+    }
+
+    public static String getProductDetails(String environment, String productId, String wso2BearerToken) throws Exception {
+        var envUriPart = envToUriPart(environment);
+        var getProductDetailsUri = PRODUCT_DETAILS_URI.replace("<ENV>", envUriPart).replace("<PRODUCTID>", productId);
+
+        SSLContext sc = SSLContext.getInstance("SSL");
+        sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
+        HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
+
+        URL url = new URL(getProductDetailsUri);
+        URLConnection con = url.openConnection();
+        HttpURLConnection http = (HttpURLConnection)con;
+        http.setRequestMethod("GET");
+        http.setDoOutput(false);
+        http.setRequestProperty("Authorization", "Bearer " + wso2BearerToken);
+        http.connect();
+
+        try(InputStream is = http.getInputStream()) {
+            return new String(is.readAllBytes(), StandardCharsets.UTF_8);
+        }
+    }
+
+    public static void putProductDetails(String environment, String productId, String jsonBody, String wso2BearerToken) throws Exception {
+        var envUriPart = envToUriPart(environment);
+        var putProductDetailsUri = PRODUCT_DETAILS_URI.replace("<ENV>", envUriPart).replace("<PRODUCTID>", productId);
+
+        LOGGER.info("PUT product details to URI: {}", putProductDetailsUri);
+
+        SSLContext sc = SSLContext.getInstance("SSL");
+        sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
+        HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
+
+        URL url = new URL(putProductDetailsUri);
+        URLConnection con = url.openConnection();
+        HttpURLConnection http = (HttpURLConnection)con;
+        http.setRequestMethod("PUT");
+        http.setDoOutput(true);
+        http.setRequestProperty("Authorization", "Bearer " + wso2BearerToken);
+        http.setRequestProperty("Content-Type", "application/json");
+
+        byte[] out = jsonBody.getBytes(StandardCharsets.UTF_8);
+        int length = out.length;
+        http.setFixedLengthStreamingMode(length);
+        http.connect();
+
+        try(OutputStream os = http.getOutputStream()) {
+            os.write(out);
+        }
+
+        try(InputStream is = http.getInputStream()) {
+            LOGGER.info("Got response from PUT API: {}", new String(is.readAllBytes(), StandardCharsets.UTF_8));
+        }
+    }
+}

src/java/ABTProductsPUTGenerator/src/main/java/nl/htm/ovpay/abt/DummyX509TrustManager.java

@@ -0,0 +1,38 @@
+package nl.htm.ovpay.abt;
+
+import java.security.cert.X509Certificate;
+import javax.net.ssl.TrustManager;
+import javax.net.ssl.X509TrustManager;
+
+public final class DummyX509TrustManager implements X509TrustManager {
+
+    private static DummyX509TrustManager INSTANCE;
+
+    private DummyX509TrustManager() {
+        // prevent instantiation
+    }
+
+    public static DummyX509TrustManager getInstance() {
+        if (INSTANCE == null) {
+            INSTANCE = new DummyX509TrustManager();
+        }
+        return INSTANCE;
+    }
+
+    public static TrustManager[] getDummyArray() {
+        if (INSTANCE == null) {
+            INSTANCE = new DummyX509TrustManager();
+        }
+        return new TrustManager[] { INSTANCE };
+    }
+
+    public X509Certificate[] getAcceptedIssuers() {
+        return null;
+    }
+
+    public void checkClientTrusted(X509Certificate[] certs, String authType) {
+    }
+
+    public void checkServerTrusted(X509Certificate[] certs, String authType) {
+    }
+}

src/java/ABTProductsPUTGenerator/src/main/resources/input.json

@@ -1,23 +1,33 @@
 {
-  "productId": 251,
-  "fikoArticleNumber": null,
+  "productId": 663,
   "parentProductId": null,
-  "gboPackageTemplateId": "30901",
+  "layerInfo": {
+    "layerInfoId": 7,
+    "choiceKey": "isRenewable",
+    "choiceLabel": "Kies voor een doorlopend abonnement of een enkele termijn",
+    "isCustomChoice": false
+  },
+  "fikoArticleNumber": null,
+  "gboPackageTemplateId": "30001",
   "tapConnectProductCode": null,
-  "productName": "MaxTestPOST-21-okt-test-1 edited PUT",
-  "productDescription": "21-okt-test-1 edited PUT - reis met 90% korting gedurende de eerste F&F pilot!",
-  "validityPeriod": null,
-  "productTranslations": null,
+  "productName": "Test OVPAY-2306",
+  "productDescription": "Test OVPAY-2306 (sellingPeriods in kindje verwijderen en later opnieuw weer kunnen toevoegen)",
+  "validityPeriod": {
+    "validityPeriodId": 782,
+    "fromInclusive": "2025-12-31T23:00:00.000Z",
+    "toInclusive": "2026-03-30T22:00:00.000Z"
+  },
+  "productTranslations": [],
+  "allowedGboAgeProfiles": [],
   "productOwner": {
     "productOwnerId": 1,
-    "name": "Corneel Verstoep",
-    "organization": "HTM"
+    "name": "Wie dit leest",
+    "organization": "... is een aap."
   },
-  "marketSegments": null,
-  "customerSegments": null,
-  "allowedGboAgeProfiles": null,
+  "marketSegments": [],
+  "customerSegments": [],
   "productCategory": {
-    "productCategoryId": 9,
+    "productCategoryId": 1,
     "isTravelProduct": true,
     "name": "Kortingsabonnement"
   },
@@ -25,32 +35,10 @@
     "requiredCustomerLevelId": 1,
     "name": "guest"
   },
-  "requiredProducts": null,
-  "incompatibleProducts": null,
-  "mandatoryCustomerDataItems": [
-    {
-      "mandatoryCustomerDataItemId": 4,
-      "customerDataItem": "emailAddress"
-    },
-    {
-      "mandatoryCustomerDataItemId": 5,
-      "customerDataItem": "address"
-    }
-  ],
-  "requiredGboPersonalAttributes": [
-    {
-      "requiredGboPersonalAttributeId": 1,
-      "name": "NAME"
-    },
-    {
-      "requiredGboPersonalAttributeId": 2,
-      "name": "BIRTHDATE"
-    },
-    {
-      "requiredGboPersonalAttributeId": 3,
-      "name": "PHOTO"
-    }
-  ],
+  "requiredProducts": [],
+  "incompatibleProducts": [],
+  "mandatoryCustomerDataItems": [],
+  "requiredGboPersonalAttributes": [],
   "tokenTypes": [
     {
       "tokenTypeId": 1,
@@ -61,72 +49,36 @@
     "paymentMomentId": 1,
     "name": "prepaid"
   },
-  "serviceOptions": null,
-  "validityDuration": "P7D",
-  "maxStartInFutureDuration": "P6W",
-  "isRenewable": false,
+  "serviceOptions": [
+    {
+      "serviceOptionId": 4,
+      "action": "cancel_notAllowed",
+      "description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)"
+    },
+    {
+      "serviceOptionId": 10,
+      "action": "refund_notAllowed",
+      "description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)"
+    }
+  ],
+  "validityDuration": "P1W",
+  "maxStartInFutureDuration": "P1W",
+  "isRenewable": null,
   "sendInvoice": false,
-  "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
-  "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina",
-  "termsUrl": "https://www.htm.nl/nog-onbekende-productvoorwaarden-pagina",
+  "imageReference": null,
+  "productPageUrl": null,
+  "termsUrl": null,
   "isSellableAtHtm": true,
   "needsSolvencyCheckConsumer": false,
   "needsSolvencyCheckBusiness": false,
   "sellingPeriods": [
     {
-      "sellingPeriodId": 240,
-      "fromInclusive": "2024-09-06T00:00:00.000+00:00",
-      "toInclusive": "2024-12-29T23:59:59.000+00:00",
+      "sellingPeriodId": 1382,
+      "fromInclusive": "2025-12-31T23:00:00.000Z",
+      "toInclusive": "2026-03-30T22:00:00.000Z",
       "salesTouchpoint": {
-        "salesTouchpointId": 6,
-        "name": "Service-engine",
-        "isActive": true,
-        "retailer": {
-          "retailerId": 1000,
-          "name": "HTM intern beheer",
-          "street": "Koningin Julianaplein",
-          "number": 10,
-          "numberAddition": null,
-          "postalCode": "2595 AA",
-          "city": "Den Haag",
-          "country": "Nederland",
-          "emailAddress": "info@htm.nl",
-          "phoneNumber": "070 374 9002",
-          "taxId": null,
-          "imageReference": "https://www.htm.nl/typo3conf/ext/htm_template/Resources/Public/img/logo.svg"
-        }
-      },
-      "forbiddenPaymentMethods": null,
-      "sellingPrices": [
-        {
-          "sellingPriceId": 318,
-          "taxCode": "V21",
-          "taxPercentage": 21.0000,
-          "amountExclTax": 94,
-          "amountInclTax": 100,
-          "fromInclusive": "2024-09-06T00:00:00.000+00:00",
-          "toInclusive": "2024-12-18T23:59:59.000+00:00",
-          "internalPrice": 92.0000
-        },
-        {
-          "sellingPriceId": 319,
-          "taxCode": "V21",
-          "taxPercentage": 21.0000,
-          "amountExclTax": 98,
-          "amountInclTax": 102,
-          "fromInclusive": "2024-12-19T00:00:00.000+00:00",
-          "toInclusive": "2024-12-29T23:59:59.000+00:00",
-          "internalPrice": 0.0000
-        }
-      ]
-    },
-    {
-      "sellingPeriodId": 241,
-      "fromInclusive": "2024-09-06T00:00:00.000+00:00",
-      "toInclusive": "2024-12-29T23:59:59.000+00:00",
-      "salesTouchpoint": {
-        "salesTouchpointId": 5,
-        "name": "Servicewinkel (Team Incident Masters)",
+        "salesTouchpointId": 3,
+        "name": "Website",
         "isActive": true,
         "retailer": {
           "retailerId": 1001,
@@ -139,64 +91,196 @@
           "country": "Nederland",
           "emailAddress": "info@htm.nl",
           "phoneNumber": "070 374 9002",
-          "taxId": null,
-          "imageReference": "https://www.htm.nl/typo3conf/ext/htm_template/Resources/Public/img/logo.svg"
+          "taxId": 572309345923,
+          "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg"
         }
       },
-      "forbiddenPaymentMethods": [
+      "forbiddenPaymentMethods": [],
+      "sellingPrices": []
+    }
+  ],
+  "purchasePrices": [],
+  "productVariants": [
+    {
+      "productId": 664,
+      "parentProductId": 663,
+      "layerInfo": {
+        "layerInfoId": null,
+        "choiceKey": null,
+        "choiceLabel": null,
+        "isCustomChoice": false
+      },
+      "fikoArticleNumber": null,
+      "gboPackageTemplateId": "30001",
+      "tapConnectProductCode": null,
+      "productName": "Losse week - Test OVPAY-2306",
+      "productDescription": "Test OVPAY-2306 (sellingPeriods in kindje verwijderen en later opnieuw weer kunnen toevoegen)",
+      "validityPeriod": {
+        "validityPeriodId": 783,
+        "fromInclusive": "2025-12-31T23:00:00.000Z",
+        "toInclusive": "2026-03-30T22:00:00.000Z"
+      },
+      "productTranslations": [],
+      "allowedGboAgeProfiles": [],
+      "productOwner": {
+        "productOwnerId": 1,
+        "name": "Wie dit leest",
+        "organization": "... is een aap."
+      },
+      "marketSegments": [],
+      "customerSegments": [],
+      "productCategory": {
+        "productCategoryId": 1,
+        "isTravelProduct": true,
+        "name": "Kortingsabonnement"
+      },
+      "requiredCustomerLevel": {
+        "requiredCustomerLevelId": 1,
+        "name": "guest"
+      },
+      "requiredProducts": [],
+      "incompatibleProducts": [],
+      "mandatoryCustomerDataItems": [],
+      "requiredGboPersonalAttributes": [],
+      "tokenTypes": [
         {
-          "forbiddenPaymentMethodId": 2,
-          "name": "creditcard",
-          "issuer": "Visa"
+          "tokenTypeId": 1,
+          "name": "EMV"
         }
       ],
-      "sellingPrices": [
+      "paymentMoment": {
+        "paymentMomentId": 1,
+        "name": "prepaid"
+      },
+      "serviceOptions": [
         {
-          "sellingPriceId": 320,
-          "taxCode": "V21",
-          "taxPercentage": 21.0000,
-          "amountExclTax": 94,
-          "amountInclTax": 100,
-          "fromInclusive": "2024-09-06T00:00:00.000+00:00",
-          "toInclusive": "2024-12-18T23:59:59.000+00:00",
-          "internalPrice": 92.0000
+          "serviceOptionId": 4,
+          "action": "cancel_notAllowed",
+          "description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)"
         },
         {
-          "sellingPriceId": 321,
-          "taxCode": "V21",
-          "taxPercentage": 21.0000,
-          "amountExclTax": 98,
-          "amountInclTax": 102,
-          "fromInclusive": "2024-12-19T00:00:00.000+00:00",
-          "toInclusive": "2024-12-29T23:59:59.000+00:00",
-          "internalPrice": 0.0000
+          "serviceOptionId": 10,
+          "action": "refund_notAllowed",
+          "description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)"
         }
-      ]
-    }
-  ],
-  "purchasePrices": [
-    {
-      "purchasePriceId": 184,
-      "taxCode": "V21",
-      "taxPercentage": 21.0000,
-      "amountExclTax": 0,
-      "amountInclTax": 0,
-      "fromInclusive": "2024-09-01T00:00:00.000+00:00",
-      "toInclusive": "2024-12-31T23:59:59.000+00:00"
-    }
-  ],
-  "auditTrail": [
-    {
-      "auditTrailId": 228,
-      "action": "update",
-      "user": "api",
-      "timestamp": "2024-10-21T09:00:30.410+00:00"
+      ],
+      "validityDuration": "P1W",
+      "maxStartInFutureDuration": "P1W",
+      "isRenewable": false,
+      "sendInvoice": false,
+      "imageReference": null,
+      "productPageUrl": null,
+      "termsUrl": null,
+      "isSellableAtHtm": true,
+      "needsSolvencyCheckConsumer": false,
+      "needsSolvencyCheckBusiness": false,
+      "sellingPeriods": [
+        {
+          "sellingPeriodId": 1384,
+          "fromInclusive": "2025-12-31T23:00:00.000Z",
+          "toInclusive": "2026-03-30T22:00:00.000Z",
+          "salesTouchpoint": {
+            "salesTouchpointId": 3,
+            "name": "Website",
+            "isActive": true,
+            "retailer": {
+              "retailerId": 1001,
+              "name": "HTM externe touchpoints",
+              "street": "Koningin Julianaplein",
+              "number": 10,
+              "numberAddition": null,
+              "postalCode": "2595 AA",
+              "city": "Den Haag",
+              "country": "Nederland",
+              "emailAddress": "info@htm.nl",
+              "phoneNumber": "070 374 9002",
+              "taxId": 572309345923,
+              "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg"
+            }
+          },
+          "forbiddenPaymentMethods": [],
+          "sellingPrices": []
+        }
+      ],
+      "purchasePrices": [],
+      "productVariants": []
     },
     {
-      "auditTrailId": 227,
-      "action": "insert",
-      "user": "api",
-      "timestamp": "2024-10-21T08:58:39.237+00:00"
+      "productId": 665,
+      "parentProductId": 663,
+      "layerInfo": {
+        "layerInfoId": null,
+        "choiceKey": null,
+        "choiceLabel": null,
+        "isCustomChoice": false
+      },
+      "fikoArticleNumber": null,
+      "gboPackageTemplateId": "30001",
+      "tapConnectProductCode": null,
+      "productName": "Doorlopend - Test OVPAY-2306",
+      "productDescription": "Test OVPAY-2306 (sellingPeriods in kindje verwijderen en later opnieuw weer kunnen toevoegen)",
+      "validityPeriod": {
+        "validityPeriodId": 784,
+        "fromInclusive": "2025-12-31T23:00:00.000Z",
+        "toInclusive": "2026-03-30T22:00:00.000Z"
+      },
+      "productTranslations": [],
+      "allowedGboAgeProfiles": [],
+      "productOwner": {
+        "productOwnerId": 1,
+        "name": "Wie dit leest",
+        "organization": "... is een aap."
+      },
+      "marketSegments": [],
+      "customerSegments": [],
+      "productCategory": {
+        "productCategoryId": 1,
+        "isTravelProduct": true,
+        "name": "Kortingsabonnement"
+      },
+      "requiredCustomerLevel": {
+        "requiredCustomerLevelId": 1,
+        "name": "guest"
+      },
+      "requiredProducts": [],
+      "incompatibleProducts": [],
+      "mandatoryCustomerDataItems": [],
+      "requiredGboPersonalAttributes": [],
+      "tokenTypes": [
+        {
+          "tokenTypeId": 1,
+          "name": "EMV"
+        }
+      ],
+      "paymentMoment": {
+        "paymentMomentId": 1,
+        "name": "prepaid"
+      },
+      "serviceOptions": [
+        {
+          "serviceOptionId": 4,
+          "action": "cancel_notAllowed",
+          "description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)"
+        },
+        {
+          "serviceOptionId": 10,
+          "action": "refund_notAllowed",
+          "description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)"
+        }
+      ],
+      "validityDuration": "P1W",
+      "maxStartInFutureDuration": "P1W",
+      "isRenewable": true,
+      "sendInvoice": false,
+      "imageReference": null,
+      "productPageUrl": null,
+      "termsUrl": null,
+      "isSellableAtHtm": true,
+      "needsSolvencyCheckConsumer": false,
+      "needsSolvencyCheckBusiness": false,
+      "sellingPeriods": [],
+      "purchasePrices": [],
+      "productVariants": []
     }
   ]
 }

src/openapi/contracts/contracts-se.yaml

@@ -386,10 +386,10 @@ paths:
                       "refundAmount": 2489,
                       "refundMethods": ["creditInvoice", "iDeal"],
                     }
-                Unsuccesful validation:
-                  summary: Unsuccesful validation
+                Unsuccessful validation:
+                  summary: Unsuccessful validation
                   description: |
-                    Unsuccesful validation. The response contains the error message.
+                    Unsuccessful validation. The response contains the error message.
                   value:
                     {
                       "validationResult": false,
@@ -574,6 +574,267 @@ paths:
                             },
                         },
                     }
+  /contracts/{uuid}/changemoments:
+    parameters:
+      - in: header
+        name: X-HTM-JWT-AUTH-HEADER
+        schema:
+          type: string
+          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+        required: true
+        description: The JWT of the logged in customer.
+      - in: path
+        name: uuid
+        schema:
+          type: string
+          format: uuid
+          example: 9e224750-3065-471d-af57-85b9cffa7c89
+        required: true
+        description: The id of the contract to process.
+    get:
+      summary: Get all change moments for a given contract.
+      description: Get all change moments for a given contract.
+      tags:
+        - SE Contract Changes v2
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                All change moments of a contract:
+                  summary: All change moments of a contract
+                  description: |
+                    All change moments of a contract. The response contains the
+                    allowed change moments for the current contract term.
+                  value:
+                    {
+                      "changeMoment": "termBound",
+                      "termDuration": "P1M",
+                      "billingDay": 18,
+                      "changeFrom": "2024-08-10T00:00:00",
+                      "changeUntil": "2024-08-10T03:59:59",
+                    }
+  /contracts/{uuid}/changevalidation:
+    parameters:
+      - in: header
+        name: X-HTM-JWT-AUTH-HEADER
+        schema:
+          type: string
+          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+        required: true
+        description: The JWT of the logged in customer.
+      - in: path
+        name: uuid
+        schema:
+          type: string
+          format: uuid
+          example: 9e224750-3065-471d-af57-85b9cffa7c89
+        required: true
+        description: The id of the contract to process.
+    post:
+      summary: Validate a change for a given contract.
+      description: Validate a change for a given contract.
+      tags:
+        - SE Contract Changes v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Validate a change to another product:
+                summary: Validate a change to another product
+                description: |
+                  Validate a change to another product. The response contains the allowed change moments for the current contract term.
+                value: { "productId": 124, "startDate": "2025-10-08" }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Successfully validated change:
+                  summary: Successfully validated change
+                  description: |
+                    Successfully validated a change. The response contains the allowed change moments for the current contract term.
+                  value:
+                    {
+                      "validationResult": true,
+                      "validationMessage": "",
+                      "contract":
+                        {
+                          "contractId": "15b43d9b-367a-4952-87f6-3e0fa902486f",
+                          "contractNumber": "D123456",
+                          "customerProfileId": 42,
+                          "orderId": "eb3d08f7-7feb-4f31-9f5b-daa634e51f48",
+                          "orderLineId": "52efbbfc-8c28-4016-9ece-dc3ef9a70bd8",
+                          "touchpointId": 2,
+                          "contractStatus":
+                            { "contractStatusId": 2, "name": "active" },
+                          "productId": 1,
+                          "productName": "HTM Maand 20% korting",
+                          "termDuration": "P0Y1M0D",
+                          "billingDay": 15,
+                          "highestInvoiceTerm": 1,
+                          "created": "2024-08-01 15:01:00.000",
+                          "ovPayTokenId": 1337,
+                          "contractVersions":
+                            [
+                              {
+                                "contractVersionId": 2,
+                                "termsAndConditions": "https://www.htm.nl",
+                                "productId": 124,
+                                "productName": "Regiovrij Regio Centrum",
+                                "taxCode": "V9",
+                                "taxPercentage": 9.0,
+                                "termAmountInclTax": 12,
+                                "start": "2025-10-08",
+                              },
+                              {
+                                "contractVersionId": 1,
+                                "termsAndConditions": "https://www.htm.nl",
+                                "productId": 123,
+                                "productName": "Regiovrij Regio Zuid",
+                                "taxCode": "V9",
+                                "taxPercentage": 9.0,
+                                "termAmountInclTax": 10,
+                                "start": "2025-01-08",
+                                "end": "2025-10-07",
+                              },
+                            ],
+                        },
+                    }
+                Unsuccessful validation:
+                  summary: Unsuccessful validation
+                  description: |
+                    Unsuccessful validation. The response contains the error message.
+                  value:
+                    {
+                      "validationResult": false,
+                      "validationMessage": "Contract status is not ACTIVE",
+                      "contract": null,
+                    }
+  /contracts/{uuid}/change:
+    parameters:
+      - in: header
+        name: X-HTM-JWT-AUTH-HEADER
+        schema:
+          type: string
+          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+        required: true
+        description: The JWT of the logged in customer.
+      - in: path
+        name: uuid
+        schema:
+          type: string
+          format: uuid
+          example: 9e224750-3065-471d-af57-85b9cffa7c89
+        required: true
+        description: The id of the contract to process.
+    post:
+      summary: Change a contract.
+      description: Change a contract.
+      tags:
+        - SE Contract Changes v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Change to another product:
+                summary: Change to another product
+                description: |
+                  Change to another product. The response contains the details of the changed contract.
+                value: { "productId": 124, "startDate": "2025-10-08" }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Successfully changed contract:
+                  summary: Successfully changed contract
+                  description: |
+                    Successfully changed a contract. The response contains the details of the changed contract.
+                  value:
+                    {
+                      "contractId": "15b43d9b-367a-4952-87f6-3e0fa902486f",
+                      "contractNumber": "D123456",
+                      "customerProfileId": 42,
+                      "orderId": "eb3d08f7-7feb-4f31-9f5b-daa634e51f48",
+                      "orderLineId": "52efbbfc-8c28-4016-9ece-dc3ef9a70bd8",
+                      "touchpointId": 2,
+                      "contractStatus":
+                        { "contractStatusId": 2, "name": "active" },
+                      "productId": 1,
+                      "productName": "HTM Maand 20% korting",
+                      "termDuration": "P0Y1M0D",
+                      "billingDay": 15,
+                      "highestInvoiceTerm": 1,
+                      "created": "2024-08-01 15:01:00.000",
+                      "ovPayTokenId": 1337,
+                      "contractVersions":
+                        [
+                          {
+                            "contractVersionId": 2,
+                            "termsAndConditions": "https://www.htm.nl",
+                            "productId": 124,
+                            "productName": "Regiovrij Regio Centrum",
+                            "taxCode": "V9",
+                            "taxPercentage": 9.0,
+                            "termAmountInclTax": 12,
+                            "start": "2025-10-08",
+                          },
+                          {
+                            "contractVersionId": 1,
+                            "termsAndConditions": "https://www.htm.nl",
+                            "productId": 123,
+                            "productName": "Regiovrij Regio Zuid",
+                            "taxCode": "V9",
+                            "taxPercentage": 9.0,
+                            "termAmountInclTax": 10,
+                            "start": "2025-01-08",
+                            "end": "2025-10-07",
+                          },
+                        ],
+                    }
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Unsuccessful change due to invalid productId:
+                  summary: Unsuccessful change due to invalid productId
+                  description: |
+                    Unsuccessful change due to invalid productId. The response contains the error message.
+                  value:
+                    {
+                      "type": "https://htm.nl/api/v1/probs/validationerror",
+                      "title": "Your request is not valid.",
+                      "detail": "The chosen parameters for this contract change are not valid.",
+                      "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
+                      "errors":
+                        [
+                          {
+                            "code": "CHANGE_DATE_IN_THE_PAST",
+                            "detail": "Chosen date of contract change is in the past. This is not alllowed.",
+                            "path": "$.startDate",
+                            "parameter": null,
+                          },
+                        ],
+                    }
   /contractpayments:
     parameters:
       - in: header
@@ -597,9 +858,13 @@ paths:
               schema:
                 $ref: "#/components/schemas/unavailable"
               examples:
-                List all contract payments for a single debtor:
-                  summary: List all contract payments for a single debtor
-                  description: List all contract payments for single debtor with debtor number 'D123456'.
+                Empty list:
+                  summary: Empty list
+                  description: List all contract payments for a debtor with no payments.
+                  value: { "contractPayments": [] }
+                Successful direct debit:
+                  summary: Successful direct debit
+                  description: One payment for a debtor with a successful direct debit.
                   value:
                     {
                       "contractPayments":
@@ -607,8 +872,133 @@ paths:
                           {
                             "paymentId": "151845776",
                             "totalAmount": "26.62",
-                            "paymentMethod": "Twikey",
+                            "paymentMethod": "Automatische incasso",
                             "paymentDate": "2024-09-12",
+                            "iban": "NL25INGB******1337",
+                            "invoice":
+                              {
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
+                              },
+                            "_links":
+                              {
+                                "get_contractdetails":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                        ],
+                    }
+                Direct debit reversal:
+                  summary: Direct debit reversal
+                  description: One payment for a debtor with a reversed direct debit.
+                  value:
+                    {
+                      "contractPayments":
+                        [
+                          {
+                            "paymentId": "151845776",
+                            "totalAmount": "-26.62",
+                            "paymentMethod": "Stornering",
+                            "paymentDate": "2024-09-12",
+                            "iban": "NL25INGB******1337",
+                            "invoice":
+                              {
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
+                              },
+                            "_links":
+                              {
+                                "get_contractdetails":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                        ],
+                    }
+                iDEAL payment:
+                  summary: iDEAL payment
+                  description: One payment for a debtor with an iDEAL payment.
+                  value:
+                    {
+                      "contractPayments":
+                        [
+                          {
+                            "paymentId": "151845776",
+                            "totalAmount": "26.62",
+                            "paymentMethod": "iDEAL",
+                            "paymentDate": "2024-09-12",
+                            "iban": "NL25INGB******1337",
+                            "invoice":
+                              {
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
+                              },
+                            "_links":
+                              {
+                                "get_contractdetails":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                        ],
+                    }
+                Bank transfer:
+                  summary: Bank transfer
+                  description: One payment for a debtor with a bank transfer.
+                  value:
+                    {
+                      "contractPayments":
+                        [
+                          {
+                            "paymentId": "151845776",
+                            "totalAmount": "26.62",
+                            "paymentMethod": "Overboeking",
+                            "paymentDate": "2024-09-12",
+                            "iban": "NL25INGB******1337",
+                            "invoice":
+                              {
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
+                              },
+                            "_links":
+                              {
+                                "get_contractdetails":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                        ],
+                    }
+                List of four payments for one invoice:
+                  summary: List of four payments for one invoice
+                  description: Four payments for a debtor for one invoice; a direct debit, a direct debit reversal, a bank transfer and an iDEAL payment.
+                  value:
+                    {
+                      "contractPayments":
+                        [
+                          {
+                            "paymentId": "151845776",
+                            "totalAmount": "26.62",
+                            "paymentMethod": "Automatische incasso",
+                            "paymentDate": "2024-09-12",
+                            "iban": "NL25INGB******1337",
                             "invoice":
                               {
                                 "invoiceId": "147722263",
@@ -626,22 +1016,67 @@ paths:
                               },
                           },
                           {
-                            "paymentId": "151845851",
-                            "totalAmount": "45.21",
-                            "paymentMethod": "Twikey",
+                            "paymentId": "151845776",
+                            "totalAmount": "-26.62",
+                            "paymentMethod": "Stornering",
                             "paymentDate": "2024-09-12",
+                            "iban": "NL25INGB******1337",
                             "invoice":
                               {
-                                "invoiceId": "147722266",
-                                "invoiceNumber": "F2024-0002",
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
                                 "description": "HTM Maandkorting 20%",
-                                "publicLink": "https://factuurinzien.nl/d/ddb245d6df67999eca48c4a71b5661b93038e20a/i/dp5h1i5cuu94nopiolkdst3u17vkmzo",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
                               },
                             "_links":
                               {
                                 "get_contractdetails":
                                   {
-                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/7b2f8c1a-3d9d-4c2d-960e-4471e8e28b6a",
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                          {
+                            "paymentId": "151845777",
+                            "totalAmount": "10.00",
+                            "paymentMethod": "Overboeking",
+                            "paymentDate": "2024-09-13",
+                            "iban": "NL25INGB******1337",
+                            "invoice":
+                              {
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
+                              },
+                            "_links":
+                              {
+                                "get_contractdetails":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                          {
+                            "paymentId": "151845778",
+                            "totalAmount": "16.62",
+                            "paymentMethod": "iDEAL",
+                            "paymentDate": "2024-09-14",
+                            "iban": "NL25INGB******1337",
+                            "invoice":
+                              {
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
+                              },
+                            "_links":
+                              {
+                                "get_contractdetails":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
                                     "method": "GET",
                                   },
                               },

src/openapi/customers/customers_reference-crud.yaml

@@ -417,38 +417,56 @@ paths:
               example:
                 Entries:
                   phoneTypes:
-                    - name: mobile
+                    - name: Mobiel
                       id: 1
-                    - name: fixed line
+                    - name: Thuis
                       id: 2
+                    - name: Ouders
+                      id: 3
+                    - name: Bewindvoerder
+                      id: 4
+                    - name: Home
+                      id: 5
+                    - name: Mobile
+                      id: 6
+                    - name: Work
+                      id: 7
+                    - name: Noodtelefoon
+                      id: 8
                   addressTypes:
-                    - name: home
+                    - name: Shipping
                       id: 1
-                    - name: office
+                    - name: Billing
                       id: 2
                   customerStatuses:
-                    - name: active
+                    - name: Inactive
                       id: 1
-                    - name: blocked
+                    - name: Active
                       id: 2
-                    - name: inactive
+                    - name: Blocked
                       id: 3
-                    - name: new
+                    - name: Frozen
                       id: 4
+                    - name: Cleared
+                      id: 5
                   tokenTypes:
-                    - name: Debit card
+                    - name: EMV
                       id: 1
-                    - name: Credit card
-                      id: 2
                     - name: OVPas physical
-                      id: 3
+                      id: 2
                     - name: OVPas digital
-                      id: 4
+                      id: 3
                   directDebitMandateTypes:
                     - name: Paper Contract
                       id: 1
                     - name: PIN transaction
                       id: 2
+                    - name: SEPA eMandate
+                      id: 3
+                    - name: Digital signature
+                      id: 4
+                    - name: IDEAL transaction
+                      id: 5
                   tokenStatuses:
                     - name: Expired
                       id: 1

src/openapi/orders/orders-crud.yaml

@@ -5,6 +5,12 @@ info:
   description: CRUD APIs for ABT Orders database. These are NOT the functional APIs from Service Engine.
 servers:
   - url: https://services.acc.api.htm.nl/abt/abtorder/1.0
+tags:
+ - name: Order
+ - name: Order Line
+ - name: Payment
+ - name: Customer
+ - name: Order Voucher
 paths:
   /orders:
     get:
@@ -50,6 +56,14 @@ paths:
             example: 1
           required: false
           description: The id of the touch point where the order was initiated.
+        - in: query
+          name: deviceId
+          schema:
+            type: string
+            format: uuid
+            example: "7a28bd54-7ca9-499a-a722-d15ab858ab99"
+          required: false
+          description: The id of the device used to place the order.
         - in: query
           name: languageId
           schema:
@@ -98,6 +112,14 @@ paths:
           explode: false
           required: false
           description: Filter on most recent order status. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled.
+        - in: query
+          name: issuedVoucherId
+          schema:
+            type: string
+            format: uuid
+            example: "b0a9f3c9-9b92-4f8c-b78d-6129be7218a6"
+          required: false
+          description: Filter on applied issuedVoucherId for the order.
       responses:
         "200":
           description: OK
@@ -119,6 +141,7 @@ paths:
                           "touchPointId": 1,
                           "name": "Perplex"
                         },
+                        "deviceId": "42e77532-d831-41da-b07a-7edb9bb7f004",
                         "language":
                           {
                             "languageId": 1,
@@ -148,6 +171,30 @@ paths:
                               "description": "Betaling in behandeling",
                             },
                           ],
+                        "orderVouchers": [
+                          {
+                            "orderVoucherId": "399bd3b3-9721-4f09-a936-d64637de1621",
+                            "issuedVoucher":{
+                              "issuedVoucherId": "a0996218-bc5e-4826-9020-cda98a32838d",
+                              "voucherCode": "Voucher1234",
+                              "purchasedProductId": 31,
+                              "fromInclusive": "2025-03-22T08:55:00",
+                              "untillInclusive": "2026-03-22T08:55:00"
+                            },
+                            "orderLineId": null
+                          },
+                          {
+                            "orderVoucherId": "f6c7ac42-1811-4e4d-82af-53e18fe16110",
+                            "issuedVoucher":{
+                              "issuedVoucherId": "54668baf-4905-4e9a-af02-09c170f295ed",
+                              "voucherCode": "Voucher124",
+                              "purchasedProductId": 35,
+                              "fromInclusive": "2025-03-22T08:55:00",
+                              "untillInclusive": "2026-03-22T08:55:00"
+                            },
+                            "orderLineId": "7a7a9d1a-3fc8-4058-a28b-082860aaa311"
+                          }
+                        ],
                         "orderLines":
                           [
                             {
@@ -277,7 +324,7 @@ paths:
                                 {
                                   "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
                                   "addressType":
-                                    { "addressTypeId": 3, "name": "Billing" },
+                                    { "addressTypeId": 2, "name": "Billing" },
                                   "street": "Kon. Julianaplein",
                                   "houseNumber": 10,
                                   "houseNumberSuffix": "a",
@@ -327,21 +374,24 @@ paths:
                   "customerProfileId": 1337,
                   "totalAmount": 121,
                   "touchPointId": 1,
+                  "deviceId": "b8ca9fdf-0bb9-4e49-b48d-41e395563377",
                   "languageId": 1,
                   "createdOn": "2024-03-22T09:00:00",
                   "order_OrderStatus":
                     [
                       {
-                        "orderStatusId": 4,
-                        "createdOn": "2024-03-22T09:00:00",
-                        "description": "Order succesvol betaald",
-                      },
-                      {
-                        "orderStatusId": 3,
+                        "orderStatusId": 1,
                         "createdOn": "2024-03-22T08:55:00",
-                        "description": "Betaling in behandeling",
+                        "description": "Concept order",
                       },
                     ],
+                    "orderVouchers":
+                    [
+                      {
+                        "issuedVoucherId": "e81b2197-a6c2-45b6-9560-8ce8442e8604",
+                        "orderLineId": "97824d2e-5189-456d-b6da-4cca511a7685"
+                      },
+                    ],  
                   "orderLines":
                     [
                       {
@@ -390,57 +440,6 @@ paths:
                           ],
                       },
                     ],
-                  "payments":
-                    [
-                      {
-                        "createdOn": "2024-03-22T09:00:00",
-                        "amountDebit": 121,
-                        "paymentMethodId": 1,
-                        "touchPointId": 1,
-                        "isRefund": false,
-                        "htmPaymentReference": "HTM-1234",
-                        "pspPaymentReference": "Buckaroo-1234",
-                        "paymentStatuses":
-                          [
-                            {
-                              "createdOn": "2024-03-22T09:00:00",
-                              "statusCode": "190",
-                              "statusDescription": "Success",
-                              "statusSubCode": "S001",
-                              "statusSubDescription": "PaymentSuccessFul",
-                            },
-                          ],
-                        "mandateInput":
-                          {
-                            "directDebitMandateTypeId": 1,
-                            "createdOn": "2024-03-22T09:00:00",
-                            "bic": "RABONL2U",
-                            "iban": "NL44RABO0123456789",
-                            "ascription": "J. de Vries",
-                            "place": "Den Haag",
-                          },
-                      },
-                    ],
-                  "orderCustomer":
-                    {
-                      "birthname": "Jan",
-                      "surname": "Vries",
-                      "prefix": "de",
-                      "emailAddress": "jandevries@outlook.com",
-                      "dateOfBirth": "1970-01-01",
-                      "orderCustomerAddresses":
-                        [
-                          {
-                            "addressTypeId": 1,
-                            "street": "Kon. Julianaplein",
-                            "houseNumber": 10,
-                            "houseNumberSuffix": "a",
-                            "postalCode": "2595 AA",
-                            "city": "Den Haag",
-                            "country": "NL",
-                          },
-                        ],
-                    },
                 }
       responses:
         "201":
@@ -487,6 +486,7 @@ paths:
                     "touchPointId": 1,
                     "name": "Perplex"
                    },
+                   "deviceId": null,
                   "language":
                     {
                       "languageId": 1,
@@ -512,6 +512,7 @@ paths:
                         "description": "Betaling in behandeling",
                       },
                     ],
+                  "orderVouchers": null,
                   "orderLines":
                     [
                       {
@@ -634,7 +635,7 @@ paths:
                           {
                             "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
                             "addressType":
-                              { "addressTypeId": 3, "name": "Billing" },
+                              { "addressTypeId": 2, "name": "Billing" },
                             "street": "Kon. Julianaplein",
                             "houseNumber": 10,
                             "houseNumberSuffix": "a",
@@ -658,6 +659,7 @@ paths:
             example:
               {
                 "customerProfileId": 1337,
+                "deviceId": "fe68e624-b75f-48ca-a179-d5f86a8ab7d5",
                 "totalAmount": 121,
                 "languageId": 1,
                 "lastUpdatedOn": "2024-03-22T09:00:00",
@@ -678,6 +680,7 @@ paths:
       responses:
         "200":
           description: OK
+ 
   /orders/{orderId}/statuses:
     parameters:
       - in: path
@@ -715,6 +718,143 @@ paths:
                 {
                   "order_orderStatusId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
                 }
+  /orders/{orderId}/ordervouchers:
+    parameters:
+      - in: path
+        name: orderId
+        schema:
+          type: string
+          format: uuid
+          example: d1dd439b-6072-4b97-89c9-724268865b93
+        required: true
+        description: The id of the order to process.
+    post:
+      summary: Add an order voucher.
+      description: Add an order voucher.
+      tags:
+        - Order Voucher
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            example:
+              {
+                "issuedVoucherId": "eec6af41-1a60-49f6-a92e-440054a92f13",
+                "orderLineId": "7a9d6e15-7c5c-421d-9ea9-00b9bb6dbe67"
+              }
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                {
+                  "orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
+                }
+  /ordervouchers:
+    parameters:
+      - in: query
+        name: orderVoucherId
+        schema:
+          type: string
+          format: uuid
+          example: d1dd439b-6072-4b97-89c9-724268865b93
+        required: false
+        description: The id of the orderVoucher you are looking for.
+      - in: query
+        name: orderId
+        schema:
+          type: string
+          example: 90c926b9-3178-4757-acca-34cff66b980c
+        required: false
+        description: The id of the order
+      - in: query
+        name: orderLineId
+        schema:
+          type: string
+          example: 9e3363c8-e776-4675-b108-99b8c2e38eb6
+        required: false
+        description: The id of the orderLine
+    get:
+      summary: Find vouchers on the order
+      description: Find vouchers on the order
+      tags:
+        - Order Voucher
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                 [
+                  {
+                    "orderVoucherId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50",
+                    "issuedVoucher":{
+                        "issuedVoucherId": "54668baf-4905-4e9a-af02-09c170f295ed",
+                        "voucherCode": "Voucher124",
+                        "purchasedProductId": 35,
+                        "fromInclusive": "2025-03-22T08:55:00",
+                        "untillInclusive": "2026-03-22T08:55:00"
+                    },
+                    "orderId": "f59e4769-53a0-4156-8991-6f9119ba629f",
+                    "orderLineId": "eeb86071-4f59-405d-b2be-7d7a77044bfa"
+                  }
+                ]
+  /ordervouchers/{ordervoucherId}:
+    parameters:
+      - in: path
+        name: ordervoucherId
+        schema:
+          type: string
+          format: uuid
+          example: d1dd439b-6072-4b97-89c9-724268865b93
+        required: true
+        description: The id of the order to process.
+    patch:
+      summary: Update an order voucher.
+      description: Update an order voucher.
+      tags:
+        - Order Voucher
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            example:
+              {
+                "issuedVoucherId": "eec6af41-1a60-49f6-a92e-440054a92f13",
+                "orderLineId": "7a9d6e15-7c5c-421d-9ea9-00b9bb6dbe67"
+              }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                {
+                  "orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
+                }
+    delete:
+      summary: Delete an order voucher.
+      description: Delete an order voucher.
+      tags:
+        - Order Voucher
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                {}
   /orders/{orderId}/orderlines:
     parameters:
       - in: path
@@ -820,7 +960,7 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/unavailable"
-            example:
+            examples:
               Minimum orderline requestBody:
                 value:
                   {
@@ -906,7 +1046,7 @@ paths:
                     "orderCustomerAddresses":
                       [
                         {
-                          "addressTypeId": 3,
+                          "addressTypeId": 2,
                           "street": "Kon. Julianaplein",
                           "houseNumber": 10,
                           "houseNumberSuffix": "a",
@@ -2187,7 +2327,7 @@ paths:
                         {
                           "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
                           "addressType":
-                            { "addressTypeId": 3, "name": "Billing" },
+                            { "addressTypeId": 2, "name": "Billing" },
                           "street": "Kon. Julianaplein",
                           "houseNumber": 10,
                           "houseNumberSuffix": "a",
@@ -2257,7 +2397,7 @@ paths:
               $ref: "#/components/schemas/unavailable"
             example:
               {
-                "addressTypeId": 3,
+                "addressTypeId": 2,
                 "street": "Kon. Julianaplein",
                 "houseNumber": 10,
                 "houseNumberSuffix": "a",
@@ -2307,7 +2447,7 @@ paths:
               type: integer
           explode: false
           required: false
-          description: Filter on possible types of addresses. 1 = Shipping, 3 = Billing.
+          description: Filter on possible types of addresses. 1 = Shipping, 2 = Billing.
         - in: query
           name: street
           schema:
@@ -2363,7 +2503,7 @@ paths:
                     "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
                     "orderCustomerId": "540d8b7a-d626-443f-8f99-c24398604d7a",
                     "orderId": "73cca95a-81d1-468f-a8bf-99b36367001a",
-                    "addressType": { "addressTypeId": 3, "name": "Billing" },
+                    "addressType": { "addressTypeId": 2, "name": "Billing" },
                     "street": "Kon. Julianaplein",
                     "houseNumber": 10,
                     "houseNumberSuffix": "a",

src/openapi/orders/service_engine_orders.yaml

@@ -1314,7 +1314,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
                                 "addressType":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 10,
                                 "houseNumberSuffix": "a",
@@ -3688,7 +3688,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
                                 "addressType":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 10,
                                 "houseNumberSuffix": "a",
@@ -3965,7 +3965,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
                                 "addressTypeId":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 10,
                                 "houseNumberSuffix": "a",
@@ -4174,7 +4174,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
                                 "addressTypeId":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 10,
                                 "houseNumberSuffix": "a",
@@ -4226,7 +4226,7 @@ paths:
                     "orderCustomerAddresses":
                       [
                         {
-                          "addressTypeId": 3,
+                          "addressTypeId": 2,
                           "street": "Kon. Julianaplein",
                           "houseNumber": 10,
                           "houseNumberSuffix": "a",
@@ -4433,7 +4433,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
                                 "addressType":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 10,
                                 "houseNumberSuffix": "a",
@@ -4680,7 +4680,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
                                 "addressType":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 10,
                                 "houseNumberSuffix": "a",
@@ -4724,7 +4724,7 @@ paths:
                 description: Add an address to a customer on an order
                 value:
                   {
-                    "addressTypeId": 3,
+                    "addressTypeId": 2,
                     "street": "Kon. Julianaplein",
                     "houseNumber": 10,
                     "houseNumberSuffix": "a",
@@ -4935,7 +4935,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
                                 "addressType":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 10,
                                 "houseNumberSuffix": "a",
@@ -4979,7 +4979,7 @@ paths:
                 description: Update order customer address
                 value:
                   {
-                    "addressTypeId": 3,
+                    "addressTypeId": 2,
                     "street": "Kon. Julianaplein",
                     "houseNumber": 101,
                     "houseNumberSuffix": "a",
@@ -5190,7 +5190,7 @@ paths:
                               {
                                 "orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
                                 "addressType":
-                                  { "addressTypeId": 3, "name": "Billing" },
+                                  { "addressTypeId": 2, "name": "Billing" },
                                 "street": "Kon. Julianaplein",
                                 "houseNumber": 101,
                                 "houseNumberSuffix": "a",

src/openapi/products/SE-vouchers-TP.yaml

@@ -0,0 +1,234 @@
+openapi: 3.0.1
+info:
+  title: Service Engine APIs for HTM voucher for sales Touchpint
+  description: Service Engine APIs for HTM vouchers. These are NOT the CRUD APIs to the data hub. These ARE the api's for sales touchpoints.
+  version: "1.0"
+servers:
+  - url: https://services.acc.api.htm.nl/abt/abtvouchersTouchpoint/1.0
+paths:
+  /issuedvouchers:
+    get:
+      summary: Get a list of issued vouchers that were issued for a specific touch point
+      description:
+        Retrieve all issued vouchers for a specific touch point. This means that only products that have active sellingPeriods for touch points within the same
+        retailer as the calling touch point are returned.
+      parameters:
+        - name: touchpointId
+          in: query
+          required: false
+          description: |
+            This endpoint is meant for salesTouchpoints to check the existance and validity of the voucher a customer has supplied
+          schema:
+            type: integer
+            example: 1001
+        - name: issuedVoucherId
+          in: query
+          required: false
+          description: The unique identifier of the issued voucher instance to retrieve.
+          schema:
+            type: string
+            format: uuid
+            example: d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90
+        - name: voucherCode
+          in: query
+          required: false
+          description: The unique code of the issued voucher to retrieve.
+          schema:
+            type: string
+            example: VOUCHER123
+      tags:
+        - Vouchers
+      responses:
+        "200":
+          description: Successful retrieval of voucher instance
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Voucher for a product with required attributes:
+                  summary: Voucher for a single product with required attributes
+                  value:
+                    {
+                      "issuedVouchers":
+                        [
+                          {
+                            "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+                            "voucherCode": "VOUCHER123",
+                            "fromInclusive": "2024-10-04T00:00:00.000",
+                            "untilInclusive": "2024-11-04T00:00:00.000",
+                            "voucherStatus":
+                              { "voucherStatusId": 1, "name": "New" },
+                            "product":
+                              {
+                                "productId": 263,
+                                "productName": "HTM-80001",
+                                "productDescription": "10 euro korting op Regiovrij maand.",
+                                "productCategory":
+                                  {
+                                    "productCategoryId": 9,
+                                    "isTravelProduct": false,
+                                    "name": "Voucher",
+                                  },
+                                "amountInclTax": -1000,
+                                "requiredProducts":
+                                  [
+                                    {
+                                      "productId": 126,
+                                      "productName": "HTM-30001",
+                                      "productDescription": "Regiovrij maand.",
+                                      "_links":
+                                        {
+                                          "get_details":
+                                            {
+                                              "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/126",
+                                              "method": "GET",
+                                            },
+                                        },
+                                    },
+                                  ],
+                                "_links":
+                                  {
+                                    "get_details":
+                                      {
+                                        "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
+                                        "method": "GET",
+                                      },
+                                  },
+                              },
+                            "mandatoryCustomerDataItems":
+                              [
+                                {
+                                  "mandatoryCustomerDataItemId": 8,
+                                  "customerDataItem": "padBirthDate"                                 
+                                },
+                                {
+                                  "mandatoryCustomerDataItemId": 4,
+                                  "customerDataItem": "emailAddress"                                 
+                                },
+                              ],
+                          },
+                        ],
+                    }
+                Voucher for a whole order:
+                  summary: Voucher for a whole order
+                  value:
+                    {
+                      "issuedVouchers":
+                        [
+                          {
+                            "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+                            "voucherCode": "VOUCHER123",
+                            "fromInclusive": "2024-10-04T00:00:00.000",
+                            "untilInclusive": "2024-11-04T00:00:00.000",
+                            "voucherStatus":
+                              { "voucherStatusId": 1, "name": "New" },
+                            "product":
+                              {
+                                "productId": 263,
+                                "productName": "HTM-80002",
+                                "productDescription": "10 euro korting op je gehele winkelmand.",
+                                "productCategory":
+                                  {
+                                    "productCategoryId": 9,
+                                    "isTravelProduct": false,
+                                    "name": "Voucher",
+                                  },
+                                "amountInclTax": -1000,
+                                "requiredProducts": [],
+                                "_links":
+                                  {
+                                    "get_details":
+                                      {
+                                        "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
+                                        "method": "GET",
+                                      },
+                                  },
+                              },
+                          },
+                          "mandatoryCustomerDataItems": [],
+                        ],
+                    }
+        "403":
+          description: Forbidden
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Access denied due to insufficient permissions:
+                  summary: Access denied due to insufficient permissions
+                  value:
+                    {
+                      "type": "https://example.com/probs/forbidden",
+                      "title": "Access denied",
+                      "detail": "You do not have permission to access this resource.",
+                      "instance": "/issuedvouchers",
+                    }
+        "404":
+          description: Not found
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Voucher not found:
+                  summary: Voucher not found
+                  value:
+                    {
+                      "type": "https://example.com/probs/not-found",
+                      "title": "Voucher not found",
+                      "detail": "The voucher with code VOUCHER123 does not exist.",
+                      "instance": "/issuedvouchers",
+                    }
+        "500":
+          description: Internal server error
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Unexpected server error:
+                  summary: Unexpected server error
+                  value:
+                    {
+                      "type": "https://example.com/probs/internal-server-error",
+                      "title": "Internal Server Error",
+                      "detail": "An unexpected error occurred while processing your request.",
+                      "instance": "/issuedvouchers",
+                    }
+components:
+  securitySchemes:
+    bearerToken:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+  schemas:
+    unavailable:
+      type: object
+    rfc9457:
+      type: object
+      properties:
+        type:
+          type: string
+          format: url
+          example: https://example.com/probs/out-of-credit
+        title:
+          type: string
+          example: You do not have enough credit.
+        detail:
+          type: string
+          example: Your current balance is 30, but that costs 50.
+        instance:
+          type: string
+          example: /account/12345/msgs/abc
+        balance:
+          type: string
+          example: 30
+        accounts:
+          type: array
+          items:
+            type: string
+            example:
+              - /account/12345
+              - /account/67890

src/openapi/products/SE-vouchers-supplier.yaml

@@ -0,0 +1,617 @@
+openapi: 3.0.1
+info:
+  title: Service Engine APIs for HTM voucher suppliers
+  description: Service Engine APIs for HTM vouchers suppliers, this means all instances responsible for supplying vouchers. These are NOT the CRUD APIs to the data hub. These are ALSO NOT the api's for sales touchpoints.
+  version: "1.0"
+servers:
+  - url: https://services.acc.api.htm.nl/abt/abtvouchers/1.0
+paths:
+  /voucherdefinitions:
+    get:
+      tags:
+        - Vouchers
+      summary: Get a list of all voucher definitions that a touch point is allowed to issue
+      description: |-
+        Get a list of all voucher definitions that the calling touch point is allowed to issue. 
+        Essentially, this means that only products that have active sellingPeriods for touch points within the same 
+        retailer as the calling touch point are returned.
+      parameters:
+        - name: touchpointId
+          in: query
+          required: false
+          description: |
+            Filter the voucher definitions on a specific touch point id. This means that only voucher definitions with active selling periods for the specified touch point are returned.
+            This query parameter is only intended for administrative purposes, since the touch point associated with the access token used in the request is used to determine which voucher definitions are returned. This query parameter can be used to retrieve voucher definitions for other touch points within the same retailer, for example to retrieve voucher definitions for a specific sales touch point that is different from the calling touch point.
+          schema:
+            type: integer
+            example: 1001
+        - name: productId
+          in: query
+          required: false
+          description: Filter the voucher definitions on a specific product id.
+          schema:
+            type: integer
+            example: 263
+        - name: requiredProductId
+          in: query
+          required: false
+          description: Filter the voucher definitions on a specific required product id. This means that only voucher definitions that have the specified product id in their requiredProducts list are returned.
+          schema:
+            type: integer
+            example: 126
+        - name: showOnlyActive
+          in: query
+          required: false
+          description: Filter the voucher definitions on active selling periods. If true, only voucher definitions with at least one active selling period are returned. If false, all voucher definitions are returned regardless of their selling periods.
+          schema:
+            type: boolean
+            example: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                No products / Empty list:
+                  summary: No products / Empty list
+                  description: No products
+                  value: { "voucherDefinitions": [] }
+                List containing one voucher definition (called by touchpointId 1001):
+                  summary: List containing one voucher definition (called by touchpointId 10010011)
+                  description: TODO
+                  value:
+                    {
+                      "voucherDefinitions":
+                        [
+                          {
+                            "productId": 1002,
+                            "productName": "Korting Ooievaarspas",
+                            "productDescription": "Kortingsvoucher voor houders van een Ooievaarspas",
+                            "validityPeriod":
+                              {
+                                "validityPeriodId": 144,
+                                "fromInclusive": "2023-12-31T23:00:00.000+00:00",
+                                "toInclusive": "2028-11-25T04:00:00.000+00:00",
+                              },
+                            "productCategory":
+                              {
+                                "productCategoryId": 9,
+                                "isTravelProduct": false,
+                                "name": "Voucher",
+                              },
+                            "requiredProducts":
+                              [
+                                {
+                                  "productId": 126,
+                                  "productName": "HTM-30001",
+                                  "productDescription": "Reis met 20% korting op je betaalpas bij HTM.",
+                                },
+                              ],
+                            "mandatoryCustomerDataItems":
+                              [
+                                {
+                                  "mandatoryCustomerDataItemId": 8,
+                                  "customerDataItem": "padBirthDate",
+                                },
+                                {
+                                  "mandatoryCustomerDataItemId": 4,
+                                  "customerDataItem": "emailAddress",
+                                },
+                              ],
+                            "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
+                            "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina",
+                            "sellingPeriods":
+                              [
+                                {
+                                  "sellingPeriodId": 78,
+                                  "fromInclusive": "2024-09-30T23:00:00.000+00:00",
+                                  "toInclusive": "2028-11-17T23:00:00.000+00:00",
+                                  "salesTouchpoint":
+                                    {
+                                      "salesTouchpointId": 1001,
+                                      "name": "Gemeente Den Haag",
+                                      "isActive": true,
+                                      "retailer":
+                                        {
+                                          "retailerId": 1001,
+                                          "name": "Gemeente Den Haag",
+                                          "street": "Koningin Julianaplein",
+                                          "number": "10",
+                                          "numberAddition": null,
+                                          "postalCode": "2595 AA",
+                                          "city": "Den Haag",
+                                          "country": "Nederland",
+                                          "emailAddress": "info@denhaag.nl",
+                                          "phoneNumber": "070 374 9002",
+                                          "taxId": "572309345923",
+                                          "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
+                                        },
+                                    },
+                                  "forbiddenPaymentMethods": [],
+                                  "sellingPrices":
+                                    [
+                                      {
+                                        "sellingPriceId": 78,
+                                        "amountExclTax": null,
+                                        "amountInclTax": -100,
+                                        "fromInclusive": "2024-09-30T23:00:00.000+00:00",
+                                        "toInclusive": "2028-11-17T23:00:00.000+00:00",
+                                        "internalPrice": 0.0000,
+                                        "taxCode": "V09",
+                                        "taxPercentage": 9.0000,
+                                      },
+                                    ],
+                                },
+                              ],
+                          },
+                        ],
+                    }
+        "403":
+          description: Forbidden
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Access denied due to insufficient permissions:
+                  summary: Access denied due to insufficient permissions
+                  value:
+                    {
+                      "type": "https://example.com/probs/forbidden",
+                      "title": "Access denied",
+                      "detail": "You do not have permission to access this resource.",
+                      "instance": "/voucherdefinitions",
+                    }
+        "404":
+          description: Not found
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Voucher not found:
+                  summary: Voucher not found
+                  value:
+                    {
+                      "type": "https://example.com/probs/not-found",
+                      "title": "Voucher not found",
+                      "detail": "The voucher definition does not exist.",
+                      "instance": "/voucherdefinitions",
+                    }
+        "500":
+          description: Internal server error
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Unexpected server error:
+                  summary: Unexpected server error
+                  value:
+                    {
+                      "type": "https://example.com/probs/internal-server-error",
+                      "title": "Internal Server Error",
+                      "detail": "An unexpected error occurred while processing your request.",
+                      "instance": "/voucherdefinitions",
+                    }
+  /issuedvouchers:
+    get:
+      summary: Get a list of issued vouchers that were issued for a specific touch point
+      description:
+        Retrieve all issued vouchers for a specific touch point. This means that only products that have active sellingPeriods for touch points within the same
+        retailer as the calling touch point are returned.
+      parameters:
+        - name: touchpointId
+          in: query
+          required: false
+          description: |
+            Filter the issued vouchers on a specific touch point id. This means that only issued vouchers for products with active selling periods for the specified touch point are returned.
+            This query parameter is only intended for administrative purposes, since the touch point associated with the access token used in the request is used to determine which issued vouchers are returned. This query parameter can be used to retrieve issued vouchers for other touch points within the same retailer, for example to retrieve issued vouchers for a specific sales touch point that is different from the calling touch point.
+          schema:
+            type: integer
+            example: 1001
+        - name: issuedVoucherId
+          in: query
+          required: false
+          description: The unique identifier of the issued voucher instance to retrieve.
+          schema:
+            type: string
+            format: uuid
+            example: d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90
+        - name: voucherCode
+          in: query
+          required: false
+          description: The unique code of the issued voucher to retrieve.
+          schema:
+            type: string
+            example: VOUCHER123
+        - name: productId
+          in: query
+          required: false
+          description: The unique identifier of the product for which to retrieve all issued vouchers.
+          schema:
+            type: integer
+            example: 263
+        - name: highestVoucherStatusId
+          in: query
+          required: false
+          explode: false
+          description: |-
+            The highest voucher status id to filter the issued vouchers on.
+            - 1 = new
+            - 2 = issued
+            - 3 = redeemed
+            - 4 = revoked
+            - 5 = expired
+          schema:
+            type: array
+            items:
+              type: integer
+            example: [1, 2]
+      tags:
+        - Vouchers
+      responses:
+        "200":
+          description: Successful retrieval of voucher instance
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Voucher for a product with required attributes:
+                  summary: Voucher for a single product with required attributes
+                  value:
+                    {
+                      "issuedVouchers":
+                        [
+                          {
+                            "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+                            "voucherCode": "VOUCHER123",
+                            "fromInclusive": "2024-10-04T00:00:00.000",
+                            "untilInclusive": "2024-11-04T00:00:00.000",
+                            "voucherStatus":
+                              { "voucherStatusId": 1, "name": "New" },
+                            "product":
+                              {
+                                "productId": 263,
+                                "productName": "HTM-80001",
+                                "productDescription": "10 euro korting op Regiovrij maand.",
+                                "productCategory":
+                                  {
+                                    "productCategoryId": 9,
+                                    "isTravelProduct": false,
+                                    "name": "Voucher",
+                                  },
+                                "amountInclTax": -1000,
+                                "requiredProducts":
+                                  [
+                                    {
+                                      "productId": 126,
+                                      "productName": "HTM-30001",
+                                      "productDescription": "Regiovrij maand.",
+                                      "_links":
+                                        {
+                                          "get_details":
+                                            {
+                                              "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/126",
+                                              "method": "GET",
+                                            },
+                                        },
+                                    },
+                                  ],
+                                "_links":
+                                  {
+                                    "get_details":
+                                      {
+                                        "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
+                                        "method": "GET",
+                                      },
+                                  },
+                              },
+                            "claims":
+                              [
+                                {
+                                  "mandatoryCustomerDataItem":
+                                    {
+                                      "mandatoryCustomerDataItemId": 8,
+                                      "customerDataItem": "padBirthDate",
+                                    },
+                                  "value": "1980-06-31",
+                                },
+                                {
+                                  "mandatoryCustomerDataItem":
+                                    {
+                                      "mandatoryCustomerDataItemId": 4,
+                                      "customerDataItem": "emailAddress",
+                                    },
+                                  "value": "harry@griffindor.co.uk",
+                                },
+                              ],
+                          },
+                        ],
+                    }
+                Voucher for a whole order:
+                  summary: Voucher for a whole order
+                  value:
+                    {
+                      "issuedVouchers":
+                        [
+                          {
+                            "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+                            "voucherCode": "VOUCHER123",
+                            "fromInclusive": "2024-10-04T00:00:00.000",
+                            "untilInclusive": "2024-11-04T00:00:00.000",
+                            "voucherStatus":
+                              { "voucherStatusId": 1, "name": "New" },
+                            "product":
+                              {
+                                "productId": 263,
+                                "productName": "HTM-80002",
+                                "productDescription": "10 euro korting op je gehele winkelmand.",
+                                "productCategory":
+                                  {
+                                    "productCategoryId": 9,
+                                    "isTravelProduct": false,
+                                    "name": "Voucher",
+                                  },
+                                "amountInclTax": -1000,
+                                "requiredProducts": [],
+                                "_links":
+                                  {
+                                    "get_details":
+                                      {
+                                        "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
+                                        "method": "GET",
+                                      },
+                                  },
+                              },
+                          },
+                          "claims": [],
+                        ],
+                    }
+        "403":
+          description: Forbidden
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Access denied due to insufficient permissions:
+                  summary: Access denied due to insufficient permissions
+                  value:
+                    {
+                      "type": "https://example.com/probs/forbidden",
+                      "title": "Access denied",
+                      "detail": "You do not have permission to access this resource.",
+                      "instance": "/issuedvouchers",
+                    }
+        "404":
+          description: Not found
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Voucher not found:
+                  summary: Voucher not found
+                  value:
+                    {
+                      "type": "https://example.com/probs/not-found",
+                      "title": "Voucher not found",
+                      "detail": "The voucher with code VOUCHER123 does not exist.",
+                      "instance": "/issuedvouchers",
+                    }
+        "500":
+          description: Internal server error
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/rfc9457"
+              examples:
+                Unexpected server error:
+                  summary: Unexpected server error
+                  value:
+                    {
+                      "type": "https://example.com/probs/internal-server-error",
+                      "title": "Internal Server Error",
+                      "detail": "An unexpected error occurred while processing your request.",
+                      "instance": "/issuedvouchers",
+                    }
+    post:
+      summary: Issue a voucher for a specific product
+      description: |
+        Issue a voucher for a specific product. The voucher will be issued for the touch point that is associated with the access token used in the request. 
+        The product for which the voucher should be issued must have active selling periods for touch points within the same retailer as the calling touch point.
+      tags:
+        - Vouchers
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Issue a voucher with prefilled voucher code:
+                summary: Issue a voucher with prefilled voucher code
+                value:
+                  {
+                    "voucherCode": "VOUCHER123",
+                    "fromInclusive": "2024-10-04T00:00:00.000",
+                    "untilInclusive": "2024-11-04T00:00:00.000",
+                    "productId": 263,
+                    "voucherClaims":
+                      [
+                        {
+                          "mandatoryCustomerDataItemId": 8,
+                          "value": "1970-01-01",
+                        },
+                        {
+                          "mandatoryCustomerDataItemId": 4,
+                          "value": "stasjo@html.nl",
+                        },
+                      ],
+                  }
+              Issue a voucher without prefilled voucher code:
+                summary: Issue a voucher without prefilled voucher code
+                value:
+                  {
+                    "fromInclusive": "2024-10-04T00:00:00.000",
+                    "untilInclusive": "2024-11-04T00:00:00.000",
+                    "productId": 263,
+                    "voucherClaims":
+                      [
+                        {
+                          "mandatoryCustomerDataItemId": 8,
+                          "value": "1970-01-01",
+                        },
+                        {
+                          "mandatoryCustomerDataItemId": 4,
+                          "value": "stasjo@html.nl",
+                        },
+                      ],
+                  }
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Successfully issued a voucher:
+                  summary: Successfully issued a voucher
+                  value:
+                    {
+                      "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+                      "voucherCode": "HKV-A7J-128-PYT",
+                      "fromInclusive": "2024-10-04T00:00:00.000",
+                      "untilInclusive": "2024-11-04T00:00:00.000",
+                      "voucherStatus": { "voucherStatusId": 1, "name": "New" },
+                      "product":
+                        {
+                          "productId": 263,
+                          "productName": "HTM-80002",
+                          "productDescription": "10 euro korting op je gehele winkelmand.",
+                          "productCategory":
+                            {
+                              "productCategoryId": 9,
+                              "isTravelProduct": false,
+                              "name": "Voucher",
+                            },
+                          "amountInclTax": -1000,
+                          "requiredProducts": [],
+                          "_links":
+                            {
+                              "get_details":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
+                                  "method": "GET",
+                                },
+                            },
+                        },
+                    }
+  /issuedvouchers/{issuedVoucherId}:
+    parameters:
+      - name: issuedVoucherId
+        in: path
+        required: true
+        description: The unique identifier of the issued voucher instance to update the status for.
+        schema:
+          type: string
+          format: uuid
+          example: d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90
+    patch:
+      summary: Update the status of an issued voucher
+      description: Update the status of an issued voucher. This can be used to mark a voucher as redeemed, revoked or expired.
+      tags:
+        - Vouchers
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Mark a voucher as expired:
+                summary: Mark a voucher as expired
+                value:
+                  {
+                    "voucherStatusId": 5,
+                  }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Successfully updated the status of a voucher:
+                  summary: Successfully updated the status of a voucher
+                  value:
+                    {
+                      "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+                      "voucherCode": "HKV-A7J-128-PYT",
+                      "fromInclusive": "2024-10-04T00:00:00.000",
+                      "untilInclusive": "2024-11-04T00:00:00.000",
+                      "voucherStatus": { "voucherStatusId": 5, "name": "Expired" },
+                      "product":
+                        {
+                          "productId": 263,
+                          "productName": "HTM-80002",
+                          "productDescription": "10 euro korting op je gehele winkelmand.",
+                          "productCategory":
+                            {
+                              "productCategoryId": 9,
+                              "isTravelProduct": false,
+                              "name": "Voucher",
+                            },
+                          "amountInclTax": -1000,
+                          "requiredProducts": [],
+                          "_links":
+                            {
+                              "get_details":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
+                                  "method": "GET",
+                                },
+                            },
+                        },
+                    }
+components:
+  securitySchemes:
+    bearerToken:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+  schemas:
+    unavailable:
+      type: object
+    rfc9457:
+      type: object
+      properties:
+        type:
+          type: string
+          format: url
+          example: https://example.com/probs/out-of-credit
+        title:
+          type: string
+          example: You do not have enough credit.
+        detail:
+          type: string
+          example: Your current balance is 30, but that costs 50.
+        instance:
+          type: string
+          example: /account/12345/msgs/abc
+        balance:
+          type: string
+          example: 30
+        accounts:
+          type: array
+          items:
+            type: string
+            example:
+              - /account/12345
+              - /account/67890

src/openapi/products/purchased_products-crud.yaml

@@ -1009,6 +1009,8 @@ paths:
                       "value": "vlad.harkonnen@househarkonnen.net",
                     },
                   ],
+                "fromInclusive": "2024-10-04T12:34:56.000",
+                "untilInclusive": "2025-10-04T12:34:56.000",
               }
       responses:
         "201":
@@ -1104,6 +1106,8 @@ paths:
                               "value": "vlad.harkonnen@househarkonnen.net",
                             },
                           ],
+                        "fromInclusive": "2024-10-04T12:34:56.000",
+                        "untilInclusive": "2025-10-04T12:34:56.000",
                       },
                     ],
                 }
@@ -1165,439 +1169,6 @@ paths:
                       { "voucherStatusId": 5, "name": "Expired" },
                     ],
                 }
-  /purchasedproducts/bulk:
-    post:
-      tags:
-        - Bulk processing
-      summary: Create one or more purchased product(s) in bulk.
-      description: Create a new purchased product.
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/unavailable"
-            examples:
-              Create Single Purchased GBO Product:
-                value:
-                  {
-                    "purchasedProducts":[
-                      {
-                        "productId": 11,
-                        "createdOn": "2024-10-04T12:34:56.000",
-                        "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                        "purchasedProductResources":
-                          [
-                            {
-                              "resourceNameId": 1,
-                              "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
-                            },
-                            {
-                              "resourceNameId": 2,
-                              "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
-                            },
-                          ],
-                        "purchasedGboProducts":
-                          [
-                            {
-                              "salesTimestamp": "2024-10-04T12:34:56.000",
-                              "refundTimestamp": "2024-10-04T12:34:56.000",
-                              "fromInclusive": "2024-10-04T12:34:56.000",
-                              "untilInclusive": "2024-10-04T12:34:56.000",
-                              "packageTemplateId": "30003",
-                              "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
-                              "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
-                              "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
-                              "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
-                              "ovPayTokenId": 13,
-                              "createdOn": "2024-10-04T12:34:56.000",
-                              "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                              "createdBy": "someuser",
-                              "lastUpdatedBy": null,
-                            },
-                          ],
-                        "purchasedTapconnectTickets": [],
-                        "issuedVouchers": [],
-                      }
-                    ]
-                  }
-              Create Single Purchased TapConnet Ticket:
-                value:                
-                  {
-                    "purchasedProducts":[
-                      {
-                        "productId": 11,
-                        "createdOn": "2024-10-04T12:34:56.000",
-                        "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                        "purchasedProductResources":
-                          [
-                            {
-                              "resourceNameId": 1,
-                              "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
-                            },
-                            {
-                              "resourceNameId": 2,
-                              "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
-                            },
-                          ],
-                        "purchasedGboProducts": [],
-                        "purchasedTapconnectTickets":
-                          [
-                            {
-                              "issuedAt": "2024-10-04T12:34:56.000",
-                              "activatedAt": "2024-10-04T12:34:56.000",
-                              "cancelledAt": null,
-                              "ticketReference": "KJj43nejhbTxhr897287",
-                              "createdOn": "2024-10-04T12:34:56.000",
-                              "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                              "createdBy": "user",
-                              "lastUpdatedBy": "user",
-                            },
-                          ],
-                        "issuedVouchers": [],
-                      }
-                    ]
-                  }
-              Create Single Issued Voucher:
-                value:
-                  {
-                    "purchasedProducts":[
-                      {
-                        "productId": 11,
-                        "createdOn": "2024-10-04T12:34:56.000",
-                        "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                        "purchasedProductResources":
-                          [
-                            {
-                              "resourceNameId": 1,
-                              "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
-                            },
-                            {
-                              "resourceNameId": 2,
-                              "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
-                            },
-                          ],
-                        "purchasedGboProducts": [],
-                        "purchasedTapconnectTickets": [],
-                        "issuedVouchers":
-                          [
-                            {
-                              "voucherCode": "VOUCHER123",
-                              "voucherStatusInstances":
-                                [
-                                  {
-                                    "voucherStatusId": 1,
-                                    "createdOn": "2024-10-04T12:34:56.000",
-                                  },
-                                ],
-                              "voucherClaims":
-                                [
-                                  {
-                                    "mandatoryCustomerDataItemId": 8,
-                                    "value": "1999-12-31",
-                                  },
-                                  {
-                                    "mandatoryCustomerDataItemId": 4,
-                                    "value": "vlad.harkonnen@househarkonnen.net",
-                                  },
-                                ],
-                            },
-                          ],
-                      }
-                    ]
-                  }
-              Create Multiple Issued Vouchers:
-                value:
-                  {
-                    "purchasedProducts":[
-                      {
-                        "productId": 11,
-                        "createdOn": "2024-10-04T12:34:56.000",
-                        "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                        "purchasedProductResources":
-                          [
-                            {
-                              "resourceNameId": 1,
-                              "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
-                            },
-                            {
-                              "resourceNameId": 2,
-                              "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
-                            },
-                          ],
-                        "purchasedGboProducts": [],
-                        "purchasedTapconnectTickets": [],
-                        "issuedVouchers":
-                          [
-                            {
-                              "voucherCode": "VOUCHER123",
-                              "voucherStatusInstances":
-                                [
-                                  {
-                                    "voucherStatusId": 1,
-                                    "createdOn": "2024-10-04T12:34:56.000",
-                                  },
-                                ],
-                              "voucherClaims":
-                                [
-                                  {
-                                    "mandatoryCustomerDataItemId": 8,
-                                    "value": "1999-12-31",
-                                  },
-                                  {
-                                    "mandatoryCustomerDataItemId": 4,
-                                    "value": "vlad.harkonnen@househarkonnen.net",
-                                  },
-                                ],
-                            },
-                          ],
-                      },
-                      {
-                        "productId": 11,
-                        "createdOn": "2024-10-04T12:34:56.000",
-                        "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                        "purchasedProductResources":
-                          [
-                            {
-                              "resourceNameId": 1,
-                              "resourceIdentifier": "7ce32f9b-52f0-4e80-a527-0c6184b57f52",
-                            },
-                            {
-                              "resourceNameId": 2,
-                              "resourceIdentifier": "02047745-f03e-4c00-8e1b-8dc5c86a786e",
-                            },
-                          ],
-                        "purchasedGboProducts": [],
-                        "purchasedTapconnectTickets": [],
-                        "issuedVouchers":
-                          [
-                            {
-                              "voucherCode": "VOUCHER123",
-                              "voucherStatusInstances":
-                                [
-                                  {
-                                    "voucherStatusId": 1,
-                                    "createdOn": "2024-10-04T12:34:56.000",
-                                  },
-                                ],
-                              "voucherClaims":
-                                [
-                                  {
-                                    "mandatoryCustomerDataItemId": 8,
-                                    "value": "1940-01-18",
-                                  },
-                                  {
-                                    "mandatoryCustomerDataItemId": 4,
-                                    "value": "valdemar.hoskanner@househarkonnen.net",
-                                  },
-                                ],
-                            },
-                          ],
-                      },
-                      {
-                        "productId": 11,
-                        "createdOn": "2024-10-04T12:34:56.000",
-                        "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                        "purchasedProductResources":
-                          [
-                            {
-                              "resourceNameId": 1,
-                              "resourceIdentifier": "7c71ec8a-3326-451f-9464-3e36d10260e3",
-                            },
-                            {
-                              "resourceNameId": 2,
-                              "resourceIdentifier": "73c7a805-2edf-4616-a04c-267e88e0931c",
-                            },
-                          ],
-                        "purchasedGboProducts": [],
-                        "purchasedTapconnectTickets": [],
-                        "issuedVouchers":
-                          [
-                            {
-                              "voucherCode": "VOUCHER123",
-                              "voucherStatusInstances":
-                                [
-                                  {
-                                    "voucherStatusId": 1,
-                                    "createdOn": "2024-10-04T12:34:56.000",
-                                  },
-                                ],
-                              "voucherClaims":
-                                [
-                                  {
-                                    "mandatoryCustomerDataItemId": 8,
-                                    "value": "2016-06-08",
-                                  },
-                                  {
-                                    "mandatoryCustomerDataItemId": 4,
-                                    "value": "alia.artreides@housearteides.net",
-                                  },
-                                ],
-                            },
-                          ],
-                      }
-                    ]
-                  }
-      responses:
-        "202":
-          description: Accepted
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/BulkResponseBody"
-              examples:
-                Array of purchased products accepted:
-                  summary: Array of purchased products accepted
-                  description: |
-                    The array of purchased products was accepted successfully.
-                    The purchased products will be processed asynchronously.
-                    In the response body the consumer will find information on how to retrieve the processing status.
-                  value:
-                    startTime: 2025-02-14T05:32:47.0672237Z
-                    status: Running
-                    clientTrackingId: 08584620957189579629541919368CU00
-                    callbackurl: https://api.integratielaag.nl/purchasedproducts/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
-                    retryAfter: 10
-                    summary: null
-  /purchasedproducts/bulk/{clientTrackingId}:
-    get:
-      tags:
-        - Bulk processing
-      summary: Get the status of the purchased products bulk post.
-      description: Get the status of the asynchronous purchased products bulk post.
-      parameters:
-        - in: path
-          name: clientTrackingId
-          schema:
-            type: string
-          required: true
-          description: The clientTrackingId of the purchased products bulk post.
-      responses:
-        "200":
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/BulkResponseBody"
-              examples:
-                Batch successfully processed:
-                  summary: Batch successfully processed
-                  description: |
-                    Body of a batch of purchased products that was successfully created. 
-                    A number of purchased products were created.
-                  value:                   
-                    startTime: "2025-02-14T05:32:47.067Z"
-                    status: "Finished"
-                    clientTrackingId: "08584620957189579629541919368CU00"
-                    callbackurl: https://api.integratielaag.nl/purchasedproducts/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
-                    retryAfter: 0
-                    summary:
-                      created: 13
-                      updated: 0
-                      total: 13
-  /voucherstatusinstances/bulk:
-    post: 
-      summary: Post voucher status instances in bulk.
-      description: Post voucher status instances in bulk.
-      tags:
-        - Bulk processing
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/unavailable"
-            examples:
-              List of issued vouchers to set status to revoked:
-                summary: List of issued vouchers to set status to revoked
-                description: List of issued vouchers to set status to revoked
-                value:
-                 {
-                  "voucherStatusInstances":[
-                    {
-                      "issuedVoucherId": "8a63552f-faf5-43f3-b22d-bebc976a8a5e",
-                      "voucherStatusId": 4,
-                      "createdOn": "2024-10-04T12:34:56.000"
-                    },
-                    {
-                      "issuedVoucherId": "a9ff40ec-2940-413a-9957-dfd471c4caf3",
-                      "voucherStatusId": 4,
-                      "createdOn": "2024-10-04T12:34:56.000"
-                    },
-                    {
-                      "issuedVoucherId": "9e7363e6-beaa-4c38-9ed6-c8afed459bd5",
-                      "voucherStatusId": 4,
-                      "createdOn": "2024-10-04T12:34:56.000"
-                    },
-                    {
-                      "issuedVoucherId": "9d7332d6-1949-4c20-aa99-d87096b035fa",
-                      "voucherStatusId": 4,
-                      "createdOn": "2024-10-04T12:34:56.000"
-                    },
-                    {
-                      "issuedVoucherId": "43ca757b-8370-4cb0-92b9-717948383d5e",
-                      "voucherStatusId": 4,
-                      "createdOn": "2024-10-04T12:34:56.000"
-                    },
-                  ]
-                 }
-      responses:
-        "202":
-          description: Accepted
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/BulkResponseBody"
-              examples:
-                Array of issued vouchers accepted:
-                  summary: Array of issued vouchers status instances accepted
-                  description: |
-                    The array of issued vouchers status instances was accepted successfully.
-                    The issued vouchers status instances will be processed asynchronously.
-                    In the response body the consumer will find information on how to retrieve the processing status.
-                  value:
-                    startTime: 2025-02-14T05:32:47.0672237Z
-                    status: Running
-                    clientTrackingId: 08584620957189579629541919368CU00
-                    callbackurl: https://api.integratielaag.nl/voucherstatusinstances/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
-                    retryAfter: 10
-                    summary: null
-  /voucherstatusinstances/bulk/responsestatus/{clientTrackingId}:
-    get:
-      tags:
-        - Bulk processing
-      summary: Get the status of the voucher status instances bulk post.
-      description: Get the status of the asynchronous voucher status instances bulk post.
-      parameters:
-        - in: path
-          name: clientTrackingId
-          schema:
-            type: string
-          required: true
-          description: The clientTrackingId of the voucher status instances bulk post.
-      responses:
-        "200":
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/BulkResponseBody"
-              examples:
-                Batch successfully processed:
-                  summary: Batch successfully processed
-                  description: |
-                    Body of a batch of voucher status instances that was successfully created. 
-                    A number of voucher status instances were created.
-                  value:                   
-                    startTime: "2025-02-14T05:32:47.067Z"
-                    status: "Finished"
-                    clientTrackingId: "08584620957189579629541919368CU00"
-                    callbackurl: https://api.integratielaag.nl/voucherstatusinstances/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
-                    retryAfter: 0
-                    summary:
-                      created: 5
-                      updated: 0
-                      total: 5 
 components:
   securitySchemes:
     bearerToken:
@@ -1627,8 +1198,8 @@ components:
         retryAfter:
           type: integer
           example: 10
-        summary: 
-          $ref: "#/components/schemas/summaryBody"        
+        summary:
+          $ref: "#/components/schemas/summaryBody"
       required:
         - startTime
         - status
@@ -1656,7 +1227,7 @@ components:
             - total
             - updated
       required:
-        - summary    
+        - summary
     rfc9457:
       type: object
       properties: