diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 3c5c830..ee94eb3 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -86,121 +86,7 @@ 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 + security: - default: [] x-auth-type: Application & Application User @@ -572,127 +458,7 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionAuditTrailsGetResponseBody" - examples: - No transaction items: - summary: No transaction audit trails were found - description: No transaction audit trails that match the search criteria were found. - value: - transactionAuditTrails: [] - href: null - List containing multiple transaction audit trails: - summary: List containing multiple transaction audit trails - description: List containing multiple transaction audit trails of different transaction items (no filters applied). - value: - transactionAuditTrails: - - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-01 12:34:51 - action: create - status: created - description: Transaction created. - correlationId: null - - transactionAuditTrailId: 1d234fc1-eb16-41d3-b2e0-e400e17b017f - transactionItemId: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b - user: fiko - timestamp: 2025-01-01 12:34:50 - action: create - status: created - description: Transaction created. - correlationId: null - - transactionAuditTrailId: f4798a84-489d-4533-9dfe-42423c70f6b6 - transactionItemId: e8891be1-1b8a-4a0f-91e2-6b523b6497dd - user: ad.vogelaar - timestamp: 2025-01-01 12:34:48 - action: update - status: return to src - description: Transaction retunred to source. - correlationId: a3891560-3084-42cb-867c-f289e7cda47d - - transactionAuditTrailId: cc80d58d-6ee7-409a-8c14-b1f807e67c10 - transactionItemId: 34ba3d7c-3ca1-4fa4-aa42-23d4c4fc767b - user: fiko - timestamp: 2025-01-01 12:34:47 - action: update - status: failed - description: Validation XYZ failed. - correlationId: null - href: null - ? List containing multiple transaction audit trails of one transaction item - : summary: List containing multiple audit trails of one transaction item - description: List containing multiple audit trail records of one transaction item (with id `d667d293-aa82-4c9e-9b10-77cffc9058a1`). - value: - transactionAuditTrails: - - transactionAuditTrailId: d571ff7c-eaa5-428a-9bc3-5a0fa3e5ee2e - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-07 12:34:59 - action: update - status: re-entered - description: Transaction re-entered. - correlationId: null - - transactionAuditTrailId: b2192e6c-ab79-4000-a04d-d8f4d574a82f - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: ad.vogelaar - timestamp: 2025-01-04 12:34:54 - action: update - status: return to src - description: Transaction retunred to source. - correlationId: a3891560-3084-42cb-867c-f289e7cda47d - - transactionAuditTrailId: 1d759985-7f1a-48bd-8dd1-efa30ce26423 - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-02 00:34:50 - action: update - status: failed - description: Validation XYZ failed. - correlationId: null - - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-01 12:34:47 - action: create - status: created - description: Transaction created. - correlationId: null - href: null - List containing multiple audit trails of failed transactions: - summary: List containing multiple audit trails of failed transactions - description: List containing multiple audit trails of just failed transactions (status = failed). - value: - transactionAuditTrails: - - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d - transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: fiko - timestamp: 2025-01-01 00:34:51 - action: update - status: failed - description: Validation XYZ failed. - correlationId: null - - transactionAuditTrailId: 1d234fc1-eb16-41d3-b2e0-e400e17b017f - transactionItemId: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b - user: fiko - timestamp: 2025-01-01 00:34:50 - action: update - status: failed - description: Validation XYZ failed. - correlationId: null - - transactionAuditTrailId: f4798a84-489d-4533-9dfe-42423c70f6b6 - transactionItemId: e8891be1-1b8a-4a0f-91e2-6b523b6497dd - user: fiko - timestamp: 2025-01-01 00:34:48 - action: update - status: failed - description: Validation XYZ failed. - correlationId: null - - transactionAuditTrailId: cc80d58d-6ee7-409a-8c14-b1f807e67c10 - transactionItemId: 34ba3d7c-3ca1-4fa4-aa42-23d4c4fc767b - user: fiko - timestamp: 2025-01-01 00:34:47 - action: update - status: failed - description: Validation XYZ failed. - correlationId: null - href: null + security: - default: [] x-auth-type: Application & Application User @@ -772,85 +538,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ProcessingFailuresGetResponseBody" - examples: - No processing failures: - summary: No processing failures - description: No processing failures were found (for example for a single transaction item). - value: - processingFailures: [] - href: null - Multiple processing failures for a single transaction item: - summary: Multiple processing failures for a single transaction item - description: | - In this example multiple processing failures were found for a single transaction item. - This example shows how a single transaction items has failed validation two times, in which the - the first failure has two validation errors, which have been resolved, and the second failure - hasn't been. Which makes three processing failures total. - value: - processingFailures: - - processingFailureId: 37a8095b-19db-498f-9349-5f37d21c5bdf - transactionItemId: 2d77d978-7141-499a-84ad-93fad8ee03ce - timestamp: 2022-01-01 00:00:00 - element: costType - value: 901 - reasonCode: "004" - reasonDescription: Cost type does not exist. - resolved: false - change: null - - processingFailureId: ccc06dc9-956d-47d8-bde7-9644ddde2193 - transactionItemId: 2d77d978-7141-499a-84ad-93fad8ee03ce - timestamp: 2025-01-01 00:43:01 - element: costCenter - value: 84955 - reasonCode: "002" - reasonDescription: Cost center does not exist. - resolved: true - change: Adapt config - - processingFailureId: 96bf8d44-0030-4509-b24e-2d62299779c5 - transactionItemId: 2d77d978-7141-499a-84ad-93fad8ee03ce - timestamp: 2025-01-01 00:43:01 - element: department - value: 1337 - reasonCode: "001" - reasonDescription: Department does not exist. - resolved: true - change: Adapt config - href: null - List of unfiltered processing failures: - summary: List of unfiltered processing failures - description: | - In this example there is a list of processing failures where no filters have been applied. - This results in a list of all processing failures, for different transaction items. - value: - processingFailures: - - processingFailureId: 1d0f237e-5fbe-4107-8bdf-a41f43307ac0 - transactionItemId: d0425652-07a3-4b95-bb37-8bb15ea1b9b5 - timestamp: 2022-01-01 00:00:00 - element: occuredOn - value: 2027-01-01 - reasonCode: "009" - reasonDescription: Transaction date is in the future - resolved: false - change: null - - processingFailureId: 76aa82e1-a10f-4664-a84f-1f30d60884b3 - transactionItemId: 3f0a8a74-c642-441e-a187-d32fedb77fdf - timestamp: 2025-01-01 00:43:01 - element: costCenter - value: 84955 - reasonCode: "002" - reasonDescription: Cost center does not exist. - resolved: false - change: null - - processingFailureId: 25d2dd6f-ae17-44a7-b7a5-43eaf6de78e1 - transactionItemId: 446ad396-41f6-4c1f-942c-a131e620075d - timestamp: 2025-01-01 00:43:01 - element: department - value: 1337 - reasonCode: "001" - reasonDescription: Department does not exist. - resolved: false - change: null - href: null + security: - default: [] x-auth-type: Application & Application User @@ -949,21 +637,7 @@ paths: application/json: schema: $ref: "#/components/schemas/BookingProcessesGetResponseBody" - examples: - List containing all booking processes: - summary: List containing all booking processes - description: Returns a list containing all booking processes (no filters applied). - value: - bookingProcesses: - - bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf - name: Verkooptransacties - transactionType: sales - identifyingFieldName: articleNumber - - bookingProcessId: 03105285-3c4c-477a-821c-0fae801d9d26 - name: Inkooptransacties - transactionType: purchase - identifyingFieldName: null - href: null + security: - default: [] x-auth-type: Application & Application User @@ -1174,37 +848,7 @@ paths: application/json: schema: $ref: "#/components/schemas/BookingMetadataGetResponseBody" - examples: - List containing all booking metadata: - summary: List containing all booking metadata - description: Returns a list containing all booking metadata (no filters applied). - value: - bookingMetadata: - - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: Dagkaart - department: 900 - costType: 84956 - documentCode: FIKO-OPBR - hasSeparateTaxLine: true - hasLinePerIdentifyingField: true - hasLinePerSource: true - hasLinePerConcession: true - validFrom: 2022-01-01 00:00:00 - validUntil: null - - bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034 - bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: Saldoreizen - department: 900 - costType: 84955 - documentCode: FIKO-OPBR - hasSeparateTaxLine: true - hasLinePerIdentifyingField: true - hasLinePerSource: true - hasLinePerConcession: true - validFrom: 2022-01-01 00:00:00 - validUntil: null - href: null + security: - default: [] x-auth-type: Application & Application User @@ -1424,63 +1068,7 @@ paths: application/json: schema: $ref: "#/components/schemas/BookingGroupFieldsGetResponseBody" - examples: - List containing all booking group fields: - summary: List containing all booking group fields - description: Returns a list containing all booking group fields for all booking metadata (no filters applied). - value: - bookingGroupFields: - - bookingGroupFieldId: b34d0fc2-96fc-409b-93b6-ae51fb8c694a - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 1737 - - bookingGroupFieldId: 3b9005f4-42c4-4e2b-b472-ba7d0926fe77 - bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034 - identifyingFieldValue: 1748 - - bookingGroupFieldId: ae773282-ac9b-4a0b-a487-b4061ea2a42f - bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034 - identifyingFieldValue: 1750 - - bookingGroupFieldId: fe1aca8c-3ef5-4e15-962b-202d28d3d761 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 1757 - href: null - List containing all booking group fields for a single booking: - summary: List containing all booking group fields for a single booking - description: | - Returns a list containing all booking group fields for a single booking booking metadata 'Dagkaart' - (identified by the same bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617). - value: - bookingGroupFields: - - bookingGroupFieldId: b34d0fc2-96fc-409b-93b6-ae51fb8c694a - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 1737 - - bookingGroupFieldId: fe1aca8c-3ef5-4e15-962b-202d28d3d761 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 1757 - - bookingGroupFieldId: fede01e0-86c5-47d0-9466-3093132148e5 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4031 - - bookingGroupFieldId: d7c25182-b64e-4e47-8998-19ddb65b8f2c - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4032 - - bookingGroupFieldId: ea02d3eb-29e6-42fd-b7eb-dfbfd2231090 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4033 - - bookingGroupFieldId: a73407a6-ff8c-4924-a7ac-5cd605e1793c - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4034 - - bookingGroupFieldId: d9af4bf1-4e85-4eb6-ae5d-d2020b18d63c - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4051 - - bookingGroupFieldId: c1ba494b-249a-475b-a542-19918aa36778 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4053 - - bookingGroupFieldId: 69be1be0-c600-492d-aec1-8490409371da - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4054 - - bookingGroupFieldId: d7d00ec1-6d53-44e9-bcd8-01f6a523f771 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - identifyingFieldValue: 4055 - href: null + security: - default: [] x-auth-type: Application & Application User @@ -1594,188 +1182,7 @@ paths: application/json: schema: $ref: "#/components/schemas/BookingLineMetadataGetResponseBody" - examples: - List containing all booking line metadata: - summary: List containing all booking line metadata - description: Returns a list containing all booking line metadata for all bookings (no filters applied). - value: - bookingLineMetadata: - - bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - name: Webshop - Dagkaart - BUS - sourceMetadata: - sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 - incomingName: HTM-website - incomingEntity: OrderLine - outgoingName: Webshop - businessOwner: Koos Verweg - rejectionProcessing: system - rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc - identifyingFieldValue: null - concession: - concessionId: 2 - name: BUS - lineType: summary - lineSense: credit - costCenter: 603031 - articleName: dagkaart - extRef1: null - extRef2: null - extRef3: 2025-02-17 - extRef4: null - extRef5: Webshop - extRef6: null - - bookingLineMetadataId: 1bca01db-40d3-4447-9f28-41475ec6877d - bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034 - name: TLS - Saldoreizen - RAIL - sourceMetadata: - sourceMetadataId: 4b06a325-1078-4a2f-b63e-1d81eae8e5c3 - incomingName: Translink - incomingEntity: Trip - outgoingName: TLS - businessOwner: Koos Verweg - rejectionProcessing: mail - rejectionInfo: helpdesk@translink.nl - identifyingFieldValue: null - concession: - concessionId: 1 - name: RAIL - lineType: summary - lineSense: credit - costCenter: 603007 - articleName: Opbrengst TLS - extRef1: null - extRef2: null - extRef3: 2025-02-17 - extRef4: null - extRef5: TLS - extRef6: null - href: null - List containing booking line metadata of one booking: - summary: List containing booking line metadata of one booking - description: | - Returns a list containing all booking line metadata a single booking. - This example contains all the booking lines for a 'Dagkaart' booking - (bookingMetadataId: "6ce10520-9a73-4cb4-b8dd-39ee46ceb617"). - value: - bookingLineMetadata: - - bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - name: Webshop Dagkaart - BUS - sourceMetadata: - sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 - incomingName: HTM-website - incomingEntity: OrderLine - outgoingName: Webshop - businessOwner: Koos Verweg - rejectionProcessing: system - rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc - identifyingFieldValue: null - concession: - concessionId: 2 - name: BUS - lineType: summary - lineSense: credit - costCenter: 619031 - articleName: dagkaart - extRef1: null - extRef2: null - extRef3: 2025-02-17 - extRef4: null - extRef5: Webshop - extRef6: null - - bookingLineMetadataId: a4464b5c-9a8e-4e48-a0a0-5500b1ca0885 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - name: Webshop Dagkaart - RAIL - sourceMetadata: - sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 - incomingName: HTM-website - incomingEntity: OrderLine - outgoingName: Webshop - businessOwner: Koos Verweg - rejectionProcessing: system - rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc - identifyingFieldValue: null - concession: - concessionId: 1 - name: RAIL - lineType: summary - lineSense: credit - costCenter: 603031 - articleName: dagkaart - extRef1: null - extRef2: null - extRef3: 2025-02-17 - extRef4: null - extRef5: Webshop - extRef6: null - - bookingLineMetadataId: feaa7b33-ba49-40a2-90f3-5dd70d591f17 - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - name: Ticketapp Dagkaart - BUS - sourceMetadata: - sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc - incomingName: HTM-app - incomingEntity: OrderLine - outgoingName: ticketapp - businessOwner: Danny Negen - rejectionProcessing: mail - rejectionInfo: d.negen@htm.nl - identifyingFieldValue: null - concession: - concessionId: 2 - name: BUS - lineType: summary - lineSense: credit - costCenter: 619031 - articleName: dagkaart - extRef1: null - extRef2: null - extRef3: 2025-02-17 - extRef4: null - extRef5: Webshop - extRef6: null - - bookingLineMetadataId: ea6ce4e7-4d52-4b89-bbea-ffe0ef6c48ff - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - name: Ticketapp Dagkaart - RAIL - sourceMetadata: - sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc - incomingName: HTM-app - incomingEntity: OrderLine - outgoingName: ticketapp - businessOwner: Danny Negen - rejectionProcessing: mail - rejectionInfo: d.negen@htm.nl - identifyingFieldValue: null - concession: - concessionId: 1 - name: RAIL - lineType: summary - lineSense: credit - costCenter: 603031 - articleName: dagkaart - extRef1: null - extRef2: null - extRef3: 2025-02-17 - extRef4: null - extRef5: Webshop - extRef6: null - - bookingLineMetadataId: 0a8dbb7d-73c8-451e-9028-e4613283c7bd - bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - name: Dagkaart - BTW - sourceMetadata: null - identifyingFieldValue: null - concession: null - lineType: tax - lineSense: credit - costCenter: 1337 - articleName: dagkaart - extRef1: null - extRef2: null - extRef3: 2025-02-17 - extRef4: null - extRef5: null - extRef6: null - href: null + security: - default: [] x-auth-type: Application & Application User @@ -1885,49 +1292,7 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxMetadataGetResponseBody" - examples: - List containing all tax metadata: - summary: List containing all tax metadata - description: Returns a list containing all tax metadata (no filters applied). - value: - taxMetadata: - - taxMetadataId: 2d444740-4131-4169-bb47-2d125641dc87 - taxCode: V0 - texPercantageAmount: 0 - description: BTW VERKOOP NUL - validFrom: 2024-03-22T09:00:00 - validUntil: null - - taxMetadataId: b5f879d1-043d-4357-9655-2eeca8ebe9bf - taxCode: V09 - taxPercentageAmount: 9 - description: BTW VERKOOP LAAG 9% - validFrom: 2024-03-22T09:00:00 - validUntil: null - - taxMetadataId: 62e1abe7-d76f-4364-9207-591c0601ba55 - taxCode: V21 - taxPercentageAmount: 21 - description: BTW VERKOOP HOOG 21% - validFrom: 2024-03-22T09:00:00 - validUntil: null - - taxMetadataId: 9a253fc3-e562-4c4a-925c-d9caf0dcc549 - taxCode: ?0 - taxPercentageAmount: 0 - description: BTW DEBIT NUL - validFrom: 2024-03-22T09:00:00 - validUntil: null - - taxMetadataId: 6243b848-5ca3-44e0-9860-4fb3a817f148 - taxCode: ?09 - taxPercentageAmount: 9 - description: BTW DEBIT laag 9% - validFrom: 2024-03-22T09:00:00 - validUntil: null - - taxMetadataId: 0240d6e4-6037-4da0-ac10-1fde0229d439 - taxCode: ?21 - taxPercentageAmount: 21 - description: BTW DEBIT hoog 21% - validFrom: 2024-03-22T09:00:00 - validUntil: null - href: null + security: - default: [] x-auth-type: Application & Application User @@ -2065,34 +1430,7 @@ paths: application/json: schema: $ref: "#/components/schemas/SourceMetadataGetResponseBody" - examples: - List containing all source metadata: - summary: List containing all source metadata - description: Returns a list containing all source metadata (no filters applied). - value: - sourceMetadata: - - sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 - incomingName: HTM-web - incomingEntity: OrderLine - outgoingName: webshop - businessOwner: Koos Verweg - rejectionProcessing: system - rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc - - sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc - incomingName: HTM-app - incomingEntity: OrderLine - outgoingName: ticketapp - businessOwner: Danny Negen - rejectionProcessing: mail - rejectionInfo: d.negen@htm.nl - - sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209 - incomingName: SMP - incomingEntity: OrderLine - outgoingName: balieverkoop - businessOwner: Guus Geluk - rejectionProcessing: mail - rejectionInfo: ao@htm.nl - href: null + security: - default: [] x-auth-type: Application & Application User @@ -2223,22 +1561,7 @@ paths: application/json: schema: $ref: "#/components/schemas/AccountingPeriodMetadataGetResponseBody" - examples: - List containing all accounting period metadata: - summary: List containing all accounting period metadata - description: Returns a list containing all accounting period metadata (no filters applied). - value: - accountingPeriodMetadata: - - accountingPeriodMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb - accountingPeriod: 2025/01 - isOpen: true - - accountingPeriodMetadataId: 36a34bd8-2b84-4c89-87a4-22e809f6ed4a - accountingPeriod: 2024/12 - isOpen: false - - accountingPeriodMetadataId: 33b4889b-0036-4870-87df-be43f9316cdf - accountingPeriod: 2024/11 - isOpen: false - href: null + security: - default: [] x-auth-type: Application & Application User @@ -2382,55 +1705,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ConcessionMetadataGetResponseBody" - examples: - List containing all concession metadata: - summary: List containing all concession metadata - description: Returns a list containing all concession metadata (no filters applied). - value: - concessionMetadata: - - concessionMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb - concession: - concessionId: 1 - name: RAIL - percentage: 84.021 - validFrom: 2025-01-01T00:00:00.000 - validUntil: null - - concessionMetadataId: 39720be0-af88-486a-b5e2-faea7eb5b352 - concession: - concessionId: 2 - name: BUS - percentage: 15.979 - validFrom: 2025-01-01T00:00:00.000 - validUntil: null - - concessionMetadataId: 274db383-96dd-410e-a07e-0b9e3040ac91 - concession: - concessionId: 1 - name: RAIL - percentage: 83.021 - validFrom: 2024-12-01T00:00:00.000 - validUntil: 2024-12-31T23:59:59.999 - - concessionMetadataId: 03959bc5-83f2-4ac7-9bf5-67e0f2a6eace - concession: - concessionId: 2 - name: BUS - percentage: 16.979 - validFrom: 2024-12-01T00:00:00.000 - validUntil: 2024-12-31T23:59:59.999 - - concessionMetadataId: d5b7d8f6-5cb8-482e-9d9a-68909dc7b5d3 - concession: - concessionId: 1 - name: RAIL - percentage: 85.021 - validFrom: 2024-11-01T00:00:00.000 - validUntil: 2024-11-30T23:59:59.999 - - concessionMetadataId: 5ee5f86f-ab00-4630-b130-4714fd060d1a - concession: - concessionId: 2 - name: BUS - percentage: 14.979 - validFrom: 2024-11-01T00:00:00.000 - validUntil: 2024-11-30T23:59:59.999 - href: null + /concessionmetadata: post: summary: P2. Add concession metadata. @@ -2563,125 +1838,123 @@ paths: application/json: schema: $ref: "#/components/schemas/ConcessionsGetResponseBody" - examples: - List containing all concessions: - summary: List containing all concessions - description: Returns a list containing all concessions (no filters applied). - value: - concessions: - - concessionId: 1 - name: RAIL - - concessionId: 2 - name: BUS - href: null + security: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited components: securitySchemes: - bearerToken: - type: http - scheme: bearer - bearerFormat: JWT + default: + type: oauth2 + flows: + implicit: + authorizationUrl: https://api.integratielaag.nl/authorize + scopes: {} schemas: unavailable: type: object TransactionItemsGetResponseBody: type: object properties: - transactionItems: + "@odata.context": + type: string + example: $metadata#TransactionItem + value: type: array items: - type: object - properties: - transactionItemId: - type: string - example: afce35b2-1dff-4ace-98d0-4b9ac405c87d - transactionType: - type: string - enum: - - sales - example: sales - 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 - articleNumber: - type: string - nullable: true - example: 4031 - status: - type: string - enum: - - created - - succeeded - - failed - - returned to trx-db - - returned to src - - re-entered - example: created - aggregationReference: - type: string - nullable: true - example: FIKO-123456 - accountingSystemReference: - type: string - nullable: true - example: U4F-123456 - required: - - transactionItemId - - transactionType - - sourceName - - transactionId - - name - - quantity - - taxCode - - amountExclTax - - amountInclTax - - amountTax - - occurredOn - - type - - status - href: + $ref: '#/components/schemas/TransactionItem' + TransactionItem: + type: object + properties: + '@odata.etag': + type: string + example: 6962e56b-c7dd-3336-9627-6687f007ee07 + transactionItemRowId: + type: integer + example: 3231 + transactionItemId: + type: string + example: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionType: + type: string + enum: + - sales + example: sales + sourceName: + type: string + example: Verkoopengine + transactionId: + type: string + example: 1001236 + transactionLineId: type: string nullable: true - description: URI for pagination. - example: null + 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 + articleNumber: + type: string + nullable: true + example: 4031 + status: + type: string + enum: + - created + - succeeded + - failed + - returned to trx-db + - returned to src + - re-entered + example: created + aggregationReference: + type: string + nullable: true + example: FIKO-123456 + accountingSystemReference: + type: string + nullable: true + example: U4F-123456 + required: + - transactionItemId + - transactionType + - sourceName + - transactionId + - name + - quantity + - taxCode + - amountExclTax + - amountInclTax + - amountTax + - occurredOn + - type + - status TransactionItemsPostRequestBody: type: object properties: @@ -2932,56 +2205,62 @@ components: ProcessingFailuresGetResponseBody: type: object properties: - processingFailures: + '@odata.context': + type: string + example: $metadata#ProcessingFailure + value: type: array items: - type: object - properties: - processingFailureId: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - transactionItemId: - type: string - format: uuid - example: 2d77d978-7141-499a-84ad-93fad8ee03ce - timestamp: - type: string - format: date-time - example: 2022-01-01 00:00:00 - element: - type: string - example: costCenter - value: - type: string - example: 84955 - reasonCode: - type: string - example: "002" - reasonDescription: - type: string - example: Contra account does not exist. - resolved: - type: boolean - example: false - change: - type: string - nullable: true - example: Adapt config - required: - - processingFailureId - - transactionItemId - - timestamp - - element - - value - - reasonCode - - reasonDescription - - resolved - href: + $ref: '#/components/schemas/ProcessingFailure' + ProcessingFailure: + type: object + properties: + '@odata.etag': + type: string + example: 464155e4-0018-3676-8102-42429f14f2ed + processingFailureRowId: + type: integer + example: 9 + processingFailureId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + transactionItemId: + type: string + format: uuid + example: 2d77d978-7141-499a-84ad-93fad8ee03ce + timestamp: + type: string + format: date-time + example: 2022-01-01 00:00:00 + element: + type: string + example: costCenter + value: + type: string + example: 84955 + reasonCode: + type: string + example: "002" + reasonDescription: + type: string + example: Contra account does not exist. + resolved: + type: boolean + example: false + change: type: string nullable: true - description: URI for pagination. - example: null + example: Adapt config + required: + - processingFailureId + - transactionItemId + - timestamp + - element + - value + - reasonCode + - reasonDescription + - resolved ProcessingFailuresPatchRequestBody: type: object properties: @@ -3054,99 +2333,108 @@ components: TransactionAuditTrailsGetResponseBody: type: object properties: - transactionAuditTrails: + '@odata.context': + type: string + example: $metadata#TransactionAuditTrail + value: type: array items: - type: object - properties: - transactionAuditTrailId: - type: string - format: uuid - example: afce35b2-1dff-4ace-98d0-4b9ac405c87d - transactionItemId: - type: string - format: uuid - example: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: - type: string - example: fiko - timestamp: - type: string - format: date-time - example: 2022-01-01 00:00:00 - action: - type: string - enum: - - create - - update - example: create - status: - type: string - enum: - - created - - succeeded - - failed - - returned to trx-db - - returned to src - - re-entered - example: created - description: - type: string - nullable: true - example: Transaction created. - correlationId: - type: string - format: uuid - nullable: true - example: a3891560-3084-42cb-867c-f289e7cda47d - required: - - transactionAuditTrailId - - transactionItemId - - user - - timestamp - - action - - status - href: + $ref: '#/components/schemas/TransactionAuditTrail' + TransactionAuditTrail: + type: object + properties: + '@odata.etag': + type: string + example: a669b92c-1a10-3dd6-b4d1-efaed0629db8 + transactionAuditTrailRowId: + type: integer + example: 8218 + transactionAuditTrailId: + type: string + format: uuid + example: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionItemId: + type: string + format: uuid + example: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: + type: string + example: fiko + timestamp: + type: string + format: date-time + example: 2022-01-01 00:00:00 + action: + type: string + enum: + - create + - update + example: create + status: + type: string + enum: + - created + - succeeded + - failed + - returned to trx-db + - returned to src + - re-entered + example: created + description: type: string nullable: true - example: null + example: Transaction created. + correlationId: + type: string + format: uuid + nullable: true + example: a3891560-3084-42cb-867c-f289e7cda47d required: - - transactionAuditTrails + - transactionAuditTrailId + - transactionItemId + - user + - timestamp + - action + - status BookingProcessesGetResponseBody: type: object properties: - bookingProcesses: + '@odata.context': + type: string + example: $metadata#BookingProcess + value: type: array items: - type: object - properties: - bookingProcessId: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - name: - type: string - example: Verkooptransacties - transactionType: - type: string - enum: - - sales - example: sales - identifyingFieldName: - type: string - nullable: true - example: articleNumber - required: - - bookingProcessId - - name - - transactionType - href: + $ref: '#/components/schemas/BookingProcess' + BookingProcess: + type: object + properties: + '@odata.etag': + type: string + example: 9e8b14cf-c03a-3be7-b9ec-ef5dd6948217 + bookingProcessRowId: + type: integer + example: 10 + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + name: + type: string + example: Verkooptransacties + transactionType: + type: string + enum: + - sales + example: sales + identifyingFieldName: type: string nullable: true - description: URI for pagination. - example: null + example: articleNumber required: - - bookingProcesses + - bookingProcessId + - name + - transactionType BookingProcessesPostRequestBody: type: object properties: @@ -3203,70 +2491,75 @@ components: BookingMetadataGetResponseBody: type: object properties: - bookingMetadata: + '@odata.context': + type: string + example: $metadata#BookingMetadata + value: type: array items: - type: object - properties: - bookingMetadataId: - type: string - format: uuid - example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - bookingProcessId: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: - type: string - example: Dagkaart - department: - type: string - example: 900 - costType: - type: string - example: 84956 - documentCode: - type: string - example: FIKO-OPBR - hasSeparateTaxLine: - type: boolean - example: true - hasLinePerIdentifyingField: - type: boolean - example: true - hasLinePerSource: - type: boolean - example: true - hasLinePerConcession: - type: boolean - example: true - validFrom: - type: string - format: date-time - example: 2022-01-01 00:00:00 - validUntil: - type: string - format: date-time - nullable: true - example: null - required: - - bookingMetadataId - - bookingProcessId - - description - - department - - costType - - documentCode - - hasSeparateTaxLine - - hasLinePerIdentifyingField - - hasLinePerSource - - hasLinePerConcession - - validFrom - href: + $ref: '#/components/schemas/BookingMetadata' + BookingMetadata: + type: object + properties: + '@odata.etag': type: string + example: f477014f-8bf2-3e72-b9b6-1bb609840b61 + bookingMetadataRowId: + type: integer + example: 13 + bookingMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: + type: string + example: Dagkaart + department: + type: string + example: 900 + costType: + type: string + example: 84956 + documentCode: + type: string + example: FIKO-OPBR + hasSeparateTaxLine: + type: boolean + example: true + hasLinePerIdentifyingField: + type: boolean + example: true + hasLinePerSource: + type: boolean + example: true + hasLinePerConcession: + type: boolean + example: true + validFrom: + type: string + format: date-time + example: 2022-01-01 00:00:00 + validUntil: + type: string + format: date-time nullable: true example: null required: - - bookingMetadata + - bookingMetadataId + - bookingProcessId + - description + - department + - costType + - documentCode + - hasSeparateTaxLine + - hasLinePerIdentifyingField + - hasLinePerSource + - hasLinePerConcession + - validFrom BookingMetadataPostRequestBody: type: object properties: @@ -3396,32 +2689,37 @@ components: BookingGroupFieldsGetResponseBody: type: object properties: - bookingGroupFields: + '@odata.context': + type: string + example: $metadata#BookingGroupField + value: type: array items: - type: object - properties: - bookingGroupFieldId: - type: string - format: uuid - example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - bookingMetadataId: - type: string - format: uuid - example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 - identifyingFieldValue: - type: string - example: 1737 - required: - - bookingGroupFieldId - - bookingMetadataId - - identifyingFieldValue - href: + $ref: '#/components/schemas/BookingGroupField' + BookingGroupField: + type: object + properties: + '@odata.etag': type: string - nullable: true - example: null + example: ef520db0-4e3d-39a0-926f-f37ad49bb7cf + bookingGroupFieldRowId: + type: integer + example: 8 + bookingGroupFieldId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + bookingMetadataId: + type: string + format: uuid + example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 + identifyingFieldValue: + type: string + example: 1737 required: - - bookingGroupFields + - bookingGroupFieldId + - bookingMetadataId + - identifyingFieldValue BookingLineMetadataPostRequestBody: type: object properties: @@ -3502,89 +2800,96 @@ components: BookingLineMetadataGetResponseBody: type: object properties: - bookingLineMetadata: + '@odata.context': + type: string + example: $metadata#BookingLineMetadata + value: type: array items: - type: object - properties: - bookingLineMetadataId: - type: string - format: uuid - example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - bookingMetadataId: - type: string - format: uuid - example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 - name: - type: string - example: Dagkaart - RAIL - sourceMetadata: - type: object - $ref: "#/components/schemas/SourceMetadata" - identifyingFieldValue: - type: string - example: null - nullable: true - concession: - type: object - $ref: "#/components/schemas/Concession" - lineType: - type: string - enum: - - summary - - analysis - - tax - example: summary - lineSense: - type: string - enum: - - debit - - credit - example: credit - costCenter: - type: string - example: 603031 - nullable: true - articleName: - type: string - example: dagkaart - nullable: true - extRef1: - type: string - example: null - nullable: true - extRef2: - type: string - example: null - nullable: true - extRef3: - type: string - example: 2025-02-17 - nullable: true - extRef4: - type: string - example: null - nullable: true - extRef5: - type: string - example: Webshop - nullable: true - extRef6: - type: string - example: null - nullable: true - required: - - bookingLineMetadataId - - bookingMetadataId - - name - - lineType - - lineSense - href: + $ref: '#/components/schemas/BookingLineMetadata' + BookingLineMetadata: + type: object + properties: + '@odata.etag': type: string + example: c0afe2d6-f4b2-321a-ae6b-2dc72b25ebc1 + bookingLineMetadataRowId: + type: integer + example: 10 + bookingLineMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + bookingMetadataId: + type: string + format: uuid + example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 + name: + type: string + example: Dagkaart - RAIL + sourceName: + type: string + example: Verkoopengine nullable: true + identifyingFieldValue: + type: string example: null + nullable: true + concessionId: + type: integer + example: 1 + nullable: true + lineType: + type: string + enum: + - summary + - analysis + - tax + example: summary + lineSense: + type: string + enum: + - debit + - credit + example: credit + costCenter: + type: string + example: 603031 + nullable: true + articleName: + type: string + example: dagkaart + nullable: true + extRef1: + type: string + example: null + nullable: true + extRef2: + type: string + example: null + nullable: true + extRef3: + type: string + example: 2025-02-17 + nullable: true + extRef4: + type: string + example: null + nullable: true + extRef5: + type: string + example: Webshop + nullable: true + extRef6: + type: string + example: null + nullable: true required: - - bookingLineMetadata + - bookingLineMetadataId + - bookingMetadataId + - name + - lineType + - lineSense BookingLineMetadataPatchRequestBody: type: object properties: @@ -3789,44 +3094,50 @@ components: TaxMetadataGetResponseBody: type: object properties: - taxMetadata: + '@odata.context': + type: string + example: $metadata#TaxMetadata + value: type: array items: - type: object - properties: - taxMetadataId: - type: string - format: uuid - example: 192882fe-3f51-46bb-bfdb-2e4cb31ef925 - taxCode: - type: string - example: V21 - taxPercentageAmount: - type: number - 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: + $ref: '#/components/schemas/TaxMetadata' + TaxMetadata: + type: object + properties: + '@odata.etag': type: string + example: e4e7c773-eb7a-3fe0-960d-df1744127a7b + taxMetadataRowId: + type: integer + example: 13 + taxMetadataId: + type: string + format: uuid + example: 192882fe-3f51-46bb-bfdb-2e4cb31ef925 + taxCode: + type: string + example: V21 + taxPercentageAmount: + type: number + 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 - description: URI for pagination. example: null + required: + - taxMetadataId + - taxCode + - taxPercentageAmount + - description + - validFrom TaxMetadataPostRequestBody: type: object properties: @@ -3895,15 +3206,53 @@ components: SourceMetadataGetResponseBody: type: object properties: - sourceMetadata: + '@odata.context': + type: string + example: $metadata#SourceMetadata + value: type: array items: - $ref: "#/components/schemas/SourceMetadata" - href: + $ref: '#/components/schemas/SourceMetadata' + SourceMetadata: + type: object + properties: + '@odata.etag': type: string - nullable: true - description: URI for pagination. - example: null + example: d7df8249-3e72-35f2-a069-d845e8e2cbba + sourceMetadataRowId: + type: integer + example: 2 + 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: Koos Verweg + rejectionProcessing: + type: string + example: system + rejectionInfo: + type: string + example: api.htm.nl/v2/account/12345/msgs/abc + required: + - sourceMetadataId + - incomingName + - incomingEntity + - outgoingName + - businessOwner + - rejectionProcessing + - rejectionInfo + - validFrom SourceMetadataPostRequestBody: type: object properties: @@ -3974,30 +3323,36 @@ components: AccountingPeriodMetadataGetResponseBody: type: object properties: - accountingPeriodMetadata: + '@odata.context': + type: string + example: $metadata#AccountingPeriodMetadata + value: 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: + $ref: '#/components/schemas/AccountingPeriodMetadata' + AccountingPeriodMetadata: + type: object + properties: + '@odata.etag': type: string - nullable: true - description: URI for pagination. - example: null + example: 333d6b7d-b709-3b89-89e0-bcb3d5fdddfc + accountingPeriodMetadataRowId: + type: integer + example: 1 + 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 AccountingPeriodMetadataPostRequestBody: type: object properties: @@ -4040,40 +3395,46 @@ components: ConcessionMetadataGetResponseBody: type: object properties: - concessionMetadata: + '@odata.context': + type: string + example: $metadata#ConcessionMetadata + value: type: array items: - type: object - properties: - concessionMetadataId: - type: string - format: en - example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb - concession: - type: object - $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: + $ref: '#/components/schemas/ConcessionMetadata' + ConcessionMetadata: + type: object + properties: + '@odata.etag': type: string + example: 77c78584-7ce8-3cf5-b89e-73b888d72d70 + concessionMetadataRowId: + type: integer + example: 14 + concessionMetadataId: + type: string + format: en + example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb + 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 - description: URI for pagination. example: null + required: + - concessionMetadataId + - concessionId + - percentage + - validFrom ConcessionMetadataPostRequestBody: type: object properties: @@ -4135,18 +3496,22 @@ components: ConcessionsGetResponseBody: type: object properties: - concessions: + '@odata.context': + type: string + example: $metadata#Concession + value: type: array items: - $ref: "#/components/schemas/Concession" - href: - type: string - nullable: true - description: URI for pagination. - example: null + $ref: '#/components/schemas/Concession' Concession: type: object properties: + '@odata.etag': + type: string + example: 49bfa10d-b80d-3f2f-b3c2-9a5da3182cc3 + concessionRowId: + type: integer + example: 1 concessionId: type: integer example: 1 @@ -4156,40 +3521,6 @@ components: required: - concessionId - name - 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: Koos Verweg - rejectionProcessing: - type: string - example: system - rejectionInfo: - type: string - example: api.htm.nl/v2/account/12345/msgs/abc - required: - - sourceMetadataId - - incomingName - - incomingEntity - - outgoingName - - businessOwner - - rejectionProcessing - - rejectionInfo - - validFrom TransactionItemsResponseStatusGetResponseBody: type: object properties: