From b115c0aed8c832553b970e568e72f8d2472a315d Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Tue, 18 Feb 2025 10:55:21 +0100 Subject: [PATCH] OVPAY-1518 - Updated /transactionitems. --- src/openapi/fiko/fiko-crud.yaml | 190 ++++++-------------------------- 1 file changed, 36 insertions(+), 154 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 3be6d63..be73076 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -6,45 +6,6 @@ info: servers: - url: https://api.integratielaag.nl/v1 paths: - /fiko/transactionitems: - post: - summary: DEPRECATED. Add a finanicial transaction item. - description: DEPRECATED. This API is deprecated. Use bulk-insert instead. - deprecated: true - tags: - - External FIKO endpoints v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/unavailable" - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/unavailable" - /fiko/transactionitems/bulk: - post: - summary: Add one ore more finanicial transaction items in bulk. - description: Add one ore more finanicial transaction items in bulk. - tags: - - External FIKO endpoints v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/TransactionItemsBulkPostRequestBody" - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/TransactionItemsBulkPostResponseBody" /transactionitems: get: summary: Find transaction items. @@ -146,11 +107,11 @@ paths: explode: false description: Possible types of the transaction ('debit' or 'credit'). - in: query - name: productCode + name: articleNumber schema: type: string - example: HTM-MND-20 - description: The product code of the transaction. + example: 4031 + description: The article number of the transaction. - in: query name: status schema: @@ -180,9 +141,8 @@ paths: schema: $ref: "#/components/schemas/TransactionItemsGetResponseBody" post: - summary: DEPRECATED. Add a finanicial transaction item. - description: DEPRECATED. This API is deprecated. Use bulk-insert instead. - deprecated: true + summary: Add one ore more finanicial transaction items in bulk. + description: Add one ore more finanicial transaction items in bulk. tags: - Transactions v2 requestBody: @@ -192,8 +152,8 @@ paths: schema: $ref: "#/components/schemas/TransactionItemsPostRequestBody" responses: - "201": - description: Created + "202": + description: Accepted content: application/json: schema: @@ -1370,10 +1330,10 @@ components: - debit - credit example: debit - productCode: + articleNumber: type: string nullable: true - example: HTM-MND-20 + example: 4031 status: type: string enum: @@ -1412,88 +1372,6 @@ components: description: URI for pagination. example: null TransactionItemsPostRequestBody: - type: object - properties: - transactionType: - type: string - enum: - - sales - example: sales - sourceName: - type: string - example: Verkoopengine - transactionId: - type: string - example: 1001236 - transactionLineId: - type: string - nullable: true - example: 1 - name: - type: string - example: HTM Maandkorting 20% - quantity: - type: integer - example: 1 - taxCode: - type: string - example: V21 - amountExclTax: - type: integer - example: 100 - amountInclTax: - type: integer - example: 121 - amountTax: - type: integer - example: 21 - occurredOn: - type: string - format: date-time - example: 2024-10-04T00:00:00Z - type: - type: string - enum: - - debit - - credit - example: debit - productCode: - type: string - nullable: true - example: HTM-MND-20 - status: - type: string - enum: - - created - - succeeded - - failed - - returned to trx-db - - returned to src - - re-entered - example: created - required: - - transactionType - - sourceName - - transactionId - - name - - quantity - - taxCode - - amountExclTax - - amountInclTax - - amountTax - - occurredOn - - type - - status - TransactionItemsPostResponseBody: - type: object - properties: - transactionItemId: - type: string - format: uuid - example: afce35b2-1dff-4ace-98d0-4b9ac405c87d - required: - - transactionItemId - TransactionItemsBulkPostRequestBody: type: object properties: transactionItems: @@ -1544,10 +1422,10 @@ components: - debit - credit example: debit - productCode: + articleNumber: type: string nullable: true - example: HTM-MND-20 + example: 4031 required: - sourceName - transactionType @@ -1560,28 +1438,32 @@ components: - amountTax - occurredOn - type - - productCode - TransactionItemsBulkPostResponseBody: + TransactionItemsPostResponseBody: type: object properties: - summary: - type: object - properties: - created: - type: integer - example: 15 - updated: - type: integer - example: 2 - total: - type: integer - example: 17 - required: - - created - - updated - - total + startTime: + type: string + format: date-time + example: 2025-02-14T05:32:47.0672237Z + status: + type: string + example: Running + clientTrackingId: + type: string + example: 08584620957189579629541919368CU00 + callbackurl: + type: string + format: uri + example: "https://services.api.htm.nl/transactionitems/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c2241509f6225d6d568526b/runs/08584620957189579629541919368CU00/operations/c9f35a54-f5de-4bc6-991b-2219164aa56f?api-version=2022-05-01&sp=%2Fruns%2F08584620957189579629541919368CU00%2Foperations%2Fc9f35a54-f5de-4bc6-991b-2219164aa56f%2Fread&sv=1.0&sig=X8dPLkbtOdndMqNfZDxTEL_3k2MhE42YyL_2ATnSYj0&code=e0W6heo7VrzW-mtYzJlavaP99VZve_9fH-9NhIJW-ceJAzFu_yZ71g%3D%3D" + retryAfter: + type: integer + example: 10 required: - - summary + - startTime + - status + - clientTrackingId + - callbackurl + - retryAfter TransactionItemsBulkBadRequestResponseBody: type: object properties: @@ -1663,10 +1545,10 @@ components: - debit - credit example: debit - productCode: + articleNumber: type: string nullable: true - example: HTM-MND-20 + example: 4031 status: type: string enum: