DHIL-2644 - Added methods on TransactionItem.

src/openapi/fiko/fiko-crud.yaml

@@ -7,30 +7,220 @@ servers:
   - url: https://api.integratielaag.nl/v1
 paths:
   /transactionitems:
+    get:
+      summary: Find transaction items.
+      description: Find transaction items.
+      tags:
+        - Transactions
+      parameters:
+        - in: query
+          name: sourceName
+          schema:
+            type: string
+            example: Verkoopengine
+          description: Source name of the transaction.
+        - in: query
+          name: transactionId
+          schema:
+            type: string
+            example: 1001236
+          description: The id of the transaction.
+        - in: query
+          name: transactionLineId
+          schema:
+            type: string
+            example: 1
+          description: The line id of the transaction.
+        - in: query
+          name: name
+          schema:
+            type: string
+            example: HTM Maandkorting 20%
+          description: The name of the product on the transaction.
+        - in: query
+          name: quantity
+          schema:
+            type: integer
+            example: 1
+          description: The quantity of the transaction.
+        - in: query
+          name: taxCode
+          schema:
+            type: string
+            example: V21
+          description: The tax code of the transaction.
+        - in: query
+          name: amountExclTax
+          schema:
+            type: integer
+            example: 100
+          description: The amount of the transaction excluding tax in cents.
+        - in: query
+          name: amountInclTax
+          schema:
+            type: integer
+            example: 121
+          description: The amount of the transaction including tax in cents.
+        - in: query
+          name: amountTax
+          schema:
+            type: integer
+            example: 21
+          description: The tax amount of the transaction in cents.
+        - in: query
+          name: occurredBefore
+          schema:
+            type: string
+            format: date-time
+            example: 2024-10-04T00:00:00Z
+          description: Timestamp before which the transaction occurred.
+        - in: query
+          name: occurredAfter
+          schema:
+            type: string
+            format: date-time
+            example: 2024-10-04T00:00:00Z
+          description: Timestamp after which the transaction occurred.
+        - in: query
+          name: type
+          schema:
+            type: array
+            items:
+              type: string
+            example: [debit, credit]
+          explode: false
+          description: Possible types of the transaction ('debit' or 'credit').
+        - in: query
+          name: productCode
+          schema:
+            type: string
+            example: HTM-MND-20
+          description: The product code of the transaction.
+        - in: query
+          name: aggregationReference
+          schema:
+            type: string
+            example: FIKO-123456
+          description: The aggregation reference of the transaction.
+        - in: query
+          name: accountingSystemReference
+          schema:
+            type: string
+            example: U4F-123456
+          description: The accounting system reference of the transaction.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                [
+                  {
+                    "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
+                    "sourceName": "Verkoopengine",
+                    "transactionId": "1001236",
+                    "transactionLineId": "1",
+                    "name": "HTM Maandkorting 20%",
+                    "quantity": 1,
+                    "taxCode": "V21",
+                    "amountExclTax": 100,
+                    "amountInclTax": 121,
+                    "amountTax": 21,
+                    "occurredOn": "2024-10-04T00:00:00Z",
+                    "type": "debit",
+                    "productCode": "HTM-MND-20",
+                    "aggregationReference": "FIKO-123456",
+                    "accountingSystemReference": "U4F-123456",
+                  },
+                ]
     post:
       summary: Add a finanicial transaction item.
       description: Add a finanicial transaction item.
       tags:
-        - TransactionItem
+        - Transactions
       requestBody:
         required: true
         content:
           application/json:
             schema:
               $ref: "#/components/schemas/unavailable"
-            example:
+            example: "TBD"
-              "TBD"
       responses:
         "201":
           description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                { "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d" }
+  /transactionitems/{transactionItemId}:
+    parameters:
+      - in: path
+        name: transactionItemId
+        schema:
+          type: string
+          format: uuid
+          example: 9834b346-d68c-438d-9bd5-6716422c2657
+        required: true
+        description: The id of the transaction item.
+    get:
+      summary: Get a single transaction item.
+      description: Get a single transaction item.
+      tags:
+        - Transactions
+      responses:
+        "200":
+          description: OK
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
               example:
                 {
-                  "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d"
+                  "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
+                  "sourceName": "Verkoopengine",
+                  "transactionId": "1001236",
+                  "transactionLineId": "1",
+                  "name": "HTM Maandkorting 20%",
+                  "quantity": 1,
+                  "taxCode": "V21",
+                  "amountExclTax": 100,
+                  "amountInclTax": 121,
+                  "amountTax": 21,
+                  "occurredOn": "2024-10-04T00:00:00Z",
+                  "type": "debit",
+                  "productCode": "HTM-MND-20",
+                  "aggregationReference": "FIKO-123456",
+                  "accountingSystemReference": "U4F-123456",
                 }
+    patch:
+      summary: Update a transaction item.
+      description: Update a transaction item.
+      tags:
+        - Transactions
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            example:
+              {
+                "aggregationReference": "FIKO-123456",
+                "accountingSystemReference": "U4F-123456",
+              }
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                { "transactionItemId": "d667d293-aa82-4c9e-9b10-77cffc9058a1" }
 components:
   securitySchemes:
     bearerToken: