OVPAY-758 - Added query on ContractInvoice

src/openapi/contracts/contracts-crud.yaml

@@ -172,6 +172,13 @@ paths:
             example: 2
           required: false
           description: Number of invoices to include in response body (per contract).
+        - in: query
+          name: pageSize
+          schema:
+            type: integer
+            example: 2
+          required: false
+          description: Number of contracts to in the response body (per page).
       responses:
         "200":
           description: OK
@@ -565,6 +572,41 @@ paths:
                       "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
                     },
                 }
+  /contractinvoices:
+    get:
+      summary: Get all contract invoices.
+      description: Get all contract invoices.
+      tags:
+        - ContractInvoice
+      parameters:
+        - in: query
+          name: externalReference
+          schema:
+            type: string
+            example: F2024-0030
+          required: true
+          description: External reference of the invoice.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Contract"
+              example:
+                {
+                  "contractInvoices":
+                    [
+                      {
+                        "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
+                        "externalReference": "F2024-0030",
+                        "term": 1,
+                        "created": "2024-06-02 15:01:00.000",
+                        "updated": "2024-06-02 15:01:00.000",
+                        "state": "invoice_created",
+                      },
+                    ],
+                }
   /contractinvoices/{contractInvoiceId}:
     parameters:
       - in: path