src/openapi/fiko/fiko-crud.yaml

@@ -219,7 +219,7 @@ paths:
       x-throttling-tier: Unlimited
   /transactionitems:
     post:
-      summary: P1. Add one ore more finanicial transaction items in bulk.
+      summary: Add one ore more finanicial transaction items in bulk.
       description: Add one ore more finanicial transaction items in bulk.
       tags:
         - Transactions v2.2
@@ -314,7 +314,7 @@ paths:
         required: true
         description: The id of the transaction item.
     patch:
-      summary: P1. Update a transaction item.
+      summary: Update a transaction item.
       description: Update a transaction item.
       tags:
         - Transactions v2.2
@@ -366,7 +366,7 @@ paths:
     get:
       tags:
         - Transactions v2.2
-      summary: P1. Get the status of the transaction items POST.
+      summary: Get the status of the transaction items POST.
       description: Get the status of the asynchronous transaction items POST processing.
       parameters:
         - in: path
@@ -431,7 +431,7 @@ paths:
         required: true
         description: The id of the transaction item to process.
     post:
-      summary: P1. Add a processing failure.
+      summary: Add a processing failure.
       description: Add a processing failure.
       tags:
         - Failures v2.2
@@ -483,7 +483,7 @@ paths:
         required: true
         description: The id of the transaction item to process.
     post:
-      summary: P1. Add an audit trail entry.
+      summary: Add an audit trail entry.
       description: Add an audit trail entry.
       tags:
         - Audit Trail v2.2
@@ -934,7 +934,7 @@ paths:
         required: true
         description: The id of the processing failure.
     patch:
-      summary: P1. Update processing failure.
+      summary: Update processing failure.
       description: Update processing failure.
       tags:
         - Failures v2.2
@@ -1046,7 +1046,7 @@ paths:
       x-throttling-tier: Unlimited
   /bookingprocesses:
     post:
-      summary: P2. Add a booking process.
+      summary: Add a booking process.
       description: Add a booking process.
       tags:
         - Booking Processes v2.2
@@ -1093,7 +1093,7 @@ paths:
         required: true
         description: The id of the booking process.
     patch:
-      summary: P2. Update a booking process.
+      summary: Update a booking process.
       description: Update a booking process.
       tags:
         - Booking Processes v2.2
@@ -1138,7 +1138,7 @@ paths:
         required: true
         description: The id of the booking process.
     post:
-      summary: P2. Add booking metadata.
+      summary: Add booking metadata.
       description: Add booking metadata.
       tags:
         - Booking Processes v2.2
@@ -1154,9 +1154,8 @@ paths:
                 description: |
                   This example shows how a new booking metadata for a booking process can be added.
                 value:
-                  description: Saldoreizen
+                  name: Saldoreizen
-                  department: 900
+                  description: Saldoreizen nov. 2024
-                  costType: 84955
                   documentCode: OPBR-FIKO
                   hasSeparateTaxLine: true
                   hasLinePerIdentifyingField: false
@@ -1207,9 +1206,8 @@ paths:
                 - bookingMetadataRowId
                 - bookingMetadataId
                 - bookingProcessId
+                - name
                 - description
-                - department
-                - costType
                 - documentCode
                 - hasSeparateTaxLine
                 - hasLinePerIdentifyingField
@@ -1232,9 +1230,8 @@ paths:
                 - bookingMetadataRowId
                 - bookingMetadataId
                 - bookingProcessId
+                - name
                 - description
-                - department
-                - costType
                 - documentCode
                 - hasSeparateTaxLine
                 - hasLinePerIdentifyingField
@@ -1273,10 +1270,9 @@ paths:
                         bookingMetadataRowId: 13
                         bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
                         bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
-                        description: Dagkaart
+                        name: Dagkaarten
-                        department: 900
+                        description: Dagkaarten nov. 2024
-                        costType: 84956
+                        documentCode: OPBR-FIKO
-                        documentCode: FIKO-OPBR
                         hasSeparateTaxLine: true
                         hasLinePerIdentifyingField: true
                         hasLinePerSource: true
@@ -1287,10 +1283,9 @@ paths:
                         bookingMetadataRowId: 14
                         bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
                         bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
-                        description: Saldoreizen
+                        name: Saldoreizen
-                        department: 900
+                        description: Saldoreizen nov. 2024
-                        costType: 84955
+                        documentCode: OPBR-FIKO
-                        documentCode: FIKO-OPBR
                         hasSeparateTaxLine: true
                         hasLinePerIdentifyingField: true
                         hasLinePerSource: true
@@ -1312,7 +1307,7 @@ paths:
         required: true
         description: The id of the booking metadata.
     patch:
-      summary: P2. Update booking metadata.
+      summary: Update booking metadata.
       description: Update booking metadata.
       tags:
         - Booking Processes v2.2
@@ -1328,6 +1323,14 @@ paths:
                 description: |
                   In this example the booking metadata is updated. The validUntil field is updated to 2024-03-22T09:00:00.
                 value:
+                  name: Dagkaarten
+                  description: Dagkaarten nov. 2024
+                  documentCode: OPBR-FIKO
+                  hasSeparateTaxLine: true
+                  hasLinePerIdentifyingField: true
+                  hasLinePerSource: true
+                  hasLinePerConcession: true
+                  validFrom: 2022-01-01 00:00:00
                   validUntil: 2024-03-22T09:00:00
       responses:
         "200":
@@ -1346,6 +1349,20 @@ paths:
         - default: []
       x-auth-type: Application & Application User
       x-throttling-tier: Unlimited
+    delete:
+      summary: Delete booking metadata.
+      description: | 
+        Delete booking metadata. Note that booking metadata can only be deleted
+        if the validFrom is in the future.
+      tags:
+        - Booking Processes v2.2
+      responses:
+        "200":
+          description: OK
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited      
   /bookingmetadata/{bookingMetadataId}/bookinggroupfields:
     parameters:
       - in: path
@@ -1357,7 +1374,7 @@ paths:
         required: true
         description: The id of the booking metadata.
     post:
-      summary: P2. Add booking group fields.
+      summary: Add booking group fields.
       description: Add booking group fields.
       tags:
         - Booking Processes v2.2
@@ -1401,7 +1418,7 @@ paths:
         required: true
         description: The id of the booking metadata.
     post:
-      summary: P2. Add booking line metadata.
+      summary: Add booking line metadata.
       description: Add booking line metadata.
       tags:
         - Booking Processes v2.2
@@ -1628,7 +1645,7 @@ paths:
         required: true
         description: The id of the booking group field.
     delete:
-      summary: P2. Delete booking group field.
+      summary: Delete booking group field.
       description: Delete booking group field.
       tags:
         - Booking Processes v2.2
@@ -1887,7 +1904,7 @@ paths:
         required: true
         description: The id of the booking line metadata.
     patch:
-      summary: P2. Update booking line metadata.
+      summary: Update booking line metadata.
       description: Update booking line metadata.
       tags:
         - Booking Processes v2.2
@@ -1922,7 +1939,7 @@ paths:
       x-auth-type: Application & Application User
       x-throttling-tier: Unlimited
     delete:
-      summary: P2. Delete booking line metadata.
+      summary: Delete booking line metadata.
       description: Delete booking line metadata.
       tags:
         - Booking Processes v2.2
@@ -2050,7 +2067,7 @@ paths:
       x-throttling-tier: Unlimited
   /taxmetadata:
     post:
-      summary: P3. Add tax metadata.
+      summary: Add tax metadata.
       description: Add tax metadata.
       tags:
         - Metadata v2.2
@@ -2098,7 +2115,7 @@ paths:
         required: true
         description: The id of the tax metadata.
     patch:
-      summary: P3. Update tax metadata.
+      summary: Update tax metadata.
       description: Update tax metadata.
       tags:
         - Metadata v2.2
@@ -2229,7 +2246,7 @@ paths:
       x-throttling-tier: Unlimited
   /sourcemetadata:
     post:
-      summary: P3. Add source metadata.
+      summary: Add source metadata.
       description: Add source metadata.
       tags:
         - Metadata v2.2
@@ -2278,7 +2295,7 @@ paths:
         required: true
         description: The id of the source metadata.
     patch:
-      summary: P3. Update source metadata.
+      summary: Update source metadata.
       description: Update source metadata.
       tags:
         - Metadata v2.2
@@ -2389,7 +2406,7 @@ paths:
       x-throttling-tier: Unlimited
   /accountingperiodmetadata:
     post:
-      summary: P2. Add accounting period metadata.
+      summary: Add accounting period metadata.
       description: Add accounting period metadata.
       tags:
         - Metadata v2.2
@@ -2434,7 +2451,7 @@ paths:
         required: true
         description: The id of the accounting period metadata.
     patch:
-      summary: P2. Update accounting period metadata.
+      summary: Update accounting period metadata.
       description: Update accounting period metadata.
       tags:
         - Metadata v2.2
@@ -2589,7 +2606,7 @@ paths:
       x-throttling-tier: Unlimited
   /concessionmetadata:
     post:
-      summary: P2. Add concession metadata.
+      summary: Add concession metadata.
       description: Add concession metadata.
       tags:
         - Metadata v2.2
@@ -2638,7 +2655,7 @@ paths:
         required: true
         description: The id of the concession metadata.
     patch:
-      summary: P2. Update concession metadata.
+      summary: Update concession metadata.
       description: Update concession metadata.
       tags:
         - Metadata v2.2
@@ -3418,18 +3435,15 @@ components:
           type: string
           format: uuid
           example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+        name:
+          type: string
+          example: Dagkaarten
         description:
           type: string
-          example: Dagkaart
+          example: Dagkaarten nov. 2024
-        department:
-          type: string
-          example: 900
-        costType:
-          type: string
-          example: 84956
         documentCode:
           type: string
-          example: FIKO-OPBR
+          example: OPBR-FIKO
         hasSeparateTaxLine:
           type: boolean
           example: true
@@ -3454,9 +3468,8 @@ components:
       required:
         - bookingMetadataId
         - bookingProcessId
+        - name
         - description
-        - department
-        - costType
         - documentCode
         - hasSeparateTaxLine
         - hasLinePerIdentifyingField
@@ -3466,18 +3479,15 @@ components:
     BookingMetadataPostRequestBody:
       type: object
       properties:
+        name:
+          type: string
+          example: Dagkaarten
         description:
           type: string
-          example: Dagkaart
+          example: Dagkaarten nov. 2024
-        department:
-          type: string
-          example: 900
-        costType:
-          type: string
-          example: 84956
         documentCode:
           type: string
-          example: FIKO-OPBR
+          example: OPBR-FIKO
         hasSeparateTaxLine:
           type: boolean
           example: true
@@ -3500,9 +3510,8 @@ components:
           nullable: true
           example: null
       required:
+        - name
         - description
-        - department
-        - costType
         - documentCode
         - hasSeparateTaxLine
         - hasLinePerIdentifyingField
@@ -3521,22 +3530,18 @@ components:
     BookingMetadataPatchRequestBody:
       type: object
       properties:
-        description:
+        name:
           type: string
           nullable: true
-          example: Dagkaart
+          example: Dagkaarten
-        department:
+        description: 
           type: string
           nullable: true
-          example: 900
+          example: Dagkaarten nov. 2024
-        costType:
-          type: string
-          nullable: true
-          example: 84956
         documentCode:
           type: string
           nullable: true
-          example: FIKO-OPBR
+          example: OPBR-FIKO
         hasSeparateTaxLine:
           type: boolean
           nullable: true