src/openapi/fiko/fiko-crud.yaml

@@ -412,12 +412,40 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/TransactionItemsResponseStatusGetResponseBody"
+              examples:
+                Batch successfully processed:
+                  summary: Batch successfully processed
+                  description: |
+                    Body of a batch of transaction items that was successfully processed. 
+                    A number of transaction items were inserted and another number was updated.
+                  value:
+                    summary:
+                      created: 15
+                      updated: 2
+                      total: 17
         "409":
           description: Conflict
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/409Response"
+              examples:
+                A transaction item already exists:
+                  summary: A transaction item already exists
+                  description: |
+                    In this batch of transaction items, a transaction with same transactionId and
+                    transactionLineId already exists. Therefore, the whole batch is rolled back and
+                    rejected.
+                  value:
+                    code: '409'
+                    type: error
+                    message: conflict
+                    description: A transaction with the same TransactionId and TransactionLineId already exists.
+                    errors:
+                      - detail: Transaction is a duplicate of a transaction already in the system.
+                        pointer: '#/transactionItems/0'
+                        transactionId: 1ad109d3-fd7d-4b6f-872b-220d492f385f
+                        transactionLineId: fee907dd-e59d-44f5-a63b-bbdec38f79b7
   /transactionitems/{transactionItemId}/processingfailures:
     parameters:
       - in: path
@@ -784,6 +812,85 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ProcessingFailuresGetResponseBody"
+              examples:
+                No processing failures:
+                  summary: No processing failures
+                  description: No processing failures were found (for example for a single transaction item).
+                  value:
+                    processingFailures: []
+                    href: null
+                Multiple processing failures for a single transaction item:
+                  summary: Multiple processing failures for a single transaction item
+                  description: |
+                    In this example multiple processing failures were found for a single transaction item.
+                    This example shows how a single transaction items has failed validation two times, in which the 
+                    the first failure has two validation errors, which have been resolved, and the second failure
+                    hasn't been. Which makes three processing failures total.
+                  value:
+                    processingFailures:
+                    - processingFailureId: 37a8095b-19db-498f-9349-5f37d21c5bdf
+                      transactionItemId: 2d77d978-7141-499a-84ad-93fad8ee03ce
+                      timestamp: 2022-01-01 00:00:00
+                      element: costType
+                      value: 901
+                      reasonCode: 004
+                      reasonDescription: Cost type does not exist.
+                      resolved: false
+                      change: null
+                    - processingFailureId: ccc06dc9-956d-47d8-bde7-9644ddde2193
+                      transactionItemId: 2d77d978-7141-499a-84ad-93fad8ee03ce
+                      timestamp: 2025-01-01 00:43:01
+                      element: costCenter
+                      value: 84955
+                      reasonCode: 002
+                      reasonDescription: Cost center does not exist.
+                      resolved: true
+                      change: Adapt config
+                    - processingFailureId: 96bf8d44-0030-4509-b24e-2d62299779c5
+                      transactionItemId: 2d77d978-7141-499a-84ad-93fad8ee03ce
+                      timestamp: 2025-01-01 00:43:01
+                      element: department
+                      value: 1337
+                      reasonCode: 001
+                      reasonDescription: Department does not exist.
+                      resolved: true
+                      change: Adapt config
+                    href: null
+                List of unfiltered processing failures:
+                  summary: List of unfiltered processing failures
+                  description: |
+                    In this example there is a list of processing failures where no filters have been applied.
+                    This results in a list of all processing failures, for different transaction items.
+                  value:
+                    processingFailures:
+                      - processingFailureId: 1d0f237e-5fbe-4107-8bdf-a41f43307ac0
+                        transactionItemId: d0425652-07a3-4b95-bb37-8bb15ea1b9b5
+                        timestamp: 2022-01-01 00:00:00
+                        element: occuredOn
+                        value: 2027-01-01
+                        reasonCode: 009
+                        reasonDescription: Transaction date is in the future
+                        resolved: false
+                        change: null
+                      - processingFailureId: 76aa82e1-a10f-4664-a84f-1f30d60884b3
+                        transactionItemId: 3f0a8a74-c642-441e-a187-d32fedb77fdf
+                        timestamp: 2025-01-01 00:43:01
+                        element: costCenter
+                        value: 84955
+                        reasonCode: 002
+                        reasonDescription: Cost center does not exist.
+                        resolved: false
+                        change: null
+                      - processingFailureId: 25d2dd6f-ae17-44a7-b7a5-43eaf6de78e1
+                        transactionItemId: 446ad396-41f6-4c1f-942c-a131e620075d
+                        timestamp: 2025-01-01 00:43:01
+                        element: department
+                        value: 1337
+                        reasonCode: 001
+                        reasonDescription: Department does not exist.
+                        resolved: false
+                        change: null
+                    href: null
   /processingfailures/{processingFailureId}:
     parameters:
       - in: path