Author SHA1 Message Date
bboterm 8c7b54c386 OVPAY-2547 - Added 'paymentMethod' to transactionItem. 2026-06-18 16:43:27 +02:00
bboterm ca784314ec OVPAY-2547 - Added 'paymentMethod' to transactionItem. 2026-06-18 16:38:50 +02:00
MirjamHTM 3f090c76b6 Merge pull request 'added additional Query params for issuedVoucher CRUD' (#62) from OVPAY2738-adjustment-CRUD-PP into develop
Reviewed-on: #62
2026-06-16 10:38:31 +00:00
MirjamHTM 25788e0976 added additional Query params for issuedVoucher CRUD 2026-06-16 12:01:37 +02:00
Max Martens 90bb7c11b5 Change mandatoryItem 6 (phone) to voucher 2026-06-11 12:19:15 +02:00
Max Martens 0c23571085 Remove whitespace 2026-06-11 12:12:11 +02:00
Max Martens f1a0850871 Now also for TP/SE endpoints 2026-06-11 12:11:05 +02:00
Max Martens cc8881b9d5 Add onlyVouchers queryParam and needsVoucher product attribute 2026-06-11 12:06:47 +02:00
Max Martens d484acbc69 Add required attributes that should always be present in every (valid) voucher definition 2026-06-11 11:14:10 +02:00
maxmartens e5a0b52d1b Merge pull request 'Updated OpenAPI spec for voucher supplier, with examples more relevant to the first usecase (ooievaarspas AOW) - this YAML is also shared with PASS devs' (#60) from feature/OVPAY-2545-vouchers into develop
Reviewed-on: #60
2026-06-08 08:45:46 +00:00
maxmartens 89833680db Merge branch 'develop' into feature/OVPAY-2545-vouchers 2026-06-08 08:44:17 +00:00
Max Martens ff225ea00c Merge branch 'feature/OVPAY-2545-vouchers' of https://git.integratielaag.nl/HTM/ovpay into feature/OVPAY-2545-vouchers 2026-06-03 19:06:25 +02:00
Max Martens bd870d0fa8 Added JSON schema and updated examples and error specs for supplier - tweaked OAS for TP 2026-06-03 19:06:17 +02:00
maxmartens 531eaa2ff6 Update src/openapi/products/SE-vouchers-TP.yaml
Fix some typos

Signed-off-by: Max Martens <m.martens@htm.nl>
2026-06-02 15:21:03 +00:00
Max Martens 7173bd3727 Finished JSON schema and all 3 relevant examples for TP vouchers OpenAPI spec (will also update vouchers supplier OpenAPI spec soon) 2026-06-01 11:17:22 +02:00
Max Martens a09ad1ad08 Process PR feedback, first version of issuedVoucher JSON schema 2026-06-01 10:40:28 +02:00
Max Martens f198c1633b Default false for isEmailVerified 2026-05-19 17:29:40 +02:00
maxmartens 5f7893b057 Merge pull request 'Reverted some links to the old/"standard" href structure, becasuse the links are buggy and not worth the effort to fix. Exception is GET /devices, that one is working' (#61) from feature/DHIL-5732-links into develop
Reviewed-on: #61
2026-05-12 14:56:25 +00:00
Max Martens 383d43122b Reverted some links to the old/"standard" href structure, becasuse the links are buggy and not worth the effort to fix. Exception is GET /devices, that one is working 2026-05-12 16:29:51 +02:00
Max Martens f8010560cc Tweak query param 2026-05-07 09:52:29 +02:00
Max Martens 69908f58b0 Finished updating, will be shared with pass devs in this state - I tweaked some stuff, needs to be discussed if this is final desired spec, but good enough to give pass devs a general idea 2026-05-06 22:44:55 +02:00
Max Martens 9fb20a491f WIP update spec with examples for Ooievaarspas-AOW (still need to finish POST/PATCH) 2026-05-06 08:28:21 +02:00
Max Martens 2fca37628e Only return deviceId in PATCH response to prevent extra internal GET call in PATCH logic 2026-05-05 15:12:20 +02:00
Max Martens 8a10320c26 Fix some typos 2026-04-23 14:24:13 +02:00
Max Martens e13b643c99 Fix missing attributes in examples 2026-04-23 14:10:41 +02:00
bboterm 7954e8012d OVPAY-2473 - Added xbot as query param for get trip details. 2026-04-17 15:55:30 +02:00
bboterm 7d84691c4b OVPAY-2473 - OvPayTokenId for get trip details is now optional. 2026-04-16 11:35:39 +02:00
bboterm 354a8bf75d OVPAY-2473 - TripId and TransactionId are optional. 2026-04-13 12:24:35 +02:00
bboterm 534ee3f8fd OVPAY-2473 - Fixed HATEOAS. 2026-04-10 14:11:46 +02:00
bboterm 3e4a59bdcc OVPAY-2473 - Updated example data types. 2026-04-10 14:08:50 +02:00
bboterm 4f54aaf027 Merge pull request 'OVPAY-2503 - Added ovPasNumber and volgnummer to claims request.' (#58) from feature/OVPAY-2503 into develop
Reviewed-on: #58
Reviewed-by: Max Martens <m.martens@htm.nl>
2026-04-09 07:36:16 +00:00
maxmartens 8dd6f7211b Small update to description 2026-04-08 16:08:21 +00:00
bboterm b59b8ca32b OVPAY-2503 - Added volgnummer to refund request. 2026-04-08 16:23:48 +02:00
bboterm c35c44a1cf OVPAY-2503 - Added ovPasNumber and volgnummer to claims request. 2026-04-08 09:59:09 +02:00
bboterm 8fc5d3b55e OVPAY-2473 - Added xpto boolean for token in profile. 2026-04-07 15:31:15 +02:00
bboterm 50bff1d3f7 OVPAY-2473 - Added xpto boolean. 2026-04-07 15:21:46 +02:00
bboterm b1fb842046 OVPAY-2473 - Fixed href in HATEOAS. 2026-04-03 11:58:22 +02:00
bboterm a621b1f06c OVPAY-2473 - Fixed inconsistency in HATEOAS. 2026-04-03 11:47:07 +02:00
Max Martens 6a4b1a1d58 Add query params for new PurchasedTapConnectTicket attributes 2026-04-02 12:13:48 +02:00
maxmartens c4d99bb8d6 Merge pull request 'Add activateBefore and description fields, update documentation; update POST/PATCH PurchasedTapConnectTicket CRUD spec' (#57) from feature/OVPAY-2493-tweaks into develop
Reviewed-on: #57
Reviewed-by: Bas Boterman <b.boterman@htm.nl>
2026-04-02 09:45:50 +00:00
bboterm db5d2ac324 OVPAY-2346 - Changed query param to path param. 2026-04-01 14:14:15 +02:00
bboterm 175c81f5cd OVPAY-2346 - Added query param for voucherStatus. 2026-03-31 16:47:12 +02:00
Max Martens 4f183fe4ab Also update POST/PATCH PurchasedTapConnectTicket CRUD spec 2026-03-31 12:37:44 +02:00
Max Martens e295a570f0 Add activateBefore and description fields, update documentation 2026-03-31 12:26:45 +02:00
maxmartens 2094ef46e4 Merge pull request 'Reworked SE purchasedproducts endpoints, added vouchers and device to TP order and updated order CRUD deviceId -> externalDeviceId' (#56) from features/OVPAY2294-vouchers-in-orders into develop
Reviewed-on: #56
2026-03-29 17:07:38 +00:00
Max Martens cf7dcc8dd4 Add serviceId in purchasedProducts CRUD API 2026-03-27 11:22:48 +01:00
Max Martens f033ab6bbe Move /purchasedproducts endpoint to SE-customers-V2 2026-03-27 11:12:25 +01:00
Max Martens 58ca9326dc Rework of purchasedproducts endpoints, including JSON Schema and documentation and examples, especially for activation logic using validityStart and validityEnd (which is in line with how TapConnect populates those same fields) 2026-03-26 18:45:32 +01:00
Max Martens d3c9e3d36b Update CRUD Customers, PurchasedProducts to reflect new externalDeviceId spec 2026-03-25 18:31:04 +01:00
Max Martens 38094e7b29 Merge branch 'develop' into features/OVPAY2294-vouchers-in-orders 2026-03-25 17:34:12 +01:00
bboterm 974f737777 OVPAY-2491 - Added missing query params. 2026-03-25 17:07:13 +01:00
bboterm 868ac3e6bd OVPAY-2491 - Added endpoint for getting trip history by SRID + amount or OVpasnumber. 2026-03-25 17:01:18 +01:00
bboterm 5c950701e0 OVPAY-2346 - Fixed query params for get voucher TP. 2026-03-25 16:30:58 +01:00
MirjamHTM f193a1204b added vouchers and device to TP order and updated order CRUD deviceId -> externalDeviceId 2026-03-23 16:43:25 +01:00
bboterm dc21af3cef OVPAY-2473 - Updated /stops example with real data. 2026-03-17 15:00:49 +01:00
bboterm c45f2059f4 OVPAY-2473 - Fixed HATEOAS in example. 2026-03-16 16:11:12 +01:00
bboterm 53185d10b1 Merge pull request 'feature/OVPAY-2473' (#55) from feature/OVPAY-2473 into develop
Reviewed-on: #55
2026-03-16 13:56:18 +00:00
bboterm f237f677e3 OVPAY-2473 - Improved examples part 2. 2026-03-16 14:45:05 +01:00
bboterm 9bb7320299 OVPAY-2473 - Improved examples. 2026-03-16 14:35:59 +01:00
bboterm 1bf9fa2fd0 OVPAY-2473 - Improved URIs. 2026-03-16 13:34:42 +01:00
bboterm 903adbe238 OVPAY-2473 - Added HATEOAS for trip correction in trips list. 2026-03-16 13:23:15 +01:00
bboterm b6586891fc OVPAY-2473 - Fixed semantic errors. 2026-03-16 13:08:02 +01:00
bboterm 8b148b22ac OVPAY-2387 - Updated examples for GET /notificationcategories. 2026-03-11 15:44:16 +01:00
bboterm 44dae159b8 OVPAY-2473 - Added HATEOAS for trip correction. 2026-03-05 13:10:48 +01:00
bboterm a7e32f6122 OVPAY-2473 - Added examples for GET trip details. 2026-03-05 12:37:04 +01:00
bboterm 513045c146 OVPAY-2473 - Added endpoint for POSTing missing tap. 2026-03-05 12:19:24 +01:00
bboterm 8c4542a151 OVPAY-2473 - Added endpoint for getting stops. 2026-03-05 12:11:35 +01:00
bboterm 0749e927dc OVPAY-2473 - Added existing trip endpoints. 2026-03-05 10:09:44 +01:00
bboterm 2b02e52c22 OVPAY-2294 - Removed bulk endpoints. 2026-03-04 15:32:25 +01:00
bboterm 2cb6f910df Merge pull request 'OVPAY-2201 - Added endpoints for contract changes.' (#54) from feature/OVPAY-2201 into develop
Reviewed-on: #54
2026-03-04 09:44:38 +00:00
bboterm 1269f8916f Merge pull request 'feature/OVPAY-2442' (#53) from feature/OVPAY-2442 into develop
Reviewed-on: #53
2026-03-04 09:39:44 +00:00
bboterm c3af1e9adf OVPAY-2201 - ChangeMoments signle entity. 2026-03-02 10:04:54 +01:00
bboterm 5d307d9808 OVPAY-2442 - Changed all bulk endpoints to single inserts and patches (yarr). 2026-02-23 17:03:24 +01:00
bboterm 105e81b5c4 OVPAY-2201 - Added endpoints for contract changes. 2026-02-23 14:42:07 +01:00
MirjamHTM 24b4832c69 fixed examples post payment 2026-02-19 12:07:29 +01:00
MirjamHTM 03372074d9 removed incorrect deviceId 2026-02-19 11:59:18 +01:00
MirjamHTM bf0ebee435 added claim value to supplier voucher GET and added seperate swagger for voucher check sales TP 2026-02-16 13:38:45 +01:00
bboterm 541b0662f1 OVPAY-2442 - Improved descriptions. 2026-02-13 14:49:44 +01:00
bboterm 594475331f OVPAY-2442 - Added touchpointId query param. 2026-02-13 14:47:12 +01:00
bboterm 42c49693f1 OVPAY-2442 - Added PATCH /issuedvouchers. 2026-02-13 14:30:32 +01:00
bboterm 62f001c902 OVPAY-2442 - Added POST /issuedvouchers. 2026-02-13 14:17:17 +01:00
bboterm a71aa2e4df OVPAY-2442 - Nested product entity for GET /voucherdefinitions. 2026-02-13 12:42:30 +01:00
bboterm 5e2b646a30 OVPAY-2442 - Added query params. Updated examples. 2026-02-11 16:31:08 +01:00
bboterm 7ab0de07c4 OVPAY-2442 - Created endpoints for GET /voucherdefinitions and /issuedvouchers. 2026-02-11 12:01:45 +01:00
Max Martens 39e5042350 Added feature: bulk clearing (set to null) of a given product attribute for all products in a given product tree - actually applies the modified products via PUT API 2026-02-05 17:42:17 +01:00
bboterm 2d742ca3f1 OVPAY-973 - Added query param deviceId for GET and PUT notificationpreferences. 2026-02-05 13:13:15 +01:00
MirjamHTM 97c58dc3fe Merge pull request 'features/OVPAY2313-V2-swaggers-infoplaza' (#52) from features/OVPAY2313-V2-swaggers-infoplaza into develop
Reviewed-on: #52
2026-02-05 10:01:01 +00:00
MirjamHTM d06da1401e fixed ovpasNumber mistake 2026-02-05 10:54:13 +01:00
MirjamHTM 04d46e0891 Merge branch 'develop' of https://git.integratielaag.nl/HTM/ovpay into features/OVPAY2313-V2-swaggers-infoplaza 2026-02-05 10:32:25 +01:00
MirjamHTM c31554a526 Merge pull request 'features/customers-v2-SE' (#51) from features/customers-v2-SE into develop
Reviewed-on: #51
2026-02-05 09:31:49 +00:00
MirjamHTM 9d9039d732 products and fixed productCategory Id 2026-02-04 10:33:38 +01:00
MirjamHTM 93efb6b8f7 Merge branch 'develop' of https://git.integratielaag.nl/HTM/ovpay into features/OVPAY2313-V2-swaggers-infoplaza 2026-02-04 09:57:24 +01:00
bboterm 77953a726a OVPAY-973 - Fixed TP endpoints. Updated response and request body. 2026-01-30 16:00:20 +01:00
Max Martens bbf21e61f7 Fixed all addressTypes 2026-01-29 14:09:08 +01:00
MirjamHTM 681e9f7671 fixed casing mismatch ovpaytokenid and tokens transfer reponsestatus path 2026-01-28 13:56:05 +01:00
MirjamHTM c9b54a095d restored crud file 2026-01-28 13:50:36 +01:00
bboterm e3139fdd6d Merge pull request 'OVPAY-2346 - Implemented /issuedvouchers/{code}.' (#48) from feature/OVPAY-2346 into develop
Reviewed-on: #48
2026-01-28 09:33:47 +00:00
MirjamHTM 4b932a0628 lowercase paths 2026-01-28 10:03:21 +01:00
MirjamHTM 43bf7bfff3 lowercase paths 2026-01-28 10:02:56 +01:00
MirjamHTM 007cf4bdef added customerprofileId to device response 2026-01-28 09:55:23 +01:00
MirjamHTM baee1e8622 misplaced customerprofileId 2026-01-28 09:53:01 +01:00
MirjamHTM ba314674a3 misplaced customerprofileId 2026-01-28 09:48:20 +01:00
MirjamHTM 1f51eaadc6 something 2026-01-28 09:47:21 +01:00
MirjamHTM 5838b14ac5 added GET on devices 2026-01-28 09:44:32 +01:00
MirjamHTM 14817cc621 fixed security semenantic error 2026-01-27 17:10:08 +01:00
MirjamHTM c1fbc0dc90 touchpoint V2 endpoints customer total 2026-01-27 16:34:51 +01:00
MirjamHTM 9b8cf65525 changes 2026-01-27 15:34:35 +01:00
bboterm 8f907896be Merge branch 'develop' of https://git.integratielaag.nl/HTM/ovpay into develop 2026-01-27 10:42:32 +01:00
bboterm 591347e080 OVPAY-973 - Added ovPayTokenId example to POST. 2026-01-27 10:42:21 +01:00
bboterm da7afd63fc Merge pull request 'feature/OVPAY-973' (#50) from feature/OVPAY-973 into develop
Reviewed-on: #50
2026-01-27 09:37:03 +00:00
MirjamHTM 2c88fac238 added voucher example product instance 2026-01-26 13:09:44 +01:00
bboterm 6a24636d50 OVPAY-973 - Added ovPayTokenId to POST /notificationsubscriptions. 2026-01-23 17:08:12 +01:00
bboterm c7fa48b554 OVPAY-2394 - Fixed schema for patch NotificationSubscription. 2026-01-22 09:28:27 +01:00
bboterm 5133903efb OVPAY-2394 - Added example for no notificationCategories found. 2026-01-21 11:03:45 +01:00
bboterm 447912e081 OVPAY-973 - Added alias to request and response bodies. 2026-01-19 15:08:42 +01:00
MirjamHTM e2d78ec969 created generic endpoint for product Instances 2026-01-19 14:51:38 +01:00
bboterm c6facc5a70 OVPAY-973 - Added GET/PUT /customers/notificationpreferences. 2026-01-19 14:31:01 +01:00
bboterm cf0d24632f Merge pull request 'feature/OVPAY-2394' (#49) from feature/OVPAY-2394 into develop
Reviewed-on: #49
2026-01-14 12:06:39 +00:00
bboterm aa4721c651 OVPAY-2394 - Processed review remarks. 2026-01-14 13:05:32 +01:00
bboterm 46bf7874d9 OVPAY-2394 - Added POST, PATCH and DELETE operations for NotificationPreferences. 2026-01-13 16:08:39 +01:00
bboterm 1a14918f4a OVPAY-2394 - Added PATCH /notificationsubscriptions/{uuid}. 2026-01-13 15:45:52 +01:00
bboterm 7147318900 OVPAY-2394 - Added resourceNameId to Channel. 2026-01-13 15:38:48 +01:00
bboterm e0f78d2e38 OVPAY-2394 - Updated GET /notificationsubscriptions examples. 2026-01-13 15:19:49 +01:00
bboterm ab57e27c1d OVPAY-2394 - Added OriginSubscription. 2026-01-12 15:08:32 +01:00
bboterm 68c7ccc279 OVPAY-2394 - Added groupName to NotificationCategory. Added query params. 2026-01-12 13:41:20 +01:00
bboterm 80c9fe7599 OVPAY-2346 - Processed review remarks. 2026-01-05 14:04:40 +01:00
bboterm 8946026860 Added fromInclusive and untilInclusive. 2026-01-05 13:34:12 +01:00
bboterm e6b2146706 OVPAY-2346 - Implemented /issuedvouchers/{code}. 2025-12-30 14:57:43 +01:00
bboterm fb8723124a Merge pull request 'OVPAY-2378 - Updated spec for /contractpayments.' (#46) from feature/OVPAY-2378 into develop
Reviewed-on: #46
Reviewed-by: Max Martens <m.martens@htm.nl>
2025-12-29 12:31:57 +00:00
bboterm 6d7c260e9e OVPAY-2378 - PaymentMethod in NL. 2025-12-29 12:32:59 +01:00
bboterm 292588b7ba OVPAY-2378 - Updated spec for /contractpayments. 2025-12-29 12:01:12 +01:00
MirjamHTM 4bd216bd37 Merge pull request 'features/OVPAY2294-vouchers-in-orders' (#45) from features/OVPAY2294-vouchers-in-orders into develop
Reviewed-on: #45
Reviewed-by: Bas Boterman <b.boterman@htm.nl>
2025-12-16 13:57:40 +00:00
MirjamHTM bfaa1ddcb1 fixed comments 2025-12-16 14:52:23 +01:00
MirjamHTM 55bac27561 simplified order_orderVoucherId 2025-12-15 15:36:51 +01:00
Max Martens 715a9668fc Clear up name and description of token transfer V2 endpoints 2025-12-15 14:27:48 +01:00
MirjamHTM b4f20a9758 moved changes to TP orders to another branch and made equal to develop in this branch 2025-12-15 11:50:39 +01:00
28 changed files with 13870 additions and 1660 deletions

No files matched your search

+1 -1
View File
@@ -8,7 +8,7 @@
</list> </list>
</option> </option>
</component> </component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="temurin-21" project-jdk-type="JavaSDK"> <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="17" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/out" /> <output url="file://$PROJECT_DIR$/out" />
</component> </component>
</project> </project>
+14 -1
View File
@@ -1,7 +1,9 @@
# ABTProducts PUT request body generator # ABTProducts PUT request body generator
Simple tool to quickly edit HTM products via ABTProducts REST API. Simple tool to quickly edit HTM products via ABTProducts REST API.
- Requires JRE 21 - Requires JRE 17
## Generating a PUT output (that you need to supply to PUT API yourself):
- Run via: `java -jar ABTProductsPUTGenerator.jar` - Run via: `java -jar ABTProductsPUTGenerator.jar`
- Specify custom input/output path via: `java -jar ABTProductsPUTGenerator.jar <inputPath> <outputPath>` - Specify custom input/output path via: `java -jar ABTProductsPUTGenerator.jar <inputPath> <outputPath>`
- Takes a ABTProducts GET response body in JSON format (product details) - Takes a ABTProducts GET response body in JSON format (product details)
@@ -10,3 +12,14 @@ Simple tool to quickly edit HTM products via ABTProducts REST API.
- `curl -X PUT -H 'Content-Type: application/json' {baseUrl}/abt/abtproducts/1.0/38 --data @output.json` - `curl -X PUT -H 'Content-Type: application/json' {baseUrl}/abt/abtproducts/1.0/38 --data @output.json`
- Default input path: /input.json - Default input path: /input.json
- Default output path: /output.json (output is overwritten if it exists) - Default output path: /output.json (output is overwritten if it exists)
## Bulk clearing (set to null) of a certain product attribute for all productIds in a product-tree (SE product reponse)
- Run via: `java -jar ABTProductsPUTGenerator.jar clearAttribute <inputPath> <attributeToClear> <environment> <wso2BearerToken>`
- Takes a SE GET product tree response body or ABTProducts GET response body in JSON format
- Also needs the attribute to clear and the WSO2 environment and valid WSO2 bearer token for that environment
- Performs the following operations:
- Finds all productId's in the given product(tree) and for each productId found:
- GETs productdetails via ABTProducts API
- Converts it to PUT request body using the functionality in the previous section
- Replaces <attributeToClear> with `null`
- Actually sends the modified PUT request body to ABTProducts PUT API
+2 -2
View File
@@ -58,8 +58,8 @@
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<configuration> <configuration>
<source>21</source> <source>17</source>
<target>21</target> <target>17</target>
</configuration> </configuration>
</plugin> </plugin>
</plugins> </plugins>
@@ -3,8 +3,11 @@ package nl.htm.ovpay.abt;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.util.Arrays;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Scanner;
import java.util.stream.Collectors;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -19,6 +22,15 @@ public class ABTProductsPUTGenerator {
private static final Logger LOGGER = LoggerFactory.getLogger(ABTProductsPUTGenerator.class); private static final Logger LOGGER = LoggerFactory.getLogger(ABTProductsPUTGenerator.class);
public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {
LOGGER.info("Starting ABTProductsPUTGenerator with arguments {}", Arrays.stream(args).toList());
if (args.length > 0 && args[0].equalsIgnoreCase("clearAttribute")) {
clearAttribute(args);
} else {
generateOutput(args);
}
}
private static void generateOutput(String[] args) throws Exception {
if (args.length != 2) { if (args.length != 2) {
LOGGER.info("To modify input/output path, use: java -jar ABTProductsPUTGenerator.jar <inputPath> <outputPath>"); LOGGER.info("To modify input/output path, use: java -jar ABTProductsPUTGenerator.jar <inputPath> <outputPath>");
} }
@@ -40,6 +52,49 @@ public class ABTProductsPUTGenerator {
} }
} }
private static void clearAttribute(String[] args) throws Exception {
if (args.length != 5) {
LOGGER.error("Incorrect input parameters!");
LOGGER.error("To clear attribute, use: java -jar ABTProductsPUTGenerator.jar clearAttribute <inputPath> <attributeToClear> <environment> <wso2BearerToken>");
return;
}
var inputFile = args[1];
var attributeToClear = args[2];
var environment = args[3];
var wso2BearerToken = args[4];
try (InputStream is = getInputStream(inputFile)) {
ObjectMapper mapper = new ObjectMapper();
JsonNode jsonNode = mapper.readTree(is);
var productIds = jsonNode.findValues("productId").stream().filter(JsonNode::isValueNode).map(JsonNode::asText).toList();
LOGGER.info("Found productIds to process: {}", productIds);
LOGGER.warn("Are you SURE you want to set attribute \"{}\" for all these productIds on environment {} to NULL?", attributeToClear, environment);
LOGGER.warn("Type 'yes' to continue...");
var input = new Scanner(System.in).nextLine();
if (!input.equalsIgnoreCase("yes")) {
LOGGER.info("Aborting...");
return;
}
for (var productId : productIds) {
LOGGER.info("Getting product details for product {}...", productId);
var productJsonString = APIHelper.getProductDetails(environment, productId, wso2BearerToken);
var productJsonNode = mapper.readTree(productJsonString);
var putJsonNode = processJsonNode(productJsonNode);
LOGGER.info("Clearing attribute \"{}\" from product with productId {}...", attributeToClear, productId);
((ObjectNode)putJsonNode).putRawValue(attributeToClear, null);
LOGGER.info("PUT product details for product with productId {} with cleared attribute \"{}\"...", productId, attributeToClear);
LOGGER.info("PUT product details with JSON body: {}", putJsonNode.toPrettyString());
APIHelper.putProductDetails(environment, productId, putJsonNode.toString(), wso2BearerToken);
}
LOGGER.info("DONE clearing attribute \"{}\" for productIds {}!", attributeToClear, productIds);
}
}
private static InputStream getInputStream(String filePath) throws IOException { private static InputStream getInputStream(String filePath) throws IOException {
var externalResource = new File(filePath); var externalResource = new File(filePath);
if (externalResource.exists()) { if (externalResource.exists()) {
@@ -0,0 +1,89 @@
package nl.htm.ovpay.abt;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import java.util.HashMap;
import java.util.Map;
import java.util.StringJoiner;
import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class APIHelper {
private static final Logger LOGGER = LoggerFactory.getLogger(APIHelper.class);
private static final String PRODUCT_DETAILS_URI = "https://services.<ENV>.api.htm.nl/abt/abtproducts/1.0/products/<PRODUCTID>";
public static String envToUriPart(String environment) {
return switch (environment) {
case "DEV" -> "dev";
case "ACC" -> "acc";
case "PRD" -> "";
default -> throw new IllegalArgumentException("Invalid environment: " + environment);
};
}
public static String getProductDetails(String environment, String productId, String wso2BearerToken) throws Exception {
var envUriPart = envToUriPart(environment);
var getProductDetailsUri = PRODUCT_DETAILS_URI.replace("<ENV>", envUriPart).replace("<PRODUCTID>", productId);
SSLContext sc = SSLContext.getInstance("SSL");
sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
URL url = new URL(getProductDetailsUri);
URLConnection con = url.openConnection();
HttpURLConnection http = (HttpURLConnection)con;
http.setRequestMethod("GET");
http.setDoOutput(false);
http.setRequestProperty("Authorization", "Bearer " + wso2BearerToken);
http.connect();
try(InputStream is = http.getInputStream()) {
return new String(is.readAllBytes(), StandardCharsets.UTF_8);
}
}
public static void putProductDetails(String environment, String productId, String jsonBody, String wso2BearerToken) throws Exception {
var envUriPart = envToUriPart(environment);
var putProductDetailsUri = PRODUCT_DETAILS_URI.replace("<ENV>", envUriPart).replace("<PRODUCTID>", productId);
LOGGER.info("PUT product details to URI: {}", putProductDetailsUri);
SSLContext sc = SSLContext.getInstance("SSL");
sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
URL url = new URL(putProductDetailsUri);
URLConnection con = url.openConnection();
HttpURLConnection http = (HttpURLConnection)con;
http.setRequestMethod("PUT");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer " + wso2BearerToken);
http.setRequestProperty("Content-Type", "application/json");
byte[] out = jsonBody.getBytes(StandardCharsets.UTF_8);
int length = out.length;
http.setFixedLengthStreamingMode(length);
http.connect();
try(OutputStream os = http.getOutputStream()) {
os.write(out);
}
try(InputStream is = http.getInputStream()) {
LOGGER.info("Got response from PUT API: {}", new String(is.readAllBytes(), StandardCharsets.UTF_8));
}
}
}
@@ -0,0 +1,38 @@
package nl.htm.ovpay.abt;
import java.security.cert.X509Certificate;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;
public final class DummyX509TrustManager implements X509TrustManager {
private static DummyX509TrustManager INSTANCE;
private DummyX509TrustManager() {
// prevent instantiation
}
public static DummyX509TrustManager getInstance() {
if (INSTANCE == null) {
INSTANCE = new DummyX509TrustManager();
}
return INSTANCE;
}
public static TrustManager[] getDummyArray() {
if (INSTANCE == null) {
INSTANCE = new DummyX509TrustManager();
}
return new TrustManager[] { INSTANCE };
}
public X509Certificate[] getAcceptedIssuers() {
return null;
}
public void checkClientTrusted(X509Certificate[] certs, String authType) {
}
public void checkServerTrusted(X509Certificate[] certs, String authType) {
}
}
@@ -1,23 +1,33 @@
{ {
"productId": 251, "productId": 663,
"fikoArticleNumber": null,
"parentProductId": null, "parentProductId": null,
"gboPackageTemplateId": "30901", "layerInfo": {
"layerInfoId": 7,
"choiceKey": "isRenewable",
"choiceLabel": "Kies voor een doorlopend abonnement of een enkele termijn",
"isCustomChoice": false
},
"fikoArticleNumber": null,
"gboPackageTemplateId": "30001",
"tapConnectProductCode": null, "tapConnectProductCode": null,
"productName": "MaxTestPOST-21-okt-test-1 edited PUT", "productName": "Test OVPAY-2306",
"productDescription": "21-okt-test-1 edited PUT - reis met 90% korting gedurende de eerste F&F pilot!", "productDescription": "Test OVPAY-2306 (sellingPeriods in kindje verwijderen en later opnieuw weer kunnen toevoegen)",
"validityPeriod": null, "validityPeriod": {
"productTranslations": null, "validityPeriodId": 782,
"fromInclusive": "2025-12-31T23:00:00.000Z",
"toInclusive": "2026-03-30T22:00:00.000Z"
},
"productTranslations": [],
"allowedGboAgeProfiles": [],
"productOwner": { "productOwner": {
"productOwnerId": 1, "productOwnerId": 1,
"name": "Corneel Verstoep", "name": "Wie dit leest",
"organization": "HTM" "organization": "... is een aap."
}, },
"marketSegments": null, "marketSegments": [],
"customerSegments": null, "customerSegments": [],
"allowedGboAgeProfiles": null,
"productCategory": { "productCategory": {
"productCategoryId": 9, "productCategoryId": 1,
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
@@ -25,32 +35,10 @@
"requiredCustomerLevelId": 1, "requiredCustomerLevelId": 1,
"name": "guest" "name": "guest"
}, },
"requiredProducts": null, "requiredProducts": [],
"incompatibleProducts": null, "incompatibleProducts": [],
"mandatoryCustomerDataItems": [ "mandatoryCustomerDataItems": [],
{ "requiredGboPersonalAttributes": [],
"mandatoryCustomerDataItemId": 4,
"customerDataItem": "emailAddress"
},
{
"mandatoryCustomerDataItemId": 5,
"customerDataItem": "address"
}
],
"requiredGboPersonalAttributes": [
{
"requiredGboPersonalAttributeId": 1,
"name": "NAME"
},
{
"requiredGboPersonalAttributeId": 2,
"name": "BIRTHDATE"
},
{
"requiredGboPersonalAttributeId": 3,
"name": "PHOTO"
}
],
"tokenTypes": [ "tokenTypes": [
{ {
"tokenTypeId": 1, "tokenTypeId": 1,
@@ -61,72 +49,36 @@
"paymentMomentId": 1, "paymentMomentId": 1,
"name": "prepaid" "name": "prepaid"
}, },
"serviceOptions": null, "serviceOptions": [
"validityDuration": "P7D", {
"maxStartInFutureDuration": "P6W", "serviceOptionId": 4,
"isRenewable": false, "action": "cancel_notAllowed",
"description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)"
},
{
"serviceOptionId": 10,
"action": "refund_notAllowed",
"description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)"
}
],
"validityDuration": "P1W",
"maxStartInFutureDuration": "P1W",
"isRenewable": null,
"sendInvoice": false, "sendInvoice": false,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", "imageReference": null,
"productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", "productPageUrl": null,
"termsUrl": "https://www.htm.nl/nog-onbekende-productvoorwaarden-pagina", "termsUrl": null,
"isSellableAtHtm": true, "isSellableAtHtm": true,
"needsSolvencyCheckConsumer": false, "needsSolvencyCheckConsumer": false,
"needsSolvencyCheckBusiness": false, "needsSolvencyCheckBusiness": false,
"sellingPeriods": [ "sellingPeriods": [
{ {
"sellingPeriodId": 240, "sellingPeriodId": 1382,
"fromInclusive": "2024-09-06T00:00:00.000+00:00", "fromInclusive": "2025-12-31T23:00:00.000Z",
"toInclusive": "2024-12-29T23:59:59.000+00:00", "toInclusive": "2026-03-30T22:00:00.000Z",
"salesTouchpoint": { "salesTouchpoint": {
"salesTouchpointId": 6, "salesTouchpointId": 3,
"name": "Service-engine", "name": "Website",
"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, "isActive": true,
"retailer": { "retailer": {
"retailerId": 1001, "retailerId": 1001,
@@ -139,64 +91,196 @@
"country": "Nederland", "country": "Nederland",
"emailAddress": "info@htm.nl", "emailAddress": "info@htm.nl",
"phoneNumber": "070 374 9002", "phoneNumber": "070 374 9002",
"taxId": null, "taxId": 572309345923,
"imageReference": "https://www.htm.nl/typo3conf/ext/htm_template/Resources/Public/img/logo.svg" "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg"
} }
}, },
"forbiddenPaymentMethods": [ "forbiddenPaymentMethods": [],
"sellingPrices": []
}
],
"purchasePrices": [],
"productVariants": [
{
"productId": 664,
"parentProductId": 663,
"layerInfo": {
"layerInfoId": null,
"choiceKey": null,
"choiceLabel": null,
"isCustomChoice": false
},
"fikoArticleNumber": null,
"gboPackageTemplateId": "30001",
"tapConnectProductCode": null,
"productName": "Losse week - Test OVPAY-2306",
"productDescription": "Test OVPAY-2306 (sellingPeriods in kindje verwijderen en later opnieuw weer kunnen toevoegen)",
"validityPeriod": {
"validityPeriodId": 783,
"fromInclusive": "2025-12-31T23:00:00.000Z",
"toInclusive": "2026-03-30T22:00:00.000Z"
},
"productTranslations": [],
"allowedGboAgeProfiles": [],
"productOwner": {
"productOwnerId": 1,
"name": "Wie dit leest",
"organization": "... is een aap."
},
"marketSegments": [],
"customerSegments": [],
"productCategory": {
"productCategoryId": 1,
"isTravelProduct": true,
"name": "Kortingsabonnement"
},
"requiredCustomerLevel": {
"requiredCustomerLevelId": 1,
"name": "guest"
},
"requiredProducts": [],
"incompatibleProducts": [],
"mandatoryCustomerDataItems": [],
"requiredGboPersonalAttributes": [],
"tokenTypes": [
{ {
"forbiddenPaymentMethodId": 2, "tokenTypeId": 1,
"name": "creditcard", "name": "EMV"
"issuer": "Visa"
} }
], ],
"sellingPrices": [ "paymentMoment": {
"paymentMomentId": 1,
"name": "prepaid"
},
"serviceOptions": [
{ {
"sellingPriceId": 320, "serviceOptionId": 4,
"taxCode": "V21", "action": "cancel_notAllowed",
"taxPercentage": 21.0000, "description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)"
"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, "serviceOptionId": 10,
"taxCode": "V21", "action": "refund_notAllowed",
"taxPercentage": 21.0000, "description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)"
"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
} }
] ],
} "validityDuration": "P1W",
], "maxStartInFutureDuration": "P1W",
"purchasePrices": [ "isRenewable": false,
{ "sendInvoice": false,
"purchasePriceId": 184, "imageReference": null,
"taxCode": "V21", "productPageUrl": null,
"taxPercentage": 21.0000, "termsUrl": null,
"amountExclTax": 0, "isSellableAtHtm": true,
"amountInclTax": 0, "needsSolvencyCheckConsumer": false,
"fromInclusive": "2024-09-01T00:00:00.000+00:00", "needsSolvencyCheckBusiness": false,
"toInclusive": "2024-12-31T23:59:59.000+00:00" "sellingPeriods": [
} {
], "sellingPeriodId": 1384,
"auditTrail": [ "fromInclusive": "2025-12-31T23:00:00.000Z",
{ "toInclusive": "2026-03-30T22:00:00.000Z",
"auditTrailId": 228, "salesTouchpoint": {
"action": "update", "salesTouchpointId": 3,
"user": "api", "name": "Website",
"timestamp": "2024-10-21T09:00:30.410+00:00" "isActive": true,
"retailer": {
"retailerId": 1001,
"name": "HTM externe touchpoints",
"street": "Koningin Julianaplein",
"number": 10,
"numberAddition": null,
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "Nederland",
"emailAddress": "info@htm.nl",
"phoneNumber": "070 374 9002",
"taxId": 572309345923,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg"
}
},
"forbiddenPaymentMethods": [],
"sellingPrices": []
}
],
"purchasePrices": [],
"productVariants": []
}, },
{ {
"auditTrailId": 227, "productId": 665,
"action": "insert", "parentProductId": 663,
"user": "api", "layerInfo": {
"timestamp": "2024-10-21T08:58:39.237+00:00" "layerInfoId": null,
"choiceKey": null,
"choiceLabel": null,
"isCustomChoice": false
},
"fikoArticleNumber": null,
"gboPackageTemplateId": "30001",
"tapConnectProductCode": null,
"productName": "Doorlopend - Test OVPAY-2306",
"productDescription": "Test OVPAY-2306 (sellingPeriods in kindje verwijderen en later opnieuw weer kunnen toevoegen)",
"validityPeriod": {
"validityPeriodId": 784,
"fromInclusive": "2025-12-31T23:00:00.000Z",
"toInclusive": "2026-03-30T22:00:00.000Z"
},
"productTranslations": [],
"allowedGboAgeProfiles": [],
"productOwner": {
"productOwnerId": 1,
"name": "Wie dit leest",
"organization": "... is een aap."
},
"marketSegments": [],
"customerSegments": [],
"productCategory": {
"productCategoryId": 1,
"isTravelProduct": true,
"name": "Kortingsabonnement"
},
"requiredCustomerLevel": {
"requiredCustomerLevelId": 1,
"name": "guest"
},
"requiredProducts": [],
"incompatibleProducts": [],
"mandatoryCustomerDataItems": [],
"requiredGboPersonalAttributes": [],
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"paymentMoment": {
"paymentMomentId": 1,
"name": "prepaid"
},
"serviceOptions": [
{
"serviceOptionId": 4,
"action": "cancel_notAllowed",
"description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)"
},
{
"serviceOptionId": 10,
"action": "refund_notAllowed",
"description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)"
}
],
"validityDuration": "P1W",
"maxStartInFutureDuration": "P1W",
"isRenewable": true,
"sendInvoice": false,
"imageReference": null,
"productPageUrl": null,
"termsUrl": null,
"isSellableAtHtm": true,
"needsSolvencyCheckConsumer": false,
"needsSolvencyCheckBusiness": false,
"sellingPeriods": [],
"purchasePrices": [],
"productVariants": []
} }
] ]
} }
+43 -14
View File
@@ -17,10 +17,10 @@ paths:
description: > description: >
Create a claim by sending a JSON as specified in the schema. By Create a claim by sending a JSON as specified in the schema. By
specifying the chipcardnumber under 'chipkaart', specifying the chipcardnumber under 'chipkaart',
a claim for OV chipcard will be sent to the OVC API. If no
a claim for OV chipcard will be send to the OVC API. If no chipcardnumber is specified under 'chipkaart', a claim for EMV/OV-pas is sent
chipcardnumber is specified under 'chipkaart', a claim for EMV is send to Mendix, where it can be handled according to the fields present
to mendix. (serviceRefId + totaalbedrag or ovPasNumber + verificationCode)
parameters: [] parameters: []
requestBody: requestBody:
content: content:
@@ -47,8 +47,6 @@ paths:
toelichting: string toelichting: string
lijn: '1' lijn: '1'
vervoertype: '1' vervoertype: '1'
serviceRefId: '1'
Totaalbedrag: 0
EMV: EMV:
value: value:
aankomsthalte: '1' aankomsthalte: '1'
@@ -67,8 +65,28 @@ paths:
toelichting: string toelichting: string
lijn: '1' lijn: '1'
vervoertype: '1' vervoertype: '1'
serviceRefId: '1' serviceRefId: 'NLOV1234567ABCDEFG'
Totaalbedrag: 0 totaalbedrag: 3.14
OV-pas:
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'
ovPasNumber: '63AW974'
verificationCode: '2FQ8'
responses: responses:
'200': '200':
description: ok description: ok
@@ -103,18 +121,19 @@ paths:
examples: examples:
EMV: EMV:
value: value:
emailAddress: 'j.beek@htm.nl' emailAddress: 'stasjo@htm.nl'
orderNumber: 'ORD1000046' orderNumber: 'ORD1000046'
serviceReferenceId: 'NLOVA5BCD124H3Z21X' serviceReferenceId: 'NLOVA5BCD124H3Z21X'
amount: 2305 amount: 2305
iban: 'NL98INGB0003856625' iban: 'NL98INGB0003856625'
orderDate: '2025-01-13' orderDate: '2025-01-13'
productName: 'HTM 20% korting' productName: 'HTM 20% korting'
OVpas: OV-pas:
value: value:
emailAddress: 'j.beek@htm.nl' emailAddress: 'stasjo@htm.nl'
orderNumber: 'ORD1000046' orderNumber: 'ORD1000046'
ovpasNumber: '63AW974' ovpasNumber: '63AW974'
verificationCode: '2FQ8'
iban: 'NL98INGB0003856625' iban: 'NL98INGB0003856625'
orderDate: '2025-01-13' orderDate: '2025-01-13'
productName: 'HTM 20% korting' productName: 'HTM 20% korting'
@@ -181,7 +200,7 @@ components:
iban: iban:
type: string type: string
description: String of length between 15 en 32 characters description: String of length between 15 en 32 characters
example: '1234123412341234' example: NL98INGB0003856625
naam: naam:
type: string type: string
emailadres: emailadres:
@@ -201,9 +220,16 @@ components:
type: string type: string
serviceRefId: serviceRefId:
type: string type: string
Totaalbedrag: example: NLOV1234567ABCDEFG
totaalbedrag:
type: number type: number
format: float format: float
ovPasNumber:
type: string
example: 63AW974
verificationCode:
type: string
example: 2FQ8
refundsEntity: refundsEntity:
required: required:
- emailAddress - emailAddress
@@ -213,7 +239,7 @@ components:
emailAddress: emailAddress:
type: string type: string
format: email format: email
example: j.beek@htm.nl example: stasjo@htm.nl
orderNumber: orderNumber:
type: string type: string
example: ORD1000046 example: ORD1000046
@@ -226,6 +252,9 @@ components:
ovpasNumber: ovpasNumber:
type: string type: string
example: 63AW974 example: 63AW974
verificationCode:
type: string
example: 2FQ8
iban: iban:
type: string type: string
example: NL00RABO000001337 example: NL00RABO000001337
+449 -14
View File
@@ -386,10 +386,10 @@ paths:
"refundAmount": 2489, "refundAmount": 2489,
"refundMethods": ["creditInvoice", "iDeal"], "refundMethods": ["creditInvoice", "iDeal"],
} }
Unsuccesful validation: Unsuccessful validation:
summary: Unsuccesful validation summary: Unsuccessful validation
description: | description: |
Unsuccesful validation. The response contains the error message. Unsuccessful validation. The response contains the error message.
value: value:
{ {
"validationResult": false, "validationResult": false,
@@ -574,6 +574,267 @@ paths:
}, },
}, },
} }
/contracts/{uuid}/changemoments:
parameters:
- in: header
name: X-HTM-JWT-AUTH-HEADER
schema:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
required: true
description: The JWT of the logged in customer.
- in: path
name: uuid
schema:
type: string
format: uuid
example: 9e224750-3065-471d-af57-85b9cffa7c89
required: true
description: The id of the contract to process.
get:
summary: Get all change moments for a given contract.
description: Get all change moments for a given contract.
tags:
- SE Contract Changes v2
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
All change moments of a contract:
summary: All change moments of a contract
description: |
All change moments of a contract. The response contains the
allowed change moments for the current contract term.
value:
{
"changeMoment": "termBound",
"termDuration": "P1M",
"billingDay": 18,
"changeFrom": "2024-08-10T00:00:00",
"changeUntil": "2024-08-10T03:59:59",
}
/contracts/{uuid}/changevalidation:
parameters:
- in: header
name: X-HTM-JWT-AUTH-HEADER
schema:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
required: true
description: The JWT of the logged in customer.
- in: path
name: uuid
schema:
type: string
format: uuid
example: 9e224750-3065-471d-af57-85b9cffa7c89
required: true
description: The id of the contract to process.
post:
summary: Validate a change for a given contract.
description: Validate a change for a given contract.
tags:
- SE Contract Changes v2
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Validate a change to another product:
summary: Validate a change to another product
description: |
Validate a change to another product. The response contains the allowed change moments for the current contract term.
value: { "productId": 124, "startDate": "2025-10-08" }
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Successfully validated change:
summary: Successfully validated change
description: |
Successfully validated a change. The response contains the allowed change moments for the current contract term.
value:
{
"validationResult": true,
"validationMessage": "",
"contract":
{
"contractId": "15b43d9b-367a-4952-87f6-3e0fa902486f",
"contractNumber": "D123456",
"customerProfileId": 42,
"orderId": "eb3d08f7-7feb-4f31-9f5b-daa634e51f48",
"orderLineId": "52efbbfc-8c28-4016-9ece-dc3ef9a70bd8",
"touchpointId": 2,
"contractStatus":
{ "contractStatusId": 2, "name": "active" },
"productId": 1,
"productName": "HTM Maand 20% korting",
"termDuration": "P0Y1M0D",
"billingDay": 15,
"highestInvoiceTerm": 1,
"created": "2024-08-01 15:01:00.000",
"ovPayTokenId": 1337,
"contractVersions":
[
{
"contractVersionId": 2,
"termsAndConditions": "https://www.htm.nl",
"productId": 124,
"productName": "Regiovrij Regio Centrum",
"taxCode": "V9",
"taxPercentage": 9.0,
"termAmountInclTax": 12,
"start": "2025-10-08",
},
{
"contractVersionId": 1,
"termsAndConditions": "https://www.htm.nl",
"productId": 123,
"productName": "Regiovrij Regio Zuid",
"taxCode": "V9",
"taxPercentage": 9.0,
"termAmountInclTax": 10,
"start": "2025-01-08",
"end": "2025-10-07",
},
],
},
}
Unsuccessful validation:
summary: Unsuccessful validation
description: |
Unsuccessful validation. The response contains the error message.
value:
{
"validationResult": false,
"validationMessage": "Contract status is not ACTIVE",
"contract": null,
}
/contracts/{uuid}/change:
parameters:
- in: header
name: X-HTM-JWT-AUTH-HEADER
schema:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
required: true
description: The JWT of the logged in customer.
- in: path
name: uuid
schema:
type: string
format: uuid
example: 9e224750-3065-471d-af57-85b9cffa7c89
required: true
description: The id of the contract to process.
post:
summary: Change a contract.
description: Change a contract.
tags:
- SE Contract Changes v2
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Change to another product:
summary: Change to another product
description: |
Change to another product. The response contains the details of the changed contract.
value: { "productId": 124, "startDate": "2025-10-08" }
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Successfully changed contract:
summary: Successfully changed contract
description: |
Successfully changed a contract. The response contains the details of the changed contract.
value:
{
"contractId": "15b43d9b-367a-4952-87f6-3e0fa902486f",
"contractNumber": "D123456",
"customerProfileId": 42,
"orderId": "eb3d08f7-7feb-4f31-9f5b-daa634e51f48",
"orderLineId": "52efbbfc-8c28-4016-9ece-dc3ef9a70bd8",
"touchpointId": 2,
"contractStatus":
{ "contractStatusId": 2, "name": "active" },
"productId": 1,
"productName": "HTM Maand 20% korting",
"termDuration": "P0Y1M0D",
"billingDay": 15,
"highestInvoiceTerm": 1,
"created": "2024-08-01 15:01:00.000",
"ovPayTokenId": 1337,
"contractVersions":
[
{
"contractVersionId": 2,
"termsAndConditions": "https://www.htm.nl",
"productId": 124,
"productName": "Regiovrij Regio Centrum",
"taxCode": "V9",
"taxPercentage": 9.0,
"termAmountInclTax": 12,
"start": "2025-10-08",
},
{
"contractVersionId": 1,
"termsAndConditions": "https://www.htm.nl",
"productId": 123,
"productName": "Regiovrij Regio Zuid",
"taxCode": "V9",
"taxPercentage": 9.0,
"termAmountInclTax": 10,
"start": "2025-01-08",
"end": "2025-10-07",
},
],
}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Unsuccessful change due to invalid productId:
summary: Unsuccessful change due to invalid productId
description: |
Unsuccessful change due to invalid productId. The response contains the error message.
value:
{
"type": "https://htm.nl/api/v1/probs/validationerror",
"title": "Your request is not valid.",
"detail": "The chosen parameters for this contract change are not valid.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"code": "CHANGE_DATE_IN_THE_PAST",
"detail": "Chosen date of contract change is in the past. This is not alllowed.",
"path": "$.startDate",
"parameter": null,
},
],
}
/contractpayments: /contractpayments:
parameters: parameters:
- in: header - in: header
@@ -597,9 +858,13 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
List all contract payments for a single debtor: Empty list:
summary: List all contract payments for a single debtor summary: Empty list
description: List all contract payments for single debtor with debtor number 'D123456'. description: List all contract payments for a debtor with no payments.
value: { "contractPayments": [] }
Successful direct debit:
summary: Successful direct debit
description: One payment for a debtor with a successful direct debit.
value: value:
{ {
"contractPayments": "contractPayments":
@@ -607,8 +872,133 @@ paths:
{ {
"paymentId": "151845776", "paymentId": "151845776",
"totalAmount": "26.62", "totalAmount": "26.62",
"paymentMethod": "Twikey", "paymentMethod": "Automatische incasso",
"paymentDate": "2024-09-12", "paymentDate": "2024-09-12",
"iban": "NL25INGB******1337",
"invoice":
{
"invoiceId": "147722263",
"invoiceNumber": "F2024-0001",
"description": "HTM Maandkorting 20%",
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
},
"_links":
{
"get_contractdetails":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
"method": "GET",
},
},
},
],
}
Direct debit reversal:
summary: Direct debit reversal
description: One payment for a debtor with a reversed direct debit.
value:
{
"contractPayments":
[
{
"paymentId": "151845776",
"totalAmount": "-26.62",
"paymentMethod": "Stornering",
"paymentDate": "2024-09-12",
"iban": "NL25INGB******1337",
"invoice":
{
"invoiceId": "147722263",
"invoiceNumber": "F2024-0001",
"description": "HTM Maandkorting 20%",
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
},
"_links":
{
"get_contractdetails":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
"method": "GET",
},
},
},
],
}
iDEAL payment:
summary: iDEAL payment
description: One payment for a debtor with an iDEAL payment.
value:
{
"contractPayments":
[
{
"paymentId": "151845776",
"totalAmount": "26.62",
"paymentMethod": "iDEAL",
"paymentDate": "2024-09-12",
"iban": "NL25INGB******1337",
"invoice":
{
"invoiceId": "147722263",
"invoiceNumber": "F2024-0001",
"description": "HTM Maandkorting 20%",
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
},
"_links":
{
"get_contractdetails":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
"method": "GET",
},
},
},
],
}
Bank transfer:
summary: Bank transfer
description: One payment for a debtor with a bank transfer.
value:
{
"contractPayments":
[
{
"paymentId": "151845776",
"totalAmount": "26.62",
"paymentMethod": "Overboeking",
"paymentDate": "2024-09-12",
"iban": "NL25INGB******1337",
"invoice":
{
"invoiceId": "147722263",
"invoiceNumber": "F2024-0001",
"description": "HTM Maandkorting 20%",
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
},
"_links":
{
"get_contractdetails":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
"method": "GET",
},
},
},
],
}
List of four payments for one invoice:
summary: List of four payments for one invoice
description: Four payments for a debtor for one invoice; a direct debit, a direct debit reversal, a bank transfer and an iDEAL payment.
value:
{
"contractPayments":
[
{
"paymentId": "151845776",
"totalAmount": "26.62",
"paymentMethod": "Automatische incasso",
"paymentDate": "2024-09-12",
"iban": "NL25INGB******1337",
"invoice": "invoice":
{ {
"invoiceId": "147722263", "invoiceId": "147722263",
@@ -626,22 +1016,67 @@ paths:
}, },
}, },
{ {
"paymentId": "151845851", "paymentId": "151845776",
"totalAmount": "45.21", "totalAmount": "-26.62",
"paymentMethod": "Twikey", "paymentMethod": "Stornering",
"paymentDate": "2024-09-12", "paymentDate": "2024-09-12",
"iban": "NL25INGB******1337",
"invoice": "invoice":
{ {
"invoiceId": "147722266", "invoiceId": "147722263",
"invoiceNumber": "F2024-0002", "invoiceNumber": "F2024-0001",
"description": "HTM Maandkorting 20%", "description": "HTM Maandkorting 20%",
"publicLink": "https://factuurinzien.nl/d/ddb245d6df67999eca48c4a71b5661b93038e20a/i/dp5h1i5cuu94nopiolkdst3u17vkmzo", "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
}, },
"_links": "_links":
{ {
"get_contractdetails": "get_contractdetails":
{ {
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/7b2f8c1a-3d9d-4c2d-960e-4471e8e28b6a", "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
"method": "GET",
},
},
},
{
"paymentId": "151845777",
"totalAmount": "10.00",
"paymentMethod": "Overboeking",
"paymentDate": "2024-09-13",
"iban": "NL25INGB******1337",
"invoice":
{
"invoiceId": "147722263",
"invoiceNumber": "F2024-0001",
"description": "HTM Maandkorting 20%",
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
},
"_links":
{
"get_contractdetails":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
"method": "GET",
},
},
},
{
"paymentId": "151845778",
"totalAmount": "16.62",
"paymentMethod": "iDEAL",
"paymentDate": "2024-09-14",
"iban": "NL25INGB******1337",
"invoice":
{
"invoiceId": "147722263",
"invoiceNumber": "F2024-0001",
"description": "HTM Maandkorting 20%",
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
},
"_links":
{
"get_contractdetails":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
"method": "GET", "method": "GET",
}, },
}, },
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
+24 -157
View File
@@ -243,7 +243,7 @@ paths:
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
isEmailVerified: True isEmailVerified: false
addresses: addresses:
- addressId: 1 - addressId: 1
street: mystreet street: mystreet
@@ -332,14 +332,6 @@ paths:
user: user user: user
timestamp: "2023-10-20T17:05:52.000+02:00" timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links:
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1",
"method": "GET",
},
}
- customerProfileId: 12 - customerProfileId: 12
customerNumber: 1000002 customerNumber: 1000002
debtorNumber: DB100121 debtorNumber: DB100121
@@ -377,7 +369,7 @@ paths:
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
isEmailVerified: False isEmailVerified: false
address: address:
- addressId: 1 - addressId: 1
street: mystreet street: mystreet
@@ -467,32 +459,7 @@ paths:
user: user user: user
timestamp: "2023-10-20T17:05:52.000+02:00" timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links: href: "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20&limit=20"
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=12",
"method": "GET",
},
}
_links:
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20",
"method": "GET",
},
"prev":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers",
"method": "GET",
},
"next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=40",
"method": "GET",
},
}
getCustomerActive: getCustomerActive:
summary: getCustomerActive summary: getCustomerActive
description: >- description: >-
@@ -526,7 +493,7 @@ paths:
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
isEmailVerified: False isEmailVerified: false
addresses: addresses:
- addressId: 1 - addressId: 1
street: mystreet street: mystreet
@@ -615,22 +582,7 @@ paths:
user: user user: user
timestamp: "2023-10-20T17:05:52.000+02:00" timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links: href: https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20&limit=20
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1",
"method": "GET",
},
}
_links:
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers",
"method": "GET",
},
}
getCustomerBlocked: getCustomerBlocked:
summary: getCustomerBlocked summary: getCustomerBlocked
description: >- description: >-
@@ -669,7 +621,7 @@ paths:
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
isEmailVerified: True isEmailVerified: false
addresses: addresses:
- addressId: 1 - addressId: 1
street: mystreet street: mystreet
@@ -758,22 +710,7 @@ paths:
user: user user: user
timestamp: "2023-10-20T17:05:52.000+02:00" timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links: href: https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20&limit=20
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1",
"method": "GET",
},
}
_links:
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers",
"method": "GET",
},
}
400: 400:
description: Bad Request description: Bad Request
content: content:
@@ -835,7 +772,7 @@ paths:
suffix: jr suffix: jr
dateOfBirth: "1970-01-01" dateOfBirth: "1970-01-01"
emailAddress: j.jansen@hatseflats.nl emailAddress: j.jansen@hatseflats.nl
isEmailVerified: False isEmailVerified: false
addresses: addresses:
- street: Laan van Meerdervoort - street: Laan van Meerdervoort
houseNumber: 5 houseNumber: 5
@@ -934,7 +871,7 @@ paths:
suffix: "jr", suffix: "jr",
dateOfBirth: "1970-01-01", dateOfBirth: "1970-01-01",
emailAddress: "TEST@TEST1.NL", emailAddress: "TEST@TEST1.NL",
isEmailVerified: False isEmailVerified: false
} }
updateCompleteEntity: updateCompleteEntity:
value: value:
@@ -946,7 +883,7 @@ paths:
suffix: "jr", suffix: "jr",
dateOfBirth: "1970-01-01", dateOfBirth: "1970-01-01",
emailAddress: "TEST@TEST1.NL", emailAddress: "TEST@TEST1.NL",
isEmailVerified: True isEmailVerified: false
} }
required: true required: true
responses: responses:
@@ -1303,7 +1240,6 @@ paths:
name: externalDeviceId name: externalDeviceId
schema: schema:
type: string type: string
format: uuid
example: c5545584-04af-4c60-a955-d6a70baab848 example: c5545584-04af-4c60-a955-d6a70baab848
required: false required: false
description: The external id of the device. description: The external id of the device.
@@ -1439,13 +1375,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/getDevices" $ref: "#/components/schemas/patchDeviceResponse"
examples:
updateDeviceResponse:
value:
deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
alias: "iPhone zakelijk"
security: security:
- default: [] - default: []
@@ -1608,24 +1538,7 @@ paths:
"replacedByTokenId": 12, "replacedByTokenId": 12,
}, },
], ],
"_links": "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=20&limit=20"
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=20",
"method": "GET",
},
"prev":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens",
"method": "GET",
},
"next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=40",
"method": "GET",
},
},
} }
/customers/{customerProfileId}/ovpaytokens: /customers/{customerProfileId}/ovpaytokens:
post: post:
@@ -1944,9 +1857,10 @@ paths:
"created": "2024-10-20T17:05:52.000", "created": "2024-10-20T17:05:52.000",
}, },
], ],
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/billingInformations?offset=20&limit=20"
} }
getBillingInformationSingleSpecificCustomer: getBillingInformationSingleSpecificCustomer:
summary: Get singel billing information entity for a specific customers summary: Get single billing information entity for a specific customers
description: >- description: >-
Found one billing information matching the search parameters Found one billing information matching the search parameters
value: value:
@@ -2136,59 +2050,7 @@ paths:
"updateTimestamp": "2024-03-22T08:55:00", "updateTimestamp": "2024-03-22T08:55:00",
}, },
], ],
"_links": "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20&limit=20"
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates",
"method": "GET",
},
"next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20",
"method": "GET",
},
},
}
getDirectDebitMandateWithNextPageandPreviousPage:
value:
{
"directDebitMandates":
[
{
"directDebitMandateId": 71,
"customerProfileId": 12,
"billingInformationId": 51,
"directDebitMandateType":
{
"directDebitMandateTypeId": 1,
"name": "import",
"description": "import",
},
"created": "2024-03-22T08:55:00",
"mandateReference": "CORE01",
"mandateState": "SIGNED",
"updateTimestamp": "2024-03-22T08:55:00",
},
],
"_links":
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20",
"method": "GET",
},
"prev":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates",
"method": "GET",
},
"next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=40",
"method": "GET",
},
},
} }
/billingInformation/{billingInformationId}/directdebitmandates: /billingInformation/{billingInformationId}/directdebitmandates:
post: post:
@@ -2480,7 +2342,6 @@ components:
format: uuid format: uuid
externalDeviceId: externalDeviceId:
type: string type: string
format: uuid
alias: alias:
type: string type: string
required: required:
@@ -2599,7 +2460,6 @@ components:
properties: properties:
externalDeviceId: externalDeviceId:
type: string type: string
format: uuid
alias: alias:
type: string type: string
defaultCustomerProfileResponse: defaultCustomerProfileResponse:
@@ -2846,7 +2706,7 @@ components:
emailAddress: emailAddress:
type: string type: string
isEmailVerified: isEmailVerified:
type: string type: boolean
postOvPayTokenResponse: postOvPayTokenResponse:
type: object type: object
properties: properties:
@@ -2860,6 +2720,14 @@ components:
type: array type: array
items: items:
$ref: "#/components/schemas/getDeviceEntity" $ref: "#/components/schemas/getDeviceEntity"
patchDeviceResponse:
type: object
properties:
deviceId:
type: string
format: uuid
example: "b2c8a8c6-3d1c-4b6b-8f8d-3a6a1b6a1b6a"
getDeviceEntity: getDeviceEntity:
type: object type: object
properties: properties:
@@ -2870,7 +2738,6 @@ components:
type: integer type: integer
externalDeviceId: externalDeviceId:
type: string type: string
format: uuid
alias: alias:
type: string type: string
required: required:
File diff suppressed because it is too large. Load diff
@@ -417,38 +417,56 @@ paths:
example: example:
Entries: Entries:
phoneTypes: phoneTypes:
- name: mobile - name: Mobiel
id: 1 id: 1
- name: fixed line - name: Thuis
id: 2 id: 2
- name: Ouders
id: 3
- name: Bewindvoerder
id: 4
- name: Home
id: 5
- name: Mobile
id: 6
- name: Work
id: 7
- name: Noodtelefoon
id: 8
addressTypes: addressTypes:
- name: home - name: Shipping
id: 1 id: 1
- name: office - name: Billing
id: 2 id: 2
customerStatuses: customerStatuses:
- name: active - name: Inactive
id: 1 id: 1
- name: blocked - name: Active
id: 2 id: 2
- name: inactive - name: Blocked
id: 3 id: 3
- name: new - name: Frozen
id: 4 id: 4
- name: Cleared
id: 5
tokenTypes: tokenTypes:
- name: Debit card - name: EMV
id: 1 id: 1
- name: Credit card
id: 2
- name: OVPas physical - name: OVPas physical
id: 3 id: 2
- name: OVPas digital - name: OVPas digital
id: 4 id: 3
directDebitMandateTypes: directDebitMandateTypes:
- name: Paper Contract - name: Paper Contract
id: 1 id: 1
- name: PIN transaction - name: PIN transaction
id: 2 id: 2
- name: SEPA eMandate
id: 3
- name: Digital signature
id: 4
- name: IDEAL transaction
id: 5
tokenStatuses: tokenStatuses:
- name: Expired - name: Expired
id: 1 id: 1
File diff suppressed because it is too large. Load diff
+46 -40
View File
@@ -46,6 +46,7 @@ paths:
- occurredOn - occurredOn
- type - type
- articleNumber - articleNumber
- paymentMethod
- status - status
- aggregationReference - aggregationReference
- accountingSystemReference - accountingSystemReference
@@ -76,6 +77,7 @@ paths:
- occurredOn - occurredOn
- type - type
- articleNumber - articleNumber
- paymentMethod
- status - status
- aggregationReference - aggregationReference
- accountingSystemReference - accountingSystemReference
@@ -115,6 +117,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
status: created status: created
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -134,6 +137,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: failed status: failed
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -153,6 +157,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: returned to src status: returned to src
aggregationReference: FIKO-171f40609e aggregationReference: FIKO-171f40609e
accountingSystemReference: null accountingSystemReference: null
@@ -172,6 +177,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: returned to trx-db status: returned to trx-db
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -191,6 +197,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: re-entered status: re-entered
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -210,6 +217,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "1737" articleNumber: "1737"
paymentMethod: iDEAL
status: succeeded status: succeeded
aggregationReference: FIKO-6a4fca8cd6 aggregationReference: FIKO-6a4fca8cd6
accountingSystemReference: U4F-123456 accountingSystemReference: U4F-123456
@@ -248,6 +256,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
Add multiple transaction items: Add multiple transaction items:
summary: Add multiple transaction items summary: Add multiple transaction items
description: Add multiple transaction items of type sales. description: Add multiple transaction items of type sales.
@@ -266,6 +275,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
- transactionType: sales - transactionType: sales
sourceName: HTM-website sourceName: HTM-website
transactionId: "1001237" transactionId: "1001237"
@@ -279,6 +289,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
responses: responses:
"202": "202":
description: Accepted description: Accepted
@@ -1447,6 +1458,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: tax lineType: tax
lineSense: credit lineSense: credit
department: 140 department: 140
@@ -1469,6 +1481,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: analysis lineType: analysis
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1491,6 +1504,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: true isContraAccount: true
paymentMethod: iDEAL
lineType: analysis lineType: analysis
lineSense: debet lineSense: debet
department: 140 department: 140
@@ -1726,6 +1740,7 @@ paths:
- identifyingFieldValue - identifyingFieldValue
- concessionId - concessionId
- isContraAccount - isContraAccount
- paymentMethod
- lineType - lineType
- lineSense - lineSense
- department - department
@@ -1759,6 +1774,7 @@ paths:
- identifyingFieldValue - identifyingFieldValue
- concessionId - concessionId
- isContraAccount - isContraAccount
- paymentMethod
- lineType - lineType
- lineSense - lineSense
- department - department
@@ -1810,6 +1826,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1832,6 +1849,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1863,6 +1881,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1884,6 +1903,8 @@ paths:
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2 sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1906,6 +1927,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1928,6 +1950,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1950,6 +1973,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: tax lineType: tax
lineSense: credit lineSense: credit
department: 140 department: 140
@@ -1972,6 +1996,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: true isContraAccount: true
paymentMethod: iDEAL
lineType: analysis lineType: analysis
lineSense: credit lineSense: credit
department: 220 department: 220
@@ -2021,6 +2046,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -3284,6 +3310,10 @@ components:
type: string type: string
nullable: true nullable: true
example: "4031" example: "4031"
paymentMethod:
type: string
nullable: true
example: iDEAL
status: status:
type: string type: string
enum: enum:
@@ -3375,6 +3405,10 @@ components:
type: string type: string
nullable: true nullable: true
example: "4031" example: "4031"
paymentMethod:
type: string
nullable: true
example: iDEAL
required: required:
- sourceName - sourceName
- transactionType - transactionType
@@ -3458,46 +3492,6 @@ components:
TransactionItemsPatchRequestBody: TransactionItemsPatchRequestBody:
type: object type: object
properties: properties:
name:
type: string
nullable: true
example: HTM Maandkorting 20%
quantity:
type: integer
nullable: true
example: 1
taxCode:
type: string
nullable: true
example: V21
amountExclTax:
type: integer
nullable: true
example: 100
amountInclTax:
type: integer
nullable: true
example: 121
amountTax:
type: integer
nullable: true
example: 21
occurredOn:
type: string
nullable: true
format: date-time
example: 2024-10-04T00:00:00Z
type:
type: string
nullable: true
enum:
- debit
- credit
example: debit
articleNumber:
type: string
nullable: true
example: 4031
status: status:
type: string type: string
enum: enum:
@@ -4098,6 +4092,10 @@ components:
isContraAccount: isContraAccount:
type: boolean type: boolean
example: false example: false
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType: lineType:
type: string type: string
enum: enum:
@@ -4215,6 +4213,10 @@ components:
isContraAccount: isContraAccount:
type: boolean type: boolean
example: false example: false
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType: lineType:
type: string type: string
enum: enum:
@@ -4304,6 +4306,10 @@ components:
type: boolean type: boolean
example: false example: false
nullable: true nullable: true
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType: lineType:
type: string type: string
enum: enum:
+34 -50
View File
@@ -57,12 +57,12 @@ paths:
required: false required: false
description: The id of the touch point where the order was initiated. description: The id of the touch point where the order was initiated.
- in: query - in: query
name: deviceId name: externalDeviceId
schema: schema:
type: string type: string
example: "7a28bd54-7ca9-499a-a722-d15ab858ab99" example: "7a28bd54-7ca9-499a-a722-d15ab858ab99"
required: false required: false
description: The id of the device used to place the order. description: The external id of the device used to place the order.
- in: query - in: query
name: languageId name: languageId
schema: schema:
@@ -140,7 +140,7 @@ paths:
"touchPointId": 1, "touchPointId": 1,
"name": "Perplex" "name": "Perplex"
}, },
"deviceId": "42e77532-d831-41da-b07a-7edb9bb7f004", "externalDeviceId": "42e77532-d831-41da-b07a-7edb9bb7f004",
"language": "language":
{ {
"languageId": 1, "languageId": 1,
@@ -170,46 +170,24 @@ paths:
"description": "Betaling in behandeling", "description": "Betaling in behandeling",
}, },
], ],
"order_OrderVouchers": [ "orderVouchers": [
{ {
"order_OrderVoucherId": "399bd3b3-9721-4f09-a936-d64637de1621", "orderVoucherId": "399bd3b3-9721-4f09-a936-d64637de1621",
"issuedVoucher":{ "issuedVoucher":{
"issuedVoucherId": "a0996218-bc5e-4826-9020-cda98a32838d", "issuedVoucherId": "a0996218-bc5e-4826-9020-cda98a32838d",
"voucherCode": "Voucher1234", "voucherCode": "Voucher1234",
"voucherStatusInstances": "purchasedProductId": 31,
[
{
"voucherStatus":
{
"voucherStatusId": 2,
"name": "issued"
},
"createdOn": "2025-11-22T13:00:00"
}
],
"productId": 31,
"fromInclusive": "2025-03-22T08:55:00", "fromInclusive": "2025-03-22T08:55:00",
"untillInclusive": "2026-03-22T08:55:00" "untillInclusive": "2026-03-22T08:55:00"
}, },
"orderLineId": null "orderLineId": null
}, },
{ {
"order_OrderVoucherId": "f6c7ac42-1811-4e4d-82af-53e18fe16110", "orderVoucherId": "f6c7ac42-1811-4e4d-82af-53e18fe16110",
"issuedVoucher":{ "issuedVoucher":{
"issuedVoucherId": "54668baf-4905-4e9a-af02-09c170f295ed", "issuedVoucherId": "54668baf-4905-4e9a-af02-09c170f295ed",
"voucherCode": "Voucher124", "voucherCode": "Voucher124",
"voucherStatusInstances": "purchasedProductId": 35,
[
{
"voucherStatus":
{
"voucherStatusId": 2,
"name": "issued"
},
"createdOn": "2025-11-22T13:00:00"
}
],
"productId": 35,
"fromInclusive": "2025-03-22T08:55:00", "fromInclusive": "2025-03-22T08:55:00",
"untillInclusive": "2026-03-22T08:55:00" "untillInclusive": "2026-03-22T08:55:00"
}, },
@@ -345,7 +323,7 @@ paths:
{ {
"orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893", "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
"addressType": "addressType":
{ "addressTypeId": 3, "name": "Billing" }, { "addressTypeId": 2, "name": "Billing" },
"street": "Kon. Julianaplein", "street": "Kon. Julianaplein",
"houseNumber": 10, "houseNumber": 10,
"houseNumberSuffix": "a", "houseNumberSuffix": "a",
@@ -395,7 +373,7 @@ paths:
"customerProfileId": 1337, "customerProfileId": 1337,
"totalAmount": 121, "totalAmount": 121,
"touchPointId": 1, "touchPointId": 1,
"deviceId": "b8ca9fdf-0bb9-4e49-b48d-41e395563377", "externalDeviceId": "b8ca9fdf-0bb9-4e49-b48d-41e395563377",
"languageId": 1, "languageId": 1,
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"order_OrderStatus": "order_OrderStatus":
@@ -406,7 +384,7 @@ paths:
"description": "Concept order", "description": "Concept order",
}, },
], ],
"order_OrderVouchers": "orderVouchers":
[ [
{ {
"issuedVoucherId": "e81b2197-a6c2-45b6-9560-8ce8442e8604", "issuedVoucherId": "e81b2197-a6c2-45b6-9560-8ce8442e8604",
@@ -507,7 +485,7 @@ paths:
"touchPointId": 1, "touchPointId": 1,
"name": "Perplex" "name": "Perplex"
}, },
"deviceId": null, "externalDeviceId": null,
"language": "language":
{ {
"languageId": 1, "languageId": 1,
@@ -533,7 +511,7 @@ paths:
"description": "Betaling in behandeling", "description": "Betaling in behandeling",
}, },
], ],
"order_OrderVouchers": null, "orderVouchers": null,
"orderLines": "orderLines":
[ [
{ {
@@ -656,7 +634,7 @@ paths:
{ {
"orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893", "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
"addressType": "addressType":
{ "addressTypeId": 3, "name": "Billing" }, { "addressTypeId": 2, "name": "Billing" },
"street": "Kon. Julianaplein", "street": "Kon. Julianaplein",
"houseNumber": 10, "houseNumber": 10,
"houseNumberSuffix": "a", "houseNumberSuffix": "a",
@@ -680,7 +658,7 @@ paths:
example: example:
{ {
"customerProfileId": 1337, "customerProfileId": 1337,
"deviceId": "fe68e624-b75f-48ca-a179-d5f86a8ab7d5", "externalDeviceId": "fe68e624-b75f-48ca-a179-d5f86a8ab7d5",
"totalAmount": 121, "totalAmount": 121,
"languageId": 1, "languageId": 1,
"lastUpdatedOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00",
@@ -773,12 +751,12 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"order_orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066", "orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
} }
/ordervouchers: /ordervouchers:
parameters: parameters:
- in: query - in: query
name: order_OrderVoucherId name: orderVoucherId
schema: schema:
type: string type: string
format: uuid format: uuid
@@ -814,15 +792,22 @@ paths:
example: example:
[ [
{ {
"order_OrderVoucherId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50", "orderVoucherId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50",
"issuedVoucher":{
"issuedVoucherId": "54668baf-4905-4e9a-af02-09c170f295ed",
"voucherCode": "Voucher124",
"purchasedProductId": 35,
"fromInclusive": "2025-03-22T08:55:00",
"untillInclusive": "2026-03-22T08:55:00"
},
"orderId": "f59e4769-53a0-4156-8991-6f9119ba629f", "orderId": "f59e4769-53a0-4156-8991-6f9119ba629f",
"orderLineId": "eeb86071-4f59-405d-b2be-7d7a77044bfa" "orderLineId": "eeb86071-4f59-405d-b2be-7d7a77044bfa"
} }
] ]
/ordervouchers/{order_ordervoucherId}: /ordervouchers/{ordervoucherId}:
parameters: parameters:
- in: path - in: path
name: order_ordervoucherId name: ordervoucherId
schema: schema:
type: string type: string
format: uuid format: uuid
@@ -853,7 +838,7 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"order_orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066", "orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
} }
delete: delete:
summary: Delete an order voucher. summary: Delete an order voucher.
@@ -974,7 +959,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: examples:
Minimum orderline requestBody: Minimum orderline requestBody:
value: value:
{ {
@@ -1060,7 +1045,7 @@ paths:
"orderCustomerAddresses": "orderCustomerAddresses":
[ [
{ {
"addressTypeId": 3, "addressTypeId": 2,
"street": "Kon. Julianaplein", "street": "Kon. Julianaplein",
"houseNumber": 10, "houseNumber": 10,
"houseNumberSuffix": "a", "houseNumberSuffix": "a",
@@ -1998,7 +1983,6 @@ paths:
"touchPointId": 1, "touchPointId": 1,
"name": "Perplex" "name": "Perplex"
}, },
"deviceId": null,
"isRefund": false, "isRefund": false,
"htmPaymentReference": "HTM-1234", "htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234", "pspPaymentReference": "Buckaroo-1234",
@@ -2342,7 +2326,7 @@ paths:
{ {
"orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893", "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
"addressType": "addressType":
{ "addressTypeId": 3, "name": "Billing" }, { "addressTypeId": 2, "name": "Billing" },
"street": "Kon. Julianaplein", "street": "Kon. Julianaplein",
"houseNumber": 10, "houseNumber": 10,
"houseNumberSuffix": "a", "houseNumberSuffix": "a",
@@ -2412,7 +2396,7 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"addressTypeId": 3, "addressTypeId": 2,
"street": "Kon. Julianaplein", "street": "Kon. Julianaplein",
"houseNumber": 10, "houseNumber": 10,
"houseNumberSuffix": "a", "houseNumberSuffix": "a",
@@ -2462,7 +2446,7 @@ paths:
type: integer type: integer
explode: false explode: false
required: false required: false
description: Filter on possible types of addresses. 1 = Shipping, 3 = Billing. description: Filter on possible types of addresses. 1 = Shipping, 2 = Billing.
- in: query - in: query
name: street name: street
schema: schema:
@@ -2518,7 +2502,7 @@ paths:
"orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893", "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
"orderCustomerId": "540d8b7a-d626-443f-8f99-c24398604d7a", "orderCustomerId": "540d8b7a-d626-443f-8f99-c24398604d7a",
"orderId": "73cca95a-81d1-468f-a8bf-99b36367001a", "orderId": "73cca95a-81d1-468f-a8bf-99b36367001a",
"addressType": { "addressTypeId": 3, "name": "Billing" }, "addressType": { "addressTypeId": 2, "name": "Billing" },
"street": "Kon. Julianaplein", "street": "Kon. Julianaplein",
"houseNumber": 10, "houseNumber": 10,
"houseNumberSuffix": "a", "houseNumberSuffix": "a",
File diff suppressed because it is too large. Load diff
+15
View File
@@ -313,6 +313,7 @@ paths:
{ {
"productId": 24, "productId": 24,
"parentProductId": null, "parentProductId": null,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "30901", "gboPackageTemplateId": "30901",
@@ -429,6 +430,7 @@ paths:
{ {
"productId": 126, "productId": 126,
"parentProductId": null, "parentProductId": null,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 1, "layerInfoId": 1,
"choiceKey": "isRenewable", "choiceKey": "isRenewable",
@@ -537,6 +539,7 @@ paths:
{ {
"productId": 119, "productId": 119,
"parentProductId": 126, "parentProductId": 126,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001", "gboPackageTemplateId": "30001",
@@ -652,6 +655,7 @@ paths:
{ {
"productId": 120, "productId": 120,
"parentProductId": 126, "parentProductId": 126,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001", "gboPackageTemplateId": "30001",
@@ -779,6 +783,7 @@ paths:
{ {
"productId": 49, "productId": 49,
"parentProductId": null, "parentProductId": null,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 2, "layerInfoId": 2,
"choiceKey": "regio", "choiceKey": "regio",
@@ -926,6 +931,7 @@ paths:
{ {
"productId": 109, "productId": 109,
"parentProductId": 49, "parentProductId": 49,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 3, "layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles", "choiceKey": "allowedGboAgeProfiles",
@@ -1076,6 +1082,7 @@ paths:
{ {
"productId": 114, "productId": 114,
"parentProductId": 109, "parentProductId": 109,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 1, "layerInfoId": 1,
"choiceKey": "isRenewable", "choiceKey": "isRenewable",
@@ -1226,6 +1233,7 @@ paths:
{ {
"productId": 115, "productId": 115,
"parentProductId": 109, "parentProductId": 109,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 1, "layerInfoId": 1,
"choiceKey": "isRenewable", "choiceKey": "isRenewable",
@@ -1377,6 +1385,7 @@ paths:
{ {
"productId": 116, "productId": 116,
"parentProductId": 115, "parentProductId": 115,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615", "gboPackageTemplateId": "33615",
@@ -1526,6 +1535,7 @@ paths:
{ {
"productId": 117, "productId": 117,
"parentProductId": 115, "parentProductId": 115,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615", "gboPackageTemplateId": "33615",
@@ -1679,6 +1689,7 @@ paths:
{ {
"productId": 112, "productId": 112,
"parentProductId": 49, "parentProductId": 49,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 3, "layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles", "choiceKey": "allowedGboAgeProfiles",
@@ -2150,6 +2161,10 @@ components:
parentProductId: parentProductId:
type: integer type: integer
example: 1 example: 1
needsVoucher:
type: boolean
description: Indicates if the product needs a voucher (with this productId as requiredProductId) to be bought - if false, this is optional, but still allowed
example: false
layerInfo: layerInfo:
$ref: '#/components/schemas/LayerInfoResponse' $ref: '#/components/schemas/LayerInfoResponse'
fikoArticleNumber: fikoArticleNumber:
+15
View File
@@ -313,6 +313,7 @@ paths:
{ {
"productId": 24, "productId": 24,
"parentProductId": null, "parentProductId": null,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "30901", "gboPackageTemplateId": "30901",
@@ -429,6 +430,7 @@ paths:
{ {
"productId": 126, "productId": 126,
"parentProductId": null, "parentProductId": null,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 1, "layerInfoId": 1,
"choiceKey": "isRenewable", "choiceKey": "isRenewable",
@@ -537,6 +539,7 @@ paths:
{ {
"productId": 119, "productId": 119,
"parentProductId": 126, "parentProductId": 126,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001", "gboPackageTemplateId": "30001",
@@ -652,6 +655,7 @@ paths:
{ {
"productId": 120, "productId": 120,
"parentProductId": 126, "parentProductId": 126,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001", "gboPackageTemplateId": "30001",
@@ -779,6 +783,7 @@ paths:
{ {
"productId": 49, "productId": 49,
"parentProductId": null, "parentProductId": null,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 2, "layerInfoId": 2,
"choiceKey": "regio", "choiceKey": "regio",
@@ -926,6 +931,7 @@ paths:
{ {
"productId": 109, "productId": 109,
"parentProductId": 49, "parentProductId": 49,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 3, "layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles", "choiceKey": "allowedGboAgeProfiles",
@@ -1076,6 +1082,7 @@ paths:
{ {
"productId": 114, "productId": 114,
"parentProductId": 109, "parentProductId": 109,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 1, "layerInfoId": 1,
"choiceKey": "isRenewable", "choiceKey": "isRenewable",
@@ -1226,6 +1233,7 @@ paths:
{ {
"productId": 115, "productId": 115,
"parentProductId": 109, "parentProductId": 109,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 1, "layerInfoId": 1,
"choiceKey": "isRenewable", "choiceKey": "isRenewable",
@@ -1377,6 +1385,7 @@ paths:
{ {
"productId": 116, "productId": 116,
"parentProductId": 115, "parentProductId": 115,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615", "gboPackageTemplateId": "33615",
@@ -1526,6 +1535,7 @@ paths:
{ {
"productId": 117, "productId": 117,
"parentProductId": 115, "parentProductId": 115,
"needsVoucher": false,
"layerInfo": null, "layerInfo": null,
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615", "gboPackageTemplateId": "33615",
@@ -1679,6 +1689,7 @@ paths:
{ {
"productId": 112, "productId": 112,
"parentProductId": 49, "parentProductId": 49,
"needsVoucher": false,
"layerInfo": { "layerInfo": {
"layerInfoId": 3, "layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles", "choiceKey": "allowedGboAgeProfiles",
@@ -2150,6 +2161,10 @@ components:
parentProductId: parentProductId:
type: integer type: integer
example: 1 example: 1
needsVoucher:
type: boolean
description: Indicates if the product needs a voucher (with this productId as requiredProductId) to be bought - if false, this is optional, but still allowed
example: false
layerInfo: layerInfo:
$ref: '#/components/schemas/LayerInfoResponse' $ref: '#/components/schemas/LayerInfoResponse'
fikoArticleNumber: fikoArticleNumber:
+400
View File
@@ -0,0 +1,400 @@
openapi: 3.0.1
info:
title: Service Engine APIs for HTM voucher for sales Touchpoint
description: Service Engine APIs for HTM vouchers. These are NOT the CRUD APIs to the data hub. These ARE the APIs for sales touchpoints.
version: "1.0"
servers:
- url: https://services.acc.api.htm.nl/abt/abtvouchersTouchpoint/1.0
paths:
/issuedvouchers/{voucherCode}:
get:
summary: Get details of a voucher, that was issued for a specific touchpoint
description:
Get details of an issued voucher for a specific touchpoint. This means that only products that the calling touchpoint is allowed to see or sell
(i.e. has active sellingPeriods for touchPointId of the calling touchpoint) are returned.
parameters:
- name: voucherCode
in: path
required: true
description: The unique code of the issued voucher to retrieve.
schema:
type: string
example: VOUCHER123
tags:
- Vouchers
responses:
"200":
description: Successful retrieval of voucher instance
content:
application/json:
schema:
$ref: "#/components/schemas/salesTouchpointIssuedVoucherResponse"
examples:
Voucher that grants a voucher-only product for free:
summary: Voucher that grants a voucher-only product for free
description: |-
Voucher that grants a product (that can only be acquired via a voucher) for free.
In this case, the voucher has an amountInclTax of 0. If the requiredProduct has a
non-zero sellingPrice (amountInclTax), the difference between sellingPrice and
voucher amountInclTax represents the granted discount. If the requiredProduct has
a sellingPrice of 0, no "discount" is shown; just the voucher's amountInclTax.
value:
{
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
"voucherCode": "HTM-A7J-128-PYT",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"voucherStatus": { "voucherStatusId": 2, "name": "issued" },
"product":
{
"productId": 263,
"productName": "Voucher Ooievaarspas-product AOW",
"productDescription": "Voucher voor AOW-ers in Den Haag met een Ooievaarspas, die ingewisseld kan worden voor het product \"Ooievaarspas voor AOW-ers in Den Haag\"",
"amountInclTax": 0,
"requiredProducts":
[
{
"productId": 982,
"productName": "Ooievaarspas voor AOW-ers in Den Haag",
"productDescription": "Vrij reizen bij HTM voor Haagse AOW-gerechtigden met een Ooievaarspas.",
"productCategory":
{
"productCategoryId": 2,
"isTravelProduct": true,
"name": "Afgekocht reisrecht",
},
"amountInclTax": 0,
"_links":
{
"get_details":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/982",
"method": "GET",
},
},
},
]
},
"mandatoryCustomerDataItems":
[
{
"mandatoryCustomerDataItemId": 8,
"customerDataItem": "padBirthDate"
}
]
}
Voucher that grants a hybrid product for a reduced price:
summary: Voucher that grants a hybrid product for a reduced price
description: |-
Voucher that grants a hybrid product (that can be acquired via voucher or via ordinary order flow)
for a reduced price. In this case, the voucher has an amountInclTax > 0, which dictates the (modified)
total amount that needs to be paid for said product. If the requiredProduct has a
non-zero sellingPrice (amountInclTax), the difference between sellingPrice and
voucher amountInclTax represents the granted discount. If the requiredProduct has
a sellingPrice of 0, no "discount" is shown; just the voucher's amountInclTax./
Specifically, in this example, the product "HTM 20% Korting" can be purchased for 1 euro instead of 5 euro.
value:
{
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
"voucherCode": "HTM-A7J-128-PYT",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"voucherStatus": { "voucherStatusId": 2, "name": "issued" },
"product":
{
"productId": 264,
"productName": "Kortingsvoucher HTM 20% Korting ",
"productDescription": "Voucher waarmee het product \"HTM 20% Korting\" voor een lagere prijs kan worden aangeschaft.",
"amountInclTax": 100,
"requiredProducts":
[
{
"productId": 984,
"productName": "HTM 20% Korting",
"productDescription": "Reis met 20% korting op je betaalpas bij HTM.",
"productCategory":
{
"productCategoryId": 1,
"isTravelProduct": true,
"name": "Kortingsabonnement",
},
"amountInclTax": 500,
"_links":
{
"get_details":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/984",
"method": "GET",
},
},
},
]
},
"mandatoryCustomerDataItems": []
}
Voucher that grants a discount for a whole order:
summary: Voucher that grants a discount for a whole order
description: |-
Voucher that grants a discount for a whole order. In this case, no requiredProduct is specified, and
the voucher has an amountInclTax < 0. The (negative) amountInclTax dictates the value of the voucher,
that is subtracted from the total order value as a discount (with a minimum order total of 0).
value:
{
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
"voucherCode": "HTM-A7J-128-PYT",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"voucherStatus": { "voucherStatusId": 2, "name": "issued" },
"product":
{
"productId": 265,
"productName": "Voucher 10 euro korting",
"productDescription": "Voucher die 10 euro korting geeft op je gehele winkelmand.",
"amountInclTax": -1000,
"requiredProducts": []
},
"mandatoryCustomerDataItems": []
}
"403":
description: Forbidden
content:
application/problem+json:
schema:
$ref: "#/components/schemas/rfc9457"
examples:
Access denied due to insufficient permissions:
summary: Access denied due to insufficient permissions
value:
{
"type": "https://example.com/probs/forbidden",
"title": "Access denied",
"detail": "You do not have permission to access this resource.",
"instance": "/issuedvouchers",
}
"400":
description: Bad request
content:
application/problem+json:
schema:
$ref: "#/components/schemas/rfc9457"
examples:
Invalid voucher code:
summary: Invalid voucher code
value:
{
"type": "https://example.com/probs/bad-request",
"title": "Invalid voucher code",
"detail": "No valid voucher found for code VOUCHER123.",
"instance": "/issuedvouchers",
}
"500":
description: Internal server error
content:
application/problem+json:
schema:
$ref: "#/components/schemas/rfc9457"
examples:
Unexpected server error:
summary: Unexpected server error
value:
{
"type": "https://example.com/probs/internal-server-error",
"title": "Internal Server Error",
"detail": "An unexpected error occurred while processing your request.",
"instance": "/issuedvouchers",
}
components:
securitySchemes:
bearerToken:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
salesTouchpointIssuedVoucherResponse:
type: object
required:
- issuedVoucherId
- voucherCode
- fromInclusive
- untilInclusive
- voucherStatus
- product
- mandatoryCustomerDataItems
properties:
issuedVoucherId:
type: string
description: The unique (technical) identifier of the issued voucher instance.
example: "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90"
voucherCode:
type: string
description: The voucher code that is shared with the customer and uniquely identifies this voucher.
example: "HTM-A7J-128-PYT"
fromInclusive:
type: string
format: date-time-offset
description: |-
The date and time the voucher becomes valid for redemption. This has nothing to do with
the allowed start date of a requiredProduct (for this, the existing order flow logic is applied).
example: "2024-10-04T00:00:00.000+02:00"
untilInclusive:
type: string
format: date-time-offset
description: |-
The date and time the voucher becomes invalid for redemption. This has nothing to do with
the maximum allowed start date of a requiredProduct (for this, the existing order flow logic is applied).
example: "2024-11-04T00:00:00.000+01:00"
voucherStatus:
type: object
required:
- voucherStatusId
- name
description: |-
The current status of the voucher. Can be any of the following:
- 1 = new
- 2 = issued
- 3 = redeemed
- 4 = revoked
- 5 = expired
- 6 = pendingRedemption
properties:
voucherStatusId:
type: integer
example: 2
name:
type: string
example: "issued"
product:
type: object
description: The "product" referencing the voucher definition that this voucher instance is based on
required:
- productId
- productName
- productDescription
- amountInclTax
properties:
productId:
type: integer
example: 263
productName:
type: string
example: Voucher Ooievaarspas-product AOW
productDescription:
type: string
example: |-
Voucher voor AOW-ers in Den Haag met een Ooievaarspas, die ingewisseld kan worden
voor het product "Ooievaarspas voor AOW-ers in Den Haag".
amountInclTax:
type: integer
description: |-
When combined with a requiredProduct, the (positive or zero) amountInclTax dictates
the (modified) total amount that needs to be paid for said product. When the requiredProduct
has a sellingPrice > 0, the difference between sellingPrice and voucher amountInclTax
represents the granted discount.
When not combined with a required product, the (negative) amountInclTax dictates
the value of the voucher, that is subtracted from the total order value as a discount
(with a minimum order total of 0).
example: 0
requiredProducts:
type: array
description: |-
Currently, only one requiredProduct is supported and thus, this array can contain at
most one element.
items:
type: object
required:
- productId
properties:
productId:
type: integer
example: 892
productName:
type: string
example: "Ooievaarspas voor AOW-ers in Den Haag"
productDescription:
type: string
example: "Vrij reizen bij HTM voor Haagse AOW-gerechtigden met een Ooievaarspas."
productCategory:
type: object
required:
- productCategoryId
- isTravelProduct
- name
properties:
productCategoryId:
type: integer
example: 2
isTravelProduct:
type: boolean
example: true
name:
type: string
example: "Afgekocht reisrecht"
amountInclTax:
type: integer
description: |-
Selling price of the product in cents (including tax, if applicable) that is
currently active for the calling touchpoint. When 0, the product is free of charge.
example: 0
imageReference:
type: string
description: Can be a URL or a base64 encoded image
example: https://www.htm.nl/nog-onbekende-productafbeelding
_links:
type: object
properties:
get_details:
type: object
description: Link to get more details for the product that this voucher instance applies to
properties:
href:
type: string
example: https://api.integratielaag.nl/abt/touchpoint/1.0/products/982
method:
type: string
example: GET
mandatoryCustomerDataItems:
type: array
description: |-
List of mandatory customer data items that are required to redeem this voucher.\
The values provided for these data items may be checked against allowed values as provided by the voucher issuer.
items:
type: object
required:
- mandatoryCustomerDataItemId
- customerDataItem
properties:
mandatoryCustomerDataItemId:
type: integer
example: 8
customerDataItem:
type: string
example: padBirthdate
unavailable:
type: object
rfc9457:
type: object
properties:
type:
type: string
format: url
example: https://example.com/probs/out-of-credit
title:
type: string
example: You do not have enough credit.
detail:
type: string
example: Your current balance is 30, but that costs 50.
instance:
type: string
example: /account/12345/msgs/abc
balance:
type: string
example: 30
accounts:
type: array
items:
type: string
example:
- /account/12345
- /account/67890
File diff suppressed because it is too large. Load diff
@@ -1553,6 +1553,9 @@ components:
- productCategoryId: 8 - productCategoryId: 8
name: Saldo name: Saldo
isTravelProduct: true isTravelProduct: true
- productCategoryId: 9
name: Voucher
isTravelProduct: false
type: array type: array
items: items:
$ref: '#/components/schemas/productCategoryGetEntity' $ref: '#/components/schemas/productCategoryGetEntity'
@@ -1811,7 +1814,7 @@ components:
- mandatoryCustomerDataItemId: 5 - mandatoryCustomerDataItemId: 5
customerDataItem: address customerDataItem: address
- mandatoryCustomerDataItemId: 6 - mandatoryCustomerDataItemId: 6
customerDataItem: phone customerDataItem: voucher
- mandatoryCustomerDataItemId: 7 - mandatoryCustomerDataItemId: 7
customerDataItem: ovPayToken customerDataItem: ovPayToken
- mandatoryCustomerDataItemId: 8 - mandatoryCustomerDataItemId: 8
@@ -1820,6 +1823,8 @@ components:
customerDataItem: shippingAddress customerDataItem: shippingAddress
- mandatoryCustomerDataItemId: 10 - mandatoryCustomerDataItemId: 10
customerDataItem: billingAddress customerDataItem: billingAddress
- mandatoryCustomerDataItemId: 11
customerDataItem: startDate
items: items:
$ref: '#/components/schemas/mandatoryCustomerDataItemGetEntity' $ref: '#/components/schemas/mandatoryCustomerDataItemGetEntity'
type: array type: array
+28
View File
@@ -46,6 +46,13 @@ paths:
when false, return only non-archived products (isArchived = false). when false, return only non-archived products (isArchived = false).
schema: schema:
type: boolean type: boolean
- name: onlyVouchers
in: query
required: false
description: |-
When omitted, defaults to false (i.e. return all normal products that are NOT voucher definitions); when true, return only voucher definitions
schema:
type: boolean
responses: responses:
'200': '200':
description: OK description: OK
@@ -387,6 +394,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901", "gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting", "productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
@@ -474,6 +482,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901", "gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting", "productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
@@ -560,6 +569,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901", "gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting", "productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
@@ -680,6 +690,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "33610", "gboPackageTemplateId": "33610",
"productName": "HTM Regio Vrij DH73", "productName": "HTM Regio Vrij DH73",
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.",
@@ -866,6 +877,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901", "gboPackageTemplateId": "30901",
"tapConnectProductCode": null, "tapConnectProductCode": null,
"productName": "HTM pilot 90% korting", "productName": "HTM pilot 90% korting",
@@ -1028,6 +1040,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901", "gboPackageTemplateId": "30901",
"tapConnectProductCode": null, "tapConnectProductCode": null,
"productName": "HTM pilot 90% korting", "productName": "HTM pilot 90% korting",
@@ -1270,6 +1283,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "33610", "gboPackageTemplateId": "33610",
"tapConnectProductCode": null, "tapConnectProductCode": null,
"productName": "HTM Regio Vrij DH73", "productName": "HTM Regio Vrij DH73",
@@ -1475,6 +1489,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": null, "gboPackageTemplateId": null,
"tapConnectProductCode": null, "tapConnectProductCode": null,
"productName": "IBAN wijzigen functioneel product", "productName": "IBAN wijzigen functioneel product",
@@ -1672,6 +1687,7 @@ paths:
"fikoArticleNumber": "1234", "fikoArticleNumber": "1234",
"isValid": true, "isValid": true,
"isArchived": false, "isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": null, "gboPackageTemplateId": null,
"tapConnectProductCode": null, "tapConnectProductCode": null,
"productName": "OV-pas saldo (1 eurocent)", "productName": "OV-pas saldo (1 eurocent)",
@@ -2775,6 +2791,10 @@ components:
type: boolean type: boolean
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
example: false example: false
needsVoucher:
type: boolean
description: Indicates if the product needs a voucher (with this productId as requiredProductId) to be bought - if false, this is optional, but still allowed
example: false
gboPackageTemplateId: gboPackageTemplateId:
type: string type: string
example: '30901' example: '30901'
@@ -3132,6 +3152,10 @@ components:
type: boolean type: boolean
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
example: false example: false
needsVoucher:
type: boolean
description: Indicates if the product needs a voucher (with this productId as requiredProductId) to be bought - if false, this is optional, but still allowed
example: false
gboPackageTemplateId: gboPackageTemplateId:
type: string type: string
description: >- description: >-
@@ -3503,6 +3527,10 @@ components:
type: boolean type: boolean
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
example: false example: false
needsVoucher:
type: boolean
description: Indicates if the product needs a voucher (with this productId as requiredProductId) to be bought - if false, this is optional, but still allowed
example: false
gboPackageTemplateId: gboPackageTemplateId:
type: string type: string
description: >- description: >-
+157 -451
View File
@@ -128,7 +128,7 @@ paths:
"createdOn": "2024-10-04T12:34:56.000", "createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000", "lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "someuser", "createdBy": "someuser",
"lastUpdatedBy": null, "lastUpdatedBy": null
}, },
], ],
"purchasedTapconnectTickets": [], "purchasedTapconnectTickets": [],
@@ -154,7 +154,7 @@ paths:
"purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114", "purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114",
"resourceName": "resourceName":
{ "resourceNameId": 2, "name": "orders" }, { "resourceNameId": 2, "name": "orders" },
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e"
}, },
], ],
"purchasedGboProducts": [], "purchasedGboProducts": [],
@@ -170,6 +170,11 @@ paths:
"lastUpdatedOn": "2024-10-04T12:34:56.000", "lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "user", "createdBy": "user",
"lastUpdatedBy": "user", "lastUpdatedBy": "user",
"externalDeviceId": "c5545584-04af-4c60-a955-d6a70baab848",
"serviceId": "HTM-1234-7654-8945",
"activateBefore": "2024-10-08",
"validityStart": "2024-10-05T12:34:56.000",
"validityEnd": "2024-10-06T12:34:56.000"
}, },
], ],
"issuedVouchers": [], "issuedVouchers": [],
@@ -341,6 +346,11 @@ paths:
"lastUpdatedOn": "2024-10-04T12:34:56.000", "lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "user", "createdBy": "user",
"lastUpdatedBy": "user", "lastUpdatedBy": "user",
"externalDeviceId": "c5545584-04af-4c60-a955-d6a70baab848",
"serviceId": "HTM-1234-7654-8945",
"activateBefore": "2024-10-08",
"validityStart": "2024-10-05T12:34:56.000",
"validityEnd": "2024-10-06T12:34:56.000"
}, },
], ],
"issuedVouchers": [], "issuedVouchers": [],
@@ -775,18 +785,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/PostPurchasedTapConnectTicketRequest"
example:
{
"issuedAt": "2024-10-04T12:34:56.000",
"activatedAt": "2024-10-04T12:34:56.000",
"cancelledAt": null,
"ticketReference": "KJj43nejhbTxhr897287",
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "user",
"lastUpdatedBy": "user",
}
responses: responses:
"201": "201":
description: Created description: Created
@@ -907,6 +906,60 @@ paths:
type: string type: string
example: user example: user
description: The user that last updated the purchased Tapconnect ticket. description: The user that last updated the purchased Tapconnect ticket.
- in: query
name: externalDeviceId
schema:
type: string
example: c5545584-04af-4c60-a955-d6a70baab848
description: The external id of the device.
- in: query
name: serviceId
schema:
type: string
example: HTM-1234-7654-8945
description: A printable id that needs to be next to the printed barcode on the ticket, which is used when the customer contacts the service desk.
- in: query
name: activateBeforeBefore
schema:
type: string
format: date
example: 2024-10-04
description: Return only PurchasedTapConnectTickets that have `activateBefore` before this date.
- in: query
name: activateBeforeAfter
schema:
type: string
format: date-time
example: 2024-10-04
description: Return only PurchasedTapConnectTickets that have `activateBefore` after this date.
- in: query
name: validityStartBefore
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: Return only PurchasedTapConnectTickets that have `validityStart` before this timestamp.
- in: query
name: validityStartAfter
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: Return only PurchasedTapConnectTickets that have `validityStart` after this timestamp.
- in: query
name: validityEndBefore
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: Return only PurchasedTapConnectTickets that have `validityEnd` before this timestamp.
- in: query
name: validityEndAfter
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: Return only PurchasedTapConnectTickets that have `validityEnd` after this timestamp.
responses: responses:
"200": "200":
description: OK description: OK
@@ -929,6 +982,11 @@ paths:
"lastUpdatedOn": "2024-10-04T12:34:56.000", "lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "user", "createdBy": "user",
"lastUpdatedBy": "user", "lastUpdatedBy": "user",
"externalDeviceId": "c5545584-04af-4c60-a955-d6a70baab848",
"serviceId": "HTM-1234-7654-8945",
"activateBefore": "2024-10-08",
"validityStart": "2024-10-05T12:34:56.000",
"validityEnd": "2024-10-06T12:34:56.000"
}, },
], ],
} }
@@ -958,6 +1016,8 @@ paths:
"activatedAt": "2024-10-05T12:34:56.000", "activatedAt": "2024-10-05T12:34:56.000",
"cancelledAt": "2024-10-06T12:34:56.000", "cancelledAt": "2024-10-06T12:34:56.000",
"lastUpdatedOn": "2024-10-05T12:34:56.000", "lastUpdatedOn": "2024-10-05T12:34:56.000",
"validityStart": "2024-10-05T12:34:56.000",
"validityEnd": "2024-10-06T12:34:56.000"
} }
responses: responses:
"200": "200":
@@ -968,7 +1028,7 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"purchasedTapconnectTicketId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", "purchasedTapconnectTicketId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90"
} }
/purchasedproducts/{purchasedProductId}/issuedvouchers: /purchasedproducts/{purchasedProductId}/issuedvouchers:
parameters: parameters:
@@ -1009,6 +1069,8 @@ paths:
"value": "vlad.harkonnen@househarkonnen.net", "value": "vlad.harkonnen@househarkonnen.net",
}, },
], ],
"fromInclusive": "2024-10-04T12:34:56.000",
"untilInclusive": "2025-10-04T12:34:56.000",
} }
responses: responses:
"201": "201":
@@ -1040,6 +1102,12 @@ paths:
format: uuid format: uuid
example: 058a1af7-897f-45d5-b691-9cc9161e387f example: 058a1af7-897f-45d5-b691-9cc9161e387f
description: The id of the purchased product. description: The id of the purchased product.
- in: query
name: productId
schema:
type: integer
example: 1
description: The id of the product and the issuedVouchers related to it
- in: query - in: query
name: voucherCode name: voucherCode
schema: schema:
@@ -1055,6 +1123,14 @@ paths:
explode: false explode: false
required: false required: false
description: The moest recent status id of the voucher. description: The moest recent status id of the voucher.
- in: query
name: orderBy
schema:
type: string
enum: [PurchasedProductCreatedOn, PurchasedProductLastUpdatedOn]
explode: false
required: false
description: The ordering of the issuedVouchers in the list
responses: responses:
"200": "200":
description: OK description: OK
@@ -1104,6 +1180,8 @@ paths:
"value": "vlad.harkonnen@househarkonnen.net", "value": "vlad.harkonnen@househarkonnen.net",
}, },
], ],
"fromInclusive": "2024-10-04T12:34:56.000",
"untilInclusive": "2025-10-04T12:34:56.000",
}, },
], ],
} }
@@ -1165,439 +1243,6 @@ paths:
{ "voucherStatusId": 5, "name": "Expired" }, { "voucherStatusId": 5, "name": "Expired" },
], ],
} }
/purchasedproducts/bulk:
post:
tags:
- Bulk processing
summary: Create one or more purchased product(s) in bulk.
description: Create a new purchased product.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Create Single Purchased GBO Product:
value:
{
"purchasedProducts":[
{
"productId": 11,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"purchasedProductResources":
[
{
"resourceNameId": 1,
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
},
{
"resourceNameId": 2,
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
},
],
"purchasedGboProducts":
[
{
"salesTimestamp": "2024-10-04T12:34:56.000",
"refundTimestamp": "2024-10-04T12:34:56.000",
"fromInclusive": "2024-10-04T12:34:56.000",
"untilInclusive": "2024-10-04T12:34:56.000",
"packageTemplateId": "30003",
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
"ovPayTokenId": 13,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "someuser",
"lastUpdatedBy": null,
},
],
"purchasedTapconnectTickets": [],
"issuedVouchers": [],
}
]
}
Create Single Purchased TapConnet Ticket:
value:
{
"purchasedProducts":[
{
"productId": 11,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"purchasedProductResources":
[
{
"resourceNameId": 1,
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
},
{
"resourceNameId": 2,
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
},
],
"purchasedGboProducts": [],
"purchasedTapconnectTickets":
[
{
"issuedAt": "2024-10-04T12:34:56.000",
"activatedAt": "2024-10-04T12:34:56.000",
"cancelledAt": null,
"ticketReference": "KJj43nejhbTxhr897287",
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "user",
"lastUpdatedBy": "user",
},
],
"issuedVouchers": [],
}
]
}
Create Single Issued Voucher:
value:
{
"purchasedProducts":[
{
"productId": 11,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"purchasedProductResources":
[
{
"resourceNameId": 1,
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
},
{
"resourceNameId": 2,
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
},
],
"purchasedGboProducts": [],
"purchasedTapconnectTickets": [],
"issuedVouchers":
[
{
"voucherCode": "VOUCHER123",
"voucherStatusInstances":
[
{
"voucherStatusId": 1,
"createdOn": "2024-10-04T12:34:56.000",
},
],
"voucherClaims":
[
{
"mandatoryCustomerDataItemId": 8,
"value": "1999-12-31",
},
{
"mandatoryCustomerDataItemId": 4,
"value": "vlad.harkonnen@househarkonnen.net",
},
],
},
],
}
]
}
Create Multiple Issued Vouchers:
value:
{
"purchasedProducts":[
{
"productId": 11,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"purchasedProductResources":
[
{
"resourceNameId": 1,
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
},
{
"resourceNameId": 2,
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
},
],
"purchasedGboProducts": [],
"purchasedTapconnectTickets": [],
"issuedVouchers":
[
{
"voucherCode": "VOUCHER123",
"voucherStatusInstances":
[
{
"voucherStatusId": 1,
"createdOn": "2024-10-04T12:34:56.000",
},
],
"voucherClaims":
[
{
"mandatoryCustomerDataItemId": 8,
"value": "1999-12-31",
},
{
"mandatoryCustomerDataItemId": 4,
"value": "vlad.harkonnen@househarkonnen.net",
},
],
},
],
},
{
"productId": 11,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"purchasedProductResources":
[
{
"resourceNameId": 1,
"resourceIdentifier": "7ce32f9b-52f0-4e80-a527-0c6184b57f52",
},
{
"resourceNameId": 2,
"resourceIdentifier": "02047745-f03e-4c00-8e1b-8dc5c86a786e",
},
],
"purchasedGboProducts": [],
"purchasedTapconnectTickets": [],
"issuedVouchers":
[
{
"voucherCode": "VOUCHER123",
"voucherStatusInstances":
[
{
"voucherStatusId": 1,
"createdOn": "2024-10-04T12:34:56.000",
},
],
"voucherClaims":
[
{
"mandatoryCustomerDataItemId": 8,
"value": "1940-01-18",
},
{
"mandatoryCustomerDataItemId": 4,
"value": "valdemar.hoskanner@househarkonnen.net",
},
],
},
],
},
{
"productId": 11,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"purchasedProductResources":
[
{
"resourceNameId": 1,
"resourceIdentifier": "7c71ec8a-3326-451f-9464-3e36d10260e3",
},
{
"resourceNameId": 2,
"resourceIdentifier": "73c7a805-2edf-4616-a04c-267e88e0931c",
},
],
"purchasedGboProducts": [],
"purchasedTapconnectTickets": [],
"issuedVouchers":
[
{
"voucherCode": "VOUCHER123",
"voucherStatusInstances":
[
{
"voucherStatusId": 1,
"createdOn": "2024-10-04T12:34:56.000",
},
],
"voucherClaims":
[
{
"mandatoryCustomerDataItemId": 8,
"value": "2016-06-08",
},
{
"mandatoryCustomerDataItemId": 4,
"value": "alia.artreides@housearteides.net",
},
],
},
],
}
]
}
responses:
"202":
description: Accepted
content:
application/json:
schema:
$ref: "#/components/schemas/BulkResponseBody"
examples:
Array of purchased products accepted:
summary: Array of purchased products accepted
description: |
The array of purchased products was accepted successfully.
The purchased products will be processed asynchronously.
In the response body the consumer will find information on how to retrieve the processing status.
value:
startTime: 2025-02-14T05:32:47.0672237Z
status: Running
clientTrackingId: 08584620957189579629541919368CU00
callbackurl: https://api.integratielaag.nl/purchasedproducts/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
retryAfter: 10
summary: null
/purchasedproducts/bulk/{clientTrackingId}:
get:
tags:
- Bulk processing
summary: Get the status of the purchased products bulk post.
description: Get the status of the asynchronous purchased products bulk post.
parameters:
- in: path
name: clientTrackingId
schema:
type: string
required: true
description: The clientTrackingId of the purchased products bulk post.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/BulkResponseBody"
examples:
Batch successfully processed:
summary: Batch successfully processed
description: |
Body of a batch of purchased products that was successfully created.
A number of purchased products were created.
value:
startTime: "2025-02-14T05:32:47.067Z"
status: "Finished"
clientTrackingId: "08584620957189579629541919368CU00"
callbackurl: https://api.integratielaag.nl/purchasedproducts/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
retryAfter: 0
summary:
created: 13
updated: 0
total: 13
/voucherstatusinstances/bulk:
post:
summary: Post voucher status instances in bulk.
description: Post voucher status instances in bulk.
tags:
- Bulk processing
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
List of issued vouchers to set status to revoked:
summary: List of issued vouchers to set status to revoked
description: List of issued vouchers to set status to revoked
value:
{
"voucherStatusInstances":[
{
"issuedVoucherId": "8a63552f-faf5-43f3-b22d-bebc976a8a5e",
"voucherStatusId": 4,
"createdOn": "2024-10-04T12:34:56.000"
},
{
"issuedVoucherId": "a9ff40ec-2940-413a-9957-dfd471c4caf3",
"voucherStatusId": 4,
"createdOn": "2024-10-04T12:34:56.000"
},
{
"issuedVoucherId": "9e7363e6-beaa-4c38-9ed6-c8afed459bd5",
"voucherStatusId": 4,
"createdOn": "2024-10-04T12:34:56.000"
},
{
"issuedVoucherId": "9d7332d6-1949-4c20-aa99-d87096b035fa",
"voucherStatusId": 4,
"createdOn": "2024-10-04T12:34:56.000"
},
{
"issuedVoucherId": "43ca757b-8370-4cb0-92b9-717948383d5e",
"voucherStatusId": 4,
"createdOn": "2024-10-04T12:34:56.000"
},
]
}
responses:
"202":
description: Accepted
content:
application/json:
schema:
$ref: "#/components/schemas/BulkResponseBody"
examples:
Array of issued vouchers accepted:
summary: Array of issued vouchers status instances accepted
description: |
The array of issued vouchers status instances was accepted successfully.
The issued vouchers status instances will be processed asynchronously.
In the response body the consumer will find information on how to retrieve the processing status.
value:
startTime: 2025-02-14T05:32:47.0672237Z
status: Running
clientTrackingId: 08584620957189579629541919368CU00
callbackurl: https://api.integratielaag.nl/voucherstatusinstances/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
retryAfter: 10
summary: null
/voucherstatusinstances/bulk/responsestatus/{clientTrackingId}:
get:
tags:
- Bulk processing
summary: Get the status of the voucher status instances bulk post.
description: Get the status of the asynchronous voucher status instances bulk post.
parameters:
- in: path
name: clientTrackingId
schema:
type: string
required: true
description: The clientTrackingId of the voucher status instances bulk post.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/BulkResponseBody"
examples:
Batch successfully processed:
summary: Batch successfully processed
description: |
Body of a batch of voucher status instances that was successfully created.
A number of voucher status instances were created.
value:
startTime: "2025-02-14T05:32:47.067Z"
status: "Finished"
clientTrackingId: "08584620957189579629541919368CU00"
callbackurl: https://api.integratielaag.nl/voucherstatusinstances/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
retryAfter: 0
summary:
created: 5
updated: 0
total: 5
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken:
@@ -1607,6 +1252,67 @@ components:
schemas: schemas:
unavailable: unavailable:
type: object type: object
PostPurchasedTapConnectTicketRequest:
type: object
required:
- issuedAt
- ticketReference
- createdOn
- lastUpdatedOn
- createdBy
- serviceId
- activateBefore
properties:
issuedAt:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
activatedAt:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
cancelledAt:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
ticketReference:
type: string
example: KJj43nejhbTxhr897287
createdOn:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
lastUpdatedOn:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
createdBy:
type: string
example: John Doe
lastUpdatedBy:
type: string
example: John Doe
externalDeviceId:
type: string
example: c5545584-04af-4c60-a955-d6a70baab848
serviceId:
type: string
example: HTM-1234-7654-8945
activateBefore:
type: string
format: date
description: Tickets can only be activated BEFORE this date. Should be equal to TapConnect's `lifeSpanEnd + P1D`
example: 2024-10-08
validityStart:
type: string
format: date-time
description: The date-time at which the ticket will become valid for for traveling. The ticket will not be valid before this date/time.
example: 2024-10-05T12:34:56.000
validityEnd:
type: string
format: date-time
description: The date-time at which the ticket will become invalid for traveling. The ticket will not be valid after this date/time.
example: 2024-10-06T12:34:56.000
BulkResponseBody: BulkResponseBody:
type: object type: object
properties: properties:
@@ -1627,8 +1333,8 @@ components:
retryAfter: retryAfter:
type: integer type: integer
example: 10 example: 10
summary: summary:
$ref: "#/components/schemas/summaryBody" $ref: "#/components/schemas/summaryBody"
required: required:
- startTime - startTime
- status - status
@@ -1656,7 +1362,7 @@ components:
- total - total
- updated - updated
required: required:
- summary - summary
rfc9457: rfc9457:
type: object type: object
properties: properties:
View File
Whitespace-only changes.