Merge branch 'develop' into feature/OVPAY-1145

Reviewed-on: #2

src/openapi/contracts/contracts-crud.yaml

@@ -216,6 +216,7 @@ 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",
@@ -224,6 +225,7 @@ paths:
                               "created": "2024-07-02 15:01:00.000",
                               "updated": "2024-07-02 15:01:00.000",
                               "state": "invoice_created",
+                              "isCredit": false,
                             },
                           ],
                         "contractVersions":
@@ -273,6 +275,7 @@ 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",
@@ -281,6 +284,7 @@ paths:
                               "created": "2024-07-02 15:01:00.000",
                               "updated": "2024-07-02 15:01:00.000",
                               "state": "invoice_created",
+                              "isCredit": false,
                             },
                           ],
                         "contractVersions":
@@ -401,6 +405,7 @@ paths:
                             "updated": "2024-07-02 15:01:00.000",
                             "state": "invoice_created",
                             "data": "{json}",
+                            "isCredit": false,
                           },
                         ],
                     },
@@ -568,6 +573,7 @@ paths:
                         "updated": "2024-07-02 15:01:00.000",
                         "state": "invoice_sent",
                         "data": "{json}",
+                        "isCredit": false,
                       },
                       {
                         "contractInvoiceId": "dadff658-4ff5-4eb8-b516-492f1f6c6245",
@@ -577,6 +583,7 @@ paths:
                         "updated": "2024-08-02 15:01:00.000",
                         "state": "invoice_created",
                         "data": "{json}",
+                        "isCredit": false,
                       },
                     ],
                 }
@@ -600,6 +607,7 @@ paths:
                     "updated": "2024-07-02 15:01:00.000",
                     "state": "invoice_created",
                     "data": "{json}",
+                    "isCredit": false,
                   },
               }
       responses:
@@ -684,6 +692,13 @@ 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
@@ -704,6 +719,7 @@ paths:
                         "updated": "2024-06-02 15:01:00.000",
                         "state": "invoice_created",
                         "data": "{json}",
+                        "isCredit": false,
                       },
                       {
                         "contractId": "a7452e22-3894-40cc-87d6-869370a92277",
@@ -714,6 +730,7 @@ paths:
                         "updated": "2024-08-02 15:01:00.000",
                         "state": "invoice_created",
                         "data": "{json}",
+                        "isCredit": false,
                       },
                     ],
                 }
@@ -1049,6 +1066,9 @@ components:
           type: string
           format: json
           example: { json }
+        isCredit:
+          type: boolean
+          example: false
     ContractStatus:
       type: object
       properties:

src/openapi/orders/orders-crud.yaml

@@ -17,8 +17,7 @@ paths:
           name: externalOrderId
           schema:
             type: string
-            format: uuid
+            example: EXT001
-            example: 26ce08bc-0443-465f-9cd2-a7143f33eed0
           required: false
           description: The order id in the external system.
         - in: query
@@ -110,7 +109,7 @@ paths:
               type: integer
           explode: false
           required: false
-          description: Filter on possible order statuses. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled.
+          description: Filter on most recent order status. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled.
       responses:
         "200":
           description: OK
@@ -141,6 +140,7 @@ paths:
                         "createdOn": "2024-03-22T09:00:00",
                         "lastUpdatedOn": "2024-03-22T09:00:00",
                         "order_OrderStatus":
