From 972219271e74e58227f202f196bd2779869336dd Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Wed, 19 Feb 2025 18:04:11 +0100 Subject: [PATCH] OVPAY-1518 - Added examples for GET Booking Processes v2. --- src/openapi/fiko/fiko-crud.yaml | 463 ++++++++++++++++++++++++++------ 1 file changed, 377 insertions(+), 86 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 04f48d8..14c38bf 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -460,15 +460,15 @@ paths: description: Transaction item created. correlationId: null Add new transaction audit trail for updated transaction item: - summary: Add new transaction audit trail for updated transaction item - description: Add a new audit trail record for an updated transaction item. - value: - user: r.meeuws - timestamp: 2022-01-02 12:34:00 - action: update - status: return to src - description: Transaction item returned to source. - correlationId: 0dc216ea-58e7-4a5e-aa18-449f0304209c + summary: Add new transaction audit trail for updated transaction item + description: Add a new audit trail record for an updated transaction item. + value: + user: r.meeuws + timestamp: 2022-01-02 12:34:00 + action: update + status: return to src + description: Transaction item returned to source. + correlationId: 0dc216ea-58e7-4a5e-aa18-449f0304209c responses: "201": description: Created @@ -613,43 +613,43 @@ paths: description: Validation XYZ failed. correlationId: null href: null - List containing multiple transaction audit trails of one transaction item: - summary: List containing multiple 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 description: List containing multiple audit trail records of one transaction item (with id d667d293-aa82-4c9e-9b10-77cffc9058a1). value: transactionAuditTrails: - - transactionAuditTrailId: d571ff7c-eaa5-428a-9bc3-5a0fa3e5ee2e - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-07 12:34:59 - action: update - status: re-entered - description: Transaction re-entered. - correlationId: null - - transactionAuditTrailId: b2192e6c-ab79-4000-a04d-d8f4d574a82f - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: r.meeuws - timestamp: 2025-01-04 12:34:54 - action: update - status: return to src - description: Transaction retunred to source. - correlationId: a3891560-3084-42cb-867c-f289e7cda47d - - transactionAuditTrailId: 1d759985-7f1a-48bd-8dd1-efa30ce26423 - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-02 00:34:50 - action: update - status: failed - description: Validation XYZ failed. - correlationId: null - - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-01 12:34:47 - action: create - status: created - description: Transaction created. - correlationId: null + - transactionAuditTrailId: d571ff7c-eaa5-428a-9bc3-5a0fa3e5ee2e + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-07 12:34:59 + action: update + status: re-entered + description: Transaction re-entered. + correlationId: null + - transactionAuditTrailId: b2192e6c-ab79-4000-a04d-d8f4d574a82f + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: r.meeuws + timestamp: 2025-01-04 12:34:54 + action: update + status: return to src + description: Transaction retunred to source. + correlationId: a3891560-3084-42cb-867c-f289e7cda47d + - transactionAuditTrailId: 1d759985-7f1a-48bd-8dd1-efa30ce26423 + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-02 00:34:50 + action: update + status: failed + description: Validation XYZ failed. + correlationId: null + - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-01 12:34:47 + action: create + status: created + description: Transaction created. + correlationId: null href: null List containing multiple audit trails of failed transactions: summary: List containing multiple audit trails of failed transactions @@ -688,7 +688,7 @@ paths: status: failed description: Validation XYZ failed. correlationId: null - href: null + href: null /processingfailures: get: summary: Find processing failures. @@ -834,6 +834,21 @@ paths: application/json: schema: $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: summary: Add a booking process. description: Add a booking process. @@ -990,6 +1005,37 @@ paths: application/json: schema: $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}: parameters: - in: path @@ -1108,6 +1154,63 @@ paths: application/json: schema: $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}: parameters: - in: path @@ -1209,31 +1312,37 @@ paths: schema: type: string example: extRef1 + description: External reference 1. - in: query name: extRef2 schema: type: string example: extRef2 + description: External reference 2. - in: query name: extRef3 schema: type: string example: extRef3 + description: External reference 3. - in: query name: extRef4 schema: type: string example: extRef4 + description: External reference 4. - in: query name: extRef5 schema: type: string example: extRef5 + description: External reference 5. - in: query name: extRef6 schema: type: string example: extRef6 + description: External reference 6. responses: "200": description: OK @@ -1241,6 +1350,188 @@ paths: application/json: schema: $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}: parameters: - in: path @@ -1478,27 +1769,27 @@ paths: description: Returns a list containing all source metadata (no filters applied). value: sourceMetadata: - - sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 - incomingName: HTM-web - incomingEntity: OrderLine - outgoingName: webshop - businessOwner: Corneel Verstoep - rejectionProcessing: system - rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc - - sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc - incomingName: HTM-app - incomingEntity: OrderLine - outgoingName: ticketapp - businessOwner: Daan Zeven - rejectionProcessing: mail - rejectionInfo: sven@infoplaza.nl - - sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209 - incomingName: SMP - incomingEntity: OrderLine - outgoingName: balieverkoop - businessOwner: Gijs Sip - rejectionProcessing: mail - rejectionInfo: ao@htm.nl + - sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 + incomingName: HTM-web + incomingEntity: OrderLine + outgoingName: webshop + businessOwner: Corneel Verstoep + rejectionProcessing: system + rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc + - sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc + incomingName: HTM-app + incomingEntity: OrderLine + outgoingName: ticketapp + businessOwner: Daan Zeven + rejectionProcessing: mail + rejectionInfo: sven@infoplaza.nl + - sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209 + incomingName: SMP + incomingEntity: OrderLine + outgoingName: balieverkoop + businessOwner: Gijs Sip + rejectionProcessing: mail + rejectionInfo: ao@htm.nl href: null post: summary: Add source metadata. @@ -1585,15 +1876,15 @@ paths: description: Returns a list containing all accounting period metadata (no filters applied). value: accountingPeriodMetadata: - - accountingPeriodMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb - accountingPeriod: 2025/01 - isOpen: true - - accountingPeriodMetadataId: 36a34bd8-2b84-4c89-87a4-22e809f6ed4a - accountingPeriod: 2024/12 - isOpen: false - - accountingPeriodMetadataId: 33b4889b-0036-4870-87df-be43f9316cdf - accountingPeriod: 2024/11 - isOpen: false + - accountingPeriodMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + accountingPeriod: 2025/01 + isOpen: true + - accountingPeriodMetadataId: 36a34bd8-2b84-4c89-87a4-22e809f6ed4a + accountingPeriod: 2024/12 + isOpen: false + - accountingPeriodMetadataId: 33b4889b-0036-4870-87df-be43f9316cdf + accountingPeriod: 2024/11 + isOpen: false href: null post: summary: Add accounting period metadata. @@ -1690,42 +1981,42 @@ paths: value: concessionMetadata: - concessionMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb - concession: + concession: concessionId: 1 name: RAIL percentage: 84.021 validFrom: 2025-01-01T00:00:00.000 validUntil: null - concessionMetadataId: 39720be0-af88-486a-b5e2-faea7eb5b352 - concession: + concession: concessionId: 2 name: BUS percentage: 15.979 validFrom: 2025-01-01T00:00:00.000 validUntil: null - concessionMetadataId: 274db383-96dd-410e-a07e-0b9e3040ac91 - concession: + concession: concessionId: 1 name: RAIL percentage: 83.021 validFrom: 2024-12-01T00:00:00.000 validUntil: 2024-12-31T23:59:59.999 - concessionMetadataId: 03959bc5-83f2-4ac7-9bf5-67e0f2a6eace - concession: + concession: concessionId: 2 name: BUS percentage: 16.979 validFrom: 2024-12-01T00:00:00.000 validUntil: 2024-12-31T23:59:59.999 - concessionMetadataId: d5b7d8f6-5cb8-482e-9d9a-68909dc7b5d3 - concession: + concession: concessionId: 1 name: RAIL percentage: 85.021 validFrom: 2024-11-01T00:00:00.000 validUntil: 2024-11-30T23:59:59.999 - concessionMetadataId: 5ee5f86f-ab00-4630-b130-4714fd060d1a - concession: + concession: concessionId: 2 name: BUS percentage: 14.979 @@ -1911,10 +2202,10 @@ paths: description: Returns a list containing all concessions (no filters applied). value: concessions: - - concessionId: 1 - name: RAIL - - concessionId: 2 - name: BUS + - concessionId: 1 + name: RAIL + - concessionId: 2 + name: BUS href: null components: securitySchemes: @@ -2743,7 +3034,7 @@ components: type: string format: uuid example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - bookingGroupMetadataId: + bookingMetadataId: type: string format: uuid example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 @@ -2752,7 +3043,7 @@ components: example: 1737 required: - bookingGroupFieldId - - bookingGroupMetadataId + - bookingMetadataId - identifyingFieldValue href: type: string