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
10 changed files with 1140 additions and 420 deletions

No files matched your search

+24 -153
View File
@@ -243,7 +243,7 @@ paths:
suffix: PhD
dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL
isEmailVerified: True
isEmailVerified: false
addresses:
- addressId: 1
street: mystreet
@@ -332,14 +332,6 @@ paths:
user: user
timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links:
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1",
"method": "GET",
},
}
- customerProfileId: 12
customerNumber: 1000002
debtorNumber: DB100121
@@ -377,7 +369,7 @@ paths:
suffix: PhD
dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL
isEmailVerified: False
isEmailVerified: false
address:
- addressId: 1
street: mystreet
@@ -467,32 +459,7 @@ paths:
user: user
timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links:
{
"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",
},
}
href: "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20&limit=20"
getCustomerActive:
summary: getCustomerActive
description: >-
@@ -526,7 +493,7 @@ paths:
suffix: PhD
dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL
isEmailVerified: False
isEmailVerified: false
addresses:
- addressId: 1
street: mystreet
@@ -615,22 +582,7 @@ paths:
user: user
timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links:
{
"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",
},
}
href: https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20&limit=20
getCustomerBlocked:
summary: getCustomerBlocked
description: >-
@@ -669,7 +621,7 @@ paths:
suffix: PhD
dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL
isEmailVerified: True
isEmailVerified: false
addresses:
- addressId: 1
street: mystreet
@@ -758,22 +710,7 @@ paths:
user: user
timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links:
{
"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",
},
}
href: https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20&limit=20
400:
description: Bad Request
content:
@@ -835,7 +772,7 @@ paths:
suffix: jr
dateOfBirth: "1970-01-01"
emailAddress: j.jansen@hatseflats.nl
isEmailVerified: False
isEmailVerified: false
addresses:
- street: Laan van Meerdervoort
houseNumber: 5
@@ -934,7 +871,7 @@ paths:
suffix: "jr",
dateOfBirth: "1970-01-01",
emailAddress: "TEST@TEST1.NL",
isEmailVerified: False
isEmailVerified: false
}
updateCompleteEntity:
value:
@@ -946,7 +883,7 @@ paths:
suffix: "jr",
dateOfBirth: "1970-01-01",
emailAddress: "TEST@TEST1.NL",
isEmailVerified: True
isEmailVerified: false
}
required: true
responses:
@@ -1438,13 +1375,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/getDevices"
examples:
updateDeviceResponse:
value:
deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
alias: "iPhone zakelijk"
$ref: "#/components/schemas/patchDeviceResponse"
security:
- default: []
@@ -1607,24 +1538,7 @@ paths:
"replacedByTokenId": 12,
},
],
"_links":
{
"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",
},
},
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=20&limit=20"
}
/customers/{customerProfileId}/ovpaytokens:
post:
@@ -1943,9 +1857,10 @@ paths:
"created": "2024-10-20T17:05:52.000",
},
],
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/billingInformations?offset=20&limit=20"
}
getBillingInformationSingleSpecificCustomer:
summary: Get singel billing information entity for a specific customers
summary: Get single billing information entity for a specific customers
description: >-
Found one billing information matching the search parameters
value:
@@ -2135,59 +2050,7 @@ paths:
"updateTimestamp": "2024-03-22T08:55:00",
},
],
"_links":
{
"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",
},
},
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20&limit=20"
}
/billingInformation/{billingInformationId}/directdebitmandates:
post:
@@ -2843,7 +2706,7 @@ components:
emailAddress:
type: string
isEmailVerified:
type: string
type: boolean
postOvPayTokenResponse:
type: object
properties:
@@ -2857,6 +2720,14 @@ components:
type: array
items:
$ref: "#/components/schemas/getDeviceEntity"
patchDeviceResponse:
type: object
properties:
deviceId:
type: string
format: uuid
example: "b2c8a8c6-3d1c-4b6b-8f8d-3a6a1b6a1b6a"
getDeviceEntity:
type: object
properties:
+46 -40
View File
@@ -46,6 +46,7 @@ paths:
- occurredOn
- type
- articleNumber
- paymentMethod
- status
- aggregationReference
- accountingSystemReference
@@ -76,6 +77,7 @@ paths:
- occurredOn
- type
- articleNumber
- paymentMethod
- status
- aggregationReference
- accountingSystemReference
@@ -115,6 +117,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4031"
paymentMethod: iDEAL
status: created
aggregationReference: null
accountingSystemReference: null
@@ -134,6 +137,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4051"
paymentMethod: iDEAL
status: failed
aggregationReference: null
accountingSystemReference: null
@@ -153,6 +157,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4051"
paymentMethod: iDEAL
status: returned to src
aggregationReference: FIKO-171f40609e
accountingSystemReference: null
@@ -172,6 +177,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4051"
paymentMethod: iDEAL
status: returned to trx-db
aggregationReference: null
accountingSystemReference: null
@@ -191,6 +197,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4051"
paymentMethod: iDEAL
status: re-entered
aggregationReference: null
accountingSystemReference: null
@@ -210,6 +217,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "1737"
paymentMethod: iDEAL
status: succeeded
aggregationReference: FIKO-6a4fca8cd6
accountingSystemReference: U4F-123456
@@ -248,6 +256,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4031"
paymentMethod: iDEAL
Add multiple transaction items:
summary: Add multiple transaction items
description: Add multiple transaction items of type sales.
@@ -266,6 +275,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4031"
paymentMethod: iDEAL
- transactionType: sales
sourceName: HTM-website
transactionId: "1001237"
@@ -279,6 +289,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z
type: debit
articleNumber: "4031"
paymentMethod: iDEAL
responses:
"202":
description: Accepted
@@ -1447,6 +1458,7 @@ paths:
identifyingFieldValue: null
concessionId: null
isContraAccount: false
paymentMethod: null
lineType: tax
lineSense: credit
department: 140
@@ -1469,6 +1481,7 @@ paths:
identifyingFieldValue: null
concessionId: 1
isContraAccount: false
paymentMethod: null
lineType: analysis
lineSense: credit
department: 900
@@ -1491,6 +1504,7 @@ paths:
identifyingFieldValue: null
concessionId: null
isContraAccount: true
paymentMethod: iDEAL
lineType: analysis
lineSense: debet
department: 140
@@ -1726,6 +1740,7 @@ paths:
- identifyingFieldValue
- concessionId
- isContraAccount
- paymentMethod
- lineType
- lineSense
- department
@@ -1759,6 +1774,7 @@ paths:
- identifyingFieldValue
- concessionId
- isContraAccount
- paymentMethod
- lineType
- lineSense
- department
@@ -1810,6 +1826,7 @@ paths:
identifyingFieldValue: null
concessionId: 2
isContraAccount: false
paymentMethod: null
lineType: summary
lineSense: credit
department: 900
@@ -1832,6 +1849,7 @@ paths:
identifyingFieldValue: null
concessionId: 1
isContraAccount: false
paymentMethod: null
lineType: summary
lineSense: credit
department: 900
@@ -1863,6 +1881,7 @@ paths:
identifyingFieldValue: null
concessionId: 2
isContraAccount: false
paymentMethod: null
lineType: summary
lineSense: credit
department: 900
@@ -1884,6 +1903,8 @@ paths:
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null
concessionId: 1
isContraAccount: false
paymentMethod: null
lineType: summary
lineSense: credit
department: 900
@@ -1906,6 +1927,7 @@ paths:
identifyingFieldValue: null
concessionId: 2
isContraAccount: false
paymentMethod: null
lineType: summary
lineSense: credit
department: 900
@@ -1928,6 +1950,7 @@ paths:
identifyingFieldValue: null
concessionId: 1
isContraAccount: false
paymentMethod: null
lineType: summary
lineSense: credit
department: 900
@@ -1950,6 +1973,7 @@ paths:
identifyingFieldValue: null
concessionId: null
isContraAccount: false
paymentMethod: null
lineType: tax
lineSense: credit
department: 140
@@ -1972,6 +1996,7 @@ paths:
identifyingFieldValue: null
concessionId: null
isContraAccount: true
paymentMethod: iDEAL
lineType: analysis
lineSense: credit
department: 220
@@ -2021,6 +2046,7 @@ paths:
identifyingFieldValue: null
concessionId: 1
isContraAccount: false
paymentMethod: null
lineType: summary
lineSense: credit
department: 900
@@ -3284,6 +3310,10 @@ components:
type: string
nullable: true
example: "4031"
paymentMethod:
type: string
nullable: true
example: iDEAL
status:
type: string
enum:
@@ -3375,6 +3405,10 @@ components:
type: string
nullable: true
example: "4031"
paymentMethod:
type: string
nullable: true
example: iDEAL
required:
- sourceName
- transactionType
@@ -3458,46 +3492,6 @@ components:
TransactionItemsPatchRequestBody:
type: object
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:
type: string
enum:
@@ -4098,6 +4092,10 @@ components:
isContraAccount:
type: boolean
example: false
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType:
type: string
enum:
@@ -4215,6 +4213,10 @@ components:
isContraAccount:
type: boolean
example: false
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType:
type: string
enum:
@@ -4304,6 +4306,10 @@ components:
type: boolean
example: false
nullable: true
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType:
type: string
enum:
+15
View File
@@ -313,6 +313,7 @@ paths:
{
"productId": 24,
"parentProductId": null,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "30901",
@@ -429,6 +430,7 @@ paths:
{
"productId": 126,
"parentProductId": null,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 1,
"choiceKey": "isRenewable",
@@ -537,6 +539,7 @@ paths:
{
"productId": 119,
"parentProductId": 126,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001",
@@ -652,6 +655,7 @@ paths:
{
"productId": 120,
"parentProductId": 126,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001",
@@ -779,6 +783,7 @@ paths:
{
"productId": 49,
"parentProductId": null,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 2,
"choiceKey": "regio",
@@ -926,6 +931,7 @@ paths:
{
"productId": 109,
"parentProductId": 49,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles",
@@ -1076,6 +1082,7 @@ paths:
{
"productId": 114,
"parentProductId": 109,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 1,
"choiceKey": "isRenewable",
@@ -1226,6 +1233,7 @@ paths:
{
"productId": 115,
"parentProductId": 109,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 1,
"choiceKey": "isRenewable",
@@ -1377,6 +1385,7 @@ paths:
{
"productId": 116,
"parentProductId": 115,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615",
@@ -1526,6 +1535,7 @@ paths:
{
"productId": 117,
"parentProductId": 115,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615",
@@ -1679,6 +1689,7 @@ paths:
{
"productId": 112,
"parentProductId": 49,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles",
@@ -2150,6 +2161,10 @@ components:
parentProductId:
type: integer
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:
$ref: '#/components/schemas/LayerInfoResponse'
fikoArticleNumber:
+15
View File
@@ -313,6 +313,7 @@ paths:
{
"productId": 24,
"parentProductId": null,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "30901",
@@ -429,6 +430,7 @@ paths:
{
"productId": 126,
"parentProductId": null,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 1,
"choiceKey": "isRenewable",
@@ -537,6 +539,7 @@ paths:
{
"productId": 119,
"parentProductId": 126,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001",
@@ -652,6 +655,7 @@ paths:
{
"productId": 120,
"parentProductId": 126,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "30001",
@@ -779,6 +783,7 @@ paths:
{
"productId": 49,
"parentProductId": null,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 2,
"choiceKey": "regio",
@@ -926,6 +931,7 @@ paths:
{
"productId": 109,
"parentProductId": 49,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles",
@@ -1076,6 +1082,7 @@ paths:
{
"productId": 114,
"parentProductId": 109,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 1,
"choiceKey": "isRenewable",
@@ -1226,6 +1233,7 @@ paths:
{
"productId": 115,
"parentProductId": 109,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 1,
"choiceKey": "isRenewable",
@@ -1377,6 +1385,7 @@ paths:
{
"productId": 116,
"parentProductId": 115,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615",
@@ -1526,6 +1535,7 @@ paths:
{
"productId": 117,
"parentProductId": 115,
"needsVoucher": false,
"layerInfo": null,
"fikoArticleNumber": "1234",
"gboPackageTemplateId": "33615",
@@ -1679,6 +1689,7 @@ paths:
{
"productId": 112,
"parentProductId": 49,
"needsVoucher": false,
"layerInfo": {
"layerInfoId": 3,
"choiceKey": "allowedGboAgeProfiles",
@@ -2150,6 +2161,10 @@ components:
parentProductId:
type: integer
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:
$ref: '#/components/schemas/LayerInfoResponse'
fikoArticleNumber:
+251 -57
View File
@@ -1,7 +1,7 @@
openapi: 3.0.1
info:
title: Service Engine APIs for HTM voucher for sales Touchpint
description: Service Engine APIs for HTM vouchers. These are NOT the CRUD APIs to the data hub. These ARE the api's for sales touchpoints.
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
@@ -28,98 +28,132 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
$ref: "#/components/schemas/salesTouchpointIssuedVoucherResponse"
examples:
Voucher for a product with required attributes:
summary: Voucher for a single product with required attributes
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": "VOUCHER123",
"voucherCode": "HTM-A7J-128-PYT",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"voucherStatus": { "voucherStatusId": 1, "name": "New" },
"voucherStatus": { "voucherStatusId": 2, "name": "issued" },
"product":
{
"productId": 263,
"productName": "HTM-80001",
"productDescription": "10 euro korting op Regiovrij maand.",
"productCategory":
{
"productCategoryId": 9,
"isTravelProduct": false,
"name": "Voucher",
},
"amountInclTax": -1000,
"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": 126,
"productName": "HTM-30001",
"productDescription": "Regiovrij maand.",
"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/126",
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/982",
"method": "GET",
},
},
},
],
"_links":
{
"get_details":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
"method": "GET",
},
},
]
},
"mandatoryCustomerDataItems":
[
{
"mandatoryCustomerDataItemId": 8,
"customerDataItem": "padBirthDate",
},
{
"mandatoryCustomerDataItemId": 4,
"customerDataItem": "emailAddress",
},
],
"customerDataItem": "padBirthDate"
}
Voucher for a whole order:
summary: Voucher for a whole order
]
}
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": "VOUCHER123",
"voucherCode": "HTM-A7J-128-PYT",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"voucherStatus": { "voucherStatusId": 1, "name": "New" },
"voucherStatus": { "voucherStatusId": 2, "name": "issued" },
"product":
{
"productId": 263,
"productName": "HTM-80002",
"productDescription": "10 euro korting op je gehele winkelmand.",
"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": 9,
"isTravelProduct": false,
"name": "Voucher",
"productCategoryId": 1,
"isTravelProduct": true,
"name": "Kortingsabonnement",
},
"amountInclTax": -1000,
"requiredProducts": [],
"amountInclTax": 500,
"_links":
{
"get_details":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/984",
"method": "GET",
},
},
},
"mandatoryCustomerDataItems": [],
]
},
"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
@@ -137,20 +171,20 @@ paths:
"detail": "You do not have permission to access this resource.",
"instance": "/issuedvouchers",
}
"404":
description: Not found
"400":
description: Bad request
content:
application/problem+json:
schema:
$ref: "#/components/schemas/rfc9457"
examples:
Voucher not found:
summary: Voucher not found
Invalid voucher code:
summary: Invalid voucher code
value:
{
"type": "https://example.com/probs/not-found",
"title": "Voucher not found",
"detail": "The voucher with code VOUCHER123 does not exist.",
"type": "https://example.com/probs/bad-request",
"title": "Invalid voucher code",
"detail": "No valid voucher found for code VOUCHER123.",
"instance": "/issuedvouchers",
}
"500":
@@ -176,6 +210,166 @@ components:
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:
File diff suppressed because it is too large. Load diff
@@ -1553,6 +1553,9 @@ components:
- productCategoryId: 8
name: Saldo
isTravelProduct: true
- productCategoryId: 9
name: Voucher
isTravelProduct: false
type: array
items:
$ref: '#/components/schemas/productCategoryGetEntity'
@@ -1811,7 +1814,7 @@ components:
- mandatoryCustomerDataItemId: 5
customerDataItem: address
- mandatoryCustomerDataItemId: 6
customerDataItem: phone
customerDataItem: voucher
- mandatoryCustomerDataItemId: 7
customerDataItem: ovPayToken
- mandatoryCustomerDataItemId: 8
+28
View File
@@ -46,6 +46,13 @@ paths:
when false, return only non-archived products (isArchived = false).
schema:
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:
'200':
description: OK
@@ -387,6 +394,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
@@ -474,6 +482,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
@@ -560,6 +569,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
@@ -680,6 +690,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "33610",
"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.",
@@ -866,6 +877,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901",
"tapConnectProductCode": null,
"productName": "HTM pilot 90% korting",
@@ -1028,6 +1040,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "30901",
"tapConnectProductCode": null,
"productName": "HTM pilot 90% korting",
@@ -1270,6 +1283,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": "33610",
"tapConnectProductCode": null,
"productName": "HTM Regio Vrij DH73",
@@ -1475,6 +1489,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": null,
"tapConnectProductCode": null,
"productName": "IBAN wijzigen functioneel product",
@@ -1672,6 +1687,7 @@ paths:
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"needsVoucher": false,
"gboPackageTemplateId": null,
"tapConnectProductCode": null,
"productName": "OV-pas saldo (1 eurocent)",
@@ -2775,6 +2791,10 @@ components:
type: boolean
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
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:
type: string
example: '30901'
@@ -3132,6 +3152,10 @@ components:
type: boolean
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
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:
type: string
description: >-
@@ -3503,6 +3527,10 @@ components:
type: boolean
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
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:
type: string
description: >-
@@ -1102,6 +1102,12 @@ paths:
format: uuid
example: 058a1af7-897f-45d5-b691-9cc9161e387f
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
name: voucherCode
schema:
@@ -1117,6 +1123,14 @@ paths:
explode: false
required: false
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:
"200":
description: OK
View File
Whitespace-only changes.