Merge pull request 'OVPAY-676 - Added GET /contractpayments.' (#15) from feature/OVPAY-676 into develop

Reviewed-on: #15

src/openapi/contracts/contracts-se.yaml

@@ -355,7 +355,7 @@ paths:
             schema:
               $ref: "#/components/schemas/unavailable"
             examples:
-              Validate a cancellation of a given end date: 
+              Validate a cancellation of a given end date:
                 summary: Validate a cancellation of a given end date
                 description: |
                   Validate a cancellation of a given end date.
@@ -427,7 +427,10 @@ paths:
                 description: |
                   Cancellation request for credit invoice.
                 value:
-                  { "end": "2024-08-10T00:00:00", "refundMethod": "creditInvoice" }
+                  {
+                    "end": "2024-08-10T00:00:00",
+                    "refundMethod": "creditInvoice",
+                  }
       responses:
         "200":
           description: OK
@@ -447,6 +450,81 @@ paths:
                       "refundAmount": 2489,
                       "refundMethod": "creditInvoice",
                     }
+  /contractpayments:
+    parameters:
+      - in: header
+        name: X-HTM-JWT-AUTH-HEADER
+        schema:
+          type: string
+          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+        required: true
+        description: The JWT of the logged in customer.
+    get:
+      summary: List all contract payments for a certain debtor.
+      description: |
+        List all contract payments for a certain debtor. The source of these payments is the accounts receivable management system (Payt).
+      tags:
+        - SE Contract Payments v2
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              examples:
+                List all contract payments for a single debtor:
+                  summary: List all contract payments for a single debtor
+                  description: List all contract payments for single debtor with debtor number 'D123456'.
+                  value:
+                    {
+                      "contractPayments":
+                        [
+                          {
+                            "paymentId": "151845776",
+                            "totalAmount": "26.62",
+                            "paymentMethod": "Twikey",
+                            "paymentDate": "2024-09-12",
+                            "invoice":
+                              {
+                                "invoiceId": "147722263",
+                                "invoiceNumber": "F2024-0001",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
+                              },
+                            "_links":
+                              {
+                                "get_contract":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                          {
+                            "paymentId": "151845851",
+                            "totalAmount": "45.21",
+                            "paymentMethod": "Twikey",
+                            "paymentDate": "2024-09-12",
+                            "invoice":
+                              {
+                                "invoiceId": "147722266",
+                                "invoiceNumber": "F2024-0002",
+                                "description": "HTM Maandkorting 20%",
+                                "publicLink": "https://factuurinzien.nl/d/ddb245d6df67999eca48c4a71b5661b93038e20a/i/dp5h1i5cuu94nopiolkdst3u17vkmzo",
+                              },
+                            "_links":
+                              {
+                                "get_contract":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/7b2f8c1a-3d9d-4c2d-960e-4471e8e28b6a",
+                                    "method": "GET",
+                                  },
+                              },
+                          },
+                        ],
+                      "href": null,
+                    }
 components:
   securitySchemes:
     bearerToken: