Merge pull request 'develop' (#38) from develop into main

Reviewed-on: #38

src/dotnet/padp-reference-web/PadpReferenceApi/.gitignore

@@ -0,0 +1,307 @@
+########################
+##                    ##
+## CUSTOM IGNORE LIST ##
+##                    ##
+########################
+
+# Ignore appsettings.json as it contains credentials - only the template should be shared!
+appsettings.json
+
+# Also ignore pfx and pem files for the same reason
+*.pfx
+*.pem
+
+
+
+
+
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+x64/
+x86/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+
+# Visual Studio 2015 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUNIT
+*.VisualState.xml
+TestResult.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+**/Properties/launchSettings.json
+
+# VS Code
+.vscode/
+
+*_i.c
+*_p.c
+*_i.h
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# TODO: Comment the next line if you want to checkin your web deploy settings
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/packages/*
+# except build/, which is used as an MSBuild target.
+!**/packages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/packages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+*.mdf
+*.ldf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Typescript v1 declaration files
+typings/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# JetBrains Rider
+.idea/
+*.sln.iml
+
+# CodeRush
+.cr/
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs

src/java/ABTProductsPUTGenerator/.gitignore

@@ -0,0 +1,38 @@
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

src/java/ABTProductsPUTGenerator/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

src/java/ABTProductsPUTGenerator/.idea/encodings.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding">
+    <file url="file://$PROJECT_DIR$/src/main/java" charset="UTF-8" />
+    <file url="file://$PROJECT_DIR$/src/main/resources" charset="UTF-8" />
+  </component>
+</project>

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

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ExternalStorageConfigurationManager" enabled="true" />
+  <component name="MavenProjectsManager">
+    <option name="originalFiles">
+      <list>
+        <option value="$PROJECT_DIR$/pom.xml" />
+      </list>
+    </option>
+  </component>
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="temurin-21" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

src/java/ABTProductsPUTGenerator/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/../../.." vcs="Git" />
+  </component>
+</project>

src/java/ABTProductsPUTGenerator/bin/README.md

@@ -0,0 +1,12 @@
+# ABTProducts PUT request body generator
+Simple tool to quickly edit HTM products via ABTProducts REST API.
+
+- Requires JRE 21
+- 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)
+- Generates the equivalent PUT request body - send via either:
+  - Postman WSO2 ABTProducts collection
+  - `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)

src/java/ABTProductsPUTGenerator/bin/input.json

@@ -0,0 +1,160 @@
+{
+  "productId": 151,
+  "fikoArticleNumber": null,
+  "parentProductId": 114,
+  "gboPackageTemplateId": "33629",
+  "tapConnectProductCode": null,
+  "productName": "HTM Regio Vrij - Voltarief - Losse Maand - HL62",
+  "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
+  "validityPeriod": {
+    "validityPeriodId": 262,
+    "fromInclusive": "2024-09-30T23:00:00.000+00:00",
+    "toInclusive": "2099-12-30T23:00:00.000+00:00"
+  },
+  "productTranslations": [
+    {
+      "language": "en",
+      "name": "HTM Regio Free - Full Fare - 1 Month - HL62",
+      "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62"
+    }
+  ],
+  "productOwner": {
+    "productOwnerId": 19,
+    "name": "MRDH",
+    "organization": "MRDH"
+  },
+  "marketSegments": null,
+  "customerSegments": null,
+  "allowedGboAgeProfiles": [
+    {
+      "gboAgeProfileId": 1,
+      "name": "Baby/peuter (0 t/m 3 jaar)",
+      "ageFromInclusive": 0,
+      "ageToInclusive": 3
+    },
+    {
+      "gboAgeProfileId": 4,
+      "name": "Volwassene (19 t/m 64 jaar)",
+      "ageFromInclusive": 19,
+      "ageToInclusive": 64
+    },
+    {
+      "gboAgeProfileId": 5,
+      "name": "Oudere (65 jaar of ouder)",
+      "ageFromInclusive": 65,
+      "ageToInclusive": 999
+    }
+  ],
+  "productCategory": {
+    "productCategoryId": 3,
+    "isTravelProduct": true,
+    "name": "Afgekocht reisrecht"
+  },
+  "requiredCustomerLevel": {
+    "requiredCustomerLevelId": 3,
+    "name": "profile"
+  },
+  "requiredProducts": null,
+  "incompatibleProducts": null,
+  "mandatoryCustomerDataItems": [
+    {
+      "mandatoryCustomerDataItemId": 1,
+      "customerDataItem": "birthname"
+    },
+    {
+      "mandatoryCustomerDataItemId": 2,
+      "customerDataItem": "surname"
+    },
+    {
+      "mandatoryCustomerDataItemId": 4,
+      "customerDataItem": "emailAddress"
+    },
+    {
+      "mandatoryCustomerDataItemId": 8,
+      "customerDataItem": "padBirthDate"
+    }
+  ],
+  "requiredGboPersonalAttributes": [
+    {
+      "requiredGboPersonalAttributeId": 1,
+      "name": "NAME"
+    },
+    {
+      "requiredGboPersonalAttributeId": 2,
+      "name": "BIRTHDATE"
+    },
+    {
+      "requiredGboPersonalAttributeId": 3,
+      "name": "PHOTO"
+    }
+  ],
+  "tokenTypes": [
+    {
+      "tokenTypeId": 1,
+      "name": "EMV"
+    }
+  ],
+  "paymentMoment": {
+    "paymentMomentId": 1,
+    "name": "prepaid"
+  },
+  "serviceOptions": null,
+  "validityDuration": "P1M",
+  "maxStartInFutureDuration": "P6W",
+  "isRenewable": false,
+  "sendInvoice": false,
+  "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg",
+  "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij",
+  "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/",
+  "isSellableAtHtm": true,
+  "needsSolvencyCheckConsumer": false,
+  "needsSolvencyCheckBusiness": false,
+  "sellingPeriods": [
+    {
+      "sellingPeriodId": 214,
+      "fromInclusive": "2024-10-30T23:00:00.000+00:00",
+      "toInclusive": "2029-12-30T23:00:00.000+00:00",
+      "salesTouchpoint": {
+        "salesTouchpointId": 3,
+        "name": "Website (Perplex)",
+        "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": null,
+      "sellingPrices": [
+        {
+          "sellingPriceId": 195,
+          "taxCode": "V09",
+          "taxPercentage": 9.0000,
+          "amountExclTax": 13486,
+          "amountInclTax": 14700,
+          "fromInclusive": "2024-10-30T23:00:00.000+00:00",
+          "toInclusive": "2029-12-01T23:00:00.000+00:00",
+          "internalPrice": 0.0000
+        }
+      ]
+    }
+  ],
+  "purchasePrices": null,
+  "auditTrail": [
+    {
+      "auditTrailId": 475,
+      "action": "insert",
+      "user": "api",
+      "timestamp": "2025-05-07T14:05:43.213+00:00"
+    }
+  ]
+}

src/java/ABTProductsPUTGenerator/bin/output.json

@@ -0,0 +1,59 @@
+{
+  "fikoArticleNumber" : null,
+  "parentProductId" : 114,
+  "gboPackageTemplateId" : "33629",
+  "tapConnectProductCode" : null,
+  "productName" : "HTM Regio Vrij - Voltarief - Losse Maand - HL62",
+  "productDescription" : "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
+  "validityPeriod" : {
+    "validityPeriodId" : 262,
+    "fromInclusive" : "2024-09-30T23:00:00.000+00:00",
+    "toInclusive" : "2099-12-30T23:00:00.000+00:00"
+  },
+  "productTranslations" : [ {
+    "language" : "en",
+    "name" : "HTM Regio Free - Full Fare - 1 Month - HL62",
+    "description" : "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62"
+  } ],
+  "productOwnerId" : 19,
+  "marketSegmentIds" : null,
+  "customerSegmentIds" : null,
+  "allowedGboAgeProfileIds" : [ 1, 4, 5 ],
+  "productCategoryId" : 3,
+  "requiredCustomerLevelId" : 3,
+  "requiredProducts" : null,
+  "incompatibleProducts" : null,
+  "mandatoryCustomerDataItemIds" : [ 1, 2, 4, 8 ],
+  "requiredGboPersonalAttributeIds" : [ 1, 2, 3 ],
+  "tokenTypeIds" : [ 1 ],
+  "paymentMomentId" : 1,
+  "serviceOptionIds" : null,
+  "validityDuration" : "P1M",
+  "maxStartInFutureDuration" : "P6W",
+  "isRenewable" : false,
+  "sendInvoice" : false,
+  "imageReference" : "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg",
+  "productPageUrl" : "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij",
+  "termsUrl" : "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/",
+  "isSellableAtHtm" : true,
+  "needsSolvencyCheckConsumer" : false,
+  "needsSolvencyCheckBusiness" : false,
+  "sellingPeriods" : [ {
+    "sellingPeriodId" : 214,
+    "fromInclusive" : "2024-10-30T23:00:00.000+00:00",
+    "toInclusive" : "2029-12-30T23:00:00.000+00:00",
+    "salesTouchpointId" : 3,
+    "forbiddenPaymentMethodIds" : null,
+    "sellingPrices" : [ {
+      "sellingPriceId" : 195,
+      "taxCode" : "V09",
+      "taxPercentage" : 9.0,
+      "amountExclTax" : 13486,
+      "amountInclTax" : 14700,
+      "fromInclusive" : "2024-10-30T23:00:00.000+00:00",
+      "toInclusive" : "2029-12-01T23:00:00.000+00:00",
+      "internalPrice" : 0.0
+    } ]
+  } ],
+  "purchasePrices" : null
+}

src/java/ABTProductsPUTGenerator/output.json

@@ -0,0 +1,58 @@
+{
+  "parentProductId" : null,
+  "productCode" : "30901-WA",
+  "gboPackageTemplateId" : "30901",
+  "tapConnectProductCode" : null,
+  "productGroupMetadata" : null,
+  "productName" : "HTM P1W Prolongatie-Test 90% Korting",
+  "productDescription" : "Reis je regelmatig met HTM? Activeer dan HTM 90% Korting op je betaalpas of credit card en reis met korting!",
+  "validityPeriod" : {
+    "validityPeriodId" : 148,
+    "fromInclusive" : "2023-12-31T23:00:00.000+00:00",
+    "toInclusive" : "2029-12-08T04:00:00.000+00:00"
+  },
+  "productTranslations" : [ {
+    "language" : "en",
+    "name" : "HTM Prolongation-Test 90% Discount",
+    "description" : "Are you a regular traveler? Activate HTM 90% discount on your EMV card!"
+  } ],
+  "productOwnerId" : 17,
+  "marketSegmentIds" : [ 1 ],
+  "customerSegmentIds" : [ 2, 3, 4, 5 ],
+  "productCategoryId" : 1,
+  "requiredCustomerLevelId" : 3,
+  "requiredProducts" : null,
+  "incompatibleProducts" : null,
+  "mandatoryCustomerDataItemIds" : [ 1, 2, 4, 5 ],
+  "requiredGboPersonalAttributes" : null,
+  "tokenTypeIds" : [ 1 ],
+  "paymentMomentId" : 1,
+  "serviceOptions" : null,
+  "validityDuration" : "P1W",
+  "maxStartInFutureDuration" : "P6W",
+  "isRenewable" : true,
+  "sendInvoice" : true,
+  "imageReference" : "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg",
+  "productPageUrl" : "https://web.acc.cloud.htm.nl/webshop/htm-90-korting/",
+  "termsUrl" : "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-90-korting/",
+  "isSellableAtHtm" : true,
+  "needsSolvencyCheckConsumer" : false,
+  "needsSolvencyCheckBusiness" : false,
+  "sellingPeriods" : [ {
+    "sellingPeriodId" : 89,
+    "fromInclusive" : "2024-09-30T23:00:00.000+00:00",
+    "toInclusive" : "2029-12-01T23:00:00.000+00:00",
+    "salesTouchpointId" : 3,
+    "forbiddenPaymentMethodIds" : null,
+    "sellingPrices" : [ {
+      "sellingPriceId" : 82,
+      "amountExclTax" : 92,
+      "amountInclTax" : 100,
+      "fromInclusive" : "2024-09-30T23:00:00.000+00:00",
+      "toInclusive" : "2029-12-01T23:00:00.000+00:00",
+      "internalPrice" : 0.0,
+      "taxMetadataId" : "47C8972E-A730-4032-9BDA-AF0A5BCB2C85"
+    } ]
+  } ],
+  "purchasePrices" : null
+}

src/java/ABTProductsPUTGenerator/pom.xml

@@ -0,0 +1,67 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>nl.htm.ovpay.abt</groupId>
+  <artifactId>ABTProductsPUTGenerator</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <name>ABTProductsPUTGenerator</name>
+  <description>Generate an ABTProducts PUT request body from a given ABTProducts GET response body</description>
+
+  <dependencies>
+    <!-- Log4j Slf4j Logging -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api</artifactId>
+      <version>2.23.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+      <version>2.23.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-slf4j-impl</artifactId>
+      <version>2.23.1</version>
+    </dependency>
+    <!-- JSON parsing -->
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+      <version>2.17.2</version>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <executions>
+          <execution>
+            <phase>package</phase>
+            <goals>
+              <goal>single</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <archive>
+            <manifest>
+              <mainClass>nl.htm.ovpay.abt.ABTProductsPUTGenerator</mainClass>
+            </manifest>
+          </archive>
+          <descriptorRefs>
+            <descriptorRef>jar-with-dependencies</descriptorRef>
+          </descriptorRefs>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <source>21</source>
+          <target>21</target>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

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

@@ -0,0 +1,338 @@
+package nl.htm.ovpay.abt;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+import java.util.Map;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
+import com.fasterxml.jackson.databind.node.JsonNodeType;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+public class ABTProductsPUTGenerator {
+    private static final Logger LOGGER = LoggerFactory.getLogger(ABTProductsPUTGenerator.class);
+
+    public static void main(String[] args) throws Exception {
+        if (args.length != 2) {
+            LOGGER.info("To modify input/output path, use: java -jar ABTProductsPUTGenerator.jar <inputPath> <outputPath>");
+        }
+        var inputFile = args.length > 0 ? args[0] : "input.json";
+        var outputFile = args.length > 1 ? args[1] : "output.json";
+        try (InputStream is = getInputStream(inputFile)) {
+            ObjectMapper mapper = new ObjectMapper();
+            JsonNode jsonNode = mapper.readTree(is);
+            Long productId = jsonNode.get("productId").asLong();
+
+            LOGGER.info("Successfully parsed product with productId {} from JSON:\n{}\n", productId, jsonNode.toPrettyString());
+
+            JsonNode putJsonNode = processJsonNode(jsonNode);
+
+            writeToFile(putJsonNode, outputFile);
+
+            LOGGER.info("DONE! Modify the output JSON as desired and send it as ABTProducts PUT request body:");
+            LOGGER.info("curl -X PUT -H 'Content-Type: application/json' {baseUrl}/abt/abtproducts/1.0/products/{} --data @{}", productId, outputFile);
+        }
+    }
+
+    private static InputStream getInputStream(String filePath) throws IOException {
+        var externalResource = new File(filePath);
+        if (externalResource.exists()) {
+            LOGGER.info("Loading ABTProducts details JSON from external file {}...", externalResource.getAbsolutePath());
+            return externalResource.toURI().toURL().openStream();
+        } else {
+            LOGGER.info("External file {} not found, using internal resource /input.json...", filePath);
+            return ABTProductsPUTGenerator.class.getResourceAsStream("/input.json");
+        }
+    }
+
+    private static void writeToFile(JsonNode jsonNode, String filePath) throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        var outputFile = new File(filePath);
+        if (outputFile.exists()) {
+            LOGGER.info("Deleting existing output file {}...", filePath);
+            outputFile.delete();
+        }
+        mapper.writerWithDefaultPrettyPrinter().writeValue(outputFile, jsonNode);
+        LOGGER.info("Successfully wrote JSON to file {}!", outputFile.getAbsolutePath(), jsonNode.toPrettyString());
+    }
+
+    private static JsonNode processJsonNode(JsonNode jsonNode) {
+        var newJsonNode = new ObjectNode(new JsonNodeFactory(true));
+
+        jsonNode.fields().forEachRemaining(jsonField -> {
+            if (!List.of(JsonNodeType.ARRAY, JsonNodeType.OBJECT).contains(jsonField.getValue().getNodeType())) {
+                if (jsonField.getValue().isNull()) {
+                    checkRewriteNullFields(jsonField, newJsonNode);
+                } else if (!jsonField.getKey().equals("productId") && !jsonField.getKey().equals("auditTrail")) {
+                    LOGGER.info("Keeping {} as-is...", jsonField.getKey());
+                    newJsonNode.put(jsonField.getKey(), jsonField.getValue());
+                }
+            } else {
+                if (List.of("validityPeriod", "productTranslations").contains(jsonField.getKey())) {
+                    LOGGER.info("Keeping {} as-is...", jsonField.getKey());
+                    newJsonNode.set(jsonField.getKey(), jsonField.getValue());
+                } else {
+                    rewriteObjectFields(jsonField, newJsonNode);
+                    rewriteArrayFields(jsonField, newJsonNode);
+                }
+            }
+        });
+
+        LOGGER.info("Successfully rewritten into PUT JSON:\n{}\n", newJsonNode.toPrettyString());
+
+        return newJsonNode;
+    }
+
+    private static void checkRewriteNullFields(Map.Entry<String, JsonNode> jsonField, JsonNode newJsonNode) {
+        switch (jsonField.getKey()) {
+            case "productOwner" -> {
+                LOGGER.info("Rewriting null productOwner to productOwnerId...");
+                ((ObjectNode)newJsonNode).putRawValue("productOwnerId", null);
+            }
+            case "productCategory" -> {
+                LOGGER.info("Rewriting null productCategory to productCategoryId...");
+                ((ObjectNode)newJsonNode).putRawValue("productCategoryId", null);
+            }
+            case "paymentMoment" -> {
+                LOGGER.info("Rewriting null paymentMoment to paymentMomentId...");
+                ((ObjectNode)newJsonNode).putRawValue("paymentMomentId", null);
+            }
+            case "requiredCustomerLevel" -> {
+                LOGGER.info("Rewriting null requiredCustomerLevel to requiredCustomerLevelId...");
+                ((ObjectNode)newJsonNode).putRawValue("requiredCustomerLevelId", null);
+            }
+            case "layerInfo" -> {
+                LOGGER.info("Rewriting null layerInfo to layerInfoId...");
+                ((ObjectNode)newJsonNode).putRawValue("layerInfoId", null);
+            }
+            case "marketSegments" -> {
+                LOGGER.info("Rewriting null marketSegments to marketSegmentIds...");
+                ((ObjectNode)newJsonNode).putRawValue("marketSegmentIds", null);
+            }
+            case "customerSegments" -> {
+                LOGGER.info("Rewriting null customerSegments to customerSegmentIds...");
+                ((ObjectNode)newJsonNode).putRawValue("customerSegmentIds", null);
+            }
+            case "allowedGboAgeProfiles" -> {
+                LOGGER.info("Rewriting null allowedGboAgeProfiles to allowedGboAgeProfileIds...");
+                ((ObjectNode)newJsonNode).putRawValue("allowedGboAgeProfileIds", null);
+            }
+            case "mandatoryCustomerDataItems" -> {
+                LOGGER.info("Rewriting null mandatoryCustomerDataItems to mandatoryCustomerDataItemIds...");
+                ((ObjectNode)newJsonNode).putRawValue("mandatoryCustomerDataItemIds", null);
+            }
+            case "requiredGboPersonalAttributes" -> {
+                LOGGER.info("Rewriting null requiredGboPersonalAttributes to requiredGboPersonalAttributeIds...");
+                ((ObjectNode)newJsonNode).putRawValue("requiredGboPersonalAttributeIds", null);
+            }
+            case "tokenTypes" -> {
+                LOGGER.info("Rewriting null tokenTypes to tokenTypeIds...");
+                ((ObjectNode)newJsonNode).putRawValue("tokenTypeIds", null);
+            }
+            case "serviceOptions" -> {
+                LOGGER.info("Rewriting null serviceOptions to serviceOptionIds...");
+                ((ObjectNode)newJsonNode).putRawValue("serviceOptionIds", null);
+            }
+            default -> {
+                LOGGER.info("Keeping {} as-is...", jsonField.getKey());
+                ((ObjectNode)newJsonNode).put(jsonField.getKey(), jsonField.getValue());
+            }
+        }
+    }
+
+    private static void rewriteObjectFields(Map.Entry<String, JsonNode> jsonField, JsonNode newJsonNode) {
+        switch (jsonField.getKey()) {
+            case "productOwner" -> {
+                LOGGER.info("Rewriting productOwner to productOwnerId...");
+                Long productOwnerId = jsonField.getValue().get("productOwnerId").asLong();
+                ((ObjectNode)newJsonNode).put("productOwnerId", productOwnerId);
+            }
+            case "productCategory" -> {
+                LOGGER.info("Rewriting productCategory to productCategoryId...");
+                Long productCategoryId = jsonField.getValue().get("productCategoryId").asLong();
+                ((ObjectNode)newJsonNode).put("productCategoryId", productCategoryId);
+            }
+            case "paymentMoment" -> {
+                LOGGER.info("Rewriting paymentMoment to paymentMomentId...");
+                Long paymentMomentId = jsonField.getValue().get("paymentMomentId").asLong();
+                ((ObjectNode)newJsonNode).put("paymentMomentId", paymentMomentId);
+            }
+            case "requiredCustomerLevel" -> {
+                LOGGER.info("Rewriting requiredCustomerLevel to requiredCustomerLevelId...");
+                Long requiredCustomerLevelId = jsonField.getValue().get("requiredCustomerLevelId").asLong();
+                ((ObjectNode)newJsonNode).put("requiredCustomerLevelId", requiredCustomerLevelId);
+            }
+            case "layerInfo" -> {
+                LOGGER.info("Rewriting layerInfo to layerInfoId...");
+                Long layerInfoId = jsonField.getValue().get("layerInfoId").asLong();
+                ((ObjectNode)newJsonNode).put("layerInfoId", layerInfoId);
+            }
+        }
+    }
+
+    private static void rewriteArrayFields(Map.Entry<String, JsonNode> jsonField, JsonNode newJsonNode) {
+        switch (jsonField.getKey()) {
+            case "marketSegments" -> {
+                LOGGER.info("Rewriting marketSegments to marketSegmentIds...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode marketSegmentIds = new ArrayNode(new JsonNodeFactory(true));
+                    ((ArrayNode)jsonField.getValue()).elements().forEachRemaining(marketSegment -> {
+                        marketSegmentIds.add(marketSegment.get("marketSegmentId").asLong());
+                    });
+                    ((ObjectNode)newJsonNode).putArray("marketSegmentIds").addAll(marketSegmentIds);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("marketSegmentIds", null);
+                }
+            }
+            case "customerSegments" -> {
+                LOGGER.info("Rewriting customerSegments to customerSegmentIds...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode customerSegmentIds = new ArrayNode(new JsonNodeFactory(true));
+                    ((ArrayNode)jsonField.getValue()).elements().forEachRemaining(customerSegment -> {
+                        customerSegmentIds.add(customerSegment.get("customerSegmentId").asLong());
+                    });
+                    ((ObjectNode)newJsonNode).putArray("customerSegmentIds").addAll(customerSegmentIds);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("customerSegmentIds", null);
+                }
+            }
+            case "allowedGboAgeProfiles" -> {
+                LOGGER.info("Rewriting allowedGboAgeProfiles to allowedGboAgeProfileIds...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode allowedGboAgeProfileIds = new ArrayNode(new JsonNodeFactory(true));
+                    ((ArrayNode)jsonField.getValue()).elements().forEachRemaining(allowedGboAgeProfile -> {
+                        allowedGboAgeProfileIds.add(allowedGboAgeProfile.get("gboAgeProfileId").asLong());
+                    });
+                    ((ObjectNode)newJsonNode).putArray("allowedGboAgeProfileIds").addAll(allowedGboAgeProfileIds);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("allowedGboAgeProfileIds", null);
+                }
+            }
+            case "tokenTypes" -> {
+                LOGGER.info("Rewriting tokenTypes to tokenTypeIds...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode tokenTypeIds = new ArrayNode(new JsonNodeFactory(true));
+                    ((ArrayNode)jsonField.getValue()).elements().forEachRemaining(tokenType -> {
+                        tokenTypeIds.add(tokenType.get("tokenTypeId").asLong());
+                    });
+                    ((ObjectNode)newJsonNode).putArray("tokenTypeIds").addAll(tokenTypeIds);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("tokenTypeIds", null);
+                }
+            }
+            case "mandatoryCustomerDataItems" -> {
+                LOGGER.info("Rewriting mandatoryCustomerDataItems to mandatoryCustomerDataItemIds...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode mandatoryCustomerDataItemIds = new ArrayNode(new JsonNodeFactory(true));
+                    ((ArrayNode)jsonField.getValue()).elements().forEachRemaining(mandatoryCustomerDataItem -> {
+                        mandatoryCustomerDataItemIds.add(mandatoryCustomerDataItem.get("mandatoryCustomerDataItemId").asLong());
+                    });
+                    ((ObjectNode)newJsonNode).putArray("mandatoryCustomerDataItemIds").addAll(mandatoryCustomerDataItemIds);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("mandatoryCustomerDataItemIds", null);
+                }
+            }
+            case "requiredGboPersonalAttributes" -> {
+                LOGGER.info("Rewriting requiredGboPersonalAttributes to requiredGboPersonalAttributeIds...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode requiredGboPersonalAttributeIds = new ArrayNode(new JsonNodeFactory(true));
+                    ((ArrayNode)jsonField.getValue()).elements().forEachRemaining(requiredGboPersonalAttribute -> {
+                        requiredGboPersonalAttributeIds.add(
+                                requiredGboPersonalAttribute.get("requiredGboPersonalAttributeId").asLong());
+                    });
+                    ((ObjectNode)newJsonNode).putArray("requiredGboPersonalAttributeIds").addAll(requiredGboPersonalAttributeIds);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("requiredGboPersonalAttributeIds", null);
+                }
+            }
+            case "serviceOptions" -> {
+                LOGGER.info("Rewriting serviceOptions to serviceOptionIds...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode serviceOptionIds = new ArrayNode(new JsonNodeFactory(true));
+                    ((ArrayNode)jsonField.getValue()).elements().forEachRemaining(serviceOption -> {
+                        serviceOptionIds.add(serviceOption.get("serviceOptionId").asLong());
+                    });
+                    ((ObjectNode)newJsonNode).putArray("serviceOptionIds").addAll(serviceOptionIds);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("serviceOptionIds", null);
+                }
+            }
+            case "incompatibleProducts" -> {
+                LOGGER.info("Rewriting incompatibleProducts to remove product names...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode incompatibleProducts = ((ArrayNode)jsonField.getValue()).deepCopy();
+                    incompatibleProducts.elements().forEachRemaining(incompatibleProduct -> {
+                        ((ObjectNode)incompatibleProduct).remove("productName");
+                    });
+                    ((ObjectNode)newJsonNode).putArray("incompatibleProducts").addAll(incompatibleProducts);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("incompatibleProducts", null);
+                }
+            }
+            case "requiredProducts" -> {
+                LOGGER.info("Rewriting requiredProducts to remove product names...");
+                if (jsonField.getValue() != null) {
+                    ArrayNode requiredProducts = ((ArrayNode)jsonField.getValue()).deepCopy();
+                    requiredProducts.elements().forEachRemaining(requiredProduct -> {
+                        ((ObjectNode)requiredProduct).remove("productName");
+                    });
+                    ((ObjectNode)newJsonNode).putArray("requiredProducts").addAll(requiredProducts);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("requiredProducts", null);
+                }
+            }
+            case "sellingPeriods" -> {
+                if (jsonField.getValue() != null) {
+                    LOGGER.info("Rewriting salesTouchpoint in sellingPeriods to salesTouchpointId...");
+                    ArrayNode sellingPeriods = ((ArrayNode)jsonField.getValue()).deepCopy();
+                    sellingPeriods.elements().forEachRemaining(sellingPeriod -> {
+                        Long salesTouchpointId = sellingPeriod.get("salesTouchpoint").get("salesTouchpointId").asLong();
+                        ((ObjectNode)sellingPeriod).put("salesTouchpointId", salesTouchpointId);
+                        ((ObjectNode)sellingPeriod).remove("salesTouchpoint");
+                        if (sellingPeriod.get("forbiddenPaymentMethods") != null) {
+                            LOGGER.info("Rewriting forbiddenPaymentMethods to forbiddenPaymentMethodIds...");
+                            ArrayNode forbiddenPaymentMethodIds = new ArrayNode(new JsonNodeFactory(true));
+                            sellingPeriod.get("forbiddenPaymentMethods").elements().forEachRemaining(forbiddenPaymentMethod -> {
+                                forbiddenPaymentMethodIds.add(forbiddenPaymentMethod.get("forbiddenPaymentMethodId").asLong());
+                            });
+                            ((ObjectNode)sellingPeriod).remove("forbiddenPaymentMethods");
+                            if (!forbiddenPaymentMethodIds.isEmpty()) {
+                                ((ObjectNode)sellingPeriod).putArray("forbiddenPaymentMethodIds").addAll(forbiddenPaymentMethodIds);
+                            } else {
+                                ((ObjectNode)sellingPeriod).putRawValue("forbiddenPaymentMethodIds", null);
+                            }
+                        }
+                        if (!sellingPeriod.get("sellingPrices").isNull()) {
+                            LOGGER.info("Deep-copying sellingPrices...");
+                            ArrayNode sellingPrices = ((ArrayNode)sellingPeriod.get("sellingPrices")).deepCopy();
+                            ((ObjectNode)sellingPeriod).remove("sellingPrices");
+                            if (!sellingPrices.isEmpty()) {
+                                ((ObjectNode)sellingPeriod).putArray("sellingPrices").addAll(sellingPrices);
+                            } else {
+                                ((ObjectNode)sellingPeriod).putRawValue("sellingPrices", null);
+                            }
+                        }
+                    });
+                    ((ObjectNode)newJsonNode).putArray("sellingPeriods").addAll(sellingPeriods);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("sellingPeriods", null);
+                }
+            }
+            case "purchasePrices" -> {
+                LOGGER.info("Deep-copying purchasePrices...");
+                if (!jsonField.getValue().isNull()) {
+                    ArrayNode purchasePrices = ((ArrayNode)jsonField.getValue()).deepCopy();
+                    ((ObjectNode)newJsonNode).putArray("purchasePrices").addAll(purchasePrices);
+                } else {
+                    ((ObjectNode)newJsonNode).putRawValue("purchasePrices", null);
+                }
+            }
+        }
+    }
+}

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

@@ -0,0 +1,202 @@
+{
+  "productId": 251,
+  "fikoArticleNumber": null,
+  "parentProductId": null,
+  "gboPackageTemplateId": "30901",
+  "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,
+  "productOwner": {
+    "productOwnerId": 1,
+    "name": "Corneel Verstoep",
+    "organization": "HTM"
+  },
+  "marketSegments": null,
+  "customerSegments": null,
+  "allowedGboAgeProfiles": null,
+  "productCategory": {
+    "productCategoryId": 9,
+    "isTravelProduct": true,
+    "name": "Kortingsabonnement"
+  },
+  "requiredCustomerLevel": {
+    "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"
+    }
+  ],
+  "tokenTypes": [
+    {
+      "tokenTypeId": 1,
+      "name": "EMV"
+    }
+  ],
+  "paymentMoment": {
+    "paymentMomentId": 1,
+    "name": "prepaid"
+  },
+  "serviceOptions": null,
+  "validityDuration": "P7D",
+  "maxStartInFutureDuration": "P6W",
+  "isRenewable": false,
+  "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",
+  "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",
+      "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)",
+        "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": null,
+          "imageReference": "https://www.htm.nl/typo3conf/ext/htm_template/Resources/Public/img/logo.svg"
+        }
+      },
+      "forbiddenPaymentMethods": [
+        {
+          "forbiddenPaymentMethodId": 2,
+          "name": "creditcard",
+          "issuer": "Visa"
+        }
+      ],
+      "sellingPrices": [
+        {
+          "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
+        },
+        {
+          "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
+        }
+      ]
+    }
+  ],
+  "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"
+    },
+    {
+      "auditTrailId": 227,
+      "action": "insert",
+      "user": "api",
+      "timestamp": "2024-10-21T08:58:39.237+00:00"
+    }
+  ]
+}

src/java/ABTProductsPUTGenerator/src/main/resources/log4j2.xml

@@ -0,0 +1,17 @@
+<Configuration status="INFO">
+    <Appenders>
+        <Console name="STDOUT-COLOR">
+            <PatternLayout
+                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} | %highlight{%-5level} | %cyan{%-28c{1}} - %msg %blue{[%t]}%n"
+                    disableAnsi="false"/>
+        </Console>
+        <Console name="STDOUT-NOCOLOR">
+            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} | %-5level | %-28c{1} - %msg [%t]%n"/>
+        </Console>
+    </Appenders>
+    <Loggers>
+        <Root level="INFO">
+            <AppenderRef ref="STDOUT-NOCOLOR"/>
+        </Root>
+    </Loggers>
+</Configuration>

src/java/rabbitmq-poc/.gitignore

@@ -0,0 +1,41 @@
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### IntelliJ IDEA ###
+.idea
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store
+
+/logs

src/java/rabbitmq-poc/pom.xml

@@ -0,0 +1,49 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>nl.ovpay</groupId>
+  <artifactId>rabbitmq</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <name>OVpay - RabbitMQ POC</name>
+  <dependencies>
+    <dependency>
+      <groupId>com.rabbitmq</groupId>
+      <artifactId>amqp-client</artifactId>
+      <version>5.23.0</version>
+    </dependency>
+
+    <!-- Log4j Slf4j Logging -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api</artifactId>
+      <version>2.23.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+      <version>2.23.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-slf4j-impl</artifactId>
+      <version>2.23.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20240303</version>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <source>11</source>
+          <target>11</target>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

src/java/rabbitmq-poc/src/main/java/nl/ovpay/queue/DummyX509TrustManager.java

@@ -0,0 +1,40 @@
+package nl.ovpay.queue;
+
+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/rabbitmq-poc/src/main/java/nl/ovpay/queue/Helpers.java

@@ -0,0 +1,90 @@
+package nl.ovpay.queue;
+
+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.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public final class Helpers {
+
+    private static Logger LOGGER = LoggerFactory.getLogger(Helpers.class);
+
+    public static String getAlertId(String string) throws IOException {
+        return new JSONObject(string).get("alertId").toString();
+    }
+
+    public static String getXbot(String string) throws IOException {
+        return new JSONObject(string).get("xbot").toString();
+    }
+
+    public static void getAlertDetails(String alertId, String xBot, String gboBearerToken) throws Exception {
+        SSLContext sc = SSLContext.getInstance("SSL");
+        sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
+        HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
+
+
+        URL url = new URL("https://api.sbx.idbt.translink.nl/api/v3/id-media/tokens/xbot/" + xBot + "/alerts/" + alertId + "/details");
+        URLConnection con = url.openConnection();
+        HttpURLConnection http = (HttpURLConnection)con;
+        http.setRequestMethod("GET");
+        http.setDoOutput(true);
+        http.setRequestProperty("Authorization", "Bearer " + gboBearerToken);
+        http.connect();
+
+        try(InputStream is = http.getInputStream()) {
+            String response = new String(is.readAllBytes(), StandardCharsets.UTF_8);
+            LOGGER.info("GBO API 8851 alert details response for xBOT " + xBot + ": \n" + new JSONObject(response).toString(2));
+        }
+    }
+
+    public static String getGboBearerToken() throws IOException, NoSuchAlgorithmException, KeyManagementException {
+        SSLContext sc = SSLContext.getInstance("SSL");
+        sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
+        HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
+
+        URL url = new URL("https://api.sbx.idbt.translink.nl/api/v3/auth/oauth2/token");
+        URLConnection con = url.openConnection();
+        HttpURLConnection http = (HttpURLConnection)con;
+        http.setRequestMethod("POST");
+        http.setDoOutput(true);
+
+        Map<String,String> arguments = new HashMap<>();
+        arguments.put("client_id", "HTM-auth-client");
+        arguments.put("client_secret", "HTM-auth-827kJJ");
+        arguments.put("grant_type", "client_credentials");
+        StringJoiner sj = new StringJoiner("&");
+        for(Map.Entry<String,String> entry : arguments.entrySet())
+            sj.add(URLEncoder.encode(entry.getKey(), "UTF-8") + "="
+                   + URLEncoder.encode(entry.getValue(), "UTF-8"));
+        byte[] out = sj.toString().getBytes(StandardCharsets.UTF_8);
+        int length = out.length;
+
+        http.setFixedLengthStreamingMode(length);
+        http.setRequestProperty("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
+        http.connect();
+        try(OutputStream os = http.getOutputStream()) {
+            os.write(out);
+        }
+        try(InputStream is = http.getInputStream()) {
+            String response = new String(is.readAllBytes(), StandardCharsets.UTF_8);
+            JSONObject json = new JSONObject(response);
+            LOGGER.info("Got GBO bearer token: " + json.get("access_token"));
+            return json.get("access_token").toString();
+        }
+    }
+}

src/java/rabbitmq-poc/src/main/java/nl/ovpay/queue/RabbitConnector.java

@@ -0,0 +1,68 @@
+package nl.ovpay.queue;
+
+import java.util.Map;
+
+import com.rabbitmq.client.AMQP;
+import com.rabbitmq.client.Channel;
+import com.rabbitmq.client.Connection;
+import com.rabbitmq.client.ConnectionFactory;
+import com.rabbitmq.client.DeliverCallback;
+import com.rabbitmq.client.impl.ForgivingExceptionHandler;
+import org.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class RabbitConnector {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(RabbitConnector.class);
+
+    public static void main(String[] args) throws Exception {
+        ConnectionFactory factory = new ConnectionFactory();
+        factory.setVirtualHost("/");
+        factory.setAutomaticRecoveryEnabled(true);
+        factory.setPort(443);
+        factory.setHost("not.sbx.idbt.translink.nl");
+        factory.setUsername("BEID_3_ALERTS_nZs3");
+        factory.setPassword("VyubhPnczKgTB2zJ");
+        factory.useSslProtocol("TLSv1.2");
+        factory.setExceptionHandler(new ForgivingExceptionHandler());
+        Map<String, Object> configs = factory.getClientProperties();
+        LOGGER.info("Client properties: \n" + new JSONObject(configs).toString(2));
+
+        Connection connection = factory.newConnection();
+        Channel channel = connection.createChannel();
+        DeliverCallback deliverCallback = initDeliverCallback(channel);
+
+        AMQP.Queue.DeclareOk queue = channel.queueDeclarePassive("BEID_3.ALERTS");
+        LOGGER.info(
+                "Declared queue: " + queue.getQueue() + ", consumer count: " + queue.getConsumerCount() + ", message count: " +
+                queue.getMessageCount());
+
+        // Second parameter controls autoAck - false = no autoAck = messages are only deleted from queue after consumer acknowledges them
+        channel.basicConsume(queue.getQueue(), false, deliverCallback, consumerTag -> {});
+        LOGGER.info("Waiting for messages from the queue. To exit press CTRL+C");
+    }
+
+    private static DeliverCallback initDeliverCallback(Channel channel) {
+        return  (consumerTag, delivery) -> {
+            final String message = new String(delivery.getBody(), "UTF-8");
+            LOGGER.info("Received from message from the queue: \n " + new JSONObject(message).toString(2));
+
+            LOGGER.info("Acknowledging message with delivery tag: " + delivery.getEnvelope().getDeliveryTag());
+            channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
+            LOGGER.info("Successfully acknowledged message with delivery tag: " + delivery.getEnvelope().getDeliveryTag());
+
+            LOGGER.info("Getting alert details via GBO API 8851...");
+            try {
+                String alertId = Helpers.getAlertId(message);
+                String xBot = Helpers.getXbot(message);
+                String gboBearerToken = Helpers.getGboBearerToken();
+
+                Helpers.getAlertDetails(alertId, xBot, gboBearerToken);
+
+            } catch (Exception e) {
+                throw new RuntimeException(e);
+            }
+        };
+    }
+}

src/java/rabbitmq-poc/src/main/resources/log4j2.xml

@@ -0,0 +1,27 @@
+<Configuration status="INFO">
+    <Appenders>
+        <Console name="STDOUT-COLOR">
+            <PatternLayout
+                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} | %highlight{%-5level} | %cyan{%-28c{1}} - %msg %blue{[%t]}%n"
+                    disableAnsi="false"/>
+        </Console>
+        <Console name="STDOUT-NOCOLOR">
+            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} | %-5level | %-28c{1} - %msg [%t]%n"/>
+        </Console>
+        <RollingFile name="FILE-NOCOLOR"
+                     fileName="logs/rabbitmq-poc.log"
+                     filePattern="logs/rabbitmq-poc.log.%i.gz">
+            <DefaultRolloverStrategy max="100"/>
+            <Policies>
+                <SizeBasedTriggeringPolicy size="1M"/>
+            </Policies>
+            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} | %-5level | %-28c{1} - %msg [%t]%n"/>
+        </RollingFile>
+    </Appenders>
+    <Loggers>
+        <Root level="INFO">
+            <AppenderRef ref="STDOUT-COLOR"/>
+            <AppenderRef ref="FILE-NOCOLOR"/>
+        </Root>
+    </Loggers>
+</Configuration>

src/openapi/apim/TP-PAD.yaml

@@ -0,0 +1,482 @@
+openapi: 3.0.1
+info:
+  title: Personal Account Data (PAD) APIs for touchpoints and Service Engine
+  description: |-
+    APIs for touchpoints and Service Engine to manage Personal Account Data (PAD) on OVpay tokens (xTATs).\
+    These APIs connect directly to the PADP APIs in GBO APIM and are implemented in Logic Apps 
+    in the Integration Layer.
+  version: '1.0'
+servers:
+  - url: https://api.integratielaag.nl/abt/touchpoint/1.0
+tags:
+  - name: Personal Data APIs for touchpoints
+    description: Personal Data APIs for touchpoints, no Service Engine in between!
+  - name: Personal Data APIs for Service Engine
+    description: Personal Data APIs for Service Engine, not to be exposed to touchpoints!
+paths:
+  /personal-data/{xtat}:
+    post:
+      tags:
+        - Personal Data APIs for touchpoints
+      summary: Add the supplied Personal Data to the given xTAT (that should not contain any Personal Data yet).
+      description: |-
+       - The given xTAT should not contain any Personal Data yet (the PATCH endpoint should be used in that case) - if the given xTAT already contains Personal Data, an error is thrown;
+       - The given e-mail address will be used for future OTP challenges to manage the Personal Data in the future - this e-mail adress should therefore be validated;
+       - If the e-mail address is not yet validated by other means (e.g. the e-mail address is used for login, or is entered twice to prevent typos), an OTP challenge for the e-mail address should be triggered and supplied to this endpoint;
+       - xTAT and e-mail address are always required, for the Personal Data it is allowed to supply any subset, or all three data attributes;
+       - Each of the three data attributes is validated - for the requirements per attribute, see the descriptions in the request details below;
+       - If any attribute fails validation, none of the attributes will be added to the xTAT.
+      operationId: CreatePersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          example: 'c3a6c0f2-3b6a-4b9a-9c5d-5d9c6b3a4c5d'
+          schema:
+            type: string
+            format: uuid
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required:
+                - email
+              properties:
+                email:
+                  type: string
+                  format: email
+                  description: Email address to be used for OTP challenges to prove ownership and manage the Personal Data in the future
+                  example: 8Z9dG@example.com
+                otp:
+                  type: string
+                  pattern: ^[0-9]{6}$
+                  description: OTP is optional, should be supplied if the e-mail address is not yet validated by other means (e.g. the e-mail address is used for login, or is entered twice to prevent typo's)  
+                  example: "053395"
+                name:
+                  type: string
+                  description: Should consist of at least two words (first name and last name)
+                  example: John Doe
+                birthDate:
+                  type: string
+                  format: date
+                  description: Should be a date between 1900-01-01 and today, in the format `YYYY-MM-DD`
+                  example: 2000-01-01
+                photo:
+                  type: string
+                  description: Should be a JPG image, with a filesize of max. 512KB and resolution between 520x520 and 720x720 pixels
+                  format: binary
+            encoding: 
+              photo:
+                contentType: image/jpeg
+      responses:
+        '201':
+          description: Created
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+    get: 
+      tags:
+        - Personal Data APIs for touchpoints
+      summary: Retrieve the decrypted Personal Data for the given xTAT, using the OTP for verification of ownership.
+      description: OTP challenge is required to retrieve the Personal Data.
+      operationId: GetDecryptedPersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+            format: uuid
+            example: 'c3a6c0f2-3b6a-4b9a-9c5d-5d9c6b3a4c5d'
+        - name: otp
+          in: query
+          required: true
+          description: OTP challenge code that the token owner received in their e-mail inbox. OTP is always required for managing existing Personal Data.
+          schema:
+            type: string
+            pattern: ^[0-9]{6}$
+            example: "053395"
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DecryptedPersonalData'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+    patch:
+      tags:
+        - Personal Data APIs for touchpoints
+      summary: Update the supplied personal data for the given xTAT, using the OTP for verification of ownership.
+      description: This is a PATCH call, so only the personal data that the user desires to change need to be supplied. Integration layer supplements with any other existing personal data to be able to call GBO (PUT call).
+      operationId: UpdatePersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true          
+          schema:
+            type: string
+            format: uuid
+            example: 'c3a6c0f2-3b6a-4b9a-9c5d-5d9c6b3a4c5d'
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required:
+                - otp
+              properties:
+                otp:
+                  type: string
+                  pattern: ^[0-9]{6}$
+                  description: OTP challenge code that the token owner received in their e-mail inbox. OTP is always required for managing existing Personal Data.
+                  example: "053395"
+                name:
+                  type: string
+                  description: Should consist of at least two words (first name and last name)
+                  example: John Doe
+                birthDate:
+                  type: string
+                  format: date
+                  description: Should be a date between 1900-01-01 and today, in the format `YYYY-MM-DD`
+                  example: 2000-01-01
+                photo:
+                  type: string
+                  description: Should be a JPG image, with a filesize of max. 512KB and resolution between 520x520 and 720x720 pixels
+                  format: binary
+            encoding: 
+              photo:
+                contentType: image/jpeg
+      responses:
+        '200':
+          description: OK
+  /personal-data/generate-otp:
+    get:
+      tags:
+        - Personal Data APIs for touchpoints
+      summary: Trigger OTP email for the given xTAT or e-mail address, to prove ownership
+      operationId: GenerateOtp
+      description: |-
+        Generate an OTP challenge e-mail to prove ownership of the given e-mail address or xTAT.\
+        Only one type of parameter can be supplied, either xtat or email. When both are supplied, an error is thrown.
+      parameters:
+        - name: xtat
+          in: query
+          required: false          
+          schema:
+            type: string
+            format: uuid
+            example: 'c3a6c0f2-3b6a-4b9a-9c5d-5d9c6b3a4c5d'
+        - name: email
+          in: query
+          required: false
+          schema:
+            type: string
+            format: email
+            example: 'sV4yj@example.com'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OtpResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /personal-data/{xtat}/administrative-data:
+    get:
+      tags:
+        - Personal Data APIs for Service Engine
+      summary: API 1211 - Get Administrative Data
+      description: Integration Layer utilizes PAD management V2 in GBO APIM (`/pad-management/v2/..`)
+      operationId: GetAdministrativeData
+      parameters:
+        - name: xtat
+          description: xTAT to get administrative data for
+          in: path
+          required: true          
+          schema:
+            type: string
+            format: uuid
+            example: 'c3a6c0f2-3b6a-4b9a-9c5d-5d9c6b3a4c5d'
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AdministrativeData"
+              examples:
+                Valid and complete PAD:
+                  summary: Valid and complete PAD
+                  value:
+                    name:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 5
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    birthdate:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                Partially filled PAD (no photo):
+                  summary: Partially filled PAD (no photo)
+                  value:
+                    name:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo: null
+                    birthdate:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                Flagged PAD:
+                  summary: Flagged PAD
+                  value:
+                    name:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid name"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 1
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid photo"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 5
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    birthdate:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid birthdate"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 2
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Invalid UUID:
+                  summary: Invalid UUID
+                  value:
+                    errors:
+                      code: "0x03000103"
+                      data: [
+                        "geen-uuid"
+                      ]
+                      message: "The provided scTat is not a valid UUID"
+                    exceptionClassName: "PadpConstraintViolationException"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                No PAD found for xTAT:
+                  summary: No PAD found for xTAT
+                  value:
+                    errors:
+                      code: "0x03000105"
+                      data: []
+                      message: "Transit account not found"
+                    exceptionClassName: "PadpEntityNotFoundException"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Unknown xTAT:
+                  summary: Unknown xTAT
+                  value:
+                    errors:
+                      code: "0x00000001"
+                      data: null
+                      message: "400 : \"{\"errorMessage\":{\"referenceId\":\"076f0de4-df33-42a3-add0-def971ab6679\",\"message\":\"Unknown external transit account token.\"},\"businessExceptions\":[{\"code\":\"TM0207\",\"message\":\"Unknown external transit account token.\"}]}\""
+                    exceptionClassName: "BadRequest"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+components:
+  schemas:
+    AdministrativeData:
+      type: object
+      properties:
+        name:
+          $ref: '#/components/schemas/AdministrativeDataElement'
+        photo:
+          $ref: '#/components/schemas/AdministrativeDataElement'
+        birthdate:
+          $ref: '#/components/schemas/AdministrativeDataElement'
+      additionalProperties: false
+    AdministrativeDataElement:
+      type: object
+      properties:
+        inaccuracyFlag:
+          type: boolean
+        inaccuracyFlagReason:
+          type: string
+          nullable: true
+        inaccuracyFlagCounter:
+          type: integer
+          format: int32
+        changeCounter:
+          type: integer
+          format: int32
+        maxUpdatesVerificationCount:
+          type: integer
+          format: int32
+        lastChangeDate:
+          type: string
+          format: date-time
+        isValidated:
+          type: boolean
+      additionalProperties: false
+    DecryptedData:
+      type: object
+      properties:
+        name:
+          type: string
+          nullable: true
+        birthdate:
+          type: string
+          nullable: true
+        photo:
+          type: string
+          description: Base64 encoded photo
+          format: byte
+          nullable: true
+      additionalProperties: false
+    DecryptedPersonalData:
+      type: object
+      properties:
+        decryptedData:
+          $ref: '#/components/schemas/DecryptedData'        
+      additionalProperties: false
+    Error:
+      type: object
+      properties:
+        code:
+          type: string
+          nullable: true
+        data:
+          type: array
+          items:
+            type: string
+          nullable: true
+        message:
+          type: string
+          nullable: true
+      additionalProperties: false
+    ErrorResponse:
+      type: object
+      properties:
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/Error'
+          nullable: true
+        exceptionClassName:
+          type: string
+          nullable: true
+        exceptionStackTrace:
+          type: string
+          nullable: true
+      additionalProperties: false
+    Metadata:
+      type: object
+      properties:
+        encryptedEphemeralKey:
+          type: string
+          nullable: true
+      additionalProperties: false
+    OtpResponse:
+      type: object
+      properties:
+        maskedEmailAddress:
+          type: string
+          nullable: true
+      additionalProperties: false    

src/openapi/apim/apim-internal.yaml

@@ -0,0 +1,477 @@
+openapi: 3.0.3
+info:
+  title: ABT GBO APIM APIs
+  description: APIs for calling GBO APIM - internal use only, these are NOT the functional APIs to be used by touchpoints!
+  version: "1.0"
+servers:
+  - url: https://api.integratielaag.nl/abt/gboapim/1.0
+paths:
+  /pad-management/v2/personal-data/{xtat}/administrative-data:
+    servers:
+      - url: https://api.integratielaag.nl/abt/serviceengine
+        description: APIPRODUCT ABT Service Engine Portal
+      - url: https://api.integratielaag.nl/abt/gboapim/1.0
+        description: API ABT GBO APIM
+    get:
+      tags:
+        - API WSO2 - GBO APIM
+      summary: API 1211 - Get Administrative Data
+      operationId: ABTPAD-GetAdministrativeData
+      parameters:
+        - name: xtat
+          description: xTAT to get administrative data for
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AdministrativeData"
+              examples:
+                Valid and complete PAD:
+                  summary: Valid and complete PAD
+                  value:
+                    name:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 5
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    birthdate:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                Partially filled PAD (no photo):
+                  summary: Partially filled PAD (no photo)
+                  value:
+                    name:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo: null
+                    birthdate:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                Flagged PAD:
+                  summary: Flagged PAD
+                  value:
+                    name:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid name"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 1
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid photo"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 5
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    birthdate:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid birthdate"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 2
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Invalid UUID:
+                  summary: Invalid UUID
+                  value:
+                    errors:
+                      code: "0x03000103"
+                      data: [
+                        "geen-uuid"
+                      ]
+                      message: "The provided scTat is not a valid UUID"
+                    exceptionClassName: "PadpConstraintViolationException"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                No PAD found for xTAT:
+                  summary: No PAD found for xTAT
+                  value:
+                    errors:
+                      code: "0x03000105"
+                      data: []
+                      message: "Transit account not found"
+                    exceptionClassName: "PadpEntityNotFoundException"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Unknown xTAT:
+                  summary: Unknown xTAT
+                  value:
+                    errors:
+                      code: "0x00000001"
+                      data: null
+                      message: "400 : \"{\"errorMessage\":{\"referenceId\":\"076f0de4-df33-42a3-add0-def971ab6679\",\"message\":\"Unknown external transit account token.\"},\"businessExceptions\":[{\"code\":\"TM0207\",\"message\":\"Unknown external transit account token.\"}]}\""
+                    exceptionClassName: "BadRequest"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+
+  /internal/b2b-client-authentication/v1/token/idp/b2b-access-token:
+    servers:
+      - url: https://only-for-internal-use.com
+    get:
+      tags:
+        - Internal DHIL use only - Raw GBO APIM
+      summary: API 1020 - Get B2B Access Token
+      description: Returns a client access token, needed for most other PADP APIs.
+      operationId: GetB2bAccessToken
+      parameters:
+        - name: APIKey
+          description: B2B IDP APIM Product API Key
+          in: header
+          required: true
+          schema:
+            type: string
+        - name: grant_type
+          description: A grant_type IS A string THAT defines the method which is used by client to request Access Token. grant_type = client_credentials - is used for M2M communication
+          in: query
+          required: true
+          example: client_credentials
+          schema:
+            type: string
+        - name: client_id
+          description: A client_id IS A string THAT is a unique identifier of the client application
+          in: query
+          required: true
+          schema:
+            type: string
+        - name: client_secret
+          description: A client_secret IS A unique identifier THAT is issued by IDP server on client registertraion and known only to Client and IDP server
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/B2bAccessToken"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /internal/pad-management/v2/personal-data/{xtat}/administrative-data:
+    servers:
+      - url: https://only-for-internal-use.com
+    get:
+      tags:
+        - Internal DHIL use only - Raw GBO APIM
+      summary: API 1211 - Get Administrative Data
+      operationId: InternalGBOAPIM-GetAdministrativeData
+      parameters:
+        - name: xtat
+          description: xTAT to get administrative data for
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: APIKey
+          description: PADP APIM Product API Key
+          in: header
+          required: true
+          schema:
+            type: string
+        - name: Authorization
+          description: B2B Client Access Token, without the 'Bearer ' prefix
+          in: header
+          required: true
+          schema:
+            type: string
+        - name: requestId
+          description: A unique identifier for the request
+          in: header
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AdministrativeData"
+              examples:
+                Valid and complete PAD:
+                  summary: Valid and complete PAD
+                  value:
+                    name:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 5
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    birthdate:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                Partially filled PAD (no photo):
+                  summary: Partially filled PAD (no photo)
+                  value:
+                    name:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo: null
+                    birthdate:
+                      inaccuracyFlag: false
+                      inaccuracyFlagReason: null
+                      inaccuracyFlagCounter: 0
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                Flagged PAD:
+                  summary: Flagged PAD
+                  value:
+                    name:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid name"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 1
+                      maxUpdatesVerificationCount: 1
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    photo:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid photo"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 0
+                      maxUpdatesVerificationCount: 5
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+                    birthdate:
+                      inaccuracyFlag: true
+                      inaccuracyFlagReason: "Invalid birthdate"
+                      inaccuracyFlagCounter: 1
+                      changeCounter: 2
+                      maxUpdatesVerificationCount: 3
+                      lastChangeDate: "2025-03-26T10:18:42.947"
+                      isValidated: false
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Invalid UUID:
+                  summary: Invalid UUID
+                  value:
+                    errors:
+                      code: "0x03000103"
+                      data: [
+                        "geen-uuid"
+                      ]
+                      message: "The provided scTat is not a valid UUID"
+                    exceptionClassName: "PadpConstraintViolationException"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                No PAD found for xTAT:
+                  summary: No PAD found for xTAT
+                  value:
+                    errors:
+                      code: "0x03000105"
+                      data: []
+                      message: "Transit account not found"
+                    exceptionClassName: "PadpEntityNotFoundException"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Unknown xTAT:
+                  summary: Unknown xTAT
+                  value:
+                    errors:
+                      code: "0x00000001"
+                      data: null
+                      message: "400 : \"{\"errorMessage\":{\"referenceId\":\"076f0de4-df33-42a3-add0-def971ab6679\",\"message\":\"Unknown external transit account token.\"},\"businessExceptions\":[{\"code\":\"TM0207\",\"message\":\"Unknown external transit account token.\"}]}\""
+                    exceptionClassName: "BadRequest"
+                    exceptionStackTrace: "not available because debug mode is turned off"
+components:
+  schemas:
+    AdministrativeData:
+      type: object
+      properties:
+        name:
+          $ref: "#/components/schemas/AdministrativeData_AdministrativeDataElement"
+        photo:
+          $ref: "#/components/schemas/AdministrativeData_AdministrativeDataElement"
+        birthdate:
+          $ref: "#/components/schemas/AdministrativeData_AdministrativeDataElement"
+      additionalProperties: false
+    AdministrativeData_AdministrativeDataElement:
+      type: object
+      properties:
+        inaccuracyFlag:
+          type: boolean
+        inaccuracyFlagReason:
+          type: string
+          nullable: true
+        inaccuracyFlagCounter:
+          type: integer
+          format: int32
+        changeCounter:
+          type: integer
+          format: int32
+        maxUpdatesVerificationCount:
+          type: integer
+          format: int32
+        lastChangeDate:
+          type: string
+          format: date-time
+        isValidated:
+          type: boolean
+      additionalProperties: false
+    B2bAccessToken:
+      type: object
+      properties:
+        access_token:
+          type: string
+          nullable: true
+        expires_in:
+          type: integer
+          format: int32
+        refresh_expires_in:
+          type: integer
+          format: int32
+        refresh_token:
+          type: string
+          nullable: true
+        token_type:
+          type: string
+          nullable: true
+        not-before-policy:
+          type: integer
+          format: int32
+        scope:
+          type: string
+          nullable: true
+        BE_ID:
+          type: string
+          nullable: true
+      additionalProperties: false
+    ErrorResponse:
+      type: object
+      properties:
+        errors:
+          type: array
+          items:
+            $ref: "#/components/schemas/ErrorResponse_Error"
+          nullable: true
+        exceptionClassName:
+          type: string
+          nullable: true
+        exceptionStackTrace:
+          type: string
+          nullable: true
+      additionalProperties: false
+    ErrorResponse_Error:
+      type: object
+      properties:
+        code:
+          type: string
+          nullable: true
+        data:
+          type: array
+          items:
+            type: string
+          nullable: true
+        message:
+          type: string
+          nullable: true
+      additionalProperties: false

src/openapi/claims/claims-forms.yaml

@@ -0,0 +1,267 @@
+openapi: 3.0.1
+info:
+  title: ClaimsAPI
+  version: '1.0'
+servers:
+  - url: https://services.acc.api.htm.nl/chipkaart/1.0
+security:
+  - default: []
+tags:
+  - name: Claims
+paths:
+  /claims:
+    post:
+      tags:
+        - Claims
+      summary: Create a claim
+      description: >
+        Create a claim by sending a JSON as specified in the schema. By
+        specifying the chipcardnumber under 'chipkaart',
+
+        a claim for OV chipcard will be send to the OVC API. If no
+        chipcardnumber is specified under 'chipkaart', a claim for EMV is send
+        to mendix.
+      parameters: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/claimsEntity'
+            examples:
+              OVCK:
+                value:
+                  aankomsthalte: '1'
+                  instapdatum: '2024-03-06T15:20:44.549Z'
+                  instaptijd: '2024-03-06T15:20:44.549Z'
+                  ingecheckt: true
+                  uitgecheckt: true
+                  chipkaart: '1234123412341234'
+                  afgeschrevenbedrag: 0
+                  vertrekhalte: string
+                  korting: true
+                  iban: '1234123412341234'
+                  naam: string
+                  emailadres: user@example.com
+                  uitstaptijd: '2024-03-06T15:20:44.549Z'
+                  verwachtbedrag: 0
+                  toelichting: string
+                  lijn: '1'
+                  vervoertype: '1'
+                  serviceRefId: '1'
+                  Totaalbedrag: 0
+              EMV:
+                value:
+                  aankomsthalte: '1'
+                  instapdatum: '2024-03-06T15:20:44.549Z'
+                  instaptijd: '2024-03-06T15:20:44.549Z'
+                  ingecheckt: true
+                  uitgecheckt: true
+                  afgeschrevenbedrag: 0
+                  vertrekhalte: string
+                  korting: true
+                  iban: '1234123412341234'
+                  naam: string
+                  emailadres: user@example.com
+                  uitstaptijd: '2024-03-06T15:20:44.549Z'
+                  verwachtbedrag: 0
+                  toelichting: string
+                  lijn: '1'
+                  vervoertype: '1'
+                  serviceRefId: '1'
+                  Totaalbedrag: 0
+      responses:
+        '200':
+          description: ok
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /refunds:
+    post:
+      tags:
+        - Claims
+      summary: Create a refund request
+      description: Create a refund request by sending a JSON as specified in the schema. Either a serviceReferenceId or ovPasNumber should be present in order to fulfill the refund request.
+      parameters: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/refundsEntity'
+            examples:
+              EMV:
+                value:
+                  emailAddress: 'j.beek@htm.nl'
+                  orderNumber: 'ORD1000046'
+                  serviceReferenceId: 'NLOVA5BCD124H3Z21X'
+                  amount: 2305
+                  iban: 'NL98INGB0003856625'
+                  orderDate: '2025-01-13'
+                  productName: 'HTM 20% korting'
+              OVpas:
+                value:
+                  emailAddress: 'j.beek@htm.nl'
+                  orderNumber: 'ORD1000046'
+                  ovpasNumber: '63AW974'
+                  iban: 'NL98INGB0003856625'
+                  orderDate: '2025-01-13'
+                  productName: 'HTM 20% korting'
+      responses:
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+components:
+  schemas:
+    claimsEntity:
+      required:
+        - Totaalbedrag
+        - aankomsthalte
+        - afgeschrevenbedrag
+        - emailadres
+        - instapdatum
+        - instaptijd
+        - korting
+        - lijn
+        - serviceRefId
+        - toelichting
+        - uitgecheckt
+        - vertrekhalte
+        - vervoertype
+        - verwachtbedrag
+      type: object
+      properties:
+        aankomsthalte:
+          type: string
+        instapdatum:
+          type: string
+          format: date-time
+        instaptijd:
+          type: string
+          format: date-time
+        ingecheckt:
+          type: boolean
+        uitgecheckt:
+          type: boolean
+        chipkaart:
+          type: string
+        afgeschrevenbedrag:
+          type: number
+          format: float
+        vertrekhalte:
+          type: string
+        korting:
+          type: boolean
+        iban:
+          type: string
+          description: String of length between 15 en 32 characters
+          example: '1234123412341234'
+        naam:
+          type: string
+        emailadres:
+          type: string
+          format: email
+        uitstaptijd:
+          type: string
+          format: date-time
+        verwachtbedrag:
+          type: number
+          format: float
+        toelichting:
+          type: string
+        lijn:
+          type: string
+        vervoertype:
+          type: string
+        serviceRefId:
+          type: string
+        Totaalbedrag:
+          type: number
+          format: float
+    refundsEntity:
+      required:
+          - emailAddress
+          - iban
+      type: object
+      properties:
+        emailAddress:
+          type: string
+          format: email
+          example: j.beek@htm.nl
+        orderNumber:
+          type: string
+          example: ORD1000046
+        serviceReferenceId:
+          type: string
+          example: NLOVA5BCD124H3Z21X
+        amount:
+          type: integer
+          example: 12305
+        ovpasNumber:
+          type: string
+          example: 63AW974
+        iban:
+          type: string
+          example: NL00RABO000001337
+        orderDate:
+          type: string
+          format: date
+          example: 2025-01-13
+        productName:
+          type: string
+          example: HTM 20% korting
+    401Response:
+      type: object
+      properties:
+        code:
+          type: string
+          example: '900901'
+        type:
+          type: string
+        message:
+          type: string
+          example: Invalid Credentials
+        description:
+          type: string
+          example: >-
+            Invalid Credentials. Make sure you have provided the correct
+            security credentials
+    500Response:
+      type: object
+      properties:
+        error:
+          type: string
+          example: error while connecting to backend
+  securitySchemes:
+    default:
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: https://services.acc.api.htm.nl/authorize
+          scopes: {}

src/openapi/contracts/contracts-se.yaml

@@ -4,7 +4,7 @@ info:
   version: "1.0"
   description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub.
 servers:
-  - url: https://api.integratielaag.nl/v1
+  - url: https://services.acc.api.htm.nl/abt/touchpoint/1.0
 paths:
   /customers/contracts:
     parameters:
@@ -27,42 +27,65 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
-                [
-                  {
-                    "contractId": "5a3876a1-e9a1-4278-8983-4679a8d583c2",
-                    "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,
-                    "xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
-                    "created": "2024-08-01 15:01:00.000",
-                  },
-                  {
-                    "contractId": "f07253e6-c364-474c-a342-a10a4a7cf305",
-                    "contractNumber": "D123456",
-                    "customerProfileId": 42,
-                    "orderId": "945d43e6-516e-425b-8847-9aba41289acd",
-                    "orderLineId": "42f68042-908f-41f4-9d9b-4cab843ff0e8",
-                    "touchpointId": 2,
-                    "contractStatus": { "contractStatusId": 1, "name": "new" },
-                    "productId": 1,
-                    "productName": "HTM Maand 20% korting",
-                    "termDuration": "P0Y1M0D",
-                    "billingDay": 15,
-                    "highestInvoiceTerm": 1,
-                    "xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
-                    "created": "2024-08-01 15:01:00.000",
-                  },
-                ]
+              examples:
+                List all contracts for a single customer profile:
+                  summary: List all contracts for a single customer profile
+                  description: |
+                    List all contracts for single customer profile with customer
+                    number 'D123456'.
+                  value:
+                    [
+                      {
+                        "contractId": "5a3876a1-e9a1-4278-8983-4679a8d583c2",
+                        "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,
+                        "_links":
+                          {
+                            "get_token":
+                              {
+                                "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens?ovPayTokenId=1337",
+                                "method": "GET",
+                              },
+                          },
+                      },
+                      {
+                        "contractId": "f07253e6-c364-474c-a342-a10a4a7cf305",
+                        "contractNumber": "D123456",
+                        "customerProfileId": 42,
+                        "orderId": "945d43e6-516e-425b-8847-9aba41289acd",
+                        "orderLineId": "42f68042-908f-41f4-9d9b-4cab843ff0e8",
+                        "touchpointId": 2,
+                        "contractStatus":
+                          { "contractStatusId": 1, "name": "new" },
+                        "productId": 1,
+                        "productName": "HTM Maand 20% korting",
+                        "termDuration": "P0Y1M0D",
+                        "billingDay": 15,
+                        "highestInvoiceTerm": 1,
+                        "created": "2024-08-01 15:01:00.000",
+                        "ovPayTokenId": 1338,
+                        "_links":
+                          {
+                            "get_token":
+                              {
+                                "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens?ovPayTokenId=1338",
+                                "method": "GET",
+                              },
+                          },
+                      },
+                    ]
   /customers/contracts/{contractId}:
     parameters:
       - in: header
@@ -114,76 +137,96 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
-                {
-                  "contractId": "5a3876a1-e9a1-4278-8983-4679a8d583c2",
-                  "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,
-                  "xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
-                  "contractVersions":
-                    [
-                      {
-                        "contractVersionId": 1,
-                        "termsAndConditions": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-maandkorting/",
-                        "termAmountExclTax": 1200,
-                        "taxCode": "V21",
-                        "taxAmount": 108,
-                        "termAmountInclTax": 1308,
-                        "start": "2024-07-04 15:01:00.000",
-                        "end": "2024-12-31 15:01:00.000",
-                      },
-                      {
-                        "contractVersionId": 2,
-                        "termsAndConditions": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-maandkorting/",
-                        "termAmountExclTax": 1300,
-                        "taxCode": "V21",
-                        "taxAmount": 117,
-                        "termAmountInclTax": 1417,
-                        "start": "2025-01-01 15:01:00.000",
-                      },
-                    ],
-                  "contractActions":
-                    [
-                      {
-                        "contractActionId": "67687851-59dd-4bbc-aa74-0f7abd26c883",
-                        "actionType": { "actionTypeId": 1, "name": "create" },
-                        "user": "subid123456",
-                        "timestamp": "2024-07-02 15:01:00.000",
-                        "details": "Contract created",
-                        "correlationId": "976e7a4c-bf24-43d2-b444-55817556e7ee",
-                      },
-                      {
-                        "contractActionId": "ea9ad287-9cd3-4e76-bcb9-d71db551cf55",
-                        "actionType": { "actionTypeId": 2, "name": "change" },
-                        "user": "subid123456",
-                        "timestamp": "2024-07-03 15:01:00.000",
-                        "details": "Contract changed",
-                        "correlationId": "e2462347-6749-4841-b42a-cf8de19ec727",
-                      },
-                    ],
-                  "contractInvoices":
-                    [
-                      {
-                        "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
-                        "externalReference": "F2024-0001",
-                        "term": 1,
-                        "created": "2024-07-02 15:01:00.000",
-                        "updated": "2024-07-02 15:01:00.000",
-                        "state": "invoice_created",
-                        "data": "{json}",
-                        "isCredit": false,
-                      },
-                    ],
-                }
+              examples:
+                Full contract details of a single contract:
+                  summary: Full contract details of a single contract
+                  description: |
+                    Full contract details of a single contract with contract
+                    number 'D123456'.
+                  value:
+                    {
+                      "contractId": "5a3876a1-e9a1-4278-8983-4679a8d583c2",
+                      "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,
+                      "ovPayTokenId": 1337,
+                      "contractVersions":
+                        [
+                          {
+                            "contractVersionId": 1,
+                            "termsAndConditions": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-maandkorting/",
+                            "productId": 1,
+                            "productName": "HTM Maand 20% korting",
+                            "taxCode": "V9",
+                            "taxPercentage": 9.0,
+                            "termAmountInclTax": 400,
+                            "start": "2024-07-04 15:01:00.000",
+                            "end": "2024-12-31 15:01:00.000",
+                          },
+                          {
+                            "contractVersionId": 2,
+                            "termsAndConditions": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-maandkorting/",
+                            "productId": 1,
+                            "productName": "HTM Maand 20% korting",
+                            "taxCode": "V9",
+                            "taxPercentage": 9.0,
+                            "termAmountInclTax": 400,
+                            "start": "2025-01-01 15:01:00.000",
+                          },
+                        ],
+                      "contractActions":
+                        [
+                          {
+                            "contractActionId": "67687851-59dd-4bbc-aa74-0f7abd26c883",
+                            "actionType":
+                              { "actionTypeId": 1, "name": "create" },
+                            "user": "subid123456",
+                            "timestamp": "2024-07-02 15:01:00.000",
+                            "details": "Contract created",
+                            "correlationId": "976e7a4c-bf24-43d2-b444-55817556e7ee",
+                          },
+                          {
+                            "contractActionId": "ea9ad287-9cd3-4e76-bcb9-d71db551cf55",
+                            "actionType":
+                              { "actionTypeId": 2, "name": "change" },
+                            "user": "subid123456",
+                            "timestamp": "2024-07-03 15:01:00.000",
+                            "details": "Contract changed",
+                            "correlationId": "e2462347-6749-4841-b42a-cf8de19ec727",
+                          },
+                        ],
+                      "contractInvoices":
+                        [
+                          {
+                            "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
+                            "externalReference": "F2024-0001",
+                            "term": 1,
+                            "invoiceDate": "2024-07-02",
+                            "created": "2024-07-02 15:01:00.000",
+                            "updated": "2024-07-02 15:01:00.000",
+                            "state": "invoice_created",
+                            "data": "{json}",
+                            "isCredit": false,
+                          },
+                        ],
+                      "_links":
+                        {
+                          "get_token":
+                            {
+                              "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens?ovPayTokenId=1337",
+                              "method": "GET",
+                            },
+                        },
+                    }
   /customers/contracts/{contractId}/invoices:
     parameters:
       - in: header
@@ -213,31 +256,398 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
-                [
+              examples:
+                Get all invoices of a single contract:
+                  summary: Get all invoices of a single contract
+                  description: |
+                    Get all invoices of a single contract with contract number
+                    'D123456'.
+                  value:
+                    [
+                      {
+                        "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
+                        "contractId": "9e224750-3065-471d-af57-85b9cffa7c89",
+                        "externalReference": "F2024-0001",
+                        "term": 1,
+                        "invoiceDate": "2024-07-02",
+                        "created": "2024-07-02 15:01:34.000",
+                        "updated": "2024-07-04 00:04:56.000",
+                        "state": "invoice_created",
+                        "public_link": "http://mijnfactuurinzien.nl/F2024-0001",
+                        "isCredit": false,
+                      },
+                      {
+                        "contractInvoiceId": "0e729101-2c84-44db-8b18-d8f759e968e0",
+                        "contractId": "9e224750-3065-471d-af57-85b9cffa7c89",
+                        "externalReference": "F2024-0002",
+                        "term": 2,
+                        "invoiceDate": "2024-08-02",
+                        "created": "2024-08-02 15:01:34.000",
+                        "updated": "2024-08-04 00:04:56.000",
+                        "state": "invoice_created",
+                        "public_link": "http://mijnfactuurinzien.nl/F2024-0002",
+                        "isCredit": false,
+                      },
+                    ]
+  /contracts/{contractId}/cancellationmoments:
+    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: contractId
+        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 cancellation moments for a given contract.
+      description: Get all cancellation moments for a given contract.
+      tags:
+        - SE Contract Cancellation v2
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                All cancellation moments of a term bound contract:
+                  summary: All cancellation moments of a term bound contract
+                  description: |
+                    All cancellation moments of a term bound contract.
+                  value:
+                    {
+                      "cancellationMoment": "termBound",
+                      "termDuration": "P1M",
+                      "billingDay": 18,
+                      "cancellationFrom": "2024-08-10T00:00:00",
+                      "cancellationUntil": "2026-08-10T00:00:00",
+                    }
+  /contracts/{contractId}/cancellationvalidation:
+    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: contractId
+        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 cancellation for a given contract.
+      description: Validate a cancellation for a given contract.
+      tags:
+        - SE Contract Cancellation v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Validate a cancellation of a given end date:
+                summary: Validate a cancellation of a given end date
+                description: |
+                  Validate a cancellation of a given end date.
+                value: { "end": "2024-08-10T00:00:00" }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Successfully validated cancellation:
+                  summary: Successfully validated cancellation
+                  description: |
+                    Successfully validated a cancellation. The response contains
+                    the refund amount and refund methods.
+                  value:
+                    {
+                      "validationResult": true,
+                      "validationMessage": "",
+                      "end": "2024-08-10T03:59:59",
+                      "refundAmount": 2489,
+                      "refundMethods": ["creditInvoice", "iDeal"],
+                    }
+                Unsuccesful validation:
+                  summary: Unsuccesful validation
+                  description: |
+                    Unsuccesful validation. The response contains the error message.
+                  value:
+                    {
+                      "validationResult": false,
+                      "validationMessage": "Cancellation end date not allowed",
+                      "end": null,
+                      "refundAmount": null,
+                      "refundMethods": [],
+                    }
+  /contracts/{contractId}/cancellation:
+    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: contractId
+        schema:
+          type: string
+          format: uuid
+          example: 9e224750-3065-471d-af57-85b9cffa7c89
+        required: true
+        description: The id of the contract to process.
+    post:
+      summary: Cancel a contract.
+      description: Cancel a contract.
+      tags:
+        - SE Contract Cancellation v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Cancellation request for credit invoice:
+                summary: Cancellation request for credit invoice
+                description: |
+                  Cancellation request for credit invoice.
+                value:
                   {
-                    "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
-                    "contractId": "9e224750-3065-471d-af57-85b9cffa7c89",
-                    "externalReference": "F2024-0001",
-                    "term": 1,
-                    "created": "2024-07-02 15:01:34.000",
-                    "updated": "2024-07-04 00:04:56.000",
-                    "state": "invoice_created",
-                    "public_link": "http://mijnfactuurinzien.nl/F2024-0001",
-                    "isCredit": false,
-                  },
-                  {
-                    "contractInvoiceId": "0e729101-2c84-44db-8b18-d8f759e968e0",
-                    "contractId": "9e224750-3065-471d-af57-85b9cffa7c89",
-                    "externalReference": "F2024-0002",
-                    "term": 2,
-                    "created": "2024-08-02 15:01:34.000",
-                    "updated": "2024-08-04 00:04:56.000",
-                    "state": "invoice_created",
-                    "public_link": "http://mijnfactuurinzien.nl/F2024-0002",
-                    "isCredit": false,
-                  },
-                ]
+                    "end": "2024-08-10T00:00:00",
+                    "refundMethod": "creditInvoice",
+                  }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Successfully cancelled contract:
+                  summary: Successfully cancelled contract
+                  description: |
+                    Successfully cancelled a contract. The response contains
+                    the refund amount and refund method.
+                  value:
+                    {
+                      "end": "2024-08-10T03:59:59",
+                      "refundAmount": 2489,
+                      "refundMethod": "creditInvoice",
+                    }
+  /contracts/{contractId}/undocancellation:
+    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: contractId
+        schema:
+          type: string
+          format: uuid
+          example: 9e224750-3065-471d-af57-85b9cffa7c89
+        required: true
+        description: The id of the contract to process.
+    post:
+      summary: Undo a pending cancellation of a contract.
+      description: Undo a pending cancellation of a contract.
+      tags:
+        - SE Contract Cancellation v2
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                Successfully undid cancellation of contract:
+                  summary: Successfully undid pending cancellation
+                  description: |
+                    Successfully undid a pending cancellation of a contract. The contract
+                    is active again.
+                  value:
+                    {
+                      "contractId": "9e224750-3065-471d-af57-85b9cffa7c89",
+                      "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,
+                      "ovPayTokenId": 1337,
+                      "contractVersions":
+                        [
+                          {
+                            "contractVersionId": 1,
+                            "termsAndConditions": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-maandkorting/",
+                            "productId": 1,
+                            "productName": "HTM Maand 20% korting",
+                            "taxCode": "V9",
+                            "taxPercentage": 9.0,
+                            "termAmountInclTax": 400,
+                            "start": "2024-07-04 15:01:00.000",
+                            "end": "2024-12-31 15:01:00.000",
+                          },
+                          {
+                            "contractVersionId": 2,
+                            "termsAndConditions": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-maandkorting/",
+                            "productId": 1,
+                            "productName": "HTM Maand 20% korting",
+                            "taxCode": "V9",
+                            "taxPercentage": 9.0,
+                            "termAmountInclTax": 400,
+                            "start": "2025-01-01 15:01:00.000",
+                          },
+                        ],
+                      "contractActions":
+                        [
+                          {
+                            "contractActionId": "67687851-59dd-4bbc-aa74-0f7abd26c883",
+                            "actionType":
+                              { "actionTypeId": 1, "name": "create" },
+                            "user": "subid123456",
+                            "timestamp": "2024-07-02 15:01:00.000",
+                            "details": "Contract created",
+                            "correlationId": "976e7a4c-bf24-43d2-b444-55817556e7ee",
+                          },
+                          {
+                            "contractActionId": "ea9ad287-9cd3-4e76-bcb9-d71db551cf55",
+                            "actionType":
+                              { "actionTypeId": 2, "name": "change" },
+                            "user": "subid123456",
+                            "timestamp": "2024-07-03 15:01:00.000",
+                            "details": "Contract changed",
+                            "correlationId": "e2462347-6749-4841-b42a-cf8de19ec727",
+                          },
+                        ],
+                      "contractInvoices":
+                        [
+                          {
+                            "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
+                            "externalReference": "F2024-0001",
+                            "term": 1,
+                            "invoiceDate": "2024-07-02",
+                            "created": "2024-07-02 15:01:00.000",
+                            "updated": "2024-07-02 15:01:00.000",
+                            "state": "invoice_created",
+                            "data": "{json}",
+                            "isCredit": false,
+                          },
+                        ],
+                      "_links":
+                        {
+                          "get_token":
+                            {
+                              "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens?ovPayTokenId=1337",
+                              "method": "GET",
+                            },
+                        },
+                    }
+  /contractpayments:
+    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.
+    get:
+      summary: List all contract payments for a certain debtor.
+      description: |
+        List all contract payments for a certain debtor. The source of these payments is the accounts receivable management system (Payt).
+      tags:
+        - SE Contract Payments v2
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              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'.
+                  value:
+                    {
+                      "contractPayments":
+                        [
+                          {
+                            "paymentId": "151845776",
+                            "totalAmount": "26.62",
+                            "paymentMethod": "Twikey",
+                            "paymentDate": "2024-09-12",
+                            "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": "151845851",
+                            "totalAmount": "45.21",
+                            "paymentMethod": "Twikey",
+                            "paymentDate": "2024-09-12",
+                            "invoice":
+                              {
+                                "invoiceId": "147722266",
+                                "invoiceNumber": "F2024-0002",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/ddb245d6df67999eca48c4a71b5661b93038e20a/i/dp5h1i5cuu94nopiolkdst3u17vkmzo",
+                              },
+                            "_links":
+                              {
+                                "get_contractdetails":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/7b2f8c1a-3d9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                        ],
+                    }
 components:
   securitySchemes:
     bearerToken:

src/openapi/customers/SE-notifications.yaml

@@ -0,0 +1,684 @@
+openapi: 3.0.1
+info:
+  title: Service Engine APIs for Notifications
+  description: >-
+    Service Engine APIs for all HTM Notifications. These are NOT the CRUD APIs to access raw data in the database.
+  version: "1.0"
+servers:
+  - url: https://services.acc.api.htm.nl/abt/touchpoint/2.0
+tags:
+  - name: Notification categories
+    description: >-
+      Service Engine APIs for all HTM Notifications metadata. To build content only.  
+  - name: Notification subscriptions
+    description: >-
+      Service Engine APIs for the HTM Notification subscriptions for a user. Contains the subscriptions on category level  
+  - name: Notification preferences
+    description: >-
+      //future  Service Engine APIs for the HTM Notification preferences for a category for a user. Contains the discrepancies from the default. or
+paths:
+  /notificationcategories:
+    get:
+      tags:
+        - Notification categories 
+      summary:  Get notification categories and optins references for that category that a touchpoint can show.
+      description: |
+        Get notification categories that a touchpoint can show and optins ( eventTypes) and channels (eventType_channels) for the optin for that category
+      parameters: 
+        - name: expand
+          in: query
+          schema: 
+              type: string
+              enum: [none, eventType, eventTypeChannel]
+              default: none
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              examples:
+                getNotifactionCategories?expand=eventTypeChannel:
+                  summary: Return all the notification categories with their nested attributes
+                  value:
+                    {
+                      "notificationCategories":[
+                        {
+                          "notificationCategoryId": 1,
+                          "name": "Nieuwsbrief",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 1,
+                              "eventOrigin": {
+                                "eventOriginId": 6,
+                                "name": "Maileon"
+                              },
+                              "name": "HTM nieuwsbrief",
+                              "subName": "",
+                              "prettyName": "HTM nieuwsbrief",
+                              "optinRequired": False,
+                              "eventTypeChannels":[                         
+                                {
+                                  "eventTypeChannelId": "447a1116-6cd7-4645-8c3d-43237b6186cd",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                    },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                }
+                              ]
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 2,
+                          "name": "Mijn Reizen",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 2,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, TRAVEL_SCHEME",
+                              "subName": "CI",
+                              "prettyName": "Check In",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                  "eventTypeChannelId": "ccc8c025-06b5-4928-a632-23e1c55cd173",
+                                  "channel":{
+                                    "channelId": 1,
+                                    "name": "push"
+                                    },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                },
+                                {
+                                  "eventTypeChannelId": "da2deb4c-ce77-4b5f-aecc-ddebfd14349d",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                    },
+                                  "isDefault": False,
+                                  "isMandatory": False
+                                }
+                              ]
+                            },
+                            {
+                              "eventTypeId": 3,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                  "eventTypeChannelId": "8e7df8f1-7e50-482f-8301-d399e75fd432",
+                                  "channel":{
+                                    "channelId": 1,
+                                    "name": "push"
+                                    },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                },
+                                {
+                                  "eventTypeChannelId": "72960a92-1855-469f-9cfd-5d72f57106f2",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                    },
+                                  "isDefault": False,
+                                  "isMandatory": False
+                                }
+                              ]
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 3,
+                          "name": "Mijn Passen",
+                          "eventTypes": [
+                            {                            
+                              "eventTypeId": 4,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, CARD",
+                              "subName": null,
+                              "prettyName": "Mijn passen",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                  "eventTypeChannelId": "be07c7bb-714b-4637-acf5-a67025ad8e60",
+                                  "channel":{
+                                    "channelId": 1,
+                                    "name": "push"
+                                  },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                },
+                                {
+                                  "eventTypeChannelId": "0c797b5a-ed34-494b-8c64-0a832830d392",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                  },
+                                  "isDefault": False,
+                                  "isMandatory": False
+                                }
+                              ]
+                            },
+                            {
+                              "eventTypeId": 5,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                    "eventTypeChannelId": "b910368f-c045-4e8e-b01d-bcbc78708bac",
+                                    "channel":{
+                                      "channelId": 1,
+                                      "name": "push"
+                                      },
+                                    "isDefault": True,
+                                    "isMandatory": False
+                                },
+                                {
+                                    "eventTypeChannelId": "93e773da-ba3b-48da-9a0e-ee478eaa752f",
+                                    "channel":{
+                                      "channelId": 2,
+                                      "name": "email"
+                                      },
+                                    "isDefault": False,
+                                    "isMandatory": False
+                                }
+                              ]
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                getNotifactionCategories?expand=eventType:
+                  summary: Return all the notification categories with nested eventTypes
+                  value:
+                    {
+                      "notificationCategories":[
+                        {
+                          "notificationCategoryId": 1,
+                          "name": "Nieuwsbrief",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 1,
+                              "eventOrigin": {
+                                "eventOriginId": 6,
+                                "name": "Maileon"
+                              },
+                              "name": "HTM nieuwsbrief",
+                              "subName": "",
+                              "prettyName": "HTM nieuwsbrief",
+                              "optinRequired": False
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 2,
+                          "name": "Mijn Reizen",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 2,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, TRAVEL_SCHEME",
+                              "subName": "CI",
+                              "prettyName": "Check In",
+                              "optinRequired": False
+                            },
+                            {
+                              "eventTypeId": 3,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 3,
+                          "name": "Mijn Passen",
+                          "eventTypes": [
+                            {                            
+                              "eventTypeId": 4,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, CARD",
+                              "subName": null,
+                              "prettyName": "Mijn passen",
+                              "optinRequired": False
+                            },
+                            {
+                              "eventTypeId": 5,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                getNotifactionCategories?expand=none:
+                  summary: Return all the notification categories
+                  value:
+                    {
+                      "notificationCategories":[
+                        {
+                          "notificationCategoryId": 1,
+                          "name": "Nieuwsbrief"
+                        },
+                        {
+                          "notificationCategoryId": 2,
+                          "name": "Mijn Reizen"
+                        },
+                        {
+                          "notificationCategoryId": 3,
+                          "name": "Mijn Passen"
+                        }
+                      ]
+                    }
+        "404":
+          description: No notification category found
+          content:
+            application/json:
+              example:
+               {
+                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",                  
+                  "title": "Niet gevonden",
+                  "detail": "Notificatiecategorie niet gevonden",
+                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
+                  "errors": [   
+                    {
+                      "code": "404",
+                      "detail": null,
+                      "path": null,
+                      "parameter": null
+                    }
+                  ],
+                }
+  /notificationsubscriptions:
+    get:
+      tags:
+       - Notification subscriptions
+      summary: Get all possible notificationSubscriptions for a customer (account or private).
+      description: |
+        Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it. 
+      parameters:
+        - name: X-HTM-JWT-AUTH-HEADER
+          in: header
+          schema:
+            type: string
+            example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+          required: false
+          description: The JWT of a customer in case of touchpoint were customer logs in themselves
+        - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER
+          in: header
+          schema:
+            type: string
+            example: feaaef83-a551-4283-8419-340b1ada3b55
+          required: false
+          description: The customerProfileId of a customer in the case of the SMP
+        - name: X-HTM-ROLE-HEADER
+          in: header
+          schema:
+            type: string
+            example: Customer
+          required: false
+          description: The role of the HTM employee in the case of the SMP
+        - name: emailAddress
+          in: query
+          schema:
+            type: integer
+            example: john.doe@mymailprovider.com 
+          required: false
+          description: The emailadress of the customer in the case of anonymous opt-ins    
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              examples:  
+                getNotifactionSubscriptionsAll:
+                  summary: Return all the notification subscriptions where for each category the client has actively opted in or out - All
+                  value:
+                    {
+                      "notificationSubscriptions":[
+                        {
+                          "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903",
+                          "notificationCategory": {
+                            "notificationCategoryId": 1,
+                            "name": "HTM nieuwbrief"
+                          },
+                          "isActive": true
+                        },
+                        {
+                          "notificationSubscriptionId": "571388cd-8903-40d5-89e6-9191cb8d656e",
+                          "notificationCategory": {
+                            "notificationCategoryId": 2,
+                            "name": "Mijn reizen"
+                          },
+                          "isActive": true
+                        },
+                        {
+                         "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b",
+                          "notificationCategory": {
+                            "notificationCategoryId": 3,
+                            "name": "Mijn contracten"
+                          },
+                          "isActive": false
+                        }
+                      ]
+                    }
+                getNotifactionSubscriptionsSome:
+                  summary: Return all the notification subscriptions where for each category the client has actively opted in or out - Some
+                  value:
+                    {
+                      "notificationSubscriptions": [
+                        {
+                          "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903",
+                          "notificationCategory": {
+                            "notificationCategoryId": 1,
+                            "name": "HTM nieuwbrief"
+                          },
+                          "isActive": true
+                        },
+                        {
+                         "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b",
+                          "notificationCategory": {
+                            "notificationCategoryId": 3,
+                            "name": "Mijn contracten"
+                          },
+                          "isActive": false
+                        }
+                      ]
+                    }
+        "403":
+          description: Forbidden // Als geverifieerd profiel gevonden wordt, maar niet op een geverifieerde manier benaderd wordt
+          content:
+            application/json:
+              example:
+                {
+                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",                 
+                  "title": "Verboden",
+                  "detail": "Niet toegestaan",
+                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
+                  "errors": [
+                    {
+                      "code": "403",
+                      "detail": null,
+                      "path": null,
+                      "parameter": null
+                    }
+                  ],
+                }
+        "404":
+          description: No notification subscriptions found
+          content:
+            application/json:
+              example:
+                {
+                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",                  
+                  "title": "Niet gevonden",
+                  "detail": "Notificatie niet gevonden",
+                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
+                  "errors": [   
+                    {
+                      "code": "404",
+                      "detail": null,
+                      "path": null,
+                      "parameter": null
+                    }
+                  ],
+                }
+    post:
+      tags:
+       - Notification subscriptions
+      summary: Create a new notificationSubscription for a customer (account or private).
+      description: |
+        Create a notificationSubscriptions for a customer (account or private), including if they have opted-in for it. 
+      parameters:
+        - name: X-HTM-JWT-AUTH-HEADER
+          in: header
+          schema:
+            type: string
+            example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+          required: false
+          description: The JWT of a customer in case of touchpoint were customer logs in themselves
+        - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER
+          in: header
+          schema:
+            type: string
+            example: feaaef83-a551-4283-8419-340b1ada3b55
+          required: false
+          description: The customerProfileId of a customer in the case of the SMP
+        - name: X-HTM-ROLE-HEADER
+          in: header
+          schema:
+            type: string
+            example: Customer
+          required: false
+          description: The role of the HTM employee in the case of the SMP
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Create notificationSubscription anonymous active:
+                value:
+                  {
+                    "emailAddress": "anonymous@mymailprovider.com",
+                    "notificationCategoryId": 1,
+                    "isActive": True
+                  }
+              Create notificationSubscription anonymous inactive:
+                value:
+                  {
+                    "emailAddress": "anonymous@mymailprovider.com",
+                    "notificationCategoryId": 1,
+                    "isActive": False
+                  }
+              Create notificationSubscription account active:
+                value:
+                  {
+                     "notificationCategoryId": 2,                    
+                     "isActive": True
+                  }
+              Create notificationSubscription account inactive:
+                value:
+                  {
+                    "notificationCategoryId": 2,
+                    "isActive": False
+                  }
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              examples:  
+                Create notificationSubscription anonymous active:
+                  summary: Return the created notification for an anonymous user active
+                  value:
+                    {
+                      "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
+                      "notificationCategory": {
+                        "notificationCategoryId": 1,
+                        "name": "HTM nieuwbrief"
+                      },                    
+                      "isActive": True
+                    }  
+                Create notificationSubscription anonymous inactive:
+                  summary:  Return the created notification for an anonymous user inactive
+                  value:
+                    {
+                      "notificationSubscriptionId": "d51081fd-c48d-4111-8de4-ac5db7d47ecb",
+                      "notificationCategory": {
+                        "notificationCategoryId": 1,
+                        "name": "HTM nieuwbrief"
+                      },                   
+                      "isActive": False
+                    } 
+                Create notificationSubscription account active:
+                  summary: Return the created notification for an anonymous user active
+                  value:
+                    {
+                      "notificationSubscriptionId": "6b88eba1-af1f-42fc-82d3-d7202d5f1afe",
+                      "notificationCategory": {
+                        "notificationCategoryId": 2,
+                        "name": "Mijn reizen"
+                      },                
+                      "isActive": True
+                    }  
+                Create notificationSubscription account inactive:
+                  summary:  Return the created notification for an anonymous user inactive
+                  value:
+                    {
+                      "notificationSubscriptionId": "0dfc0ac9-c221-4493-8828-9dfa79ad9061",
+                      "notificationCategory": {
+                        "notificationCategoryId": 2,
+                        "name": "Mijn reizen"
+                      },                             
+                      "isActive": False
+                    }
+        "405":
+          description: Method not allowed, ook als een notificatie aangemaakt wordt voor een account maar op een anonieme manier benadert wordt.
+          content: 
+            application/json:
+              example: 
+                {
+                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",             
+                  "title": "Methode niet toegestaan",
+                  "detail": "",
+                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
+                  "errors": [   
+                    {
+                      "code": "405",
+                      "detail": null,
+                      "path": null,
+                      "parameter": null
+                    }
+                  ],
+                }
+  /notificationsubscriptions/{notificationSubscriptionId}:
+    patch:
+      tags: 
+        - Notification subscriptions
+      summary: Update a notificationSubscription for a customer (account or private).
+      description: |
+        Update a  notificationSubscription for a customer (account or private). 
+      parameters:
+        - name: X-HTM-JWT-AUTH-HEADER
+          in: header
+          schema:
+            type: string
+            example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+          required: false
+          description: The JWT of a customer in case of touchpoint were customer logs in themselves
+        - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER
+          in: header
+          schema:
+            type: string
+            example: feaaef83-a551-4283-8419-340b1ada3b55
+          required: false
+          description: The customerProfileId of a customer in the case of the SMP
+        - name: X-HTM-ROLE-HEADER
+          in: header
+          schema:
+            type: string
+            example: Customer
+          required: false
+          description: The role of the HTM employee in the case of the SMP
+        - name: notificationSubscriptionId
+          in: path
+          schema:
+            type: string
+            format: uuid
+            example: e112f26e-37fa-4bde-8def-9977cd1d50ae
+          required: true
+          description: The id of the notificationSubscription you want to update
+        - name: emailAddress
+          in: query
+          schema:
+            type: string
+            format: email
+            example: john.doe@mymailprovider.com 
+          required: false
+          description: The emailadress of the customer in the case of anonymous opt-ins   
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              Update a notificationSubscription to inactive:
+                value:
+                  {                        
+                    "isActive": False                    
+                  }
+              Update a notificationSubscription to active:
+                value:
+                  {                        
+                    "isActive": True
+                  }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              examples:  
+                Update a notificationSubscription to inactive:
+                  summary: Return the updated inactive notification
+                  value:
+                    {
+                      "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
+                      "notificationCategory": {
+                        "notificationCategoryId": 1,
+                        "name": "HTM nieuwbrief"
+                      },                  
+                      "isActive": False
+                    }  
+                Update a notificationSubscription to active:
+                  summary: Return the updated active notification
+                  value:
+                    {
+                      "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
+                       "notificationCategory": {
+                        "notificationCategoryId": 1,
+                        "name": "HTM nieuwbrief"
+                      },                    
+                      "isActive": True
+                    } 
+components:
+  schemas:
+    unavailable:
+      type: object

src/openapi/customers/customers_reference-crud.yaml

@@ -0,0 +1,888 @@
+openapi: 3.0.1
+info:
+  title: ABTCustomerReference
+  version: '1.0'
+servers:
+  - url: https://services.acc.api.htm.nl/abt/customerreference/1.0
+security:
+  - default: []
+tags:
+  - name: ABTCustomerReference
+paths:
+  /directdebitmandatetype:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of direct debit mandate types
+      description: gives list of direct debit mandate types
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of direct debit mandate types
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/directDebitMandateTypes'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /phonetype:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of phone types
+      description: gives list of phone types
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of phoneTypes
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/phoneTypes'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+    post:
+      tags:
+        - ABTCustomerReference
+      summary: Create a phone type
+      description: Create a phone type with a specific value
+      parameters: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/phoneType'
+        required: true
+      responses:
+        '201':
+          description: Successful created a new phone type
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: integer
+                    example: 1
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /phonetype/{phoneTypeId}:
+    put:
+      tags:
+        - ABTCustomerReference
+      summary: Update a phone type
+      description: Update an existing phone type with a specific value
+      parameters:
+        - name: phoneTypeId
+          in: path
+          required: true
+          style: simple
+          explode: false
+          schema:
+            type: integer
+            format: integer
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/phoneType'
+        required: true
+      responses:
+        '202':
+          description: Successful updated an existing a phone type
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: integer
+                    example: 1
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+    delete:
+      tags:
+        - ABTCustomerReference
+      summary: Remove a phone type
+      description: Remove an existing phone type with a specific value
+      parameters:
+        - name: phoneTypeId
+          in: path
+          required: true
+          style: simple
+          explode: false
+          schema:
+            type: integer
+            format: integer
+      responses:
+        '202':
+          description: Successful removed a phone type
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '#/components/schemas/404ResponseId'
+                  - $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /addresstype:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of address types
+      description: gives list of address types
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of addressTypes
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/addressTypes'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /customerstatus:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of customer status
+      description: gives list of customer status
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of customer status
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/customerStatus'
+              example:
+                Entries:
+                  - customerStatusId: 1
+                    name: Inactive
+                  - customerStatusId: 2
+                    name: Active
+                  - customerStatusId: 3
+                    name: Blocked
+                  - customerStatusId: 4
+                    name: Frozen
+                  - customerStatusId: 5
+                    name: Cleared
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /tokentype:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of token types
+      description: gives list of token types
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of customer status
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/tokenType'
+              example:
+                Entries:
+                  - tokenTypeId: 1
+                    name: Debit card
+                  - tokenTypeId: 2
+                    name: Credit card
+                  - tokenTypeId: 3
+                    name: OVPas physical
+                  - tokenTypeId: 4
+                    name: OVPas digital
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /customerreferences:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of all possible customer reference values
+      description: gives list of all possible customer reference values availbale
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of all possible customer reference values
+          content:
+            application/json:
+              schema:
+                allOf:
+                  - $ref: '#/components/schemas/customerReferences'
+              example:
+                Entries:
+                  phoneTypes:
+                    - name: mobile
+                      id: 1
+                    - name: fixed line
+                      id: 2
+                  addressTypes:
+                    - name: home
+                      id: 1
+                    - name: office
+                      id: 2
+                  customerStatuses:
+                    - name: active
+                      id: 1
+                    - name: blocked
+                      id: 2
+                    - name: inactive
+                      id: 3
+                    - name: new
+                      id: 4
+                  tokenTypes:
+                    - name: Debit card
+                      id: 1
+                    - name: Credit card
+                      id: 2
+                    - name: OVPas physical
+                      id: 3
+                    - name: OVPas digital
+                      id: 4
+                  directDebitMandateTypes:
+                    - name: Paper Contract
+                      id: 1
+                    - name: PIN transaction
+                      id: 2
+                  tokenStatuses:
+                    - name: Expired
+                      id: 1
+                    - name: Active
+                      id: 2
+                    - name: Replaced
+                      id: 3
+                    - name: Inactive
+                      id: 4
+                    - name: Suspended
+                      id: 5
+                    - name: Removed by customer
+                      id: 6
+                  debtorStatuses:
+                    - name: Inactive
+                      id: 1
+                    - name: Active
+                      id: 2
+                  languages:
+                    - id: 1
+                      name: Nederlands
+                      ietfCode: nl-Nl
+                      iso639Code: nl
+                    - id: 2
+                      name: English
+                      ietfCode: en-US
+                      iso639Code: en
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /tokenstatus:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of all token status
+      description: gives list of all token statuses
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of customer status
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/language'
+              example:
+                Entries:
+                  - tokenStatusId: 1
+                    name: Expired
+                  - tokenStatusId: 2
+                    name: Active
+                  - tokenStatusId: 3
+                    name: Replaced
+                  - tokenStatusId: 4
+                    name: Inactive
+                  - tokenStatusId: 5
+                    name: Suspended
+                  - tokenStatusId: 6
+                    name: Removed by customer
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /language:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of all languages
+      description: gives list of all languages
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of languages
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/language'
+              example:
+                Entries:
+                  - languageId: 1
+                    name: Expired
+                    ietfCode: nl-NL
+                    iso639Code: nl
+                  - languageId: 2
+                    name: Expired
+                    ietfCode: en-US
+                    iso639Code: en
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /debtorstatus:
+    get:
+      tags:
+        - ABTCustomerReference
+      summary: List of all debtorstatuses
+      description: gives list of all debtorstatuses
+      parameters: []
+      responses:
+        '200':
+          description: Successful retrieved list of debtorstatuses
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/tokenStatus'
+              example:
+                Entries:
+                  - debtorStatusId: 1
+                    name: Inactive
+                  - debtorStatusId: 2
+                    name: Active
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400Response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/401Response'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404Response'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/500Response'
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+components:
+  schemas:
+    directDebitMandateTypeList:
+      type: array
+      items:
+        properties:
+          directDebitMandateTypeId:
+            type: integer
+            example: 1
+          name:
+            type: string
+            example: name
+    directDebitMandateType:
+      properties:
+        name:
+          type: string
+          example: name
+        id:
+          type: integer
+          example: 1
+    directDebitMandateTypes:
+      type: object
+      properties:
+        Entries:
+          $ref: '#/components/schemas/directDebitMandateTypeList'
+    phoneType:
+      properties:
+        name:
+          type: string
+          example: name
+    phoneTypeIdList:
+      type: array
+      items:
+        properties:
+          phoneTypeId:
+            type: integer
+            example: 123
+          name:
+            type: string
+            example: name
+    phoneTypes:
+      type: object
+      properties:
+        Entries:
+          $ref: '#/components/schemas/phoneTypeIdList'
+    addressType:
+      properties:
+        name:
+          type: string
+          example: name
+    addressTypeIdList:
+      type: array
+      items:
+        properties:
+          addressTypeId:
+            type: integer
+            example: 123
+          name:
+            type: string
+            example: name
+    addressTypes:
+      type: object
+      properties:
+        Entries:
+          $ref: '#/components/schemas/addressTypeIdList'
+    customerStatuses:
+      type: object
+      properties:
+        Entries:
+          $ref: '#/components/schemas/customerStatusIdList'
+    customerStatusIdList:
+      type: array
+      items:
+        properties:
+          customerStatusId:
+            type: integer
+          name:
+            type: string
+    customerStatus:
+      properties:
+        name:
+          type: string
+          example: name
+    tokenTypes:
+      type: object
+      properties:
+        Entries:
+          $ref: '#/components/schemas/customerStatusIdList'
+    tokenTypeIdList:
+      type: array
+      items:
+        properties:
+          tokenTypeId:
+            type: integer
+          name:
+            type: string
+    tokenType:
+      properties:
+        name:
+          type: string
+          example: name
+    tokenStatuses:
+      type: object
+      properties:
+        Entries:
+          $ref: '#/components/schemas/customerStatusIdList'
+    tokenStatusIdList:
+      type: array
+      items:
+        properties:
+          tokenStatusId:
+            type: integer
+          name:
+            type: string
+    tokenStatus:
+      properties:
+        tokenStatusId:
+          type: integer
+          example: 1
+        name:
+          type: string
+          example: name
+    debtorStatus:
+      properties:
+        debtorStatusId:
+          type: integer
+          example: 1
+        name:
+          type: string
+          example: name
+    language:
+      properties:
+        languageId:
+          type: integer
+          example: 1
+        name:
+          type: string
+          example: name
+        ietfCode:
+          type: string
+          example: nl-NL
+        iso639Code:
+          type: string
+          example: nl
+    customerReferences:
+      type: object
+      properties:
+        Entries:
+          oneOf:
+            - $ref: '#/components/schemas/addressType'
+            - $ref: '#/components/schemas/phoneType'
+            - $ref: '#/components/schemas/customerStatus'
+            - $ref: '#/components/schemas/tokenType'
+            - $ref: '#/components/schemas/directDebitMandateType'
+            - $ref: '#/components/schemas/tokenStatus'
+    400Response:
+      type: object
+      properties:
+        code:
+          type: string
+          example: '400'
+        type:
+          type: string
+        message:
+          type: string
+          example: Bad Request
+        description:
+          type: string
+          example: '''2023-02-01 00:00:00'' is not a valid Datetime'
+    401Response:
+      type: object
+      properties:
+        code:
+          type: string
+          example: '900901'
+        type:
+          type: string
+        message:
+          type: string
+          example: Invalid Credentials
+        description:
+          type: string
+          example: >-
+            Invalid Credentials. Make sure you have provided the correct
+            security credentials
+    404Response:
+      type: object
+      properties:
+        code:
+          type: string
+          example: '404'
+        type:
+          type: string
+          example: Status report
+        message:
+          type: string
+          example: Not Found
+        description:
+          type: string
+          example: The requested resource is not available.
+    404ResponseId:
+      type: object
+      properties:
+        error:
+          type: string
+          example: 'No record found for id: 5'
+    500Response:
+      type: object
+      properties:
+        code:
+          type: string
+          example: '500'
+        type:
+          type: string
+        message:
+          type: string
+          example: Internal Server Error
+        description:
+          type: string
+  securitySchemes:
+    default:
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: https://services.dev.api.htm.nl/authorize
+          scopes: {}

src/openapi/customers/se-maileon.yaml

@@ -0,0 +1,468 @@
+openapi: 3.0.1
+info:
+  title: Service Engine APIs for maileon
+  description: >-
+    Service Engine APIs for maileon. These are NOT the CRUD APIs to access raw data in the database.
+  version: "1.0"
+servers:
+  - url: https://services.acc.api.htm.nl/abt/maileon/1.0
+tags:
+  - name: Customers
+    description: >-
+      Service Engine API's for maileon to update the customer profile. Only field isEmailVerified.
+  - name: Notification categories
+    description: >-
+      Service Engine APIs for all HTM Notifications metadata. To build content only.  
+  - name: Notification subscriptions
+    description: >-
+      Service Engine APIs for the HTM Notification subscriptions for a user. Contains the subscriptions on category level.
+paths:
+  /customers:
+    patch:
+      tags:
+        - Customers
+      parameters:
+        - name: customerProfileId
+          in: header
+          schema:
+            type: string
+            example: 1
+          required: true
+          description: The customerProfileId of a customer
+        - name: emailAddress
+          in: header
+          schema:
+            type: string
+            format: email
+            example: john.doe@mymailprovider.com 
+          required: true
+          description: The emailadress of the customer
+      summary: Update a customer profile
+      description: Update a customer profile based on the customerProfileId and emailAddress
+      requestBody:      
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            examples:
+              patchCustomer:
+                value:
+                  {
+                    "person": {
+                      "isEmailVerified": True
+                    }
+                  } 
+      responses: 
+        "202":
+          description: OK    
+  /notificationcategories:
+    get:
+      tags:
+        - Notification categories
+      summary:  Get notification categories and optins for that category that a touchpoint can show.
+      description: |
+        Get notification categories that a touchpoint can show and optins ( eventTypes) and channels (eventType_channels) for the optin for that category
+      parameters: 
+        - name: expand
+          in: query
+          schema: 
+              type: string
+              enum: [none, eventType, eventTypeChannel]
+              default: none
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              examples:
+                getNotifactionCategories?expand=evenTypeChannel:
+                  summary: Return all the notification categories with their nested attributes
+                  value:
+                    {
+                      "notificationCategories":[
+                        {
+                          "notificationCategoryId": 1,
+                          "name": "Nieuwsbrief",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 1,
+                              "eventOrigin": {
+                                "eventOriginId": 6,
+                                "name": "Maileon"
+                              },
+                              "name": "HTM nieuwsbrief",
+                              "subName": "",
+                              "prettyName": "HTM nieuwsbrief",
+                              "optinRequired": False,
+                              "eventTypeChannels":[                         
+                                {
+                                  "eventTypeChannelId": "447a1116-6cd7-4645-8c3d-43237b6186cd",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                    },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                }
+                              ]
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 2,
+                          "name": "Mijn Reizen",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 2,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, TRAVEL_SCHEME",
+                              "subName": "CI",
+                              "prettyName": "Check In",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                  "eventTypeChannelId": "ccc8c025-06b5-4928-a632-23e1c55cd173",
+                                  "channel":{
+                                    "channelId": 1,
+                                    "name": "push"
+                                    },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                },
+                                {
+                                  "eventTypeChannelId": "da2deb4c-ce77-4b5f-aecc-ddebfd14349d",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                    },
+                                  "isDefault": False,
+                                  "isMandatory": False
+                                }
+                              ]
+                            },
+                            {
+                              "eventTypeId": 3,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                  "eventTypeChannelId": "8e7df8f1-7e50-482f-8301-d399e75fd432",
+                                  "channel":{
+                                    "channelId": 1,
+                                    "name": "push"
+                                    },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                },
+                                {
+                                  "eventTypeChannelId": "72960a92-1855-469f-9cfd-5d72f57106f2",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                    },
+                                  "isDefault": False,
+                                  "isMandatory": False
+                                }
+                              ]
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 3,
+                          "name": "Mijn Passen",
+                          "eventTypes": [
+                            {                            
+                              "eventTypeId": 4,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, CARD",
+                              "subName": null,
+                              "prettyName": "Mijn passen",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                  "eventTypeChannelId": "be07c7bb-714b-4637-acf5-a67025ad8e60",
+                                  "channel":{
+                                    "channelId": 1,
+                                    "name": "push"
+                                  },
+                                  "isDefault": True,
+                                  "isMandatory": False
+                                },
+                                {
+                                  "eventTypeChannelId": "0c797b5a-ed34-494b-8c64-0a832830d392",
+                                  "channel":{
+                                    "channelId": 2,
+                                    "name": "email"
+                                  },
+                                  "isDefault": False,
+                                  "isMandatory": False
+                                }
+                              ]
+                            },
+                            {
+                              "eventTypeId": 5,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False,
+                              "eventTypeChannels":[
+                                {
+                                    "eventTypeChannelId": "b910368f-c045-4e8e-b01d-bcbc78708bac",
+                                    "channel":{
+                                      "channelId": 1,
+                                      "name": "push"
+                                      },
+                                    "isDefault": True,
+                                    "isMandatory": False
+                                },
+                                {
+                                    "eventTypeChannelId": "93e773da-ba3b-48da-9a0e-ee478eaa752f",
+                                    "channel":{
+                                      "channelId": 2,
+                                      "name": "email"
+                                      },
+                                    "isDefault": False,
+                                    "isMandatory": False
+                                }
+                              ]
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                getNotifactionCategories?expand=eventType:
+                  summary: Return all the notification categories with nested eventTypes
+                  value:
+                    {
+                      "notificationCategories":[
+                        {
+                          "notificationCategoryId": 1,
+                          "name": "Nieuwsbrief",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 1,
+                              "eventOrigin": {
+                                "eventOriginId": 6,
+                                "name": "Maileon"
+                              },
+                              "name": "HTM nieuwsbrief",
+                              "subName": "",
+                              "prettyName": "HTM nieuwsbrief",
+                              "optinRequired": False
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 2,
+                          "name": "Mijn Reizen",
+                          "eventTypes": [
+                            {
+                              "eventTypeId": 2,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, TRAVEL_SCHEME",
+                              "subName": "CI",
+                              "prettyName": "Check In",
+                              "optinRequired": False
+                            },
+                            {
+                              "eventTypeId": 3,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False
+                            }
+                          ]
+                        },
+                        {
+                          "notificationCategoryId": 3,
+                          "name": "Mijn Passen",
+                          "eventTypes": [
+                            {                            
+                              "eventTypeId": 4,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, CARD",
+                              "subName": null,
+                              "prettyName": "Mijn passen",
+                              "optinRequired": False
+                            },
+                            {
+                              "eventTypeId": 5,
+                              "eventOrigin": {
+                                "eventOriginId": 1,
+                                "name": "GBO"
+                              },
+                              "name": "ALERTS, PAD",
+                              "subName": null,
+                              "prettyName": "Profielgegevens op de pas",
+                              "optinRequired": False
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                getNotifactionCategories?expand=none:
+                  summary: Return all the notification categories
+                  value:
+                    {
+                      "notificationCategories":[
+                        {
+                          "notificationCategoryId": 1,
+                          "name": "Nieuwsbrief"
+                        },
+                        {
+                          "notificationCategoryId": 2,
+                          "name": "Mijn Reizen"
+                        },
+                        {
+                          "notificationCategoryId": 3,
+                          "name": "Mijn Passen"
+                        }
+                      ]
+                    }
+        "404":
+          description: No notification category found
+          content:
+            application/json:
+              example:
+                {
+                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",                  
+                  "title": "Niet gevonden",
+                  "detail": "Notificatiecategorie niet gevonden",
+                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
+                  "errors": [   
+                    {
+                      "code": "404",
+                      "detail": null,
+                      "path": null,
+                      "parameter": null
+                    }
+                  ],
+                }
+  /notificationsubscriptions:
+    get:
+      tags:
+       - Notification subscriptions
+      summary: Get all possible notificationSubscriptions for a customer (account or private).
+      description: |
+        Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it. 
+      parameters:
+        - name: customerProfileId
+          in: header
+          schema:
+            type: integer
+            example: 12361
+          required: true
+          description: The customerProfileId of a customer 
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              examples:  
+                getNotifactionSubscriptionsAll:
+                  summary: Return all the notification subscriptions where for each category the client has actively opted in or out - All
+                  value:
+                    {
+                      "notificationSubscriptions":[
+                        {
+                          "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903",
+                          "notificationCategoryId": 1,
+                          "isActive": true
+                        },
+                        {
+                          "notificationSubscriptionId": "571388cd-8903-40d5-89e6-9191cb8d656e",
+                          "notificationCategoryId": 2,
+                          "isActive": true
+                        },
+                        {
+                         "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b",
+                          "notificationCategoryId": 3,
+                          "isActive": false
+                        }
+                      ]
+                    }
+                getNotifactionSubscriptionsSome:
+                  summary: Return all the notification subscriptions where for each category the client has actively opted in or out - Some
+                  value:
+                    {
+                      "notificationSubscriptions": [
+                        {
+                          "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903",
+                          "notificationCategoryId": 1,
+                          "isActive": true
+                        },
+                        {
+                         "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b",
+                          "notificationCategoryId": 3,
+                          "isActive": false
+                        }
+                      ]
+                    }
+        "403":
+          description: Forbidden // Als geverifieerd profiel gevonden wordt, maar niet op een geverifieerde manier benaderd wordt
+          content:
+            application/json:
+              example:
+                {
+                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",                  
+                  "title": "Verboden",
+                  "detail": "Niet toegestaan",
+                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
+                  "errors": [   
+                    {
+                      "code": "403",
+                      "detail": null,
+                      "path": null,
+                      "parameter": null
+                    }
+                  ],
+                }
+        "404":
+          description: No notification subscriptions found
+          content:
+            application/json:
+              example:
+                  {
+                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",                  
+                  "title": "Niet gevonden",
+                  "detail": "Notificaties niet gevonden",
+                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
+                  "errors": [   
+                    {
+                      "code": "404",
+                      "detail": null,
+                      "path": null,
+                      "parameter": null
+                    }
+                  ],
+                }
+components:
+  schemas:
+    unavailable:
+      type: object

src/openapi/fiko/fikoreference-crud.yaml

@@ -1,381 +0,0 @@
-openapi: 3.0.1
-info:
-  title: ABTFikoReference
-  description: |-
-    CRUD APIs for FIKO reference data (based on the v1 model for FIKO, see [the FIKO v1 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=145%2C-316%2C2782%2C1418%2C0_0&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)). This means that, for now, only GET endpoints on `TaxMetadata` and `ProductGroupMetadata` (already named `ProductMetadata` to avoid rework for v2) are available.
-    
-    When the v2 model for FIKO is implemented (see [the FIKO v2 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=-72%2C-954%2C2406%2C1226%2CUnjZp4g0O~CK&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)), POST/PUT/DELETE for these tables (as well as CRUD for additional tables) will become available, to support populating the reference tables with Unit4Financials data.
-    
-    These are NOT functional API's to be published by the Service Engine, but are direct CRUD API's on top of the database.
-  version: '1.0'
-servers:
-  - url: https://api.integratielaag.nl/abt/fikoreference/1.0
-tags:
-  - name: ABTFikoReference CRUD v1
-    description: >-
-      CRUD APIs for FIKO reference data (based on the v1 model for FIKO, see [the FIKO v1 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=145%2C-316%2C2782%2C1418%2C0_0&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)).
-  - name: ABTFikoReference CRUD v2
-    description: >-
-      CRUD APIs for FIKO reference data (based on the v2 model for FIKO, see [the FIKO v2 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=-72%2C-954%2C2406%2C1226%2CUnjZp4g0O~CK&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)).
-
-paths:
-  /taxmetadata:
-    get:
-      tags:
-        - ABTFikoReference CRUD v1
-      summary: Get a list of all possible values of the "TaxMetadata" reference table. Mainly used for populating dropdown lists (in PMT for example).
-      description: |-
-        Get a list of all possible values of the `TaxMetadata` reference table. Mainly used for populating dropdown lists (in PMT for example).\
-        The attributes `validFrom` and `validUntil` are not yet present in the FIKO v1 datamodel, but are already included in this resourcemodel; to prevent rework in the near future.\
-        For now, for `validFrom`, the value will always be returned as `2024-01-01T00:00:00.000+00:00` and for `validUntil` it will always be `null`.
-      responses:
-        '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/TaxMetadataListResponse'
-              examples:
-                getListTaxMetadataSales:
-                  summary: List containing three TaxMetadata entries, used for sales tax
-                  value:
-                    {
-                      "Entries": [
-                        {
-                          "taxMetadataId": "61A148AF-6DCB-4BB6-9D3F-17A8B627F745",
-                          "taxCode": "V21",
-                          "taxPercentageAmount": 21,
-                          "description": "BTW VERKOOP HOOG 21%",
-                          "validFrom": "2024-01-01T00:00:00.000+00:00",
-                          "validUntil": null
-                        },
-                        {
-                          "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85",
-                          "taxCode": "V09",
-                          "taxPercentageAmount": 9,
-                          "description": "BTW VERKOOP LAAG 9%",
-                          "validFrom": "2024-01-01T00:00:00.000+00:00",
-                          "validUntil": null
-                        },
-                        {
-                          "taxMetadataId": "AC20A838-C81B-4652-96EA-F6E79E696E9C",
-                          "taxCode": "V0",
-                          "taxPercentageAmount": 0,
-                          "description": "BTW VERKOOP NUL",
-                          "validFrom": "2024-01-01T00:00:00.000+00:00",
-                          "validUntil": null
-                        }
-                      ]
-                    }
-                getListTaxMetadataSalesAndPurchase:
-                  summary: List containing x TaxMetadata entries, used for sales and purchase tax
-                  value:
-                    {
-                      "Entries": [
-                        {
-                          "taxMetadataId": "61A148AF-6DCB-4BB6-9D3F-17A8B627F745",
-                          "taxCode": "V21",
-                          "taxPercentageAmount": 21,
-                          "description": "BTW VERKOOP HOOG 21%",
-                          "validFrom": "2024-01-01T00:00:00.000+00:00",
-                          "validUntil": null
-                        },
-                        {
-                          "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85",
-                          "taxCode": "V09",
-                          "taxPercentageAmount": 9,
-                          "description": "BTW VERKOOP LAAG 9%",
-                          "validFrom": "2024-01-01T00:00:00.000+00:00",
-                          "validUntil": null
-                        },
-                        {
-                          "taxMetadataId": "AC20A838-C81B-4652-96EA-F6E79E696E9C",
-                          "taxCode": "V0",
-                          "taxPercentageAmount": 0,
-                          "description": "BTW VERKOOP NUL",
-                          "validFrom": "2024-01-01T00:00:00.000+00:00",
-                          "validUntil": null
-                        },
-                        {
-                          "TBD": "TBD"
-                        },
-                        {
-                          "TBD": "TBD"
-                        },
-                        {
-                          "TBD": "TBD"
-                        }
-                      ]
-                    }                   
-        '400':
-          description: '400'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/400Response'
-        '401':
-          description: '401'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/401Response'
-        '404':
-          description: '404'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/404Response'
-        '500':
-          description: '500'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/500Response'
-  /productmetadata:
-    get:
-      tags:
-        - ABTFikoReference CRUD v1
-      summary: Get a list of all possible values of the "ProductMetadata" reference table. Mainly used for populating dropdown lists (in PMT for example).
-      description: |-
-        Get a list of all possible values of the `ProductGroupMetadata` (soon to be renamed to `ProductMetadata`) reference table. Mainly used for populating dropdown lists (in PMT for example).\
-        The name of the entity is `ProductGroupMetadata` in the FIKO v1 datamodel, but the resourcemodel already uses the name `ProductMetadata`, as will be the name from FIKO v2 onwards.\
-        This also applies to the attributes `productMetadataId` (still called `ProductGroupMetadataId` in FIKO v1), `productCode` (still called `productGroupCode` in FIKO v1) and `user` (present in FIKO v1, but removed in FIKO v2, so also in this resourcemodel).
-      responses:
-        '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ProductMetadataListResponse'
-              examples:
-                getListProductMetadata:
-                  summary: List containing one ProductMetadata entry, used for testing purposes
-                  value:
-                    {
-                      "Entries": [
-                        {
-                          "productMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E",
-                          "productCode": "PG001",
-                          "department": "Electronics",
-                          "costCenter": "CC101",
-                          "costType": "TypeA",
-                          "description": "Group for electronic products",
-                          "documentCode": "DOC001",
-                          "timestampUpdated": "2024-09-03T15:07:53.470+00:00",
-                          "validFrom": "2024-08-01T00:00:00.000+00:00",
-                          "validUntil": "2025-08-01T00:00:00.000+00:00"
-                        }
-                      ],
-                    }
-        '400':
-          description: '400'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/400Response'
-        '401':
-          description: '401'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/401Response'
-        '404':
-          description: '404'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/404Response'
-        '500':
-          description: '500'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/500Response'
-    
-components:
-  schemas:
-    TaxMetadataListResponse:
-      type: object
-      required:
-        - Entries
-      properties:
-        Entries:
-          type: array
-          items:
-            $ref: '#/components/schemas/TaxMetadataResponse'
-    ProductMetadataListResponse:
-      type: object
-      required:
-        - Entries
-      properties:
-        Entries:
-          type: array
-          items:
-          $ref: '#/components/schemas/ProductMetadataResponse'
-    TaxMetadataResponse:
-      type: object
-      required:
-        - taxMetadataId
-        - taxCode
-        - taxPercentageAmount
-        - validFrom
-      properties:
-        taxMetadataId:
-          type: string
-          format: uuid
-          example: 501B17EF-36C4-4039-B92C-6517969B464E
-        taxCode:
-          type: string
-          example: V09
-        taxPercentageAmount:
-          type: integer
-          example: 21
-        description:
-          type: string
-          example: BTW VERKOOP LAAG 9%
-        validFrom:
-          type: string
-          format: date-time-offset
-          example: '2024-09-03T10:01:34.000+00:00'
-        validUntil:
-          type: string
-          format: date-time-offset
-          example: '2024-09-03T10:01:34.000+00:00'
-    ProductMetadataResponse:
-      type: object
-      required:
-        - productMetadataId
-        - productCode
-        - department
-        - costCenter
-        - costType
-        - description
-        - documentCode
-        - timestampUpdated
-        - validFrom
-      properties:
-        productMetadataId:
-          type: string
-          format: uuid
-          example: 501B17EF-36C4-4039-B92C-6517969B464E
-        productCode:
-          type: string
-          description: Called "artikelnr" in U4F
-          example: TBD
-        department:
-          type: string
-          description: Called "element 1" in U4F
-          example: TBD
-        costCenter:
-          type: string
-          description: Called "element 3" in U4F
-          example: TBD
-        costType:
-          type: string
-          description: Called "element 2" in U4F
-          example: TBD
-        description:
-          type: string
-          example: TBD
-        documentCode:
-          type: string
-          example: TBD
-        timestampUpdated:
-          type: string
-          format: date-time-offset
-          example: '2024-09-03T10:01:34.000+00:00'
-        validFrom:
-          type: string
-          format: date-time-offset
-          example: '2024-09-03T10:01:34.000+00:00'
-        validUntil:
-          type: string
-          format: date-time-offset
-          example: '2024-09-03T10:01:34.000+00:00'
-    400Response:
-      type: object
-      properties:
-        code:
-          type: string
-          example: '400'
-        type:
-          type: string
-        message:
-          type: string
-          example: Bad Request
-        description:
-          type: string
-          example: '''2023-02-01 00:00:00'' is not a valid Datetime'
-        apiErrorCode:
-          type: string
-          example: htm.api.err.40xxx
-    401Response:
-      type: object
-      properties:
-        code:
-          type: string
-          example: '900901'
-        type:
-          type: string
-        message:
-          type: string
-          example: Invalid Credentials
-        description:
-          type: string
-          example: >-
-            Invalid Credentials. Make sure you have provided the correct
-            security credentials
-        apiErrorCode:
-          type: string
-          example: htm.api.err.40xxx
-    403Response:
-      type: object
-      properties:
-        code:
-          type: string
-          example: '900901'
-        type:
-          type: string
-        message:
-          type: string
-          example: Retailer not authorized
-        description:
-          type: string
-          example: The retailer is not allowed to access resource for requested
-        apiErrorCode:
-          type: string
-          example: htm.api.err.40xxx touchpoint
-    404Response:
-      type: object
-      properties:
-        code:
-          type: string
-          example: '404'
-        type:
-          type: string
-          example: Status report
-        message:
-          type: string
-          example: Not Found
-        description:
-          type: string
-          example: The requested resource is not available.
-        apiErrorCode:
-          type: string
-          example: htm.api.err.40xxx
-    500Response:
-      type: object
-      properties:
-        code:
-          type: string
-          example: '500'
-        type:
-          type: string
-        message:
-          type: string
-          example: Internal Server Error
-        description:
-          type: string
-        apiErrorCode:
-          type: string
-          example: htm.api.err.40xxx

src/openapi/nfc_reader/servicedeskcardreader-api.yaml

@@ -0,0 +1,206 @@
+openapi: 3.0.3
+info:
+  title: Service Desk Card Reader API
+  version: 0.9.0
+  description: |-
+    This API enables that external systems (such as SOS) can operate on information from service desk card readers.
+
+    ### 0.9.0
+    - First draft version
+servers:
+  - url: /v1
+paths:
+  /card-reader/token:
+    post:
+      tags:
+        - CardReader
+      summary: Register a token from the card
+      operationId: registerToken
+      description: |
+        Register a token from the card to the external system.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/TokenRegisterRequest"
+      responses:
+        "202":
+          description: Accepted
+        "400":
+          description: |-
+            Bad Request. Occurs when the readerId is unknown to the external system. A call to `/card-reader/registrations`, 
+            followed by a `/card-reader/register` is needed in order to restore reader registrations.
+  /card-reader/register:
+    post:
+      tags:
+        - CardReader
+      summary: Register a reader that is connected to the Card Reader Interface
+      operationId: registerReader
+      description: |
+        Register a reader to the external system to receive a newly generated readerID.
+
+        **N.B.**: After the last reader has been registered, an initial `/card-reader/registrations` call must be sent.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ReaderRegisterRequest"
+      responses:
+        "200":
+          description: Registration was successful
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ReaderRegisterResponse"
+        "400":
+          description: Bad Request
+
+  /card-reader/unregister:
+    post:
+      tags:
+        - CardReader
+      summary: Unregister a reader from the external system
+      operationId: unregisterReader
+      description: |
+        Unregister a reader from the external system.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ReaderUnregisterRequest"
+      responses:
+        "204":
+          description: Unregistration was successful
+        "400":
+          description: Bad Request
+  /card-reader/registrations:
+    post:
+      tags:
+        - CardReader
+      summary: Send a list of readers that should currently be registered
+      operationId: sendReaderRegistrations
+      description: |
+        Send a list of readers of which the Card Reader Interface believes are registered. This must be done periodically.
+        The period is determined by the timeout duration in the response.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RegistrationsRequest"
+      responses:
+        "200":
+          description: Reader registrations successfully received
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RegistrationsResponse"
+
+components:
+  schemas:
+    TokenRegisterRequest:
+      description: Request containing token information read using the card reader
+      type: object
+      properties:
+        readerId:
+          $ref: "#/components/schemas/ReaderId"
+        xBot:
+          type: string
+          format: uuid
+          description: The unique identifier of the token.
+      required:
+        - readerId
+        - xBot
+
+    ReaderRegisterRequest:
+      description: Request containing card reader information for one or more readers to be be registered
+      type: object
+      properties:
+        readerIdQuantity:
+          type: integer
+          default: 1
+          minimum: 1
+        cardReaderInterfaceId:
+          $ref: "#/components/schemas/cardReaderInterfaceId"
+        locationName:
+          $ref: "#/components/schemas/LocationName"
+      required:
+        - cardReaderInterfaceId
+        - locationName
+        - readerIdQuantity
+    ReaderRegisterResponse:
+      description: Response containing one or more readerIds for the registered reader(s)
+      type: object
+      properties:
+        readerIds:
+          type: array
+          items:
+            $ref: "#/components/schemas/ReaderId"
+      required:
+        - readerIds
+
+    ReaderUnregisterRequest:
+      description: Request containing the readerId to unregister
+      type: object
+      properties:
+        cardReaderInterfaceId:
+          $ref: "#/components/schemas/cardReaderInterfaceId"
+        locationName:
+          $ref: "#/components/schemas/LocationName"
+        readerId:
+          $ref: "#/components/schemas/ReaderId"
+      required:
+        - readerId
+
+    RegistrationsRequest:
+      description: Request containing a list of readerId of which the Card Reader Interface believes are registered.
+      type: object
+      properties:
+        cardReaderInterfaceId:
+          $ref: "#/components/schemas/cardReaderInterfaceId"
+        locationName:
+          $ref: "#/components/schemas/LocationName"
+        readerIds:
+          type: array
+          items:
+            $ref: "#/components/schemas/ReaderId"
+      required:
+        - cardReaderInterfaceId
+        - locationName
+        - readerIds
+    RegistrationsResponse:
+      description: Response with actionable information for the Card Reader Interface.
+      type: object
+      properties:
+        nextCallTimeout:
+
+          type: integer
+          description: |
+            Timeout duration in seconds BEFORE which the next `/card-reader/registrations` call should happen. 
+            Failure to send a call before this timeout will result in automatic unregistration of all readers associated to this Card Read Interface.
+
+            The external systems must maintain a grace period on reception of the next call.
+            The Card Read Interface must start sending the next call on or before the timeout (grace period not needed).
+        readerIds:
+          type: array
+          items:
+            $ref: "#/components/schemas/ReaderId"
+          description: |
+            A list of readerIds that are registered to the external system. This mean all readerIds that readers with 
+            readerIds missing from this list must be reregistered using `/card-reader/register`.
+      required:
+        - nextCallTimeout
+        - readerIds
+
+    cardReaderInterfaceId:
+      type: string
+      description: Each Card Reader Interface has a unique cardReaderInterfaceId. Identifier for the Card Reader Interface to which one or more readers are connected.
+    LocationName:
+      type: string
+      description: Name of the location of the reader. A location can have one ore more Card Reader Interfaces (cardReaderInterfaceIds)
+    ReaderId:
+      type: string
+      description: Unique identifier generated by the external system. Should be displayed on the screen of the reader.

src/openapi/orders/SE-orders-gboAgeProfile.yaml

@@ -0,0 +1,180 @@
+openapi: 3.0.1
+info:
+  title: ABT Service Engine Order APIs
+  version: "1.0"
+  description: Order APIs available in the Service Engine for order validation and fulfillment.
+servers: 
+  - url: https://services.acc.api.htm.nl/abt/touchpoint/2.0
+paths:
+  /orders/validation/gboAgeProfile:
+    get:
+      tags:
+        - ServiceEngine Order validation
+      summary: Get GBO age profile that is valid for the given input
+      description: |-
+        Only one age profile can be valid at any one time, so only one profile is returned.
+      parameters:
+        - name: productStartDate
+          in: query
+          required: true
+          description: Start date of product validity
+          schema:
+            type: string
+            format: date
+            example: 2025-03-20
+        - name: birthDate
+          in: query
+          required: false
+          description: Birthdate of the OVpay-token holder
+          schema:
+            type: string
+            format: date
+            example: 2000-01-01
+        - name: ovPayTokenId
+          in: query
+          required: false
+          description: ovPayTokenId of the customer's selected token
+          schema:
+            type: integer
+            example: 1
+        - name: customerTokenId
+          in: query
+          required: false
+          description: customerTokenId of the customer's selected token
+          schema:
+            type: string
+            format: uuid
+            example: "4a2d2c9c-1e5d-4d8a-9c0a-6c0a6c0a6c0a"
+        - name: serviceReferenceId
+          in: query
+          required: false
+          description: serviceReferenceId of the customer's selected token
+          schema:
+            type: string
+            example: "NLOV1234567ABCDEFG"
+        - name: amount
+          in: query
+          required: false
+          description: amount belonging to the serviceReferenceId
+          schema:
+            type: integer
+            example: 100
+        - name: ovpasNumber
+          in: query
+          required: false
+          description: OVpas number of the customer's selected token
+          schema:
+            type: string
+            example: "63AW974"
+        - name: verificationCode
+          in: query
+          required: false
+          description: verification code belonging to the OVpas number
+          schema:
+            type: string
+            example: 1A3C7D        
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GboAgeProfileResponse"
+
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/rfc9457Response"
+              examples:
+                Missing parameter(s):
+                  summary: Missing parameter(s)
+                  value:
+                    {
+                      "type": "https://www.htm.nl/api/v1/400Error",
+                      "title": "Missing parameter(s)",
+                      "detail": "At least one of the following parameters must be present: birthDate, ovPayTokenId, customerTokenId, (serviceReferenceId and amount), (ovpasNumber and verificationCode)",
+                      "instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c",
+                      "apiErrorCode": "htm.api.err.400.2",
+                    }
+                Invalid date format:
+                  summary: Invalid date format
+                  value:
+                    {
+                      "type": "https://www.htm.nl/api/v1/400Error",
+                      "title": "Invalid input",
+                      "detail": "The given birthDate is not a valid Date format",
+                      "instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c",
+                      "apiErrorCode": "htm.api.err.400.3",
+                    }
+        "404":
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/rfc9457Response"
+              examples:
+                No birthdate present in PAD of OVpay token:
+                  summary: No birthdate present in PAD of OVpay token
+                  value:
+                    {
+                      "type": "https://www.htm.nl/api/v1/404Error",
+                      "title": "Missing birthdate in PAD",
+                      "detail": "There is no birthdate present in the PAD of the OVpay token, or there is no PAD present at all",
+                      "instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c",
+                      "apiErrorCode": "htm.api.err.404.1",
+                    }
+components:
+  schemas:
+    GboAgeProfileResponse:
+      type: object
+      required:
+        - gboAgeProfileId
+        - name
+        - ageFromInclusive
+        - ageToInclusive
+      properties:
+        gboAgeProfileId:
+          type: integer
+          example: 1
+        name:
+          type: string
+          example: Kind (4 t/m 11 jaar)
+        ageFromInclusive:
+          type: integer
+          example: 4
+        ageToInclusive:
+          type: integer
+          example: 11
+    rfc9457Response:
+      type: object
+      properties:
+        type:
+          type: string
+          format: url
+          example: "https://www.htm.nl/api/v1/rfc9457Error"
+        title:
+          type: string
+          description: "Short summary of the error."
+          example: "The request is not valid."
+        detail:
+          type: string
+          description: "More detailed descriptionof the error."
+          example: "Some required parameters are missing."
+        instance:
+          type: string
+          description: "Unique identifier to correlate this specific error with logging in other applications."
+          example: "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c"
+        additionalProperty1:
+          type: string
+          description: "Example of an additional property value to be used for error reporting."
+          example: "additionalValue1"
+        additionalProperty2:
+          type: array
+          description: "Example of an additional property array to be used for error reporting."
+          items:
+            type: string
+            example:
+              - "additionalValue2-1"
+              - "additionalValue2-2"

src/openapi/pad/padp-poc-openapi.yaml

@@ -0,0 +1,760 @@
+openapi: 3.0.1
+info:
+  title: PadpReferenceApi
+  version: '1.0'
+paths:
+  /poc/encrypt-decrypt-poc:
+    get:
+      tags:
+        - Encrypt/decrypt POC
+      summary: Encrypt/Decrypt POC
+      operationId: EncryptDecryptPoc
+      parameters:
+        - name: textToEncrypt
+          in: header
+          required: true
+          schema:
+            type: string
+        - name: encryptedEphemeralKey
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                type: string
+  /poc/encrypt-poc:
+    get:
+      tags:
+        - Encrypt/decrypt POC
+      summary: Encrypt POC
+      operationId: EncryptPoc
+      parameters:
+        - name: textToEncrypt
+          in: header
+          required: true
+          schema:
+            type: string
+        - name: encryptedEphemeralKey
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                type: string
+  /poc/decrypt-poc:
+    get:
+      tags:
+        - Encrypt/decrypt POC
+      summary: Decrypt POC
+      operationId: DecryptPoc
+      parameters:
+        - name: textToDecrypt
+          in: header
+          required: true
+          schema:
+            type: string
+        - name: encryptedEphemeralKey
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                type: string
+  /idp/b2b-access-token:
+    get:
+      tags:
+        - PADP Reference API
+      summary: API 1020 - Get B2B Access Token
+      description: Returns a client access token, needed for most other PADP APIs.
+      operationId: GetB2bAccessToken
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/B2bAccessToken'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /get-image-from-base64:
+    get:
+      tags:
+        - PADP Reference API
+      summary: Get rendered image from Base64 encoded String
+      operationId: GetImageFromBase64
+      parameters:
+        - name: base64String
+          in: header
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            image/jpeg:
+              schema:
+                $ref: '#/components/schemas/FileContentHttpResult'
+  /personal-data/{xtat}:
+    post:
+      tags:
+        - PADP Reference API
+      summary: API 1201 - Create Personal Data - First create an ephemeral key using API 1210!
+      description: First create an ephemeral key using API 1210!
+      operationId: CreatePersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: email
+          in: query
+          description: Email address to be used for OTP challenges
+          required: true
+          schema:
+            type: string
+        - name: name
+          in: query
+          description: Should be at least two words (first name and last name)
+          schema:
+            type: string
+        - name: birthDate
+          in: query
+          description: Should be a date between 1900-01-01 and now, in the format YYYY-MM-DD
+          schema:
+            type: string
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                photo:
+                  type: string
+                  description: Should be a JPG image, of max. 512KB and resolution between 520x520 and 720x720
+                  format: binary
+            encoding:
+              photo:
+                style: form
+      responses:
+        '201':
+          description: Created
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+    get:
+      tags:
+        - PADP Reference API
+      summary: API 1202 - Get Personal Data- First perform an OTP challenge using API 1206 and 1207!
+      description: First perform an OTP challenge using API 1206 and 1207!
+      operationId: GetPersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PersonalData'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+    delete:
+      tags:
+        - PADP Reference API
+      summary: API 1204 - Delete Personal Data - First perform an OTP challenge using API 1206 and 1207!
+      description: First perform an OTP challenge using API 1206 and 1207!
+      operationId: DeletePersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DeletePersonalDataResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+    put:
+      tags:
+        - PADP Reference API
+      summary: API 1205 - Update Personal Data - First perform an OTP challenge using API 1206 and 1207!
+      description: First perform an OTP challenge using API 1206 and 1207!Performs a complete replacement; empty request parameters will result in the corresponding PADP attribute being deleted.
+      operationId: UpdatePersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: skipUpdateCounter
+          in: query
+          required: true
+          schema:
+            type: boolean
+        - name: name
+          in: query
+          description: Should be at least two words (first name and last name)
+          schema:
+            type: string
+        - name: birthDate
+          in: query
+          description: Should be a date between 1900-01-01 and now, in the format YYYY-MM-DD
+          schema:
+            type: string
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                photo:
+                  type: string
+                  description: Should be a JPG image, of max. 512KB and resolution between 520x520 and 720x720
+                  format: binary
+            encoding:
+              photo:
+                style: form
+      responses:
+        '200':
+          description: OK
+  /personal-data/{xtat}/decrypted:
+    get:
+      tags:
+        - PADP Reference API
+      summary: API 1202 - Get Personal Data AND decrypt response - First perform an OTP challenge using API 1206 and 1207!
+      description: First perform an OTP challenge using API 1206 and 1207!
+      operationId: GetDecryptedPersonalData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DecryptedPersonalData'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /personal-data/{xtat}/generate-otp:
+    get:
+      tags:
+        - PADP Reference API
+      summary: API 1206 - Generate OTP
+      operationId: GenerateOtp
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OtpResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /personal-data/{xtat}/validate-otp:
+    get:
+      tags:
+        - PADP Reference API
+      summary: API 1207 - Validate OTP
+      operationId: ValidateOtp
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: otp
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserAccessToken'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /personal-data/{xtat}/encrypted-update-init:
+    get:
+      tags:
+        - PADP Reference API
+      summary: API 1210 - Create Ephemeral Key
+      operationId: CreateEphemeralKey
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EphemeralKey'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  /personal-data/{xtat}/administrative-data:
+    get:
+      tags:
+        - PADP Reference API
+      summary: API 1211 - Get Administrative Data
+      operationId: GetAdministrativeData
+      parameters:
+        - name: xtat
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AdministrativeData'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+components:
+  schemas:
+    AdministrativeData:
+      type: object
+      properties:
+        name:
+          $ref: '#/components/schemas/AdministrativeDataElement'
+        photo:
+          $ref: '#/components/schemas/AdministrativeDataElement'
+        birthdate:
+          $ref: '#/components/schemas/AdministrativeDataElement'
+      additionalProperties: false
+    AdministrativeDataElement:
+      type: object
+      properties:
+        inaccuracyFlag:
+          type: boolean
+        inaccuracyFlagReason:
+          type: string
+          nullable: true
+        inaccuracyFlagCounter:
+          type: integer
+          format: int32
+        changeCounter:
+          type: integer
+          format: int32
+        maxUpdatesVerificationCount:
+          type: integer
+          format: int32
+        lastChangeDate:
+          type: string
+          format: date-time
+        isValidated:
+          type: boolean
+      additionalProperties: false
+    B2bAccessToken:
+      type: object
+      properties:
+        access_token:
+          type: string
+          nullable: true
+        expires_in:
+          type: integer
+          format: int32
+        refresh_expires_in:
+          type: integer
+          format: int32
+        refresh_token:
+          type: string
+          nullable: true
+        token_type:
+          type: string
+          nullable: true
+        not-before-policy:
+          type: integer
+          format: int32
+        scope:
+          type: string
+          nullable: true
+        BE_ID:
+          type: string
+          nullable: true
+      additionalProperties: false
+    ByteReadOnlyMemory:
+      type: object
+      properties:
+        length:
+          type: integer
+          format: int32
+          readOnly: true
+        isEmpty:
+          type: boolean
+          readOnly: true
+        span:
+          $ref: '#/components/schemas/ByteReadOnlySpan'
+      additionalProperties: false
+    ByteReadOnlySpan:
+      type: object
+      properties:
+        length:
+          type: integer
+          format: int32
+          readOnly: true
+        isEmpty:
+          type: boolean
+          readOnly: true
+      additionalProperties: false
+    Data:
+      type: object
+      properties:
+        name:
+          type: string
+          nullable: true
+        birthdate:
+          type: string
+          nullable: true
+        photo:
+          type: string
+          nullable: true
+      additionalProperties: false
+    DecryptedData:
+      type: object
+      properties:
+        decryptedName:
+          type: string
+          nullable: true
+        decryptedBirthdate:
+          type: string
+          nullable: true
+        decryptedPhoto:
+          type: string
+          description: Base64 encoded photo
+          format: byte
+          nullable: true
+      additionalProperties: false
+    DecryptedPersonalData:
+      type: object
+      properties:
+        decryptedData:
+          $ref: '#/components/schemas/DecryptedData'
+        encryptedData:
+          $ref: '#/components/schemas/PersonalData'
+      additionalProperties: false
+    DeletePersonalDataResponse:
+      type: object
+      properties:
+        deletedAttributes:
+          type: array
+          items:
+            type: string
+          nullable: true
+      additionalProperties: false
+    EntityTagHeaderValue:
+      type: object
+      properties:
+        tag:
+          $ref: '#/components/schemas/StringSegment'
+        isWeak:
+          type: boolean
+          readOnly: true
+      additionalProperties: false
+    EphemeralKey:
+      type: object
+      properties:
+        ephemeralKeyAlias:
+          type: string
+          nullable: true
+        encryptedEphemeralKey:
+          type: string
+          nullable: true
+      additionalProperties: false
+    Error:
+      type: object
+      properties:
+        code:
+          type: string
+          nullable: true
+        data:
+          type: array
+          items:
+            type: string
+          nullable: true
+        message:
+          type: string
+          nullable: true
+      additionalProperties: false
+    ErrorResponse:
+      type: object
+      properties:
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/Error'
+          nullable: true
+        exceptionClassName:
+          type: string
+          nullable: true
+        exceptionStackTrace:
+          type: string
+          nullable: true
+      additionalProperties: false
+    FileContentHttpResult:
+      type: object
+      properties:
+        contentType:
+          type: string
+          nullable: true
+          readOnly: true
+        fileDownloadName:
+          type: string
+          nullable: true
+          readOnly: true
+        lastModified:
+          type: string
+          format: date-time
+          nullable: true
+          readOnly: true
+        entityTag:
+          $ref: '#/components/schemas/EntityTagHeaderValue'
+        enableRangeProcessing:
+          type: boolean
+          readOnly: true
+        fileLength:
+          type: integer
+          format: int64
+          nullable: true
+          readOnly: true
+        fileContents:
+          $ref: '#/components/schemas/ByteReadOnlyMemory'
+      additionalProperties: false
+    Metadata:
+      type: object
+      properties:
+        encryptedEphemeralKey:
+          type: string
+          nullable: true
+      additionalProperties: false
+    OtpResponse:
+      type: object
+      properties:
+        maskedEmailAddress:
+          type: string
+          nullable: true
+      additionalProperties: false
+    PersonalData:
+      type: object
+      properties:
+        metadata:
+          $ref: '#/components/schemas/Metadata'
+        data:
+          $ref: '#/components/schemas/Data'
+      additionalProperties: false
+    StringSegment:
+      type: object
+      properties:
+        buffer:
+          type: string
+          nullable: true
+        offset:
+          type: integer
+          format: int32
+          readOnly: true
+        length:
+          type: integer
+          format: int32
+          readOnly: true
+        value:
+          type: string
+          nullable: true
+          readOnly: true
+        hasValue:
+          type: boolean
+          readOnly: true
+      additionalProperties: false
+    UserAccessToken:
+      type: object
+      properties:
+        accessToken:
+          type: string
+          nullable: true
+      additionalProperties: false

src/openapi/products/purchased_products-crud.yaml

@@ -4,7 +4,7 @@ info:
   version: "1.0"
   description: CRUD APIs for ABT Purchased Products database. These are NOT the functional APIs from Service Engine.
 servers:
-  - url: https://api.integratielaag.nl/v1
+  - url: https://services.acc.api.htm.nl/abt/abtproducts/1.0
 paths:
   /purchasedproducts:
     get:
@@ -53,14 +53,21 @@ paths:
           required: false
           description: The purchased product should be last updated after this timestamp.
         - in: query
-          name: resrouceName
+          name: resourceNameId
+          schema:
+            type: integer
+            example: 2
+          required: false
+          description: The id of the resource.
+        - in: query
+          name: resourceName
           schema:
             type: string
             example: orders
           required: false
           description: The name of the resource.
         - in: query
-          name: resrouceIdentifier
+          name: resourceIdentifier
           schema:
             type: string
             example: f461004f-d98e-4323-aa26-f09bf8ea2f2d
@@ -74,49 +81,53 @@ paths:
               schema:
                 $ref: "#/components/schemas/unavailable"
               example:
-                [
-                  {
-                    "purchasedProductId": "45573af8-a9aa-4f7c-95f4-b1971bf2c3c6",
-                    "productId": 12,
-                    "createdOn": "2024-10-04T12:34:56.000",
-                    "lastUpdatedOn": "2024-10-04T12:34:56.000",
-                    "purchasedProductResources":
-                      [
-                        {
-                          "purchasedProductResourceId": "c7900130-0637-41d7-83fe-6fe283a0a1f1",
-                          "resourceName":
-                            { "resourceNameId": 1, "name": "contracts" },
-                          "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
-                        },
-                        {
-                          "purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114",
-                          "resourceName":
-                            { "resourceNameId": 2, "name": "orders" },
-                          "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
-                        },
-                      ],
-                    "purchasedGboProducts":
-                      [
-                        {
-                          "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
-                          "salesTimestamp": "2024-10-04T12:34:56.000",
-                          "refundTimestamp": "2024-10-04T12:34:56.000",
-                          "fromInclusive": "2024-10-04T12:34:56.000",
-                          "unitilInclusive": "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,
-                        },
-                      ],
-                  },
-                ]
+                {
+                  "purchasedProducts":
+                    [
+                      {
+                        "purchasedProductId": "45573af8-a9aa-4f7c-95f4-b1971bf2c3c6",
+                        "productId": 12,
+                        "createdOn": "2024-10-04T12:34:56.000",
+                        "lastUpdatedOn": "2024-10-04T12:34:56.000",
+                        "purchasedProductResources":
+                          [
+                            {
+                              "purchasedProductResourceId": "c7900130-0637-41d7-83fe-6fe283a0a1f1",
+                              "resourceName":
+                                { "resourceNameId": 1, "name": "contracts" },
+                              "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
+                            },
+                            {
+                              "purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114",
+                              "resourceName":
+                                { "resourceNameId": 2, "name": "orders" },
+                              "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
+                            },
+                          ],
+                        "purchasedGboProducts":
+                          [
+                            {
+                              "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
+                              "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,
+                            },
+                          ],
+                      },
+                    ],
+                  "href": null,
+                }
     post:
       tags:
         - Purchased Product
@@ -136,12 +147,11 @@ paths:
                 "purchasedProductResources":
                   [
                     {
-                      "resourceName":
-                        { "resourceNameId": 1, "name": "contracts" },
+                      "resourceNameId": 1,
                       "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
                     },
                     {
-                      "resourceName": { "resourceNameId": 2, "name": "orders" },
+                      "resourceNameId": 2,
                       "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
                     },
                   ],
@@ -151,7 +161,7 @@ paths:
                       "salesTimestamp": "2024-10-04T12:34:56.000",
                       "refundTimestamp": "2024-10-04T12:34:56.000",
                       "fromInclusive": "2024-10-04T12:34:56.000",
-                      "unitilInclusive": "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",
@@ -221,7 +231,7 @@ paths:
                         "salesTimestamp": "2024-10-04T12:34:56.000",
                         "refundTimestamp": "2024-10-04T12:34:56.000",
                         "fromInclusive": "2024-10-04T12:34:56.000",
-                        "unitilInclusive": "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",
@@ -279,7 +289,7 @@ paths:
               $ref: "#/components/schemas/unavailable"
             example:
               {
-                "resourceName": 1,
+                "resourceNameId": 1,
                 "resourceIdentifier": "502d2e0d-4e3b-4a7e-9f6e-0d0b1e1e1e1e",
               }
       responses:
@@ -319,7 +329,7 @@ paths:
                 "salesTimestamp": "2024-10-04T12:34:56.000",
                 "refundTimestamp": "2024-10-04T12:34:56.000",
                 "fromInclusive": "2024-10-04T12:34:56.000",
-                "unitilInclusive": "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",
@@ -406,14 +416,14 @@ paths:
             example: 2024-10-04T12:34:56.000
           description: The purchased GBO product should be valid after this timestamp.
         - in: query
-          name: unitilInclusiveBefore
+          name: untilInclusiveBefore
           schema:
             type: string
             format: date-time
             example: 2024-10-04T12:34:56.000
           description: The purchased GBO product should be valid before this timestamp.
         - in: query
-          name: unitilInclusiveAfter
+          name: untilInclusiveAfter
           schema:
             type: string
             format: date-time
@@ -508,44 +518,48 @@ paths:
               schema:
                 $ref: "#/components/schemas/unavailable"
               example:
-                [
-                  {
-                    "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
-                    "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
-                    "salesTimestamp": "2024-10-04T12:34:56.000",
-                    "refundTimestamp": "2024-10-05T12:34:56.000",
-                    "fromInclusive": "2024-10-04T12:34:56.000",
-                    "unitilInclusive": "2024-10-05T12: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,
-                  },
-                  {
-                    "purchasedGboProductId": 431e481f-4330-4ad4-be47-393db38cfe38,
-                    "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
-                    "salesTimestamp": "2024-10-05T12:34:56.000",
-                    "refundTimestamp": "2024-10-06T12:34:56.000",
-                    "fromInclusive": "2024-10-05T12:34:56.000",
-                    "unitilInclusive": "2024-10-06T12:34:56.000",
-                    "packageTemplateId": "30003",
-                    "xBot": "f8f13d64-fd07-44e8-9c85-968857da5d68",
-                    "xTat": "01a82ebe-5d07-45d8-a897-66152e8954dd",
-                    "xSpit": "c3868858-b250-4480-9cb4-725d2e9198f3",
-                    "customerTokenId": "6c7a6d4b-7e6c-4f6a-9b1e-0a9b1e6c7a6d",
-                    "ovPayTokenId": 14,
-                    "createdOn": "2024-10-05T12:34:56.000",
-                    "lastUpdatedOn": "2024-10-05T12:34:56.000",
-                    "createdBy": "someuser",
-                    "lastUpdatedBy": null,
-                  },
-                ]
+                {
+                  "purchasedGboProducts":
+                    [
+                      {
+                        "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
+                        "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
+                        "salesTimestamp": "2024-10-04T12:34:56.000",
+                        "refundTimestamp": "2024-10-05T12:34:56.000",
+                        "fromInclusive": "2024-10-04T12:34:56.000",
+                        "untilInclusive": "2024-10-05T12: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,
+                      },
+                      {
+                        "purchasedGboProductId": 431e481f-4330-4ad4-be47-393db38cfe38,
+                        "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
+                        "salesTimestamp": "2024-10-05T12:34:56.000",
+                        "refundTimestamp": "2024-10-06T12:34:56.000",
+                        "fromInclusive": "2024-10-05T12:34:56.000",
+                        "untilInclusive": "2024-10-06T12:34:56.000",
+                        "packageTemplateId": "30003",
+                        "xBot": "f8f13d64-fd07-44e8-9c85-968857da5d68",
+                        "xTat": "01a82ebe-5d07-45d8-a897-66152e8954dd",
+                        "xSpit": "c3868858-b250-4480-9cb4-725d2e9198f3",
+                        "customerTokenId": "6c7a6d4b-7e6c-4f6a-9b1e-0a9b1e6c7a6d",
+                        "ovPayTokenId": 14,
+                        "createdOn": "2024-10-05T12:34:56.000",
+                        "lastUpdatedOn": "2024-10-05T12:34:56.000",
+                        "createdBy": "someuser",
+                        "lastUpdatedBy": null,
+                      },
+                    ],
+                  "href": null,
+                }
   /purchasedgboproducts/{purchasedGboProductId}:
     parameters:
       - in: path

src/openapi/sendgrid/sendgrid-oas_v3.yaml

@@ -0,0 +1,593 @@
+openapi: "3.0.3"
+info:
+  title: Twilio SendGrid v3 API
+  description: >-
+    The Twilio SendGrid v3 API provides a simple, intuitive RESTful-like
+    interface for sending email at scale, monitoring email engagement data
+    programmatically, managing account settings, and more. This OpenAPI
+    representation of the Twilio SendGrid v3 API allows you to generate helper
+    libraries (in addition to the libraries officially released by Twilio
+    SendGrid) and build mock servers for testing.
+  termsOfService: https://www.twilio.com/legal/tos
+  contact:
+    name: Twilio SendGrid Support
+    url: https://support.sendgrid.com/hc/en-us
+  license:
+    name: MIT
+    url: https://github.com/sendgrid/sendgrid-oai/blob/main/LICENSE
+  version: 1.8.1
+servers:
+  - url: https://https://services.acc.api.htm.nl/sendgrid
+    description: The Integration Layer SendGrid API integration (Acceptance).
+paths:
+  /v3/mail/send:
+    post:
+      operationId: POST_mail-send
+      summary: v3 Mail Send
+      tags:
+        - Mail Send
+      description: |-
+        The Mail Send endpoint allows you to send email over SendGrid's v3 Web API, the most recent version of our API. If you are looking for documentation about the v2 Mail Send endpoint, see our [v2 API Reference](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
+  
+        ## Helper Libraries
+  
+        Twilio SendGrid provides libraries to help you quickly and easily integrate with the v3 Web API in 7 different languages:
+  
+        * [C#](https://github.com/sendgrid/sendgrid-csharp) 
+        * [Go](https://github.com/sendgrid/sendgrid-go)
+        * [Java](https://github.com/sendgrid/sendgrid-java)
+        * [Node JS](https://github.com/sendgrid/sendgrid-nodejs)
+        * [PHP](https://github.com/sendgrid/sendgrid-php)
+        * [Python](https://github.com/sendgrid/sendgrid-python)
+        * [Ruby](https://github.com/sendgrid/sendgrid-ruby)
+  
+        ## Dynamic Transactional Templates and Handlebars
+  
+        In order to send a dynamic template, specify the template ID with the `template_id` parameter. 
+  
+        To specify handlebar substitutions, define your substitutions in the request JSON with this syntax:
+  
+        ```
+        "dynamic_template_data": {
+           "guest": "Jane Doe",
+           "partysize": "4",
+           "english": true,
+           "date": "April 1st, 2021"
+        }
+        ```
+  
+        For more information about Dynamic Transactional Templates and Handlebars, see our documentation and reference pages.
+  
+        * [How to send an email with Dynamic Transactional Templates
+        ](https://sendgrid.com/docs/ui/sending-email/how-to-send-an-email-with-dynamic-transactional-templates/)
+        * [Using Handlebars](https://sendgrid.com/docs/for-developers/sending-email/using-handlebars/) 
+  
+        ## Mail Body Compression
+  
+        Mail body compression is available to some high volume accounts. Talk to your CSM if you are interested in this functionality. Mail body compression works by setting up a JSON payload as defined on this page, then compressing it with gzip (the gzip file can be no more than 30mb).
+  
+        To use mail body compression:
+  
+        1. Add a `Content-Encoding` header, with a value of `gzip`.  
+           a. `Content-Encoding: gzip` 
+        2. Send the gzip as a data-binary.  
+           a. `--data-binary '@data.json.gz'
+        `
+  
+        ## Multiple Reply-To Emails
+  
+        Using `reply_to_list` allows senders to include more than one recipient email address to receive reply and/or bounce messages from the recipient of the email.
+  
+        ### Usage Considerations
+  
+        * `reply_to` is mutually exclusive with `reply_to_list`. If both are used, then the API call will be rejected. 
+        * The `reply_to_list` object, when used, must at least have an email parameter and may also contain a name parameter.
+        * Each email address in the `reply_to_list` should be unique.
+        * There is a limit of 1000 `reply_to_list` emails per mail/send request.
+        * In SMTP calls, we will omit any invalid emails.
+  
+        ### Possible 400 Error Messages
+  
+        * `reply_to` is mutually exclusive with `reply_to_list`.
+        * The `reply_to_list` object, when used, must at least have an email parameter and may also contain a name parameter.
+        * Each email address in the `reply_to_list` should be unique.
+        * There is a limit of X `reply_to` emails per mail/send request.
+        * The `reply_to_list` email does not contain a valid address.
+        * The `reply_to_list` email exceeds the maximum total length of X characters.
+        * The `reply_to_list` email parameter is required.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                personalizations:
+                  type: array
+                  description: An array of messages and their metadata. Each object within personalizations can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled. See our [Personalizations documentation](https://sendgrid.com/docs/for-developers/sending-email/personalizations/) for examples.
+                  uniqueItems: false
+                  maxItems: 1000
+                  items:
+                    type: object
+                    properties:
+                      from:
+                        $ref: "#/components/schemas/from_email_object"
+                      to:
+                        $ref: "#/components/schemas/to_email_array"
+                      cc:
+                        type: array
+                        description: An array of recipients who will receive a copy of your email. Each object in this array must contain the recipient's email address. Each object in the array may optionally contain the recipient's name.
+                        maxItems: 1000
+                        items:
+                          $ref: "#/components/schemas/cc_bcc_email_object"
+                      bcc:
+                        type: array
+                        description: An array of recipients who will receive a blind carbon copy of your email. Each object in this array must contain the recipient's email address. Each object in the array may optionally contain the recipient's name.
+                        maxItems: 1000
+                        items:
+                          $ref: "#/components/schemas/cc_bcc_email_object"
+                      subject:
+                        type: string
+                        description: The subject of your email. See character length requirements according to [RFC 2822](http://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit#answer-1592310).
+                        minLength: 1
+                      headers:
+                        type: object
+                        description: 'A collection of JSON key/value pairs allowing you to specify handling instructions for your email. You may not overwrite the following headers: `x-sg-id`, `x-sg-eid`, `received`, `dkim-signature`, `Content-Type`, `Content-Transfer-Encoding`, `To`, `From`, `Subject`, `Reply-To`, `CC`, `BCC`'
+                      substitutions:
+                        type: object
+                        description: Substitutions allow you to insert data without using Dynamic Transactional Templates. This field should **not** be used in combination with a Dynamic Transactional Template, which can be identified by a `template_id` starting with `d-`. This field is a collection of key/value pairs following the pattern "substitution_tag":"value to substitute". The key/value pairs must be strings. These substitutions will apply to the text and html content of the body of your email, in addition to the `subject` and `reply-to` parameters. The total collective size of your substitutions may not exceed 10,000 bytes per personalization object.
+                        maxProperties: 10000
+                      dynamic_template_data:
+                        type: object
+                        description: Dynamic template data is available using Handlebars syntax in Dynamic Transactional Templates. This field should be used in combination with a Dynamic Transactional Template, which can be identified by a `template_id` starting with `d-`. This field is a collection of key/value pairs following the pattern "variable_name":"value to insert".
+                      custom_args:
+                        type: object
+                        description: Values that are specific to this personalization that will be carried along with the email and its activity data. Substitutions will not be made on custom arguments, so any string that is entered into this parameter will be assumed to be the custom argument that you would like to be used. This field may not exceed 10,000 bytes.
+                        maxProperties: 10000
+                      send_at:
+                        type: integer
+                        description: A unix timestamp allowing you to specify when your email should be delivered. Scheduling delivery more than 72 hours in advance is forbidden.
+                    required:
+                      - to
+                from:
+                  $ref: "#/components/schemas/from_email_object"
+                reply_to:
+                  $ref: "#/components/schemas/reply_to_email_object"
+                reply_to_list:
+                  type: array
+                  description: An array of recipients who will receive replies and/or bounces. Each object in this array must contain the recipient's email address. Each object in the array may optionally contain the recipient's name. You can either choose to use “reply_to” field or “reply_to_list” but not both.
+                  uniqueItems: true
+                  maxItems: 1000
+                  items:
+                    type: object
+                    properties:
+                      email:
+                        type: string
+                        description: The email address where any replies or bounces will be returned.
+                        format: email
+                      name:
+                        type: string
+                        description: A name or title associated with the `reply_to_list` email address.
+                    required:
+                      - email
+                subject:
+                  type: string
+                  description: The global or 'message level' subject of your email. This may be overridden by subject lines set in personalizations.
+                  minLength: 1
+                content:
+                  type: array
+                  description: An array where you can specify the content of your email. You can include multiple [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of content, but you must specify at least one MIME type. To include more than one MIME type, add another object to the array containing the `type` and `value` parameters.
+                  items:
+                    type: object
+                    properties:
+                      type:
+                        type: string
+                        description: The MIME type of the content you are including in your email (e.g., `“text/plain”` or `“text/html”`).
+                        minLength: 1
+                      value:
+                        type: string
+                        description: The actual content of the specified MIME type that you are including in your email.
+                        minLength: 1
+                    required:
+                      - type
+                      - value
+                attachments:
+                  type: array
+                  description: An array of objects where you can specify any attachments you want to include.
+                  items:
+                    type: object
+                    properties:
+                      content:
+                        type: string
+                        description: The Base64 encoded content of the attachment.
+                        minLength: 1
+                      type:
+                        type: string
+                        description: The MIME type of the content you are attaching (e.g., `“text/plain”` or `“text/html”`).
+                        minLength: 1
+                      filename:
+                        type: string
+                        description: The attachment's filename.
+                      disposition:
+                        type: string
+                        default: attachment
+                        description: The attachment's content-disposition, specifying how you would like the attachment to be displayed. For example, `“inline”` results in the attached file are displayed automatically within the message while `“attachment”` results in the attached file require some action to be taken before it is displayed, such as opening or downloading the file.
+                        enum:
+                          - inline
+                          - attachment
+                      content_id:
+                        type: string
+                        description: The attachment's content ID. This is used when the disposition is set to `“inline”` and the attachment is an image, allowing the file to be displayed within the body of your email.
+                    required:
+                      - content
+                      - filename
+                template_id:
+                  type: string
+                  description: An email template ID. A template that contains a subject and content — either text or html — will override any subject and content values specified at the personalizations or message level.
+                headers:
+                  description: An object containing key/value pairs of header names and the value to substitute for them. The key/value pairs must be strings. You must ensure these are properly encoded if they contain unicode characters. These headers cannot be one of the reserved headers.
+                  type: object
+                categories:
+                  type: array
+                  description: 'An array of category names for this message. Each category name may not exceed 255 characters. '
+                  uniqueItems: true
+                  maxItems: 10
+                  items:
+                    type: string
+                    maxLength: 255
+                custom_args:
+                  description: Values that are specific to the entire send that will be carried along with the email and its activity data.  Key/value pairs must be strings. Substitutions will not be made on custom arguments, so any string that is entered into this parameter will be assumed to be the custom argument that you would like to be used. This parameter is overridden by `custom_args` set at the personalizations level. Total `custom_args` size may not exceed 10,000 bytes.
+                  type: string
+                send_at:
+                  type: integer
+                  description: A unix timestamp allowing you to specify when you want your email to be delivered. This may be overridden by the `send_at` parameter set at the personalizations level. Delivery cannot be scheduled more than 72 hours in advance. If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid peak times — for example, scheduling at 10:53 — can result in lower deferral rates due to the reduced traffic during off-peak times.
+                batch_id:
+                  type: string
+                  description: An ID representing a batch of emails to be sent at the same time. Including a `batch_id` in your request allows you include this email in that batch. It also enables you to cancel or pause the delivery of that batch. For more information, see the [Cancel Scheduled Sends API](https://sendgrid.com/docs/api-reference/).
+                asm:
+                  type: object
+                  description: An object allowing you to specify how to handle unsubscribes.
+                  properties:
+                    group_id:
+                      type: integer
+                      description: The unsubscribe group to associate with this email.
+                    groups_to_display:
+                      type: array
+                      description: An array containing the unsubscribe groups that you would like to be displayed on the unsubscribe preferences page.
+                      maxItems: 25
+                      items:
+                        type: integer
+                  required:
+                    - group_id
+                ip_pool_name:
+                  type: string
+                  description: The IP Pool that you would like to send this email from.
+                  minLength: 2
+                  maxLength: 64
+                mail_settings:
+                  type: object
+                  description: A collection of different mail settings that you can use to specify how you would like this email to be handled.
+                  properties:
+                    bypass_list_management:
+                      type: object
+                      description: Allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email. This filter cannot be combined with any other bypass filters. See our [documentation](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) for more about bypass filters.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                    bypass_spam_management:
+                      type: object
+                      description: Allows you to bypass the spam report list to ensure that the email is delivered to recipients. Bounce and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the `bypass_list_management` filter. See our [documentation](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) for more about bypass filters.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                    bypass_bounce_management:
+                      type: object
+                      description: Allows you to bypass the bounce list to ensure that the email is delivered to recipients. Spam report and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the `bypass_list_management` filter. See our [documentation](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) for more about bypass filters.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                    bypass_unsubscribe_management:
+                      type: object
+                      description: Allows you to bypass the global unsubscribe list to ensure that the email is delivered to recipients. Bounce and spam report lists will still be checked; addresses on these other lists will not receive the message. This filter applies only to global unsubscribes and will not bypass group unsubscribes. This filter cannot be combined with the `bypass_list_management` filter. See our [documentation](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) for more about bypass filters.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                    footer:
+                      type: object
+                      description: The default footer that you would like included on every email.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                        text:
+                          type: string
+                          description: The plain text content of your footer.
+                        html:
+                          type: string
+                          description: The HTML content of your footer.
+                    sandbox_mode:
+                      type: object
+                      description: Sandbox Mode allows you to send a test email to ensure that your request body is valid and formatted correctly.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                tracking_settings:
+                  type: object
+                  description: Settings to determine how you would like to track the metrics of how your recipients interact with your email.
+                  properties:
+                    click_tracking:
+                      type: object
+                      description: Allows you to track if a recipient clicked a link in your email.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                        enable_text:
+                          type: boolean
+                          description: Indicates if this setting should be included in the `text/plain` portion of your email.
+                    open_tracking:
+                      type: object
+                      description: Allows you to track if the email was opened by including a single pixel image in the body of the content. When the pixel is loaded, Twilio SendGrid can log that the email was opened.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                        substitution_tag:
+                          type: string
+                          description: Allows you to specify a substitution tag that you can insert in the body of your email at a location that you desire. This tag will be replaced by the open tracking pixel.
+                    subscription_tracking:
+                      type: object
+                      description: Allows you to insert a subscription management link at the bottom of the text and HTML bodies of your email. If you would like to specify the location of the link within your email, you may use the `substitution_tag`.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                        text:
+                          type: string
+                          description: Text to be appended to the email with the subscription tracking link. You may control where the link is by using the tag <% %>
+                        html:
+                          type: string
+                          description: HTML to be appended to the email with the subscription tracking link. You may control where the link is by using the tag <% %>
+                        substitution_tag:
+                          type: string
+                          description: "A tag that will be replaced with the unsubscribe URL. for example: `[unsubscribe_url]`. If this parameter is used, it will override both the `text` and `html` parameters. The URL of the link will be placed at the substitution tag's location with no additional formatting."
+                    ganalytics:
+                      type: object
+                      description: Allows you to enable tracking provided by Google Analytics.
+                      properties:
+                        enable:
+                          type: boolean
+                          description: Indicates if this setting is enabled.
+                        utm_source:
+                          type: string
+                          description: Name of the referrer source. (e.g. Google, SomeDomain.com, or Marketing Email)
+                        utm_medium:
+                          type: string
+                          description: Name of the marketing medium. (e.g. Email)
+                        utm_term:
+                          type: string
+                          description: Used to identify any paid keywords.
+                        utm_content:
+                          type: string
+                          description: Used to differentiate your campaign from advertisements.
+                        utm_campaign:
+                          type: string
+                          description: The name of the campaign.
+              required:
+                - personalizations
+                - from
+                - subject
+                - content
+              example:
+                personalizations:
+                  - to:
+                      - email: john_doe@example.com
+                        name: John Doe
+                      - email: julia_doe@example.com
+                        name: Julia Doe
+                    cc:
+                      - email: jane_doe@example.com
+                        name: Jane Doe
+                    bcc:
+                      - email: james_doe@example.com
+                        name: Jim Doe
+                  - from:
+                      email: sales@example.com
+                      name: Example Sales Team
+                    to:
+                      - email: janice_doe@example.com
+                        name: Janice Doe
+                    bcc:
+                      - email: jordan_doe@example.com
+                        name: Jordan Doe
+                from:
+                  email: orders@example.com
+                  name: Example Order Confirmation
+                reply_to:
+                  email: customer_service@example.com
+                  name: Example Customer Service Team
+                subject: Your Example Order Confirmation
+                content:
+                  - type: text/html
+                    value: <p>Hello from Twilio SendGrid!</p><p>Sending with the email service trusted by developers and marketers for <strong>time-savings</strong>, <strong>scalability</strong>, and <strong>delivery expertise</strong>.</p><p>%open-track%</p>
+                attachments:
+                  - content: PCFET0NUWVBFIGh0bWw+CjxodG1sIGxhbmc9ImVuIj4KCiAgICA8aGVhZD4KICAgICAgICA8bWV0YSBjaGFyc2V0PSJVVEYtOCI+CiAgICAgICAgPG1ldGEgaHR0cC1lcXVpdj0iWC1VQS1Db21wYXRpYmxlIiBjb250ZW50PSJJRT1lZGdlIj4KICAgICAgICA8bWV0YSBuYW1lPSJ2aWV3cG9ydCIgY29udGVudD0id2lkdGg9ZGV2aWNlLXdpZHRoLCBpbml0aWFsLXNjYWxlPTEuMCI+CiAgICAgICAgPHRpdGxlPkRvY3VtZW50PC90aXRsZT4KICAgIDwvaGVhZD4KCiAgICA8Ym9keT4KCiAgICA8L2JvZHk+Cgo8L2h0bWw+Cg==
+                    filename: index.html
+                    type: text/html
+                    disposition: attachment
+                categories:
+                  - cake
+                  - pie
+                  - baking
+                send_at: 1617260400
+                batch_id: AsdFgHjklQweRTYuIopzXcVBNm0aSDfGHjklmZcVbNMqWert1znmOP2asDFjkl
+                asm:
+                  group_id: 12345
+                  groups_to_display:
+                    - 12345
+                ip_pool_name: transactional email
+                mail_settings:
+                  bypass_list_management:
+                    enable: false
+                  footer:
+                    enable: false
+                  sandbox_mode:
+                    enable: false
+                tracking_settings:
+                  click_tracking:
+                    enable: true
+                    enable_text: false
+                  open_tracking:
+                    enable: true
+                    substitution_tag: '%open-track%'
+                  subscription_tracking:
+                    enable: false
+      responses:
+        '202':
+          description: ''
+        '400':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/global_error_response_schema"
+        '401':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/global_error_response_schema"
+        '403':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/global_error_response_schema"
+        '404':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/global_error_response_schema"
+        '413':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/global_error_response_schema"
+        '500':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/global_error_response_schema"
+      security:
+        - Authorization: []
+components:
+  securitySchemes:
+    Authorization:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: >-
+        The API key used to authenticate with the SendGrid v3 API. You can find
+        your API key in the [Twilio SendGrid UI](https://app.sendgrid.com/settings/api_keys).
+        For more information, see our [API Key documentation](https://sendgrid.com/docs/ui/account-and-settings/api-keys/).
+  schemas:
+    from_email_object:
+      title: From Email Object
+      type: object
+      properties:
+        email:
+          type: string
+          format: email
+          description: The 'From' email address used to deliver the message. This address should be a verified sender in your Twilio SendGrid account.
+        name:
+          type: string
+          description: A name or title associated with the sending email address.
+      required:
+      - email
+      example:
+        email: jane_doe@example.com
+        name: Jane Doe
+    to_email_array:
+      title: To Email Array
+      type: array
+      items:
+        type: object
+        properties:
+          email:
+            type: string
+            format: email
+            description: The intended recipient's email address.
+          name:
+            type: string
+            description: The intended recipient's name.
+        required:
+        - email
+      example:
+      - email: john_doe@example.com
+        name: John Doe
+    cc_bcc_email_object:
+      title: CC BCC Email Object
+      type: object
+      properties:
+        email:
+          type: string
+          format: email
+          description: The intended recipient's email address.
+        name:
+          type: string
+          description: The intended recipient's name.
+      required:
+      - email
+      example:
+        email: jane_doe@example.com
+        name: Jane Doe
+    reply_to_email_object:
+      title: Reply_to Email Object
+      type: object
+      properties:
+        email:
+          type: string
+          format: email
+          description: The email address where any replies or bounces will be returned.
+        name:
+          type: string
+          description: A name or title associated with the `reply_to` email address.
+      required:
+      - email
+      example:
+        email: jane_doe@example.com
+        name: Jane Doe
+    global_error_response_schema:
+      title: Global Error Response Schema
+      type: object
+      properties:
+        errors:
+          type: array
+          items:
+            type: object
+            properties:
+              message:
+                type: string
+                description: the error message
+              field:
+                description: the field that generated the error
+                nullable: true
+                type: string
+              help:
+                type: object
+                description: helper text or docs for troubleshooting
+            required:
+            - message
+        id:
+          type: string
+      example:
+        errors:
+        - field: field_name
+          message: error message

src/openapi/service/service-crud.yaml

@@ -0,0 +1,159 @@
+openapi: "3.0.3"
+info:
+  title: ABT Service CRUD APIs
+  version: "1.0"
+  description: CRUD APIs for ABT Service processes.
+servers:
+  - url: https://api.integratielaag.nl/v1/service
+paths:
+  /tokenregisterrequests:
+    get:
+      summary: Get all token register requests.
+      description: Get all token register requests.
+      tags:
+        - NFC Reader
+      parameters:
+        - in: query
+          name: readerId
+          schema:
+            type: string
+            example: b14b0320-2b72-48bb-990b-b97a2d67f9df
+          explode: false
+          required: false
+          description: Filter on possible NFC reader ids.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TokenRegisterRequestsGetResponse"
+              examples:
+                Single TokenRegisterRequest:
+                  summary: Single TokenRegisterRequest
+                  value:
+                    {
+                      "tokenRegisterRequests":
+                        [
+                          {
+                            "readerId": "b14b0320-2b72-48bb-990b-b97a2d67f9df",
+                            "xBot": "4bfaede2-a6c9-45dd-8a80-1f83a075a115",
+                            "updated": "2025-07-02T15:01:00.000+00:00",
+                          },
+                        ],
+                    }
+                Multiple TokenRegisterRequests:
+                  summary: Multiple TokenRegisterRequests
+                  value:
+                    {
+                      "tokenRegisterRequests":
+                        [
+                          {
+                            "readerId": "b14b0320-2b72-48bb-990b-b97a2d67f9df",
+                            "xBot": "4bfaede2-a6c9-45dd-8a80-1f83a075a115",
+                            "updated": "22025-07-02T15:01:00.000+00:00",
+                          },
+                          {
+                            "readerId": "b4d8e43c-be21-472c-955b-a0c7c11b4bfb",
+                            "xBot": "625bc66b-a5de-42fc-ba9e-fb02ada4a4ee",
+                            "updated": "2025-07-02T13:37:07.000+00:00",
+                          },
+                        ],
+                    }
+  /tokenregisterrequests/{readerId}:
+    parameters:
+      - in: path
+        name: readerId
+        required: true
+        description: The NFC reader id.
+        schema:
+          type: string
+          example: b14b0320-2b72-48bb-990b-b97a2d67f9df
+    put:
+      summary: Insert or update token register request.
+      description: Insert or update token register request.
+      tags:
+        - NFC Reader
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/TokenRegisterRequestPutRequest"
+            example: { "xBot": "4bfaede2-a6c9-45dd-8a80-1f83a075a115" }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TokenRegisterRequestPutResponse"
+              example:
+                {
+                  "readerId": "b14b0320-2b72-48bb-990b-b97a2d67f9df",
+                  "xBot": "4bfaede2-a6c9-45dd-8a80-1f83a075a115",
+                  "updated": "2025-07-02T15:01:00.000+00:00",
+                }
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TokenRegisterRequestPutResponse"
+              example:
+                {
+                  "readerId": "b14b0320-2b72-48bb-990b-b97a2d67f9df",
+                  "xBot": "4bfaede2-a6c9-45dd-8a80-1f83a075a115",
+                  "updated": "2025-07-02T15:01:00.000+00:00",
+                }
+components:
+  securitySchemes:
+    bearerToken:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+  schemas:
+    TokenRegisterRequestsGetResponse:
+      type: object
+      properties:
+        tokenRegisterRequests:
+          type: array
+          items:
+            $ref: "#/components/schemas/TokenRegisterRequest"
+    TokenRegisterRequestPutRequest:
+      type: object
+      properties:
+        xBot:
+          type: string
+          format: uuid
+          example: 4bfaede2-a6c9-45dd-8a80-1f83a075a115
+          nullable: false
+          description: The xBOT id.
+      required:
+        - xBot
+    TokenRegisterRequestPutResponse:
+        $ref: "#/components/schemas/TokenRegisterRequest"
+    TokenRegisterRequest:
+      type: object
+      properties:
+        readerId:
+          type: string
+          example: b14b0320-2b72-48bb-990b-b97a2d67f9df
+          nullable: false
+          description: The NFC reader id.
+        xBot:
+          type: string
+          format: uuid
+          example: 4bfaede2-a6c9-45dd-8a80-1f83a075a115
+          nullable: false
+          description: The xBOT id.
+        updated:
+          type: string
+          format: date-time
+          example: "2025-07-02T15:01:00+00:00"
+          nullable: false
+          description: The date and time when the token register request was updated.
+      required:
+        - readerId
+        - xBot
+        - updated

src/openapi/util/util-crud.yaml

@@ -4,7 +4,7 @@ info:
   version: "1.0"
   description: CRUD APIs for ABT Utility tables. These are NOT the functional APIs from Service Engine.
 servers:
-  - url: https://api.integratielaag.nl/v1
+  - url: https://services.acc.api.htm.nl/abt/abtutility/1.0
 paths:
   /scheduledactions:
     get:
@@ -86,6 +86,20 @@ paths:
             example: 65ad5520-4e62-41b7-89dd-a01be6cb78bf
           required: false
           description: Pointer to executor of this action (e.g. the batch job).
+        - in: query
+          name: role
+          schema:
+            type: string
+            example: customer
+          required: false
+          description: Role of the user or process that initiated the action.
+        - in: query
+          name: user
+          schema:
+            type: string
+            example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
+          required: false
+          description: User that initiated the action. In case of a customer this is the customer id.
         - in: query
           name: resourceName
           schema:
@@ -123,6 +137,8 @@ paths:
                         "created": "2024-07-02 15:01:00.000",
                         "updated": "2024-07-02 15:01:00.000",
                         "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
+                        "role": "customer",
+                        "user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
                         "scheduledActionResources":
                           [
                             {
@@ -157,6 +173,8 @@ paths:
                     "created": "2024-07-02 15:01:00.000",
                     "updated": "2024-07-02 15:01:00.000",
                     "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
+                    "role": "customer",
+                    "user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
                     "scheduledActionResources":
                       [
                         {
@@ -217,6 +235,8 @@ paths:
                       "created": "2024-07-02 15:01:00.000",
                       "updated": "2024-07-02 15:01:00.000",
                       "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
+                      "role": "customer",
+                      "user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
                       "scheduledActionResources":
                         [
                           {
@@ -390,6 +410,12 @@ components:
           type: string
           format: uuid
           example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f
+        role:
+          type: string
+          example: customer
+        user:
+          type: string
+          example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
     ScheduledActionType:
       type: object
       properties:

src/plugins/gitea-add-swagger-button.user.js

@@ -0,0 +1,52 @@
+// ==UserScript==
+// @name         gitea-add-swagger-button
+// @namespace    https://integratielaag.nl/
+// @version      0.1.1
+// @description  Creates a button in Gitea to view Swagger
+// @author       bboterm
+// @match        https://git.integratielaag.nl/*.yaml
+// @match        https://git.integratielaag.nl/*.json
+// @icon         https://www.google.com/s2/favicons?sz=64&domain=gitea.com
+// @grant        none
+// @updateURL    https://git.integratielaag.nl/HTM/ovpay/raw/branch/develop/src/plugins/gitea-add-swagger-button.user.js
+// @downloadURL  https://git.integratielaag.nl/HTM/ovpay/raw/branch/develop/src/plugins/gitea-add-swagger-button.user.js
+// ==/UserScript==
+// @history      0.1.0 Initial release
+// @history      0.1.1 Added support for YAML and JSON files
+
+(function() {
+    'use strict';
+
+    // Set the base URL for the Swagger instance
+    const swaggerBaseURL = 'https://swagger.integratielaag.nl/?url=';
+    // Get the base URL from the current webpage
+    const gitBaseURL = window.location.origin;
+
+    // Replace 'parent-class-name' with the class name of the parent div
+    const parentClassName = 'file-actions';
+    // Replace 'child-class-name' with the class name of the child div
+    const childClassName = 'buttons';
+
+    const parentDiv = document.querySelector('div.file-actions');
+    if (parentDiv) {
+        const childDiv = parentDiv.querySelector('div.buttons');
+        if (childDiv) {
+            const firstATag = childDiv.querySelector('a');
+            if (firstATag) {
+                // Get the URL of the raw file
+                const hrefValue = firstATag.getAttribute('href');
+                // Create a string literal for the new Swagger button
+                const swaggerButton = `<a class="ui mini basic button" target="_blank" href="${swaggerBaseURL}${gitBaseURL}/${hrefValue}">Swagger</a>`;
+                // Add the Swagger button to the HTML
+				childDiv.innerHTML = swaggerButton + childDiv.innerHTML;
+            } else {
+                console.log('No <a> tag found inside the child div.');
+            }
+        } else {
+            console.log(`Child div with class '${childClassName}' not found.`);
+        }
+    } else {
+        console.log(`Parent div with class '${parentClassName}' not found.`);
+    }
+})();
+

src/u4f/examples/codaSoapRequestPostToBook.xml

@@ -0,0 +1,65 @@
+<soapenv:Envelope
+    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:web="http://www.coda.com/efinance/schemas/inputext/input-14.0/webservice"
+    xmlns:tran="http://www.coda.com/efinance/schemas/transaction"
+    xmlns:flex="http://www.coda.com/common/schemas/flexifield"
+    xmlns:att="http://www.coda.com/common/schemas/attachment"
+    xmlns:inp="http://www.coda.com/efinance/schemas/inputext"
+    xmlns:mat="http://www.coda.com/efinance/schemas/matching"
+    xmlns:ass="http://www.coda.com/efinance/schemas/association">
+    <soapenv:Body>
+        <web:PostToBooksRequest>
+            <web:Transaction>
+                <tran:Header
+                    xmlns:tran="http://www.coda.com/efinance/schemas/transaction">
+                    <tran:Key>
+                        <tran:CmpCode>1HTM</tran:CmpCode>
+                        <tran:Code>OPBR-FIKO</tran:Code>
+                    </tran:Key>
+                    <tran:TimeStamp>0</tran:TimeStamp>
+                    <tran:InputDate>2024-11-25T00:00:00.000Z</tran:InputDate>
+                    <tran:Period>2024/7</tran:Period>
+                    <tran:CurCode>EUR</tran:CurCode>
+                    <tran:Date>2024-07-25T00:00:00.000Z</tran:Date>
+                    <tran:OriginalCompany>1HTM</tran:OriginalCompany>
+                    <tran:OriginalCode>OPBR-FIKO</tran:OriginalCode>
+                    <tran:CompletionWorkflow>
+                        <tran:CompletionStatus>wfl_no_completion</tran:CompletionStatus>
+                    </tran:CompletionWorkflow>
+                    <tran:SalesInvoiceStatus>salesinv_notyetinv</tran:SalesInvoiceStatus>
+                </tran:Header>
+                <tran:Lines
+                    xmlns:tran="http://www.coda.com/efinance/schemas/transaction">
+                    <tran:Line>
+                        <tran:Number>1</tran:Number>
+                        <tran:AccountCode>100.12400.D150000001</tran:AccountCode>
+                        <tran:DocValue>100.00</tran:DocValue>
+                        <tran:LineType>summary</tran:LineType>
+                        <tran:LineSense>debit</tran:LineSense>
+                        <tran:LineOrigin>dl_orig_defined</tran:LineOrigin>
+                        <tran:Description>test</tran:Description>
+                        <tran:ExtRef1>987654</tran:ExtRef1>
+                        <tran:ExtRef2>test987654</tran:ExtRef2>
+                        <tran:SEPAPaymentCategoryPurposeCode>none</tran:SEPAPaymentCategoryPurposeCode>
+                        <tran:SEPAPaymentPurposeCode>none</tran:SEPAPaymentPurposeCode>
+                    </tran:Line>
+                    <tran:Line>
+                        <tran:Number>2</tran:Number>
+                        <tran:AccountCode>642.41236.609311</tran:AccountCode>
+                        <tran:DocValue>100.00</tran:DocValue>
+                        <tran:UserStatus/>
+                        <tran:LineType>analysis</tran:LineType>
+                        <tran:LineSense>credit</tran:LineSense>
+                        <tran:LineOrigin>dl_orig_defined</tran:LineOrigin>
+                        <tran:SEPAPaymentCategoryPurposeCode>none</tran:SEPAPaymentCategoryPurposeCode>
+                        <tran:SEPAPaymentPurposeCode>none</tran:SEPAPaymentPurposeCode>
+                    </tran:Line>
+                </tran:Lines>
+            </web:Transaction>
+            <web:PostData>
+                <web:Template>OPBR-FIKO</web:Template>
+                <web:DocumentWideData/>
+            </web:PostData>
+        </web:PostToBooksRequest>
+    </soapenv:Body>
+</soapenv:Envelope>

src/u4f/examples/exampleBooking.xml

@@ -0,0 +1,77 @@
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://www.coda.com/efinance/schemas/inputext/input-14.0/webservice" xmlns:tran="http://www.coda.com/efinance/schemas/transaction" xmlns:flex="http://www.coda.com/common/schemas/flexifield" xmlns:att="http://www.coda.com/common/schemas/attachment" xmlns:inp="http://www.coda.com/efinance/schemas/inputext" xmlns:mat="http://www.coda.com/efinance/schemas/matching" xmlns:ass="http://www.coda.com/efinance/schemas/association">
+   <soapenv:Header>
+      <web:Options/>
+   </soapenv:Header>
+   <soapenv:Body>
+      <web:PostRequest>        
+         <web:PostOptions postto="intray" reportallerrors="1"/> <!-- postto staat nu naar het register (intray). Dit zou ik een live situatie moeten/kunnen worden aangepast naar de boeken (books) -->
+         <web:Transaction>
+            <tran:Header>
+               <tran:Key>
+                  <tran:CmpCode>1HTM</tran:CmpCode> <!-- Unit4 Financials bedrijf -->
+                  <tran:Code>VERK_FACTUUR</tran:Code> <!--  Documentcode -->
+               </tran:Key>
+               <tran:TimeStamp>0</tran:TimeStamp> <!-- Timestamp bij nieuwe transacties altijd 0 -->
+               <tran:Period>2024/5</tran:Period> <!-- Jaar en periode van boeken -->
+               <tran:CurCode>EUR</tran:CurCode> <!-- Valutacode -->
+               <tran:Date>2024-06-05T00:00:00.000Z</tran:Date> <!-- Documentdatum> -->
+               <tran:Description>DW12345</tran:Description> <!-- Omschrijving document -->
+            </tran:Header>
+            <tran:Lines>
+               <tran:Line>
+                  <tran:Number>1</tran:Number> <!-- Regelnummer - 1 Debiteurenregel -->
+                  <tran:AccountCode>1200.D001</tran:AccountCode> <!-- Boeken op elementcode, in dit geval alleen elementen op niveau 1 en 2 (gescheiden door een punt) -->
+                  <tran:DocValue>121.00</tran:DocValue> <!-- Totaalbedrag debiteurenregel -->
+                  <tran:LineType>summary</tran:LineType> <!-- Type regel, in het geval van een debiteurenregel is dit summary -->
+                  <tran:LineSense>credit</tran:LineSense> <!-- Debet of Credit -->
+                  <tran:LineOrigin>dl_orig_defined</tran:LineOrigin> <!-- Aangezien hier gebruik wordt gemaakt van het invoersjabloon FACTUUR_VER (zie regel 72) is dit een vooraf gedefinieerde regel ( dl_orig_defined) --> 
+                  <tran:Description>Nov 2020 Huur</tran:Description> <!-- Regelomschrijving -->
+ 			      <tran:ExtRef1>DW12345</tran:ExtRef1> <!-- Externe referentie 1 -->
+                  <tran:ExtRef2/> <!-- Externe referentie 2, nu niet gevuld -->
+                  <tran:ExtRef3/> <!-- Externe referentie 3, nu niet gevuld, hieronder kunnen ook nog andere referenties worden opgenomen -->
+                  <tran:DocSumTax>21.00</tran:DocSumTax> <!-- BTW-bedrag behorende bij debiteurenregel -->
+                  <tran:TaxInclusive>false</tran:TaxInclusive> <!-- Inclusief of exclusief BTW -->             
+               </tran:Line>
+               <tran:Line>
+                  <tran:Number>2</tran:Number> <!-- Regelnummer - 1 Omzetregel -->
+                  <tran:AccountCode>4300</tran:AccountCode> <!-- Boeken op elementcode, in dit geval alleen element op niveau 1 -->
+                  <tran:DocValue>100.00</tran:DocValue> <!-- Totaalbedrag omzetregel -->
+                  <tran:LineType>analysis</tran:LineType> <!-- Type regel, in het geval van een omzetregel is dit analyses (analyse) -->
+                  <tran:LineSense>debit</tran:LineSense> <!-- Debet of Credit -->
+                  <tran:LineOrigin>dl_orig_defined</tran:LineOrigin> <!-- Aangezien hier gebruik wordt gemaakt van het invoersjabloon FACTUUR_VER (zie regel 72) is dit een vooraf gedefinieerde regel ( dl_orig_defined) --> 
+                  <tran:Description>Voorschot Q1.</tran:Description> <!-- Regelomschrijving -->
+  			      <tran:ExtRef1>Ref. DW12345</tran:ExtRef1> <!-- Externe referentie 1 -->
+                  <tran:ExtRef2/> <!-- Externe referentie 2, nu niet gevuld -->
+                  <tran:ExtRef3/> <!-- Externe referentie 3, nu niet gevuld, hieronder kunnen ook nog andere referenties worden opgenomen -->
+                  <tran:TaxInclusive>false</tran:TaxInclusive> <!-- Inclusief of exclusief BTW -->  
+                  <tran:Taxes>
+                    <tran:Tax>
+                      <tran:Code>21%</tran:Code> <!-- BTW-code -->
+                      <tran:ShortName>21% BTW</tran:ShortName> <!-- Verkorte omschrijving BTW -->
+                      <tran:Value>21.00</tran:Value> <!-- BTW-bedrag analyse regel -->
+                    </tran:Tax>   
+                  </tran:Taxes>
+               </tran:Line>
+               <tran:Line>
+                  <tran:Number>3</tran:Number> <!-- Regelnummer - 3 BTW-regel -->
+                  <tran:AccountCode>1400</tran:AccountCode> <!-- Boeken op elementcode, in dit geval alleen element op niveau 1 -->
+                  <tran:DocValue>21.00</tran:DocValue> <!-- BTW-bedrag -->
+                  <tran:LineType>tax</tran:LineType> <!-- Type regel, in het geval van een BTW-regel is dit tax (BTW) -->
+                  <tran:LineSense>debit</tran:LineSense> <!-- Debet of Credit -->
+                  <tran:LineOrigin>dl_orig_gentax</tran:LineOrigin> <!-- Aangezien hier gebruik wordt gemaakt van het invoersjabloon FACTUUR_VER (zie regel 72) is dit een vooraf gedefinieerde regel ( dl_orig_gentax) --> 
+                  <tran:Description>Test DW</tran:Description> <!-- Regelomschrijving -->
+ 			      <tran:ExtRef1/>
+                  <tran:ExtRef2/>
+                  <tran:ExtRef3/>
+     		      <tran:TaxLineCode>21%</tran:TaxLineCode> <!-- BTW-code -->
+                  <tran:DocTaxTurnover>100.00</tran:DocTaxTurnover> <!-- Bedrag waar BTW over berekend -->
+               </tran:Line>
+            </tran:Lines>
+         </web:Transaction>
+         <web:PostData>
+           <inp:Template>FACTUUR_VER</inp:Template> <!-- Te gebruiken invoersjabloon -->
+           <inp:DocumentWideData/>
+         </web:PostData>
+      </web:PostRequest>
+   </soapenv:Body>
+</soapenv:Envelope>