+                          [
                             {
                               "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
                               "orderStatus":
@@ -148,6 +148,17 @@ paths:
                               "createdOn": "2024-03-22T09:00:00",
                               "description": "Order succesvol betaald",
                             },
+                            {
+                              "order_orderStatusId": "2b9b7943-3a74-4f2e-ad65-012b62c80821",
+                              "orderStatus":
+                                {
+                                  "orderStatusId": 3,
+                                  "name": "pendingPayment",
+                                },
+                              "createdOn": "2024-03-22T08:55:00",
+                              "description": "Betaling in behandeling",
+                            },
+                          ],
                         "orderLines":
                           [
                             {
@@ -315,11 +326,18 @@ paths:
                 "shippingAddressId": 1,
                 "createdOn": "2024-03-22T09:00:00",
                 "order_OrderStatus":
+                  [
                     {
                       "orderStatusId": 4,
                       "createdOn": "2024-03-22T09:00:00",
                       "description": "Order succesvol betaald",
                     },
+                    {
+                      "orderStatusId": 3,
+                      "createdOn": "2024-03-22T08:55:00",
+                      "description": "Betaling in behandeling",
+                    },
+                  ],
                 "orderLines":
                   [
                     {
@@ -475,12 +493,21 @@ paths:
                   "createdOn": "2024-03-22T09:00:00",
                   "lastUpdatedOn": "2024-03-22T09:00:00",
                   "order_OrderStatus":
+                    [
                       {
                         "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
                         "orderStatus": { "orderStatusId": 4, "name": "paid" },
                         "createdOn": "2024-03-22T09:00:00",
                         "description": "Order succesvol betaald",
                       },
+                      {
+                        "order_orderStatusId": "2b9b7943-3a74-4f2e-ad65-012b62c80821",
+                        "orderStatus":
+                          { "orderStatusId": 3, "name": "pendingPayment" },
+                        "createdOn": "2024-03-22T08:55:00",
+                        "description": "Betaling in behandeling",
+                      },
+                    ],
                   "orderLines":
                     [
                       {
@@ -644,6 +671,14 @@ paths:
               schema:
                 $ref: "#/components/schemas/unavailable"
               example: { "orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d" }
+    delete:
+      summary: RFU. Delete an order.
+      description: Delete an order.
+      tags:
+        - Order
+      responses:
+        "200":
+          description: OK
   /orders/{orderId}/statuses:
     parameters:
       - in: path
@@ -767,8 +802,8 @@ paths:
         required: true
         description: The id of the order to process.
     post:
-      summary: P2. Add one or more payments to an order.
+      summary: P2. Add a payment to an order.
-      description: Add one or more payments to an order.
+      description: Add a payment to an order.
       tags:
         - Payment
       requestBody:
@@ -777,7 +812,6 @@ paths:
             schema:
               $ref: "#/components/schemas/unavailable"
             example:
-              [
               {
                 "createdOn": "2024-03-22T09:00:00",
                 "amountDebit": 121,
@@ -805,8 +839,7 @@ paths:
                     "ascription": "J. de Vries",
                     "place": "Den Haag",
                   },
-                },
+              }
-              ]
       responses:
         "201":
           description: Created
@@ -1133,6 +1166,14 @@ paths:
               schema:
                 $ref: "#/components/schemas/unavailable"
               example: { "orderLineId": "ee82686a-a9f6-4888-b336-8e2aab6f4e13" }
+    delete:
+      summary: RFU. Delete an order line.
+      description: Delete an order line.
+      tags:
+        - Order Line
+      responses:
+        "200":
+          description: OK
   /orderlines/{orderLineId}/accountingstatuses:
     parameters:
       - in: path
@@ -1963,8 +2004,8 @@ paths:
         required: true
         description: The id of the customer on the order.
     post:
-      summary: P3. Add one or more addresses to a customer of the order.
+      summary: P3. Add an addresses to a customer of the order.
-      description: Add one or more addresses to a customer of the order.
+      description: Add an addresses to a customer of the order.
       tags:
         - Customer
       requestBody:
@@ -1973,7 +2014,6 @@ paths:
             schema:
               $ref: "#/components/schemas/unavailable"
             example:
-              [
               {
                 "addressTypeId": 1,
                 "street": "Kon. Julianaplein",
@@ -1982,8 +2022,7 @@ paths:
                 "postalCode": "2595 AA",
                 "city": "Den Haag",
                 "country": "NL",
-                },
+              }
-              ]
       responses:
         "201":
           description: Created

src/openapi/util/util-crud.yaml

@@ -86,6 +86,20 @@ paths:
             example: 65ad5520-4e62-41b7-89dd-a01be6cb78bf
           required: false
           description: Pointer to executor of this action (e.g. the batch job).
+        - in: query
+          name: role
+          schema:
+            type: string
+            example: customer
+          required: false
+          description: Role of the user or process that initiated the action.
+        - in: query
+          name: user
+          schema:
+            type: string
+            example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
+          required: false
+          description: User that initiated the action. In case of a customer this is the customer id.
         - in: query
           name: resourceName
           schema:
@@ -123,6 +137,8 @@ paths:
                         "created": "2024-07-02 15:01:00.000",
                         "updated": "2024-07-02 15:01:00.000",
                         "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
+                        "role": "customer",
+                        "user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
                         "scheduledActionResources":
                           [
                             {
@@ -157,6 +173,8 @@ paths:
                     "created": "2024-07-02 15:01:00.000",
                     "updated": "2024-07-02 15:01:00.000",
                     "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
+                    "role": "customer",
+                    "user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
                     "scheduledActionResources":
                       [
                         {
@@ -217,6 +235,8 @@ paths:
                       "created": "2024-07-02 15:01:00.000",
                       "updated": "2024-07-02 15:01:00.000",
                       "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
+                      "role": "customer",
+                      "user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
                       "scheduledActionResources":
                         [
                           {
@@ -390,6 +410,12 @@ components:
           type: string
           format: uuid
           example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f
+        role:
+          type: string
+          example: customer
+        user:
+          type: string
+          example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
     ScheduledActionType:
       type: object
       properties: