From a6f85b32fc37fc35cb9fa24e6b0f2e6fdd4d832c Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 11:35:13 +0200 Subject: [PATCH 1/8] OVPAY-1755 - Updated BookingMetadata. --- src/openapi/fiko/fiko-crud.yaml | 139 +++++++++++++++++--------------- 1 file changed, 72 insertions(+), 67 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index bfc55cd..474090c 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -219,7 +219,7 @@ paths: x-throttling-tier: Unlimited /transactionitems: post: - summary: P1. Add one ore more finanicial transaction items in bulk. + summary: Add one ore more finanicial transaction items in bulk. description: Add one ore more finanicial transaction items in bulk. tags: - Transactions v2.2 @@ -314,7 +314,7 @@ paths: required: true description: The id of the transaction item. patch: - summary: P1. Update a transaction item. + summary: Update a transaction item. description: Update a transaction item. tags: - Transactions v2.2 @@ -366,7 +366,7 @@ paths: get: tags: - Transactions v2.2 - summary: P1. Get the status of the transaction items POST. + summary: Get the status of the transaction items POST. description: Get the status of the asynchronous transaction items POST processing. parameters: - in: path @@ -431,7 +431,7 @@ paths: required: true description: The id of the transaction item to process. post: - summary: P1. Add a processing failure. + summary: Add a processing failure. description: Add a processing failure. tags: - Failures v2.2 @@ -483,7 +483,7 @@ paths: required: true description: The id of the transaction item to process. post: - summary: P1. Add an audit trail entry. + summary: Add an audit trail entry. description: Add an audit trail entry. tags: - Audit Trail v2.2 @@ -934,7 +934,7 @@ paths: required: true description: The id of the processing failure. patch: - summary: P1. Update processing failure. + summary: Update processing failure. description: Update processing failure. tags: - Failures v2.2 @@ -1046,7 +1046,7 @@ paths: x-throttling-tier: Unlimited /bookingprocesses: post: - summary: P2. Add a booking process. + summary: Add a booking process. description: Add a booking process. tags: - Booking Processes v2.2 @@ -1093,7 +1093,7 @@ paths: required: true description: The id of the booking process. patch: - summary: P2. Update a booking process. + summary: Update a booking process. description: Update a booking process. tags: - Booking Processes v2.2 @@ -1138,7 +1138,7 @@ paths: required: true description: The id of the booking process. post: - summary: P2. Add booking metadata. + summary: Add booking metadata. description: Add booking metadata. tags: - Booking Processes v2.2 @@ -1154,9 +1154,8 @@ paths: description: | This example shows how a new booking metadata for a booking process can be added. value: - description: Saldoreizen - department: 900 - costType: 84955 + name: Saldoreizen + description: Saldoreizen nov. 2024 documentCode: OPBR-FIKO hasSeparateTaxLine: true hasLinePerIdentifyingField: false @@ -1207,9 +1206,8 @@ paths: - bookingMetadataRowId - bookingMetadataId - bookingProcessId + - name - description - - department - - costType - documentCode - hasSeparateTaxLine - hasLinePerIdentifyingField @@ -1232,9 +1230,8 @@ paths: - bookingMetadataRowId - bookingMetadataId - bookingProcessId + - name - description - - department - - costType - documentCode - hasSeparateTaxLine - hasLinePerIdentifyingField @@ -1273,10 +1270,9 @@ paths: bookingMetadataRowId: 13 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: Dagkaart - department: 900 - costType: 84956 - documentCode: FIKO-OPBR + name: Dagkaarten + description: Dagkaarten nov. 2024 + documentCode: OPBR-FIKO hasSeparateTaxLine: true hasLinePerIdentifyingField: true hasLinePerSource: true @@ -1287,10 +1283,9 @@ paths: bookingMetadataRowId: 14 bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034 bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: Saldoreizen - department: 900 - costType: 84955 - documentCode: FIKO-OPBR + name: Saldoreizen + description: Saldoreizen nov. 2024 + documentCode: OPBR-FIKO hasSeparateTaxLine: true hasLinePerIdentifyingField: true hasLinePerSource: true @@ -1312,7 +1307,7 @@ paths: required: true description: The id of the booking metadata. patch: - summary: P2. Update booking metadata. + summary: Update booking metadata. description: Update booking metadata. tags: - Booking Processes v2.2 @@ -1328,6 +1323,14 @@ paths: description: | In this example the booking metadata is updated. The validUntil field is updated to 2024-03-22T09:00:00. value: + name: Dagkaarten + description: Dagkaarten nov. 2024 + documentCode: OPBR-FIKO + hasSeparateTaxLine: true + hasLinePerIdentifyingField: true + hasLinePerSource: true + hasLinePerConcession: true + validFrom: 2022-01-01 00:00:00 validUntil: 2024-03-22T09:00:00 responses: "200": @@ -1346,6 +1349,20 @@ paths: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited + delete: + summary: Delete booking metadata. + description: | + Delete booking metadata. Note that booking metadata can only be deleted + if the validFrom is in the future. + tags: + - Booking Processes v2.2 + responses: + "200": + description: OK + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /bookingmetadata/{bookingMetadataId}/bookinggroupfields: parameters: - in: path @@ -1357,7 +1374,7 @@ paths: required: true description: The id of the booking metadata. post: - summary: P2. Add booking group fields. + summary: Add booking group fields. description: Add booking group fields. tags: - Booking Processes v2.2 @@ -1401,7 +1418,7 @@ paths: required: true description: The id of the booking metadata. post: - summary: P2. Add booking line metadata. + summary: Add booking line metadata. description: Add booking line metadata. tags: - Booking Processes v2.2 @@ -1628,7 +1645,7 @@ paths: required: true description: The id of the booking group field. delete: - summary: P2. Delete booking group field. + summary: Delete booking group field. description: Delete booking group field. tags: - Booking Processes v2.2 @@ -1887,7 +1904,7 @@ paths: required: true description: The id of the booking line metadata. patch: - summary: P2. Update booking line metadata. + summary: Update booking line metadata. description: Update booking line metadata. tags: - Booking Processes v2.2 @@ -1922,7 +1939,7 @@ paths: x-auth-type: Application & Application User x-throttling-tier: Unlimited delete: - summary: P2. Delete booking line metadata. + summary: Delete booking line metadata. description: Delete booking line metadata. tags: - Booking Processes v2.2 @@ -2050,7 +2067,7 @@ paths: x-throttling-tier: Unlimited /taxmetadata: post: - summary: P3. Add tax metadata. + summary: Add tax metadata. description: Add tax metadata. tags: - Metadata v2.2 @@ -2098,7 +2115,7 @@ paths: required: true description: The id of the tax metadata. patch: - summary: P3. Update tax metadata. + summary: Update tax metadata. description: Update tax metadata. tags: - Metadata v2.2 @@ -2229,7 +2246,7 @@ paths: x-throttling-tier: Unlimited /sourcemetadata: post: - summary: P3. Add source metadata. + summary: Add source metadata. description: Add source metadata. tags: - Metadata v2.2 @@ -2278,7 +2295,7 @@ paths: required: true description: The id of the source metadata. patch: - summary: P3. Update source metadata. + summary: Update source metadata. description: Update source metadata. tags: - Metadata v2.2 @@ -2389,7 +2406,7 @@ paths: x-throttling-tier: Unlimited /accountingperiodmetadata: post: - summary: P2. Add accounting period metadata. + summary: Add accounting period metadata. description: Add accounting period metadata. tags: - Metadata v2.2 @@ -2434,7 +2451,7 @@ paths: required: true description: The id of the accounting period metadata. patch: - summary: P2. Update accounting period metadata. + summary: Update accounting period metadata. description: Update accounting period metadata. tags: - Metadata v2.2 @@ -2589,7 +2606,7 @@ paths: x-throttling-tier: Unlimited /concessionmetadata: post: - summary: P2. Add concession metadata. + summary: Add concession metadata. description: Add concession metadata. tags: - Metadata v2.2 @@ -2638,7 +2655,7 @@ paths: required: true description: The id of the concession metadata. patch: - summary: P2. Update concession metadata. + summary: Update concession metadata. description: Update concession metadata. tags: - Metadata v2.2 @@ -3418,18 +3435,15 @@ components: type: string format: uuid example: 37a8095b-19db-498f-9349-5f37d21c5bdf + name: + type: string + example: Dagkaarten description: type: string - example: Dagkaart - department: - type: string - example: 900 - costType: - type: string - example: 84956 + example: Dagkaarten nov. 2024 documentCode: type: string - example: FIKO-OPBR + example: OPBR-FIKO hasSeparateTaxLine: type: boolean example: true @@ -3454,9 +3468,8 @@ components: required: - bookingMetadataId - bookingProcessId + - name - description - - department - - costType - documentCode - hasSeparateTaxLine - hasLinePerIdentifyingField @@ -3466,18 +3479,15 @@ components: BookingMetadataPostRequestBody: type: object properties: + name: + type: string + example: Dagkaarten description: type: string - example: Dagkaart - department: - type: string - example: 900 - costType: - type: string - example: 84956 + example: Dagkaarten nov. 2024 documentCode: type: string - example: FIKO-OPBR + example: OPBR-FIKO hasSeparateTaxLine: type: boolean example: true @@ -3500,9 +3510,8 @@ components: nullable: true example: null required: + - name - description - - department - - costType - documentCode - hasSeparateTaxLine - hasLinePerIdentifyingField @@ -3521,22 +3530,18 @@ components: BookingMetadataPatchRequestBody: type: object properties: - description: + name: type: string nullable: true - example: Dagkaart - department: + example: Dagkaarten + description: type: string nullable: true - example: 900 - costType: - type: string - nullable: true - example: 84956 + example: Dagkaarten nov. 2024 documentCode: type: string nullable: true - example: FIKO-OPBR + example: OPBR-FIKO hasSeparateTaxLine: type: boolean nullable: true From 1a853a11efe1502c259b7b72bdc72fb3daf252b6 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 13:52:36 +0200 Subject: [PATCH 2/8] OVPAY-1755 - Updated BookingLineMetadata. --- src/openapi/fiko/fiko-crud.yaml | 225 +++++++++++++++++++++++++++----- 1 file changed, 195 insertions(+), 30 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 474090c..d8a7ff9 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -1321,7 +1321,7 @@ paths: Update booking metadata: summary: Update booking metadata description: | - In this example the booking metadata is updated. The validUntil field is updated to 2024-03-22T09:00:00. + In this example the booking metadata is updated. All fields are updated. value: name: Dagkaarten description: Dagkaarten nov. 2024 @@ -1332,6 +1332,12 @@ paths: hasLinePerConcession: true validFrom: 2022-01-01 00:00:00 validUntil: 2024-03-22T09:00:00 + Update valid until: + summary: Update valid until + description: | + In this example the booking metadata is updated. The validUntil field is updated to 2024-03-22T09:00:00. + value: + validUntil: 2024-03-22T09:00:00 responses: "200": description: OK @@ -1351,7 +1357,7 @@ paths: x-throttling-tier: Unlimited delete: summary: Delete booking metadata. - description: | + description: | Delete booking metadata. Note that booking metadata can only be deleted if the validFrom is in the future. tags: @@ -1362,7 +1368,7 @@ paths: security: - default: [] x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited /bookingmetadata/{bookingMetadataId}/bookinggroupfields: parameters: - in: path @@ -1434,12 +1440,16 @@ paths: description: In this example a new tax booking line metadata is added to an existing booking. value: name: Saldoreizen - BTW + description: BTW 9% sourceMetadataId: null identifyingFieldValue: null concessionId: null + isContraAccount: false lineType: tax lineSense: credit - costCenter: 603031 + department: 140 + costType: 15427 + costCenter: null articleName: null extRef1: null extRef2: null @@ -1452,11 +1462,15 @@ paths: description: In this example a new yield booking line metadata is added to an existing booking. value: name: Opbrengst Saldoreizen - RAIL + description: Saldoreizen nov. 2024 sourceMetadataId: null identifyingFieldValue: null concessionId: 1 + isContraAccount: false lineType: analysis lineSense: credit + department: 900 + costType: 84956 costCenter: 603031 articleName: Saldoreizen extRef1: null @@ -1465,6 +1479,28 @@ paths: extRef4: null extRef5: TLS extRef6: null + Add a new contra account booking line metadata: + summary: Add a new contra account booking line metadata + description: In this example a new contra account booking line metadata is added to an existing booking. + value: + name: Tegenrekening productverkopen + description: ST20 produktverkopen nov 2024 + sourceMetadataId: null + identifyingFieldValue: null + concessionId: null + isContraAccount: true + lineType: analysis + lineSense: debet + department: 140 + costType: 15427 + costCenter: null + articleName: null + extRef1: null + extRef2: null + extRef3: null + extRef4: null + extRef5: null + extRef6: null responses: "201": description: Created @@ -1683,11 +1719,15 @@ paths: - bookingLineMetadataId - bookingMetadataId - name + - description - sourceMetadataId - identifyingFieldValue - concessionId + - isContraAccount - lineType - lineSense + - department + - costType - costCenter - articleName - extRef1 @@ -1712,11 +1752,15 @@ paths: - bookingLineMetadataId - bookingMetadataId - name + - description - sourceMetadataId - identifyingFieldValue - concessionId + - isContraAccount - lineType - lineSense + - department + - costType - costCenter - articleName - extRef1 @@ -1759,11 +1803,15 @@ paths: bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 name: Webshop - Dagkaart - BUS - sourceName: HTM-website + description: Dagkaarten nov. 2024 BUS + sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2 identifyingFieldValue: null concessionId: 2 + isContraAccount: false lineType: summary lineSense: credit + department: 900 + costType: 84956 costCenter: 603031 articleName: dagkaart extRef1: null @@ -1777,11 +1825,15 @@ paths: bookingLineMetadataId: 1bca01db-40d3-4447-9f28-41475ec6877d bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034 name: TLS - Saldoreizen - RAIL - sourceName: Translink + description: Saldoreizen nov. 2024 RAIL + sourceMetadataId: 4dab350d-a47c-4cc0-80e8-404e099f5c24 identifyingFieldValue: null concessionId: 1 + isContraAccount: false lineType: summary lineSense: credit + department: 900 + costType: 84955 costCenter: 603007 articleName: Opbrengst TLS extRef1: null @@ -1804,11 +1856,15 @@ paths: bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 name: Webshop - Dagkaart - BUS - sourceName: HTM-website + description: Dagkaarten nov. 2024 BUS + sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2 identifyingFieldValue: null concessionId: 2 + isContraAccount: false lineType: summary lineSense: credit + department: 900 + costType: 84956 costCenter: 619031 articleName: dagkaart extRef1: null @@ -1822,11 +1878,14 @@ paths: bookingLineMetadataId: a4464b5c-9a8e-4e48-a0a0-5500b1ca0885 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 name: Webshop - Dagkaart - RAIL - sourceName: HTM-website + description: Dagkaarten nov. 2024 RAIL + sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2 identifyingFieldValue: null concessionId: 1 lineType: summary lineSense: credit + department: 900 + costType: 84956 costCenter: 603031 articleName: dagkaart extRef1: null @@ -1840,11 +1899,15 @@ paths: bookingLineMetadataId: feaa7b33-ba49-40a2-90f3-5dd70d591f17 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 name: Ticketapp - Dagkaart - BUS - sourceName: HTM-app + description: Dagkaarten nov. 2024 BUS + sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2 identifyingFieldValue: null concessionId: 2 + isContraAccount: false lineType: summary lineSense: credit + department: 900 + costType: 84956 costCenter: 619031 articleName: dagkaart extRef1: null @@ -1858,11 +1921,15 @@ paths: bookingLineMetadataId: ea6ce4e7-4d52-4b89-bbea-ffe0ef6c48ff bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 name: Ticketapp - Dagkaart - RAIL - sourceName: HTM-app + description: Dagkaarten nov. 2024 RAIL + sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2 identifyingFieldValue: null concessionId: 1 + isContraAccount: false lineType: summary lineSense: credit + department: 900 + costType: 84956 costCenter: 603031 articleName: dagkaart extRef1: null @@ -1876,12 +1943,16 @@ paths: bookingLineMetadataId: 0a8dbb7d-73c8-451e-9028-e4613283c7bd bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 name: Dagkaart - BTW - sourceMetadata: null + description: BTW 9% + sourceMetadataId: null identifyingFieldValue: null - concession: null + concessionId: null + isContraAccount: false lineType: tax lineSense: credit - costCenter: 1337 + department: 140 + costType: 15427 + costCenter: null articleName: dagkaart extRef1: null extRef2: null @@ -1889,6 +1960,28 @@ paths: extRef4: null extRef5: null extRef6: null + - "@odata.etag": 26c89ff7-2fc3-4cc5-ae80-7e1e90886148 + bookingLineMetadataRowId: 16 + bookingLineMetadataId: d8c8b3b8-e996-463e-9c32-f0878ebfbcbb + bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + name: Dagkaart - Tegenrekening + description: ST20 produktverkopen nov 2024 + sourceMetadataId: null + identifyingFieldValue: null + concessionId: null + isContraAccount: true + lineType: analysis + lineSense: credit + department: 220 + costType: 10486 + costCenter: null + articleName: null + extRef1: null + extRef2: null + extRef3: 2025-02-17 + extRef4: null + extRef5: null + extRef6: null security: - default: [] x-auth-type: Application & Application User @@ -1915,6 +2008,29 @@ paths: schema: $ref: "#/components/schemas/BookingLineMetadataPatchRequestBody" examples: + Update a booking line: + summary: Update a booking line + description: | + In this example an existing booking line metadata is updated. + value: + name: Ticketapp - Dagkaart - RAIL + description: Dagkaarten nov. 2024 RAIL + sourceMetadataId: 8cddd157-c9ea-4027-9e8b-f1c5201440f1 + identifyingFieldValue: null + concessionId: 1 + isContraAccount: false + lineType: summary + lineSense: credit + department: 900 + costType: 84956 + costCenter: 603031 + articleName: dagkaart + extRef1: null + extRef2: null + extRef3: 2025-02-17 + extRef4: null + extRef5: Webshop + extRef6: null Update cost center of a booking line: summary: Update cost center of a booking line description: | @@ -3534,7 +3650,7 @@ components: type: string nullable: true example: Dagkaarten - description: + description: type: string nullable: true example: Dagkaarten nov. 2024 @@ -3634,6 +3750,9 @@ components: name: type: string example: Dagkaart - BUS + description: + type: string + example: Dagkaarten nov. 2024 BUS sourceMetadataId: type: string format: uuid @@ -3647,6 +3766,9 @@ components: type: integer example: 1 nullable: true + isContraAccount: + type: boolean + example: false lineType: type: string enum: @@ -3660,6 +3782,12 @@ components: - debit - credit example: credit + department: + type: string + example: 900 + costType: + type: string + example: 84956 costCenter: type: string example: 603031 @@ -3694,8 +3822,12 @@ components: nullable: true required: - name + - description + - isContraAccount - lineType - lineSense + - department + - costType BookingLineMetadataPostResponseBody: type: object properties: @@ -3735,9 +3867,13 @@ components: name: type: string example: Dagkaart - RAIL - sourceName: + description: type: string - example: HTM-website + example: Dagkaarten nov. 2024 RAIL + sourceMetadataId: + type: string + format: uuid + example: db7e5899-3904-4b53-bd62-a56aef34c66d nullable: true identifyingFieldValue: type: string @@ -3747,6 +3883,9 @@ components: type: integer example: 1 nullable: true + isContraAccount: + type: boolean + example: false lineType: type: string enum: @@ -3760,6 +3899,12 @@ components: - debit - credit example: credit + department: + type: string + example: 900 + costType: + type: string + example: 84956 costCenter: type: string example: 603031 @@ -3796,75 +3941,95 @@ components: - bookingLineMetadataId - bookingMetadataId - name + - description + - isContraAccount - lineType - lineSense + - department + - costType BookingLineMetadataPatchRequestBody: type: object properties: name: type: string - nullable: true example: Dagkaart - RAIL + nullable: true + description: + type: string + example: Dagkaarten nov. 2024 RAIL + nullable: true sourceMetadataId: type: string format: uuid - nullable: true example: null + nullable: true identifyingFieldValue: type: string - nullable: true example: null + nullable: true concessionId: type: integer - nullable: true example: 1 + nullable: true + isContraAccount: + type: boolean + example: false + nullable: true lineType: type: string - nullable: true enum: - summary - analysis - tax example: summary + nullable: true lineSense: type: string - nullable: true enum: - debit - credit example: credit + nullable: true + department: + type: string + example: 900 + nullable: true + costType: + type: string + example: 84956 + nullable: true costCenter: type: string - nullable: true example: 603031 + nullable: true articleName: type: string - nullable: true example: dagkaart + nullable: true extRef1: type: string - nullable: true example: null + nullable: true extRef2: type: string - nullable: true example: null + nullable: true extRef3: type: string - nullable: true example: 2025-02-17 + nullable: true extRef4: type: string - nullable: true example: null + nullable: true extRef5: type: string - nullable: true example: Webshop + nullable: true extRef6: type: string - nullable: true example: null + nullable: true BookingLineMetadataPatchResponseBody: type: object properties: From ea6d8d18641f10acb5b76f122050b28df28520a0 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 13:58:54 +0200 Subject: [PATCH 3/8] OVPAY-1755 - Updated BookingProcesses. --- src/openapi/fiko/fiko-crud.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index d8a7ff9..37f29ee 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -1109,6 +1109,8 @@ paths: description: | This example shows how a booking process can be updated. value: + name: Verkooptransacties + transactionType: sales identifyingFieldName: orderNumber responses: "200": From 33fa5e408c47500313b1a079fea744cd660ef28a Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 14:09:24 +0200 Subject: [PATCH 4/8] OVPAY-1755 - Updated the examples of ConcessionMetdata. --- src/openapi/fiko/fiko-crud.yaml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 37f29ee..fde66cd 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -2786,6 +2786,15 @@ paths: examples: Update a concession distribution: summary: Update a concession distribution + description: | + In this example, the whole concession distribution is updated. + value: + concessionId: 1 + percentage: 80.042 + validFrom: 2025-02-01T00:00:00.000 + validUntil: 2025-02-28T23:59:59.999 + Update the validity of a concession distribution: + summary: Update the validity of a concession distribution description: | Every month, the administrator determines the concession distribution for the next month. In this example, the concession distribution for last month gets an end date. From 7097b49097eaffab5a7638e12ad5a47aead899e5 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 14:14:52 +0200 Subject: [PATCH 5/8] OVPAY-1755 - Added delete of concessionmetada. --- src/openapi/fiko/fiko-crud.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index fde66cd..27dc790 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -2817,6 +2817,20 @@ paths: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited + delete: + summary: Delete concession metadata. + description: | + Delete concession metadata. Note that concession metadata can only be deleted + if the validFrom is in the future. + tags: + - Metadata v2.2 + responses: + "200": + description: OK + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /Odata/Concession: get: summary: Find concessions. From a1175b57d85721c1a16f2fd04e9bdf7ecf74fc69 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 14:34:43 +0200 Subject: [PATCH 6/8] OVPAY-1755 - Updated TaxMetadata. --- src/openapi/fiko/fiko-crud.yaml | 80 ++++++++++++++++++++++++++------- 1 file changed, 64 insertions(+), 16 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 27dc790..41399ba 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -2094,8 +2094,9 @@ paths: - taxMetadataRowId - taxMetadataId - taxCode - - taxPercentageAmount + - taxPercentage - description + - weFactTaxCode - validFrom - validUntil - name: $select @@ -2113,7 +2114,7 @@ paths: - taxMetadataRowId - taxMetadataId - taxCode - - taxPercentageAmount + - taxPercentage - description - validFrom - validUntil @@ -2134,49 +2135,55 @@ paths: - "@odata.etag": 4a758689-c28f-47d1-a230-e5422e9ad3be taxMetadataRowId: 13 taxMetadataId: 2d444740-4131-4169-bb47-2d125641dc87 - taxCode: V0 - texPercantageAmount: 0 + taxCode: V00 + taxPercentage: 0 description: BTW VERKOOP NUL + weFactTaxCode: V0 validFrom: 2024-03-22T09:00:00 validUntil: null - "@odata.etag": f848cce9-7fbe-4371-a70c-085fefe4613e taxMetadataRowId: 14 taxMetadataId: b5f879d1-043d-4357-9655-2eeca8ebe9bf taxCode: V09 - taxPercentageAmount: 9 + taxPercentage: 9 description: BTW VERKOOP LAAG 9% + weFactTaxCode: V9 validFrom: 2024-03-22T09:00:00 validUntil: null - "@odata.etag": db06ae45-710d-4a4b-958b-cba61a8ba027 taxMetadataRowId: 15 taxMetadataId: 62e1abe7-d76f-4364-9207-591c0601ba55 taxCode: V21 - taxPercentageAmount: 21 + taxPercentage: 21 description: BTW VERKOOP HOOG 21% + weFactTaxCode: V21 validFrom: 2024-03-22T09:00:00 validUntil: null - "@odata.etag": 3bc97433-06f8-431c-b931-f5e33641bf88 taxMetadataRowId: 16 taxMetadataId: 9a253fc3-e562-4c4a-925c-d9caf0dcc549 - taxCode: ?0 - taxPercentageAmount: 0 + taxCode: I00 + taxPercentage: 0 description: BTW DEBIT NUL + weFactTaxCode: I0 validFrom: 2024-03-22T09:00:00 validUntil: null - "@odata.etag": 2262ab02-57a8-4425-a823-88d3c8d956bf taxMetadataRowId: 17 taxMetadataId: 6243b848-5ca3-44e0-9860-4fb3a817f148 - taxCode: ?09 - taxPercentageAmount: 9 + taxCode: I09 + taxPercentage: 9 description: BTW DEBIT laag 9% + weFactTaxCode: I9 validFrom: 2024-03-22T09:00:00 validUntil: null - "@odata.etag": 261794fa-11fa-47a2-9429-1e671638cb9d taxMetadataRowId: 18 taxMetadataId: 0240d6e4-6037-4da0-ac10-1fde0229d439 - taxCode: ?21 - taxPercentageAmount: 21 + taxCode: I21 + taxPercentage: 21 description: BTW DEBIT hoog 21% + weFactTaxCode: I21 validFrom: 2024-03-22T09:00:00 validUntil: null security: @@ -2201,8 +2208,9 @@ paths: description: This example adds a new tax metadata record to the database. value: taxCode: V21.4 - taxPercentageAmount: 21.4 + taxPercentage: 21.4 description: BTW VERKOOP HOOG 21.4% + weFactTaxCode: V21.4 validFrom: 2025-03-22T09:00:00 validUntil: null responses: @@ -2246,7 +2254,17 @@ paths: examples: Update tax metadata: summary: Update tax metadata - description: In this example the tax metadata is updated. The validUntil field is updated to 2025-03-22T09:00:00. + description: In this example the tax metadata is updated. + value: + taxCode: V09 + taxPercentage: 9 + description: BTW VERKOOP LAAG 9% + weFactTaxCode: V9 + validFrom: 2024-03-22T09:00:00 + validUntil: 2025-03-22T09:00:00 + Update tax metadata validity: + summary: Update tax metadata validity + description: In this example the validity of a tax metadata is updated. The validUntil field is updated to 2025-03-22T09:00:00. value: validUntil: 2025-03-22T09:00:00 responses: @@ -2266,6 +2284,20 @@ paths: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited + delete: + summary: Delete tax metadata. + description: | + Delete tax metadata. Note that tax metadata can only be deleted + if the validFrom is in the future. + tags: + - Metadata v2.2 + responses: + "200": + description: OK + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /Odata/SourceMetadata: get: summary: Find source metadata. @@ -4215,12 +4247,16 @@ components: taxCode: type: string example: V21 - taxPercentageAmount: + taxPercentage: type: number example: 21 description: type: string example: BTW VERKOOP HOOG 21% + weFactTaxCode: + type: string + example: V21 + nullable: true validFrom: type: string format: date-time @@ -4242,12 +4278,16 @@ components: taxCode: type: string example: V21 - taxPercentageAmount: + taxPercentage: type: number example: 21 description: type: string example: BTW VERKOOP HOOG 21% + weFactTaxCode: + type: string + example: V21 + nullable: true validFrom: type: string format: date-time @@ -4277,16 +4317,24 @@ components: taxCode: type: string example: V21 + nullable: true taxPercentageAmount: type: number example: 21 + nullable: true description: type: string example: BTW VERKOOP HOOG 21% + nullable: true + weFactTaxCode: + type: string + example: V21 + nullable: true validFrom: type: string format: date-time example: 2024-03-22T09:00:00 + nullable: true validUntil: type: string format: date-time From 248208ec7b9f4d2eaa79cc27873e8ae4bf22b45b Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 14:49:22 +0200 Subject: [PATCH 7/8] OVPAY-1755 - Updated SourceMetadata. --- src/openapi/fiko/fiko-crud.yaml | 84 +++++++++++++++++++++++++++++++-- 1 file changed, 81 insertions(+), 3 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 41399ba..e93b813 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -2329,6 +2329,8 @@ paths: - businessOwner - rejectionProcessing - rejectionInfo + - validFrom + - validUntil - name: $select in: query description: Select properties to be returned @@ -2349,6 +2351,8 @@ paths: - businessOwner - rejectionProcessing - rejectionInfo + - validFrom + - validUntil responses: "200": description: OK @@ -2372,6 +2376,8 @@ paths: businessOwner: Koos Verweg rejectionProcessing: system rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc + validFrom: 2025-01-01T00:00.000 + validUntil: null - "@odata.etag": 4b743da5-4195-4b2e-a11b-6e5393a94c0a sourceMetadataRowId: 3 sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc @@ -2381,6 +2387,8 @@ paths: businessOwner: Danny Negen rejectionProcessing: mail rejectionInfo: d.negen@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: null - "@odata.etag": 502e2f58-b4e1-4dd0-947a-db6eea726e3a sourceMetadataRowId: 4 sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209 @@ -2390,6 +2398,8 @@ paths: businessOwner: Guus Geluk rejectionProcessing: mail rejectionInfo: ao@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: null security: - default: [] x-auth-type: Application & Application User @@ -2417,6 +2427,8 @@ paths: businessOwner: Danny Negen rejectionProcessing: mail rejectionInfo: d.negen@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: null responses: "201": description: Created @@ -2456,9 +2468,26 @@ paths: schema: $ref: "#/components/schemas/SourceMetadataPatchRequestBody" examples: - Update a source in the metadata: - summary: Update a source in the metadata - description: In this example we update the business owner of a single source meta data + Update a source: + summary: Update a source + description: In this example we update a single source. + value: + incomingName: HTM-app + incomingEntity: OrderLine + outgoingName: ticketapp + businessOwner: Danny Negen + rejectionProcessing: mail + rejectionInfo: d.negen@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: 2025-01-31T23:59:59.999 + Update a source validity: + summary: Update a source validity + description: In this example we update the validity of a single source. + value: + validUntil: 2025-01-31T23:59:59.999 + Update a business owner of a source: + summary: Update a business owner of a source + description: In this example we update the business owner of a single source. value: businessOwner: Chef Erwin responses: @@ -2478,6 +2507,20 @@ paths: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited + delete: + summary: Delete source metadata. + description: | + Delete source metadata. Note that source metadata can only be deleted + if the validFrom is in the future. + tags: + - Metadata v2.2 + responses: + "200": + description: OK + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /Odata/AccountingPeriodMetadata: get: summary: Find accounting period metadata. @@ -4390,6 +4433,15 @@ components: rejectionInfo: type: string example: api.htm.nl/v2/account/12345/msgs/abc + validFrom: + type: string + format: date-time + example: 2025-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + example: null + nullable: true required: - sourceMetadataId - incomingName @@ -4420,6 +4472,15 @@ components: rejectionInfo: type: string example: api.htm.nl/v2/account/12345/msgs/abc + validFrom: + type: string + format: date-time + example: 2025-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + example: null + nullable: true required: - incomingName - incomingEntity @@ -4427,6 +4488,7 @@ components: - businessOwner - rejectionProcessing - rejectionInfo + - validFrom SourceMetadataPostResponseBody: type: object properties: @@ -4442,21 +4504,37 @@ components: incomingName: type: string example: HTM-website + nullable: true incomingEntity: type: string example: OrderLine + nullable: true outgoingName: type: string example: Website Verkopen + nullable: true businessOwner: type: string example: Koos Verweg + nullable: true rejectionProcessing: type: string example: system + nullable: true rejectionInfo: type: string example: api.htm.nl/v2/account/12345/msgs/abc + nullable: true + validFrom: + type: string + format: date-time + example: 2025-01-01T00:00:00.000 + nullable: true + validUntil: + type: string + format: date-time + example: null + nullable: true SourceMetadataPatchResponseBody: type: object properties: From 6e0b61346313c42c83b540ca9a6a8df562244473 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 28 Apr 2025 14:51:52 +0200 Subject: [PATCH 8/8] OVPAY-1755 - Updated AccoutingPeriodMetadata. --- src/openapi/fiko/fiko-crud.yaml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index e93b813..f7b30f8 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -2254,7 +2254,7 @@ paths: examples: Update tax metadata: summary: Update tax metadata - description: In this example the tax metadata is updated. + description: In this example the tax metadata is updated. value: taxCode: V09 taxPercentage: 9 @@ -4601,12 +4601,11 @@ components: AccountingPeriodMetadataPatchRequestBody: type: object properties: - accountingPeriod: - type: string - example: 2024/01 isOpen: type: boolean example: true + required: + - isOpen AccountingPeriodMetadataPatchResponseBody: type: object properties: