OVPAY-758 - Merged GET contractInvoices.

src/openapi/contracts/contracts-crud.yaml

@@ -544,8 +544,8 @@ paths:
         required: true
         description: The contractId of the Contract, formatted as UUID.
     get:
-      summary: Get invoices of a single contract.
+      summary: Get invoices of a single contract. DEPRECATED.
-      description: Get invoices of a single contract.
+      description: Get invoices of a single contract. WARNING; This method is deprecated. Please use GET /contractinvoices instead.
       deprecated: true
       tags:
         - ContractInvoice
@@ -623,6 +623,14 @@ paths:
       tags:
         - ContractInvoice
       parameters:
+        - in: query
+          name: contractId
+          schema:
+            type: string
+            format: uuid
+            example: f13dbd2d-315d-4839-b0db-e03a2cade495
+          required: false
+          description: External reference of the invoice.
         - in: query
           name: externalReference
           schema:
@@ -688,12 +696,24 @@ paths:
                   "contractInvoices":
                     [
                       {
+                        "contractId": "f13dbd2d-315d-4839-b0db-e03a2cade495",
                         "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",
+                        "data": "{json}",
+                      },
+                      {
+                        "contractId": "a7452e22-3894-40cc-87d6-869370a92277",
+                        "contractInvoiceId": "dadff658-4ff5-4eb8-b516-492f1f6c6245",
+                        "externalReference": "F2024-0002",
+                        "term": 2,
+                        "created": "2024-08-02 15:01:00.000",
+                        "updated": "2024-08-02 15:01:00.000",
+                        "state": "invoice_created",
+                        "data": "{json}",
                       },
                     ],
                 }
@@ -753,7 +773,6 @@ paths:
     get:
       summary: Get all actions of a single contract.
       description: Get all actions of a single contract.
-      deprecated: true
       tags:
         - ContractAction
       responses: