From 520362ae4de5058771921a76872224dc390b7e0b Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Fri, 3 Jan 2025 16:07:43 +0100 Subject: [PATCH] OVPAY-879 - Metadata v2 overhaul. --- src/openapi/fiko/fiko-crud.yaml | 1380 +++++++++++++++++++++---------- 1 file changed, 948 insertions(+), 432 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 8a4a360..94d7930 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -595,81 +595,8 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "productMetadata": - [ - { - "productMetadataId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61", - "productCode": "4031", - "department": "900", - "costType": "619031", - "description": "O4031_Reisproduct HTM 1 dag Anoniem", - "documentCode": "VERK_FACTUUR", - "timestampUpdated": "2022-01-01T00:00:00", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - "productContraAccounts": - [ - { - "contraAccountMetadata": - { - "contraAccountMetadataId": "e0af8c8f-d421-4567-a14e-48e2a1bb86fb", - "contraAccountCode": "123456", - "contraAccountNumber": "220.10419", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - }, - "concession": - { "concessionId": 2, "name": "bus" }, - "sourceMetadata": - { - "sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", - "incomingName": "VerkoopEngine", - "incomingEntity": "OrderLine", - "outgoingName": "Website Verkopen", - "businessOwner": "Corneel Verstoep", - "rejectionProcessing": "system", - "rejectionInfo": "api.htm.nl/v2/account/12345/msgs/abc", - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - "costCenter": "84955", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - }, - { - "contraAccountMetadata": - { - "contraAccountMetadataId": "69c562ca-5299-4585-ac92-46fb54aeb99e", - "contraAccountCode": "123456", - "contraAccountNumber": "220.10419", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - }, - "concession": - { "concessionId": 1, "name": "bus" }, - "sourceMetadata": - { - "sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", - "incomingName": "VerkoopEngine", - "incomingEntity": "OrderLine", - "outgoingName": "Website Verkopen", - "businessOwner": "Corneel Verstoep", - "rejectionProcessing": "system", - "rejectionInfo": "api.htm.nl/v2/account/12345/msgs/abc", - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - }, - ], - }, - ], - "href": null, - } + $ref: "#/components/schemas/ProductMetadataGetResponseBody" + post: summary: Add product metadata. description: Add product metadata. @@ -680,47 +607,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "productCode": "4031", - "department": "900", - "costCenter": "84955", - "costType": "619031", - "description": "O4031_Reisproduct HTM 1 dag Anoniem", - "documentCode": "VERK_FACTUUR", - "timestampUpdated": "2022-01-01 00:00:00", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - "productContraAccounts": - [ - { - "contraAccountMetadataId": "e0af8c8f-d421-4567-a14e-48e2a1bb86fb", - "concessionId": 1, - "sourceMetadataId": "08d96f94-f468-467e-9068-c86c34f43097", - "costCenter": "84955", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - }, - { - "contraAccountMetadataId": "02e458ce-f77a-4262-8b38-490e54f52856", - "concessionId": 2, - "sourceMetadataId": "08d96f94-f468-467e-9068-c86c34f43097", - "costCenter": "84955", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - }, - ], - } + $ref: "#/components/schemas/ProductMetadataPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "productMetadataId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61" } + $ref: "#/components/schemas/ProductMetadataPostResponseBody" /productmetadata/{productMetadataId}: parameters: - in: path @@ -741,27 +635,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "productCode": "4031", - "department": "900", - "costType": "619031", - "description": "O4031_Reisproduct HTM 1 dag Anoniem", - "documentCode": "VERK_FACTUUR", - "timestampUpdated": "2022-01-01 00:00:00", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/ProductMetadataPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "productMetadataId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61" } + $ref: "#/components/schemas/ProductMetadataPatchResponseBody" /productmetadata/{productMetadataId}/productcontraaccounts: parameters: - in: path @@ -782,27 +663,77 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "contraAccountMetadataId": "e0af8c8f-d421-4567-a14e-48e2a1bb86fb", - "concessionId": 1, - "sourceMetadataId": "08d96f94-f468-467e-9068-c86c34f43097", - "costCenter": "84955", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/ProductContraAccountsPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "productContraAccountId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61", - } + $ref: "#/components/schemas/ProductContraAccountsPostResponseBody" + /productcontraaccounts: + get: + summary: Find product contra accounts. + description: Find product contra accounts. + tags: + - Metadata v2 + parameters: + - in: query + name: productContraAccountId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the product contra account. + - in: query + name: productMetadataId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the product metadata. + - in: query + name: contraAccountMetadataId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the contra account metadata. + - in: query + name: concessionId + schema: + type: array + items: + type: integer + example: [1, 2] + explode: false + description: Find product metadata that is linked to this concession. + - in: query + name: sourceMetadataId + schema: + type: string + format: uuid + example: 08d96f94-f468-467e-9068-c86c34f43097 + description: Find product metadata that is linked to this source metadata. + - in: query + name: costCenter + schema: + type: string + example: 84955 + description: Find product metadata that is linked to this cost center. + - in: query + name: validAt + schema: + type: string + example: 2024-03-22T09:00:00 + description: Timestamp that the metadata is valid. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/ProductContraAccountsGetResponseBody" /productcontraaccounts/{productContraAccountId}: parameters: - in: path @@ -823,27 +754,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "contraAccountMetadataId": "e0af8c8f-d421-4567-a14e-48e2a1bb86fb", - "concessionId": 1, - "sourceMetadataId": "08d96f94-f468-467e-9068-c86c34f43097", - "costCenter": "84955", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/ProductContraAccountsPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "productContraAccountId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61", - } + $ref: "#/components/schemas/ProductContraAccountsPatchResponseBody" /contraaccountmetadata: get: summary: Find contra account metadata. @@ -883,21 +801,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "contraAccountMetadata": - [ - { - "contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - "contraAccountCode": "123456", - "contraAccountNumber": "220.10419", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - }, - ], - "href": null, - } + $ref: "#/components/schemas/ContraAccountMetadataGetResponseBody" post: summary: Add contra account metadata. description: Add contra account metadata. @@ -908,25 +812,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "contraAccountCode": "123456", - "contraAccountNumber": "220.10419", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/ContraAccountMetadataPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - } + $ref: "#/components/schemas/ContraAccountMetadataPostResponseBody" /contraaccountmetadata/{contraAccountMetadataId}: parameters: - in: path @@ -947,24 +840,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "contraAccountNumber": "220.10419", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/ContraAccountMetadataPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - } + $ref: "#/components/schemas/ContraAccountMetadataPatchResponseBody" /taxmetadata: get: summary: Find tax metadata. @@ -1010,38 +893,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "taxMetadata": - [ - { - "taxMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", - "taxCode": "V21", - "taxPercentageAmount": 21, - "description": "BTW VERKOOP HOOG 21%", - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - { - "taxMetadataId": "73c47af3-7c8b-44d3-b599-9b6f5a587a82", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%", - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - { - "taxMetadataId": "423b879c-e8db-4ba2-a2b4-0adfe037043d", - "taxCode": "V0", - "taxPercentageAmount": 0, - "description": "BTW VERKOOP NUL", - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - ], - "href": null, - } + $ref: "#/components/schemas/TaxMetadataGetResponseBody" post: summary: Add tax metadata. description: Add tax metadata. @@ -1052,24 +904,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "taxCode": "V21", - "taxPercentageAmount": 21, - "description": "BTW VERKOOP HOOG 21%", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/TaxMetadataPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "taxMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" } + $ref: "#/components/schemas/TaxMetadataPostResponseBody" /taxmetadata/{taxMetadataId}: parameters: - in: path @@ -1090,24 +932,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "taxCode": "V21", - "taxPercentageAmount": 21, - "description": "BTW VERKOOP HOOG 21%", - "validFrom": "2024-03-22T09:00:00", - "validUntil": "2025-12-31T23:59:59", - } + $ref: "#/components/schemas/TaxMetadataPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "taxMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" } + $ref: "#/components/schemas/TaxMetadataPatchResponseBody" /sourcemetadata: get: summary: Find source metadata. @@ -1173,25 +1005,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "sourceMetadata": - [ - { - "sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", - "incomingName": "VerkoopEngine", - "incomingEntity": "OrderLine", - "outgoingName": "Website Verkopen", - "businessOwner": "Corneel Verstoep", - "rejectionProcessing": "system", - "rejectionInfo": "api.htm.nl/v2/account/12345/msgs/abc", - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - ], - "href": null, - } + $ref: "#/components/schemas/SourceMetadataGetResponseBody" post: summary: Add source metadata. description: Add source metadata. @@ -1202,27 +1016,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "incomingName": "VerkoopEngine", - "incomingEntity": "OrderLine", - "outgoingName": "Website Verkopen", - "businessOwner": "Corneel Verstoep", - "rejectionProcessing": "system", - "rejectionInfo": "api.htm.nl/v2/account/12345/msgs/abc", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/SourceMetadataPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "sourceMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" } + $ref: "#/components/schemas/SourceMetadataPostResponseBody" /sourcemetadata/{sourceMetadataId}: parameters: - in: path @@ -1243,27 +1044,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "incomingName": "VerkoopEngine", - "incomingEntity": "OrderLine", - "outgoingName": "Website Verkopen", - "businessOwner": "Corneel Verstoep", - "rejectionProcessing": "system", - "rejectionInfo": "api.htm.nl/v2/account/12345/msgs/abc", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - } + $ref: "#/components/schemas/SourceMetadataPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { "sourceMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" } + $ref: "#/components/schemas/SourceMetadataPatchResponseBody" /accountingperiodmetadata: get: summary: Find accounting period metadata. @@ -1296,24 +1084,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "accountingPeriodMetadata": - [ - { - "accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - "accountingPeriod": "2024-01", - "isOpen": false, - }, - { - "accountingPeriodMetadataId": "0302c651-f040-4cbc-8a4d-90dc82f29a32", - "accountingPeriod": "2024-02", - "isOpen": true, - }, - ], - "href": null, - } + $ref: "#/components/schemas/AccountingPeriodMetadataGetResponseBody" post: summary: Add accounting period metadata. description: Add accounting period metadata. @@ -1324,19 +1095,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: { "accountingPeriod": "2024-01", "isOpen": true } + $ref: "#/components/schemas/AccountingPeriodMetadataPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - } + $ref: "#/components/schemas/AccountingPeriodMetadataPostResponseBody" /accountingperiodmetadata/{accountingPeriodMetadataId}: parameters: - in: path @@ -1357,19 +1123,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: { "accountingPeriod": "2024-01", "isOpen": true } + $ref: "#/components/schemas/AccountingPeriodMetadataPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - } + $ref: "#/components/schemas/AccountingPeriodMetadataPatchResponseBody" /concessionmetadata: get: summary: Find concession metadata. @@ -1411,28 +1172,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "concessionMetadata": - [ - { - "concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - "concession": { "concessionId": 1, "name": "rail" }, - "percentage": 84.021, - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - { - "concessionMetadataId": "5ac3a5a8-4b9b-4a6a-9b1f-86ae8d6d4a9b", - "concession": { "concessionId": 2, "name": "bus" }, - "percentage": 15.979, - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - }, - ], - "href": null, - } + $ref: "#/components/schemas/ConcessionMetadataGetResponseBody" post: summary: Add concession metadata. description: Add concession metadata. @@ -1443,25 +1183,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "concessionId": 2, - "percentage": 15.979, - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - } + $ref: "#/components/schemas/ConcessionMetadataPostRequestBody" responses: "201": description: Created content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - } + $ref: "#/components/schemas/ConcessionMetadataPostResponseBody" /concessionmetadata/{concessionMetadataId}: parameters: - in: path @@ -1482,25 +1211,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "concessionId": 2, - "percentage": 15.979, - "validFrom": "2024-01-01T00:00:00.000", - "validUntil": null, - } + $ref: "#/components/schemas/ConcessionMetadataPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", - } + $ref: "#/components/schemas/ConcessionMetadataPatchResponseBody" /metadataaudittrails: get: summary: Find metadata audit trails. @@ -1596,7 +1314,7 @@ paths: schema: $ref: "#/components/schemas/MetadataAuditTrailsGetResponseBody" post: - summary: Add metadata audit trail. + summary: Add metadata audit trail. description: Add metadata audit trail. tags: - Audit Trail v2 @@ -1625,17 +1343,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "concessions": - [ - { "concessionId": 1, "name": "rail" }, - { "concessionId": 2, "name": "bus" }, - { "concessionId": 3, "name": "not_applicable" }, - ], - "href": null, - } + $ref: "#/components/schemas/ConcessionsGetResponseBody" /failurereasons: get: summary: Get all failure reasons. @@ -1648,24 +1356,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" - example: - { - "failureReasons": - [ - { - "failureReasonId": 1, - "reasonCode": "002", - "reasonDesc": "Contra account does not exist", - }, - { - "failureReasonId": 2, - "reasonCode": "003", - "reasonDesc": "Accouting period closed", - }, - ], - "href": null, - } + $ref: "#/components/schemas/FailureReasonsGetResponseBody" components: securitySchemes: bearerToken: @@ -2046,21 +1737,7 @@ components: format: date-time example: 2022-01-01 00:00:00 failureReason: - type: object - properties: - failureReasonId: - type: integer - example: 1 - reasonCode: - type: string - example: 002 - reasonDesc: - type: string - example: Contra account does not exist - required: - - failureReasonId - - reasonCode - - reasonDesc + $ref: "#/components/schemas/FailureReason" element: type: string example: costCenter @@ -2390,6 +2067,852 @@ components: example: b6161270-eb08-4242-90ec-967d5db62070 required: - metadataAuditTrailId + ProductMetadataGetResponseBody: + type: object + properties: + productMetadata: + type: array + items: + type: object + properties: + productMetadataId: + type: string + format: uuid + example: 39a87c2a-9011-4dfd-b35e-1245a98c2e61 + productCode: + type: string + example: 4031 + department: + type: string + example: 900 + costType: + type: string + example: 619031 + description: + type: string + example: O4031_Reisproduct HTM 1 dag Anoniem + documentCode: + type: string + example: VERK_FACTUUR + timestampUpdated: + type: string + format: date-time + example: 2022-01-01T00:00:00 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + productContraAccounts: + type: array + items: + type: object + properties: + contraAccountMetadata: + $ref: "#/components/schemas/ContraAccountMetadata" + concession: + $ref: "#/components/schemas/Concession" + sourceMetadata: + $ref: "#/components/schemas/SourceMetadata" + costCenter: + type: string + example: 84955 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - contraAccountMetadata + - concession + - sourceMetadata + - costCenter + - validFrom + required: + - productMetadataId + - productCode + - department + - costType + - description + - documentCode + - timestampUpdated + - validFrom + - productContraAccounts + href: + type: string + nullable: true + description: URI for pagination. + example: null + ProductMetadataPostRequestBody: + type: object + properties: + productCode: + type: string + example: 4031 + department: + type: string + example: 900 + costType: + type: string + example: 619031 + description: + type: string + example: O4031_Reisproduct HTM 1 dag Anoniem + documentCode: + type: string + example: VERK_FACTUUR + timestampUpdated: + type: string + format: date-time + example: 2022-01-01T00:00:00 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - productCode + - department + - costType + - description + - documentCode + - timestampUpdated + - validFrom + ProductMetadataPostResponseBody: + type: object + properties: + productMetadataId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - productMetadataId + ProductMetadataPatchRequestBody: + type: object + properties: + productCode: + type: string + example: 4031 + department: + type: string + example: 900 + costType: + type: string + example: 619031 + description: + type: string + example: O4031_Reisproduct HTM 1 dag Anoniem + documentCode: + type: string + example: VERK_FACTUUR + timestampUpdated: + type: string + format: date-time + example: 2022-01-01T00:00:00 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: 2024-06-22T09:00:00 + ProductMetadataPatchResponseBody: + type: object + properties: + productMetadataId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - productMetadataId + ProductContraAccountsPostRequestBody: + type: object + properties: + contraAccountMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + concessionId: + type: integer + example: 1 + sourceMetadataId: + type: string + format: uuid + example: 08d96f94-f468-467e-9068-c86c34f43097 + costCenter: + type: string + example: 84955 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - contraAccountMetadataId + - concessionId + - sourceMetadataId + - costCenter + - validFrom + ProductContraAccountsPostResponseBody: + type: object + properties: + productContraAccountId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - productContraAccountId + ProductContraAccountsGetResponseBody: + type: object + properties: + productContraAccounts: + type: array + items: + type: object + properties: + productContraAccountId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + contraAccountMetadata: + $ref: "#/components/schemas/ContraAccountMetadata" + concession: + $ref: "#/components/schemas/Concession" + sourceMetadata: + $ref: "#/components/schemas/SourceMetadata" + costCenter: + type: string + example: 84955 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - productContraAccountId + - contraAccountMetadataId + - concessionId + - sourceMetadataId + - costCenter + - validFrom + href: + type: string + nullable: true + description: URI for pagination. + example: null + ProductContraAccountsPatchRequestBody: + type: object + properties: + contraAccountMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + concessionId: + type: integer + example: 1 + sourceMetadataId: + type: string + format: uuid + example: 08d96f94-f468-467e-9068-c86c34f43097 + costCenter: + type: string + example: 84955 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + ProductContraAccountsPatchResponseBody: + type: object + properties: + productContraAccountId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - productContraAccountId + ContraAccountMetadataGetResponseBody: + type: object + properties: + contraAccountMetadata: + type: array + items: + $ref: "#/components/schemas/ContraAccountMetadata" + href: + type: string + nullable: true + description: URI for pagination. + example: null + ContraAccountMetadataPostRequestBody: + type: object + properties: + contraAccountCode: + type: string + example: 123456 + contraAccountNumber: + type: string + example: 220.10419 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - contraAccountCode + - contraAccountNumber + - validFrom + ContraAccountMetadataPostResponseBody: + type: object + properties: + contraAccountMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - contraAccountMetadataId + ContraAccountMetadataPatchRequestBody: + type: object + properties: + contraAccountCode: + type: string + example: 123456 + contraAccountNumber: + type: string + example: 220.10419 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + ContraAccountMetadataPatchResponseBody: + type: object + properties: + contraAccountMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - contraAccountMetadataId + TaxMetadataGetResponseBody: + type: object + properties: + taxMetadata: + type: array + items: + type: object + properties: + taxMetadataId: + type: string + format: uuid + example: 192882fe-3f51-46bb-bfdb-2e4cb31ef925 + taxCode: + type: string + example: V21 + taxPercentageAmount: + type: integer + example: 21 + description: + type: string + example: BTW VERKOOP HOOG 21% + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - taxMetadataId + - taxCode + - taxPercentageAmount + - description + - validFrom + href: + type: string + nullable: true + description: URI for pagination. + example: null + TaxMetadataPostRequestBody: + type: object + properties: + taxCode: + type: string + example: V21 + taxPercentageAmount: + type: integer + example: 21 + description: + type: string + example: BTW VERKOOP HOOG 21% + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - taxCode + - taxPercentageAmount + - description + - validFrom + TaxMetadataPostResponseBody: + type: object + properties: + taxMetadataId: + type: string + format: uuid + example: 192882fe-3f51-46bb-bfdb-2e4cb31ef925 + required: + - taxMetadataId + TaxMetadataPatchRequestBody: + type: object + properties: + taxCode: + type: string + example: V21 + taxPercentageAmount: + type: integer + example: 21 + description: + type: string + example: BTW VERKOOP HOOG 21% + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + TaxMetadataPatchResponseBody: + type: object + properties: + taxMetadataId: + type: string + format: uuid + example: 192882fe-3f51-46bb-bfdb-2e4cb31ef925 + required: + - taxMetadataId + SourceMetadataGetResponseBody: + type: object + properties: + sourceMetadata: + type: array + items: + $ref: '#/components/schemas/SourceMetadata' + href: + type: string + nullable: true + description: URI for pagination. + example: null + SourceMetadataPostRequestBody: + type: object + properties: + incomingName: + type: string + example: VerkoopEngine + incomingEntity: + type: string + example: OrderLine + outgoingName: + type: string + example: Website Verkopen + businessOwner: + type: string + example: Corneel Verstoep + rejectionProcessing: + type: string + example: system + rejectionInfo: + type: string + example: api.htm.nl/v2/account/12345/msgs/abc + validFrom: + type: string + format: date-time + example: 2024-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - sourceMetadataId + - incomingName + - incomingEntity + - outgoingName + - businessOwner + - rejectionProcessing + - rejectionInfo + - validFrom + SourceMetadataPostResponseBody: + type: object + properties: + sourceMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - sourceMetadataId + SourceMetadataPatchRequestBody: + type: object + properties: + incomingName: + type: string + example: VerkoopEngine + incomingEntity: + type: string + example: OrderLine + outgoingName: + type: string + example: Website Verkopen + businessOwner: + type: string + example: Corneel Verstoep + rejectionProcessing: + type: string + example: system + rejectionInfo: + type: string + example: api.htm.nl/v2/account/12345/msgs/abc + validFrom: + type: string + format: date-time + example: 2024-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + nullable: true + example: null + SourceMetadataPatchResponseBody: + type: object + properties: + sourceMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - sourceMetadataId + AccountingPeriodMetadataGetResponseBody: + type: object + properties: + accountingPeriodMetadata: + type: array + items: + type: object + properties: + accountingPeriodMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + accountingPeriod: + type: string + example: 2024-01 + isOpen: + type: boolean + example: true + required: + - accountingPeriodMetadataId + - accountingPeriod + - isOpen + href: + type: string + nullable: true + description: URI for pagination. + example: null + AccountingPeriodMetadataPostRequestBody: + type: object + properties: + accountingPeriod: + type: string + example: 2024-01 + isOpen: + type: boolean + example: true + required: + - accountingPeriod + - isOpen + AccountingPeriodMetadataPostResponseBody: + type: object + properties: + accountingPeriodMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - accountingPeriodMetadataId + AccountingPeriodMetadataPatchRequestBody: + type: object + properties: + accountingPeriod: + type: string + example: 2024-01 + isOpen: + type: boolean + example: true + AccountingPeriodMetadataPatchResponseBody: + type: object + properties: + accountingPeriodMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - accountingPeriodMetadataId + ConcessionMetadataGetResponseBody: + type: object + properties: + concessionMetadata: + type: array + items: + type: object + properties: + concessionMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + concession: + $ref: '#/components/schemas/Concession' + percentage: + type: number + example: 84.021 + validFrom: + type: string + format: date-time + example: 2024-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - concessionMetadataId + - concession + - percentage + - validFrom + href: + type: string + nullable: true + description: URI for pagination. + example: null + ConcessionMetadataPostRequestBody: + type: object + properties: + concessionId: + type: integer + example: 1 + percentage: + type: number + example: 84.021 + validFrom: + type: string + format: date-time + example: 2024-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - concessionId + - percentage + - validFrom + ConcessionMetadataPostResponseBody: + type: object + properties: + concessionMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - concessionMetadataId + ConcessionMetadataPatchRequestBody: + type: object + properties: + concessionId: + type: integer + example: 1 + percentage: + type: number + example: 84.021 + validFrom: + type: string + format: date-time + example: 2024-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + nullable: true + example: null + ConcessionMetadataPatchResponseBody: + type: object + properties: + concessionMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + required: + - concessionMetadataId + ConcessionsGetResponseBody: + type: object + properties: + concessions: + type: array + items: + $ref: '#/components/schemas/Concession' + href: + type: string + nullable: true + description: URI for pagination. + example: null + FailureReasonsGetResponseBody: + type: object + properties: + failureReasons: + type: array + items: + $ref: '#/components/schemas/FailureReason' + href: + type: string + nullable: true + description: URI for pagination. + example: null + ContraAccountMetadata: + type: object + properties: + contraAccountMetadataId: + type: string + format: uuid + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + contraAccountCode: + type: string + example: 123456 + contraAccountNumber: + type: string + example: 220.10419 + validFrom: + type: string + format: date-time + example: 2024-03-22T09:00:00 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - contraAccountMetadataId + - contraAccountCode + - contraAccountNumber + - validFrom + Concession: + type: object + properties: + concessionId: + type: integer + example: 1 + name: + type: string + example: bus + required: + - concessionId + SourceMetadata: + type: object + properties: + sourceMetadataId: + type: string + format: uuid + example: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 + incomingName: + type: string + example: VerkoopEngine + incomingEntity: + type: string + example: OrderLine + outgoingName: + type: string + example: Website Verkopen + businessOwner: + type: string + example: Corneel Verstoep + rejectionProcessing: + type: string + example: system + rejectionInfo: + type: string + example: api.htm.nl/v2/account/12345/msgs/abc + validFrom: + type: string + format: date-time + example: 2024-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + nullable: true + example: null + required: + - sourceMetadataId + - incomingName + - incomingEntity + - outgoingName + - businessOwner + - rejectionProcessing + - rejectionInfo + - validFrom + FailureReason: + type: object + properties: + failureReasonId: + type: integer + example: 2 + reasonCode: + type: string + example: "002" + reasonDesc: + type: string + example: Contra account does not exist + required: + - failureReasonId + - reasonCode + - reasonDesc rfc9457: type: object properties: @@ -2416,10 +2939,3 @@ components: example: - "/account/12345" - "/account/67890" - postMetadataAuditTrailResponse: - type: object - properties: - metadataAuditTrailId: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf