HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

OVPAY-1518 - Added examples for GET Booking Processes v2.

Browse Source
This commit is contained in:
Bas Boterman 2025-02-19 18:04:11 +01:00
parent 7b2cf2f579
commit 972219271e
1 changed files with 377 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

299
src/openapi/fiko/fiko-crud.yaml
View File

@ -613,8 +613,8 @@ paths:
description: Validation XYZ failed. description: Validation XYZ failed.
correlationId: null correlationId: null
href: null href: null
List containing multiple transaction audit trails of one transaction item: ? List containing multiple transaction audit trails of one transaction item
summary: List containing multiple audit trails of one transaction item : summary: List containing multiple audit trails of one transaction item
description: List containing multiple audit trail records of one transaction item (with id d667d293-aa82-4c9e-9b10-77cffc9058a1). description: List containing multiple audit trail records of one transaction item (with id d667d293-aa82-4c9e-9b10-77cffc9058a1).
value: value:
transactionAuditTrails: transactionAuditTrails:
@ -834,6 +834,21 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingProcessesGetResponseBody" $ref: "#/components/schemas/BookingProcessesGetResponseBody"
examples:
List containing all booking processes:
summary: List containing all booking processes
description: Returns a list containing all booking processes (no filters applied).
value:
bookingProcesses:
- bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
name: Verkooptransacties
transactionType: sales
identifyingFieldName: articleNumber
- bookingProcessId: 03105285-3c4c-477a-821c-0fae801d9d26
name: Inkooptransacties
transactionType: purchase
identifyingFieldName: null
href: null
post: post:
summary: Add a booking process. summary: Add a booking process.
description: Add a booking process. description: Add a booking process.
@ -990,6 +1005,37 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingMetadataGetResponseBody" $ref: "#/components/schemas/BookingMetadataGetResponseBody"
examples:
List containing all booking metadata:
summary: List containing all booking metadata
description: Returns a list containing all booking metadata (no filters applied).
value:
bookingMetadata:
- bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
description: Dagkaart
department: 900
costType: 84956
documentCode: FIKO-OPBR
hasSeparateTaxLine: true
hasLinePerIdentifyingField: true
hasLinePerSource: true
hasLinePerConcession: true
validFrom: 2022-01-01 00:00:00
validTo: null
- bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
description: Saldoreizen
department: 900
costType: 84955
documentCode: FIKO-OPBR
hasSeparateTaxLine: true
hasLinePerIdentifyingField: true
hasLinePerSource: true
hasLinePerConcession: true
validFrom: 2022-01-01 00:00:00
validTo: null
href: null
/bookingmetadata/{bookingMetadataId}: /bookingmetadata/{bookingMetadataId}:
parameters: parameters:
- in: path - in: path
@ -1108,6 +1154,63 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingGroupFieldsGetResponseBody" $ref: "#/components/schemas/BookingGroupFieldsGetResponseBody"
examples:
List containing all booking group fields:
summary: List containing all booking group fields
description: Returns a list containing all booking group fields for all booking metadata (no filters applied).
value:
bookingGroupFields:
- bookingGroupFieldId: b34d0fc2-96fc-409b-93b6-ae51fb8c694a
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1737
- bookingGroupFieldId: 3b9005f4-42c4-4e2b-b472-ba7d0926fe77
bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
identifyingFieldValue: 1748
- bookingGroupFieldId: ae773282-ac9b-4a0b-a487-b4061ea2a42f
bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
identifyingFieldValue: 1750
- bookingGroupFieldId: fe1aca8c-3ef5-4e15-962b-202d28d3d761
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1757
href: null
List containing all booking group fields for a single booking:
summary: List containing all booking group fields for a single booking
description: |
Returns a list containing all booking group fields for a single booking booking metadata 'Dagkaart'
(identified by the same bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617).
value:
bookingGroupFields:
- bookingGroupFieldId: b34d0fc2-96fc-409b-93b6-ae51fb8c694a
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1737
- bookingGroupFieldId: fe1aca8c-3ef5-4e15-962b-202d28d3d761
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1757
- bookingGroupFieldId: fede01e0-86c5-47d0-9466-3093132148e5
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4031
- bookingGroupFieldId: d7c25182-b64e-4e47-8998-19ddb65b8f2c
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4032
- bookingGroupFieldId: ea02d3eb-29e6-42fd-b7eb-dfbfd2231090
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4033
- bookingGroupFieldId: a73407a6-ff8c-4924-a7ac-5cd605e1793c
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4034
- bookingGroupFieldId: d9af4bf1-4e85-4eb6-ae5d-d2020b18d63c
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4051
- bookingGroupFieldId: c1ba494b-249a-475b-a542-19918aa36778
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4053
- bookingGroupFieldId: 69be1be0-c600-492d-aec1-8490409371da
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4054
- bookingGroupFieldId: d7d00ec1-6d53-44e9-bcd8-01f6a523f771
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4055
href: null
/bookinggroupfields/{bookingGroupFieldId}: /bookinggroupfields/{bookingGroupFieldId}:
parameters: parameters:
- in: path - in: path
@ -1209,31 +1312,37 @@ paths:
schema: schema:
type: string type: string
example: extRef1 example: extRef1
description: External reference 1.
- in: query - in: query
name: extRef2 name: extRef2
schema: schema:
type: string type: string
example: extRef2 example: extRef2
description: External reference 2.
- in: query - in: query
name: extRef3 name: extRef3
schema: schema:
type: string type: string
example: extRef3 example: extRef3
description: External reference 3.
- in: query - in: query
name: extRef4 name: extRef4
schema: schema:
type: string type: string
example: extRef4 example: extRef4
description: External reference 4.
- in: query - in: query
name: extRef5 name: extRef5
schema: schema:
type: string type: string
example: extRef5 example: extRef5
description: External reference 5.
- in: query - in: query
name: extRef6 name: extRef6
schema: schema:
type: string type: string
example: extRef6 example: extRef6
description: External reference 6.
responses: responses:
"200": "200":
description: OK description: OK
@ -1241,6 +1350,188 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingLineMetadataGetResponseBody" $ref: "#/components/schemas/BookingLineMetadataGetResponseBody"
examples:
List containing all booking line metadata:
summary: List containing all booking line metadata
description: Returns a list containing all booking line metadata for all bookings (no filters applied).
value:
bookingLineMetadata:
- bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop - Dagkaart - BUS
sourceMetadata:
sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0
incomingName: HTM-website
incomingEntity: OrderLine
outgoingName: Webshop
businessOwner: Corneel Verstoep
rejectionProcessing: system
rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc
identifyingFieldValue: null
concession:
concessionId: 2
name: BUS
lineType: summary
lineSense: credit
costCenter: 603031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- bookingLineMetadataId: 1bca01db-40d3-4447-9f28-41475ec6877d
bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
name: TLS - Saldoreizen - RAIL
sourceMetadata:
sourceMetadataId: 4b06a325-1078-4a2f-b63e-1d81eae8e5c3
incomingName: Translink
incomingEntity: Trip
outgoingName: TLS
businessOwner: Corneel Verstoep
rejectionProcessing: mail
rejectionInfo: helpdesk@translink.nl
identifyingFieldValue: null
concession:
concessionId: 1
name: RAIL
lineType: summary
lineSense: credit
costCenter: 603007
articleName: Opbrengst TLS
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: TLS
extRef6: null
href: null
List containing booking line metadata of one booking:
summary: List containing booking line metadata of one booking
description: |
Returns a list containing all booking line metadata a single booking.
This example contains all the booking lines for a 'Dagkaart' booking
(bookingMetadataId: "6ce10520-9a73-4cb4-b8dd-39ee46ceb617").
value:
bookingLineMetadata:
- bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop Dagkaart - BUS
sourceMetadata:
sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0
incomingName: HTM-website
incomingEntity: OrderLine
outgoingName: Webshop
businessOwner: Corneel Verstoep
rejectionProcessing: system
rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc
identifyingFieldValue: null
concession:
concessionId: 2
name: BUS
lineType: summary
lineSense: credit
costCenter: 619031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- bookingLineMetadataId: a4464b5c-9a8e-4e48-a0a0-5500b1ca0885
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop Dagkaart - RAIL
sourceMetadata:
sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0
incomingName: HTM-website
incomingEntity: OrderLine
outgoingName: Webshop
businessOwner: Corneel Verstoep
rejectionProcessing: system
rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc
identifyingFieldValue: null
concession:
concessionId: 1
name: RAIL
lineType: summary
lineSense: credit
costCenter: 603031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- bookingLineMetadataId: feaa7b33-ba49-40a2-90f3-5dd70d591f17
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Ticketapp Dagkaart - BUS
sourceMetadata:
sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc
incomingName: HTM-app
incomingEntity: OrderLine
outgoingName: ticketapp
businessOwner: Daan Zeven
rejectionProcessing: mail
rejectionInfo: sven@infoplaza.nl
identifyingFieldValue: null
concession:
concessionId: 2
name: BUS
lineType: summary
lineSense: credit
costCenter: 619031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- bookingLineMetadataId: ea6ce4e7-4d52-4b89-bbea-ffe0ef6c48ff
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Ticketapp Dagkaart - RAIL
sourceMetadata:
sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc
incomingName: HTM-app
incomingEntity: OrderLine
outgoingName: ticketapp
businessOwner: Daan Zeven
rejectionProcessing: mail
rejectionInfo: sven@infoplaza.nl
identifyingFieldValue: null
concession:
concessionId: 1
name: RAIL
lineType: summary
lineSense: credit
costCenter: 603031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- bookingLineMetadataId: 0a8dbb7d-73c8-451e-9028-e4613283c7bd
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Dagkaart - BTW
sourceMetadata: null
identifyingFieldValue: null
concession: null
lineType: tax
lineSense: credit
costCenter: 1337
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: null
extRef6: null
href: null
/bookinglinemetadata/{bookingLineMetadataId}: /bookinglinemetadata/{bookingLineMetadataId}:
parameters: parameters:
- in: path - in: path
@ -2743,7 +3034,7 @@ components:
type: string type: string
format: uuid format: uuid
example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
bookingGroupMetadataId: bookingMetadataId:
type: string type: string
format: uuid format: uuid
example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 example: 12b4d128-0ab8-4a4a-944d-25b83de38b27
@ -2752,7 +3043,7 @@ components:
example: 1737 example: 1737
required: required:
- bookingGroupFieldId - bookingGroupFieldId
- bookingGroupMetadataId - bookingMetadataId
- identifyingFieldValue - identifyingFieldValue
href: href:
type: string type: string