From 0d61d06198052cc90c59936ad5fbaa715a87627d Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 6 Feb 2025 10:49:44 +0100 Subject: [PATCH] OVPAY-1518 - Update TransactionItems data mode. --- src/openapi/fiko/fiko-crud.yaml | 126 ++++++++++++++++++++++++++------ 1 file changed, 104 insertions(+), 22 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 1c7b409..6c0fd0a 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -45,12 +45,6 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionItemsBulkPostResponseBody" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/TransactionItemsBulkBadRequestResponseBody" /transactionitems: get: summary: Find transaction items. @@ -65,6 +59,15 @@ paths: format: uuid example: 75174a9d-fff4-4682-b66b-ebd93cbe7ea3 description: The id of the transaction item. + - in: query + name: transactionType + schema: + type: array + items: + type: string + example: [sales] + explode: false + description: Possible types of the transaction ('sales'). - in: query name: sourceName schema: @@ -148,6 +151,15 @@ paths: type: string example: HTM-MND-20 description: The product code of the transaction. + - in: query + name: status + schema: + type: array + items: + type: string + example: [created, succeeded, failed, returned to trx-db, returned to src, re-entered] + explode: false + description: Possible statuses of the transaction ('created', 'succeeded', 'failed', 'returned to trx-db', 'returned to src', 're-entered'). - in: query name: aggregationReference schema: @@ -160,15 +172,6 @@ paths: type: string example: U4F-123456 description: The accounting system reference of the transaction. %00 is searching for NULL-values. - - in: query - name: highestProcessingFailureStatus - schema: - type: array - items: - type: string - example: [open] - explode: false - description: Find the highest processing failure status of the transaction. %00 is searching for NULL-values. responses: "200": description: OK @@ -1403,6 +1406,11 @@ components: transactionItemId: type: string example: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionType: + type: string + enum: + - sales + example: sales sourceName: type: string example: Verkoopengine @@ -1444,6 +1452,16 @@ components: productCode: type: string example: HTM-MND-20 + status: + type: string + enum: + - created + - succeeded + - failed + - returned to trx-db + - returned to src + - re-entered + example: created aggregationReference: type: string nullable: true @@ -1454,6 +1472,7 @@ components: example: U4F-123456 required: - transactionItemId + - transactionType - sourceName - transactionId - name @@ -1464,7 +1483,7 @@ components: - amountTax - occurredOn - type - - productCode + - status href: type: string nullable: true @@ -1473,6 +1492,11 @@ components: TransactionItemsPostRequestBody: type: object properties: + transactionType: + type: string + enum: + - sales + example: sales sourceName: type: string example: Verkoopengine @@ -1514,7 +1538,18 @@ components: productCode: type: string 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 @@ -1525,7 +1560,7 @@ components: - amountTax - occurredOn - type - - productCode + - status TransactionItemsPostResponseBody: type: object properties: @@ -1543,6 +1578,11 @@ components: items: type: object properties: + transactionType: + type: string + enum: + - sales + example: sales sourceName: type: string example: Verkoopengine @@ -1586,6 +1626,7 @@ components: example: HTM-MND-20 required: - sourceName + - transactionType - transactionId - name - quantity @@ -1662,6 +1703,47 @@ components: TransactionItemsPatchRequestBody: type: object properties: + 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 + example: HTM-MND-20 + status: + type: string + enum: + - created + - succeeded + - failed + - returned to trx-db + - returned to src + - re-entered + example: created aggregationReference: type: string nullable: true @@ -2587,7 +2669,7 @@ components: taxCode: type: string example: V21 - taxPercentageAmount: + taxPercentageAmount: type: integer example: 21 description: @@ -2617,7 +2699,7 @@ components: sourceMetadata: type: array items: - $ref: "#/components/schemas/SourceMetadata" + $ref: '#/components/schemas/SourceMetadata' href: type: string nullable: true @@ -2789,7 +2871,7 @@ components: format: uuid example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb concession: - $ref: "#/components/schemas/Concession" + $ref: '#/components/schemas/Concession' percentage: type: number example: 84.021 @@ -2876,7 +2958,7 @@ components: concessions: type: array items: - $ref: "#/components/schemas/Concession" + $ref: '#/components/schemas/Concession' href: type: string nullable: true @@ -2888,7 +2970,7 @@ components: failureReasons: type: array items: - $ref: "#/components/schemas/FailureReason" + $ref: '#/components/schemas/FailureReason' href: type: string nullable: true