src/openapi/fiko/fiko-crud.yaml

@@ -437,13 +437,13 @@ paths:
                     transactionLineId already exists. Therefore, the whole batch is rolled back and
                     rejected.
                   value:
-                    code: '409'
+                    code: "409"
                     type: error
                     message: conflict
                     description: A transaction with the same TransactionId and TransactionLineId already exists.
                     errors:
                       - detail: Transaction is a duplicate of a transaction already in the system.
-                        pointer: '#/transactionItems/0'
+                        pointer: "#/transactionItems/0"
                         transactionId: 1ad109d3-fd7d-4b6f-872b-220d492f385f
                         transactionLineId: fee907dd-e59d-44f5-a63b-bbdec38f79b7
   /transactionitems/{transactionItemId}/processingfailures:
@@ -1925,6 +1925,16 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/TaxMetadataPostRequestBody"
+            examples:
+              Add new tax metadata:
+                summary: Add new tax metadata
+                description: This example adds a new tax metadata record to the database.
+                value:
+                  taxCode: V21.4
+                  taxPercentageAmount: 21.4
+                  description: BTW VERKOOP HOOG 21.4%
+                  validFrom: 2025-03-22T09:00:00
+                  validUntil: null
       responses:
         "201":
           description: Created
@@ -1932,6 +1942,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/TaxMetadataPostResponseBody"
+              examples:
+                Tax metadata created successfully:
+                  summary: Tax metadata created successfully
+                  description: The tax metadata was successfully added to the database.
+                  value:
+                    taxMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
   /taxmetadata/{taxMetadataId}:
     parameters:
       - in: path
@@ -1953,6 +1969,12 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/TaxMetadataPatchRequestBody"
+            examples:
+              Update tax metadata:
+                summary: Update tax metadata
+                description: In this example the tax metadata is updated. The validUntil field is updated to 2025-03-22T09:00:00.
+                value:
+                  validUntil: 2025-03-22T09:00:00
       responses:
         "200":
           description: OK
@@ -1960,6 +1982,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/TaxMetadataPatchResponseBody"
+              examples:
+                Tax metadata updated successfully:
+                  summary: Tax metadata updated successfully
+                  description: The tax metadata was successfully updated in the database.
+                  value:
+                    taxMetadataId: 7c3a5b0f-b89e-4f02-8b09-d11c5a050a07
   /sourcemetadata:
     get:
       summary: Find source metadata.
@@ -2059,6 +2087,17 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/SourceMetadataPostRequestBody"
+            examples:
+              Add a new source to the metadata:
+                summary: Add a new source to the metadata
+                description: Add a new record to the source metadata in the database.
+                value:
+                  incomingName: HTM-app
+                  incomingEntity: OrderLine
+                  outgoingName: ticketapp
+                  businessOwner: Daan Zeven
+                  rejectionProcessing: mail
+                  rejectionInfo: sven@infoplaza.nl
       responses:
         "201":
           description: Created
@@ -2066,6 +2105,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/SourceMetadataPostResponseBody"
+              examples:
+                Source metadata created successfully:
+                  summary: Source metadata created successfully
+                  description: The source metadata was successfully added to the database.
+                  value:
+                    sourceMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
   /sourcemetadata/{sourceMetadataId}:
     parameters:
       - in: path
@@ -2087,6 +2132,12 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/SourceMetadataPatchRequestBody"
+            examples:
+              Update a source in the metadata:
+                summary: Update a source in the metadata
+                description: In this example we update the business owner of a single source meta data
+                value:
+                  businessOwner: Eric Kok
       responses:
         "200":
           description: OK
@@ -2094,6 +2145,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/SourceMetadataPatchResponseBody"
+              examples:
+                Source metadata updated successfully:
+                  summary: Source metadata updated successfully
+                  description: The source metadata was successfully updated in the database.
+                  value:
+                    sourceMetadataId: 37a8095b-19db-498f-9349-5f37d21c5bdf
   /accountingperiodmetadata:
     get:
       summary: Find accounting period metadata.
@@ -2154,6 +2211,13 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/AccountingPeriodMetadataPostRequestBody"
+            examples:
+              Add a new accounting period metadata:
+                summary: Add a new accounting period metadata
+                description: In this example we add a new accounting period metadata.
+                value:
+                  accountingPeriod: 2025/03
+                  isOpen: true
       responses:
         "201":
           description: Created
@@ -2161,6 +2225,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/AccountingPeriodMetadataPostResponseBody"
+              examples:
+                Accounting period metadata created successfully:
+                  summary: Accounting period metadata created successfully
+                  description: The accounting period metadata was successfully added to the database.
+                  value:
+                    accountingPeriodMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
   /accountingperiodmetadata/{accountingPeriodMetadataId}:
     parameters:
       - in: path
@@ -2182,6 +2252,12 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/AccountingPeriodMetadataPatchRequestBody"
+            examples:
+              Update an accounting period metadata:
+                summary: Update an accounting period metadata
+                description: In this example we close an existing accounting period in the metadata.
+                value:
+                  isOpen: false
       responses:
         "200":
           description: OK
@@ -2189,6 +2265,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/AccountingPeriodMetadataPatchResponseBody"
+              examples:
+                Accounting period metadata updated successfully:
+                  summary: Accounting period metadata updated successfully
+                  description: The accounting period metadata was successfully updated in the database.
+                  value:
+                    accountingPeriodMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
   /concessionmetadata:
     get:
       summary: Find concession metadata.
@@ -2291,6 +2373,17 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/ConcessionMetadataPostRequestBody"
+            examples:
+              Add a new concession distribution:
+                summary: Add a new concession distribution
+                description: |
+                  Every month, the administrator determines the concession distribution for the next month.
+                  In this example, a new concession distribution for RAIL is added to the metadata.
+                value:
+                  concessionId: 1
+                  percentage: 83.041
+                  validFrom: 2025-03-01T00:00:00.000
+                  validUntil: null
       responses:
         "201":
           description: Created
@@ -2298,6 +2391,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ConcessionMetadataPostResponseBody"
+              examples:
+                Concession metadata added succesfully:
+                  summary: Concession metadata added succesfully
+                  description: The new concession metadata was successfully added to the database.
+                  value:
+                    concessionMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
   /concessionmetadata/{concessionMetadataId}:
     parameters:
       - in: path
@@ -2319,6 +2418,14 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/ConcessionMetadataPatchRequestBody"
+            examples:
+              Update a concession distribution:
+                summary: Update a concession distribution
+                description: |
+                  Every month, the administrator determines the concession distribution for the next month.
+                  In this example, the concession distribution for last month gets an end date.
+                value:
+                  validUntil: 2025-02-28T23:59:59.999
       responses:
         "200":
           description: OK
@@ -2326,6 +2433,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ConcessionMetadataPatchResponseBody"
+              examples:
+                Concession metadata updated successfully:
+                  summary: Concession metadata updated successfully
+                  description: The concession metadata was successfully updated in the database.
+                  value:
+                    concessionMetadataId: 37a8095b-19db-498f-9349-5f37d21c5bdf
   /metadataaudittrails:
     get:
       summary: Find metadata audit trails.