From 8e77c34615c7ea8e35a728300ced30706e5eba35 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Wed, 19 Feb 2025 11:18:03 +0100 Subject: [PATCH] OVPAY-1518 - Added examples for Transactions v2. --- src/openapi/fiko/fiko-crud.yaml | 206 +++++++++++++++++++++++++++++++- 1 file changed, 204 insertions(+), 2 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index ca35c86..421467e 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -4,7 +4,7 @@ info: version: "1.0" description: CRUD APIs for ABT FIKO database v2. servers: - - url: https://api.integratielaag.nl/v1 + - url: https://api.integratielaag.nl/fiko/1.0 paths: /transactionitems: get: @@ -148,6 +148,121 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionItemsGetResponseBody" + examples: + No transaction items: + summary: No transaction items were found + description: No transaction items that match the search criteria were found. + value: + transactionItems: [] + href: null + List containing multiple sales transaction items: + summary: List containing multiple sales transaction items + description: List containing multiple sales transaction items of transaction type 'sales' with different statuses. + value: + transactionItems: + - transactionItemId: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionType: sales + 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 + articleNumber: 4031 + status: created + aggregationReference: null + accountingSystemReference: null + - transactionItemId: 1c1fc1c8-57f4-4336-9b43-a974eae5afbf + transactionType: sales + sourceName: Verkoopengine + transactionId: 1002001 + transactionLineId: 1 + name: Reisproduct HTM 3 dag Anoniem + quantity: 1 + taxCode: V21 + amountExclTax: 100 + amountInclTax: 121 + amountTax: 21 + occurredOn: 2024-10-04T00:00:00Z + type: debit + articleNumber: 4051 + status: failed + aggregationReference: null + accountingSystemReference: null + - transactionItemId: 3f58441e-dc8f-4956-9bc5-c952312476db + transactionType: sales + sourceName: Verkoopengine + transactionId: 1001871 + transactionLineId: 1 + name: Reisproduct HTM 3 dag Anoniem + quantity: 1 + taxCode: V21 + amountExclTax: 100 + amountInclTax: 121 + amountTax: 21 + occurredOn: 2024-10-04T00:00:00Z + type: debit + articleNumber: 4051 + status: returned to src + aggregationReference: FIKO-171f40609e + accountingSystemReference: null + - transactionItemId: 4418825f-3f9b-45bc-b662-dc3cd4ce6599 + transactionType: sales + sourceName: Verkoopengine + transactionId: 1001131 + transactionLineId: 1 + name: Reisproduct HTM 3 dag Anoniem + quantity: 1 + taxCode: V21 + amountExclTax: 100 + amountInclTax: 121 + amountTax: 21 + occurredOn: 2024-10-04T00:00:00Z + type: debit + articleNumber: 4051 + status: returned to trx-db + aggregationReference: null + accountingSystemReference: null + - transactionItemId: 2ddc1831-cf7b-4a77-8aa1-11aaf8e98d9f + transactionType: sales + sourceName: Verkoopengine + transactionId: 1001885 + transactionLineId: 1 + name: Reisproduct HTM 3 dag Anoniem + quantity: 1 + taxCode: V21 + amountExclTax: 100 + amountInclTax: 121 + amountTax: 21 + occurredOn: 2024-10-04T00:00:00Z + type: debit + articleNumber: 4051 + status: re-entered + aggregationReference: null + accountingSystemReference: null + - transactionItemId: 5ab2513d-f334-4cf8-8895-4e7269374a4b + transactionType: sales + sourceName: Verkoopengine + transactionId: 1001679 + transactionLineId: 1 + name: Reisproduct HTM 1 dag Anoniem + quantity: 1 + taxCode: V21 + amountExclTax: 100 + amountInclTax: 121 + amountTax: 21 + occurredOn: 2024-10-04T00:00:00Z + type: debit + articleNumber: 1737 + status: succeeded + aggregationReference: FIKO-6a4fca8cd6 + accountingSystemReference: U4F-123456 + href: null post: summary: Add one ore more finanicial transaction items in bulk. description: Add one ore more finanicial transaction items in bulk. @@ -159,6 +274,56 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionItemsPostRequestBody" + examples: + Add single transaction item: + summary: Add single transaction item + description: Add single transaction item of type sales. + value: + transactionItems: + - transactionType: sales + 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 + articleNumber: 4031 + Add multiple transaction items: + summary: Add multiple transaction items + description: Add multiple transaction items of type sales. + value: + transactionItems: + - transactionType: sales + 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 + articleNumber: 4031 + - transactionType: sales + sourceName: Verkoopengine + transactionId: 1001237 + transactionLineId: 1 + name: HTM Maandkorting 20% + quantity: 1 + taxCode: V21 + amountExclTax: 100 + amountInclTax: 121 + amountTax: 21 + occurredOn: 2024-10-04T00:00:00Z + type: debit + articleNumber: 4031 responses: "202": description: Accepted @@ -166,6 +331,16 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionItemsPostResponseBody" + examples: + Array of transaction items accepted: + summary: Array of transaction items accepted + description: Array of transaction items accepted. + value: + startTime: 2025-02-14T05:32:47.0672237Z + status: Running + clientTrackingId: 08584620957189579629541919368CU00 + callbackurl: https://api.integratielaag.nl/transactionitems/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c + retryAfter: 10 /transactionitems/{transactionItemId}: parameters: - in: path @@ -187,6 +362,27 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionItemsPatchRequestBody" + examples: + Return transaction item to transaction database: + summary: Return transaction item to transaction database + description: | + FMT updates the transaction item so that it is returned to the transaction database. + This is done by changing the status to 'returned to trx-db' and emptying the + aggregationReference and accountingSystemReference. + value: + status: returned to trx-db + aggregationReference: null + accountingSystemReference: null + Return transaction item to source: + summary: Return transaction item to source + description: | + FMT updates the transaction item so that it is returned to the source. + This is done by changing the status to 'returned to src' and emptying the + aggregationReference and accountingSystemReference. + value: + status: returned to src + aggregationReference: null + accountingSystemReference: null responses: "200": description: OK @@ -194,6 +390,12 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionItemsPatchResponseBody" + examples: + Transaction item successfully updated: + summary: Transaction item successfully updated + description: The transaction item was successfully updated in the database. + value: + transactionItemId: 7c3a5b0f-b89e-4f02-8b09-d11c5a050a07 /transactionitems/{transactionItemId}/processingfailures: parameters: - in: path @@ -1601,7 +1803,7 @@ components: 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" + example: https://services.api.htm.nl/transactionitems/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c retryAfter: type: integer example: 10