diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index b51e1ad..27dbd5b 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -130,48 +130,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "transactionItems": - [ - { - "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", - }, - { - "transactionItemId": "e63cc37b-4d87-4278-8eb5-1477e07edf3d", - "sourceName": "Verkoopengine", - "transactionId": "1001237", - "transactionLineId": "1", - "name": "HTM Maandkorting 20%", - "quantity": 1, - "taxCode": "V21", - "amountExclTax": 100, - "amountInclTax": 121, - "amountTax": 21, - "occurredOn": "2024-10-04T00:05:00Z", - "type": "debit", - "productCode": "HTM-MND-20", - "aggregationReference": "FIKO-123456", - "accountingSystemReference": "U4F-123456", - }, - ], - "href": null, - } + $ref: "#/components/schemas/TransactionItemsGetResponseBody" post: summary: Add a finanicial transaction item. description: Add a finanicial transaction item. @@ -182,33 +141,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "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": null, - "accountingSystemReference": null, - } + $ref: "#/components/schemas/TransactionItemsPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d" } + $ref: "#/components/schemas/TransactionItemsPostResponseBody" /transactionitems/bulk: post: summary: Add one ore more finanicial transaction items in bulk. @@ -220,58 +160,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - [ - { - "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": null, - "accountingSystemReference": null, - }, - { - "sourceName": "Verkoopengine", - "transactionId": "1001237", - "transactionLineId": "1", - "name": "HTM Maandkorting 20%", - "quantity": 1, - "taxCode": "V21", - "amountExclTax": 100, - "amountInclTax": 121, - "amountTax": 21, - "occurredOn": "2024-10-04T00:05:00Z", - "type": "debit", - "productCode": "HTM-MND-20", - "aggregationReference": null, - "accountingSystemReference": null, - }, - ] + $ref: "#/components/schemas/TransactionItemsBulkPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - [ - { - "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d", - }, - { - "transactionItemId": "e63cc37b-4d87-4278-8eb5-1477e07edf3d", - }, - ] + $ref: "#/components/schemas/TransactionItemsBulkPostResponseBody" /transactionitems/{transactionItemId}: parameters: - in: path @@ -292,21 +188,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "aggregationReference": "FIKO-123456", - "accountingSystemReference": "U4F-123456", - } + $ref: "#/components/schemas/TransactionItemsPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "transactionItemId": "d667d293-aa82-4c9e-9b10-77cffc9058a1" } + $ref: "#/components/schemas/TransactionItemsPatchResponseBody" /transactionitems/{transactionItemId}/processingfailures: parameters: - in: path @@ -2172,6 +2061,238 @@ components: schemas: unavailable: type: object + TransactionItemsGetResponseBody: + type: object + properties: + transactionItems: + type: "array" + items: + type: object + properties: + transactionItemId: + type: string + example: afce35b2-1dff-4ace-98d0-4b9ac405c87d + 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: number + example: 100 + amountInclTax: + type: number + example: 121 + amountTax: + type: number + 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 + aggregationReference: + type: string + nullable: true + example: FIKO-123456 + accountingSystemReference: + type: string + nullable: true + example: U4F-123456 + required: + - transactionItemId + - sourceName + - transactionId + - name + - quantity + - taxCode + - amountExclTax + - amountInclTax + - amountTax + - occurredOn + - type + - productCode + href: + type: string + nullable: true + description: URI for pagination. + example: null + TransactionItemsPostRequestBody: + type: object + properties: + 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 + example: HTM-MND-20 + required: + - sourceName + - transactionId + - name + - quantity + - taxCode + - amountExclTax + - amountInclTax + - amountTax + - occurredOn + - type + - productCode + TransactionItemsPostResponseBody: + type: object + properties: + transactionItemId: + type: string + example: afce35b2-1dff-4ace-98d0-4b9ac405c87d + required: + - transactionItemId + TransactionItemsBulkPostRequestBody: + type: object + properties: + transactionItems: + type: array + items: + type: object + properties: + 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 + example: HTM-MND-20 + required: + - sourceName + - transactionId + - name + - quantity + - taxCode + - amountExclTax + - amountInclTax + - amountTax + - occurredOn + - type + - productCode + TransactionItemsBulkPostResponseBody: + type: array + items: + type: object + properties: + transactionItemId: + type: string + example: afce35b2-1dff-4ace-98d0-4b9ac405c87d + required: + - transactionItemId + TransactionItemsPatchRequestBody: + type: object + properties: + aggregationReference: + type: string + nullable: true + example: FIKO-123456 + accountingSystemReference: + type: string + nullable: true + example: U4F-123456 + TransactionItemsPatchResponseBody: + type: object + properties: + transactionItemId: + type: string + example: afce35b2-1dff-4ace-98d0-4b9ac405c87d + required: + - transactionItemId rfc9457: type: object properties: