src/openapi/contracts/contracts-crud.yaml

@@ -216,7 +216,6 @@ paths:
                               "created": "2024-06-02 15:01:00.000",
                               "updated": "2024-06-02 15:01:00.000",
                               "state": "invoice_created",
-                              "isCredit": false,
                             },
                             {
                               "contractInvoiceId": "1c345237-4d84-47f0-93c2-7b94338e3355",
@@ -225,7 +224,6 @@ paths:
                               "created": "2024-07-02 15:01:00.000",
                               "updated": "2024-07-02 15:01:00.000",
                               "state": "invoice_created",
-                              "isCredit": false,
                             },
                           ],
                         "contractVersions":
@@ -275,7 +273,6 @@ paths:
                               "created": "2024-06-02 15:01:00.000",
                               "updated": "2024-06-02 15:01:00.000",
                               "state": "invoice_created",
-                              "isCredit": false,
                             },
                             {
                               "contractInvoiceId": "1c345237-4d84-47f0-93c2-7b94338e3355",
@@ -284,7 +281,6 @@ paths:
                               "created": "2024-07-02 15:01:00.000",
                               "updated": "2024-07-02 15:01:00.000",
                               "state": "invoice_created",
-                              "isCredit": false,
                             },
                           ],
                         "contractVersions":
@@ -405,7 +401,6 @@ paths:
                             "updated": "2024-07-02 15:01:00.000",
                             "state": "invoice_created",
                             "data": "{json}",
-                            "isCredit": false,
                           },
                         ],
                     },
@@ -573,7 +568,6 @@ paths:
                         "updated": "2024-07-02 15:01:00.000",
                         "state": "invoice_sent",
                         "data": "{json}",
-                        "isCredit": false,
                       },
                       {
                         "contractInvoiceId": "dadff658-4ff5-4eb8-b516-492f1f6c6245",
@@ -583,7 +577,6 @@ paths:
                         "updated": "2024-08-02 15:01:00.000",
                         "state": "invoice_created",
                         "data": "{json}",
-                        "isCredit": false,
                       },
                     ],
                 }
@@ -607,7 +600,6 @@ paths:
                     "updated": "2024-07-02 15:01:00.000",
                     "state": "invoice_created",
                     "data": "{json}",
-                    "isCredit": false,
                   },
               }
       responses:
@@ -692,13 +684,6 @@ paths:
             example: created
           required: false
           description: Invoice state.
-        - in: query
-          name: isCredit
-          schema:
-            type: boolean
-            example: false
-          required: false
-          description: Whether the invoice is a credit invoice.
       responses:
         "200":
           description: OK
@@ -719,7 +704,6 @@ paths:
                         "updated": "2024-06-02 15:01:00.000",
                         "state": "invoice_created",
                         "data": "{json}",
-                        "isCredit": false,
                       },
                       {
                         "contractId": "a7452e22-3894-40cc-87d6-869370a92277",
@@ -730,7 +714,6 @@ paths:
                         "updated": "2024-08-02 15:01:00.000",
                         "state": "invoice_created",
                         "data": "{json}",
-                        "isCredit": false,
                       },
                     ],
                 }
@@ -1066,9 +1049,6 @@ components:
           type: string
           format: json
           example: { json }
-        isCredit:
-          type: boolean
-          example: false
     ContractStatus:
       type: object
       properties:

src/openapi/fiko/fiko-crud.yaml

@@ -13,13 +13,6 @@ paths:
       tags:
         - Transactions v2
       parameters:
-        - in: query
-          name: transactionItemId
-          schema:
-            type: string
-            format: uuid
-            example: 75174a9d-fff4-4682-b66b-ebd93cbe7ea3
-          description: The id of the transaction item.
         - in: query
           name: sourceName
           schema:
@@ -173,6 +166,36 @@ paths:
           example: 9834b346-d68c-438d-9bd5-6716422c2657
         required: true
         description: The id of the transaction item.
+    get:
+      summary: Get a single transaction item.
+      description: Get a single transaction item.
+      tags:
+        - Transactions v2
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                {
+                  "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
+                  "sourceName": "Verkoopengine",
+                  "transactionId": "1001236",
+                  "transactionLineId": "1",
+                  "name": "HTM Maandkorting 20%",
+                  "quantity": 1,
+                  "taxCode": "V21",
+                  "amountExclTax": 100,
+                  "amountInclTax": 121,
+                  "amountTax": 21,
+                  "occurredOn": "2024-10-04T00:00:00Z",
+                  "type": "debit",
+                  "productCode": "HTM-MND-20",
+                  "aggregationReference": "FIKO-123456",
+                  "accountingSystemReference": "U4F-123456",
+                }
     patch:
       summary: Update a transaction item.
       description: Update a transaction item.
@@ -308,6 +331,7 @@ paths:
             type: string
             format: uuid
             example: 498e11fd-86c7-4e26-8ca9-c5ed9049da9e
+          required: true
           description: The id of the audit trail.
         - in: query
           name: transactionItemId
@@ -315,6 +339,7 @@ paths:
             type: string
             format: uuid
             example: 9834b346-d68c-438d-9bd5-6716422c2657
+          required: true
           description: The id of the transaction item.
         - in: query
           name: user
@@ -494,7 +519,7 @@ paths:
                           "timestamp": "2022-01-01 00:00:00",
                           "failureReason":
                             {
-                              "failureReasonId": 12,
+                              "failureReasonId": "122be602-139d-49f5-b34f-1e3e2de29408",
                               "reasonCode": "1234ABCD",
                               "reasonDesc": "description",
                             },
@@ -505,118 +530,10 @@ paths:
                       ],
                   },
                 ]
-  /processingfailures/{processingFailureId}:
-    parameters:
-      - in: path
-        name: processingFailureId
-        schema:
-          type: string
-          format: uuid
-          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
-        required: true
-        description: The id of the processing failure.
-    patch:
-      summary: Update processing failure.
-      description: Update processing failure.
-      tags:
-        - Failures v2
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/unavailable"
-            example: { "status": "open", "occurence": 2 }
-      responses:
-        "200":
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/unavailable"
-              example:
-                {
-                  "processingFailureId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
-                }
-  /processingfailures/{processingFailureId}/processingfailureinstances:
-    parameters:
-      - in: path
-        name: processingFailureId
-        schema:
-          type: string
-          format: uuid
-          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
-        required: true
-        description: The id of the processing failure.
-    post:
-      summary: Add a processing failure instance to a processing failure.
-      description: Add a processing failure instance to a processing failure.
-      tags:
-        - Failures v2
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/unavailable"
-            example:
-              {
-                "timestamp": "2022-01-01 00:00:00",
-                "failureReasonId": 12,
-                "element": "costCenter",
-                "occurence": 1,
-                "change": "Adapt config",
-              }
-      responses:
-        "201":
-          description: Created
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/unavailable"
-              example:
-                {
-                  "processingFailureInstanceId": "9afa9a6b-5b6a-4b0a-9c9e-4b0a5b6a4b0a",
-                }
-  /processingfailureinstances/{processingFailureInstanceId}:
-    parameters:
-      - in: path
-        name: processingFailureInstanceId
-        schema:
-          type: string
-          format: uuid
-          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
-        required: true
-        description: The id of the processing failure instance.
-    patch:
-      summary: Update processing failure instance.
-      description: Update processing failure instance.
-      tags:
-        - Failures v2
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/unavailable"
-            example:
-              {
-                "timestamp": "2022-01-01 00:00:00",
-                "occurence": 2,
-                "change": "Adapt config",
-              }
-      responses:
-        "200":
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/unavailable"
-              example:
-                {
-                  "processingFailureInstanceId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
-                }
   /productmetadata:
     get:
-      summary: Find product metadata.
+      summary: Get all product metadata.
-      description: Find product metadata.
+      description: Get all product metadata.
       tags:
         - Metadata v2
       parameters:
@@ -664,17 +581,11 @@ paths:
             example: VERK_FACTUUR
           description: The document code.
         - in: query
-          name: updatedBefore
+          name: timestampUpdated
           schema:
             type: string
             example: 2022-01-01 00:00:00
-          description: Timestamp that the metadata was updated before.
+          description: The timestamp updated.
-        - in: query
-          name: updatedAfter
-          schema:
-            type: string
-            example: 2022-01-01 00:00:00
-          description: Timestamp that the metadata was updated after.
         - in: query
           name: validAt
           schema:
@@ -900,9 +811,7 @@ paths:
               schema:
                 $ref: "#/components/schemas/unavailable"
               example:
-                {
+                { "productContraAccountId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61" }
-                  "productContraAccountId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61",
-                }
   /productmetadata/{productMetadataId}/metadataaudittrails:
     parameters:
       - in: path
@@ -923,20 +832,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
-            example:
-              {
-                "user": "rmeeuws",
-                "timestamp": "2024-10-04T00:00:00",
-                "correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
-                "metadataChanges": [
-                  {
-                    "fieldName": "department",
-                    "oldValue": "900",
-                    "newValue": "999",
-                  }
-                ]
-              }
       responses:
         "201":
           description: Created
@@ -1073,20 +969,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
-            example:
-              {
-                "user": "rmeeuws",
-                "timestamp": "2024-10-04T00:00:00",
-                "correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
-                "metadataChanges": [
-                  {
-                    "fieldName": "contraAccountMetadataId",
-                    "oldValue": "873810a3-a11a-4d4d-9af7-395520fa207c",
-                    "newValue": "9a8eb116-5270-4ef9-81ef-fdc2e72c281a",
-                  }
-                ]
-              }
       responses:
         "201":
           description: Created
@@ -1253,20 +1136,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
-            example:
-              {
-                "user": "rmeeuws",
-                "timestamp": "2024-10-04T00:00:00",
-                "correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
-                "metadataChanges": [
-                  {
-                    "fieldName": "taxCode",
-                    "oldValue": null,
-                    "newValue": "V21",
-                  }
-                ]
-              }
       responses:
         "201":
           description: Created
@@ -1287,6 +1157,7 @@ paths:
             type: string
             format: uuid
             example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          required: true
           description: The id of the source metadata.
         - in: query
           name: incomingName
@@ -1443,20 +1314,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
-            example:
-              {
-                "user": "rmeeuws",
-                "timestamp": "2024-10-04T00:00:00",
-                "correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
-                "metadataChanges": [
-                  {
-                    "fieldName": "businessOwner",
-                    "oldValue": "Corneel Verstoep",
-                    "newValue": "Mark Verheij",
-                  }
-                ]
-              }
       responses:
         "201":
           description: Created
@@ -1581,20 +1439,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
-            example:
-              {
-                "user": "rmeeuws",
-                "timestamp": "2024-10-04T00:00:00",
-                "correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
-                "metadataChanges": [
-                  {
-                    "fieldName": "isOpen",
-                    "oldValue": "true",
-                    "newValue": "false",
-                  }
-                ]
-              }
       responses:
         "201":
           description: Created
@@ -1615,6 +1460,7 @@ paths:
             type: string
             format: uuid
             example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          required: true
           description: The id of the concession metadata.
         - in: query
           name: concessionId
@@ -1748,20 +1594,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
-            example:
-              {
-                "user": "rmeeuws",
-                "timestamp": "2024-10-04T00:00:00",
-                "correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
-                "metadataChanges": [
-                  {
-                    "fieldName": "percentage",
-                    "oldValue": null,
-                    "newValue": "23.456",
-                  },
-                ],
-              }
       responses:
         "201":
           description: Created
@@ -1782,6 +1615,7 @@ paths:
             type: string
             format: uuid
             example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          required: true
           description: The id of the metadata audit trail.
         - in: query
           name: productMetadataId
@@ -1958,6 +1792,34 @@ components:
             example:
               - "/account/12345"
               - "/account/67890"
+    postMetadataAuditTrailRequest:
+      type: object
+      properties:
+        user:
+          type: string
+          example: rmeeuws
+        timestamp:
+          type: string
+          format: date-time
+          example: 2024-10-04T00:00:00
+        correlationId:
+          type: string
+          format: uuid
+          example: a03cd0c2-38b5-4619-b9e3-d6e5b842e127
+        metadataChanges:
+          type: array
+          items:
+            type: object
+            properties:
+              fieldName:
+                type: string
+                example: businessOwner
+              oldValue:
+                type: string
+                example: Corneel Verstoep
+              newValue:
+                type: string
+                example: Jan-Willem Vermeij
     postMetadataAuditTrailResponse:
       type: object
       properties:

src/openapi/orders/orders-crud.yaml

@@ -17,7 +17,8 @@ paths:
           name: externalOrderId
           schema:
             type: string
-            example: EXT001
+            format: uuid
+            example: 26ce08bc-0443-465f-9cd2-a7143f33eed0
           required: false
           description: The order id in the external system.
         - in: query