diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 3be6d63..ca35c86 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -6,45 +6,6 @@ info: servers: - url: https://api.integratielaag.nl/v1 paths: - /fiko/transactionitems: - post: - summary: DEPRECATED. Add a finanicial transaction item. - description: DEPRECATED. This API is deprecated. Use bulk-insert instead. - deprecated: true - tags: - - External FIKO endpoints v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/unavailable" - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/unavailable" - /fiko/transactionitems/bulk: - post: - summary: Add one ore more finanicial transaction items in bulk. - description: Add one ore more finanicial transaction items in bulk. - tags: - - External FIKO endpoints v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/TransactionItemsBulkPostRequestBody" - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/TransactionItemsBulkPostResponseBody" /transactionitems: get: summary: Find transaction items. @@ -146,18 +107,26 @@ paths: explode: false description: Possible types of the transaction ('debit' or 'credit'). - in: query - name: productCode + name: articleNumber schema: type: string - example: HTM-MND-20 - description: The product code of the transaction. + example: 4031 + description: The article number of the transaction. - in: query name: status schema: type: array items: type: string - example: [created, succeeded, failed, returned to trx-db, returned to src, re-entered] + example: + [ + created, + succeeded, + failed, + returned to trx-db, + returned to src, + re-entered, + ] explode: false description: Possible statuses of the transaction ('created', 'succeeded', 'failed', 'returned to trx-db', 'returned to src', 're-entered'). - in: query @@ -180,9 +149,8 @@ paths: schema: $ref: "#/components/schemas/TransactionItemsGetResponseBody" post: - summary: DEPRECATED. Add a finanicial transaction item. - description: DEPRECATED. This API is deprecated. Use bulk-insert instead. - deprecated: true + summary: Add one ore more finanicial transaction items in bulk. + description: Add one ore more finanicial transaction items in bulk. tags: - Transactions v2 requestBody: @@ -192,8 +160,8 @@ paths: schema: $ref: "#/components/schemas/TransactionItemsPostRequestBody" responses: - "201": - description: Created + "202": + description: Accepted content: application/json: schema: @@ -336,7 +304,15 @@ paths: type: array items: type: string - example: [created, succeeded, failed, returned to trx-db, returned to src, re-entered] + example: + [ + created, + succeeded, + failed, + returned to trx-db, + returned to src, + re-entered, + ] explode: false description: The status of the transaction item. - in: query @@ -461,75 +437,379 @@ paths: application/json: schema: $ref: "#/components/schemas/ProcessingFailuresPatchResponseBody" - /productmetadata: + /bookingprocesses: get: - summary: Find product metadata. - description: Find product metadata. + summary: Find booking processes. + description: Find booking processes. tags: - - Metadata v2 + - Booking Processes v2 parameters: - in: query - name: productMetadataId + name: bookingProcessId schema: type: string format: uuid example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the product metadata. + description: The id of the booking process. - in: query - name: productCode + name: name schema: type: string - example: 4031 - description: The product code. + example: Verkooptransacties + description: The name of the booking process. + - in: query + name: transactionType + schema: + type: array + items: + type: string + example: [sales, purchase] + explode: false + description: The transaction type of the booking process. + - in: query + name: identifyingFieldName + schema: + type: string + example: articleNumber + description: The identifying field name of the booking process. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesGetResponseBody" + post: + summary: Add a booking process. + description: Add a booking process. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPostResponseBody" + /bookingprocesses/{bookingProcessId}: + parameters: + - in: path + name: bookingProcessId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: true + description: The id of the booking process. + patch: + summary: Update a booking process. + description: Update a booking process. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPatchRequestBody" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPatchResponseBody" + /bookingprocesses/{bookingProcessId}/bookingmetadata: + parameters: + - in: path + name: bookingProcessId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: true + description: The id of the booking process. + post: + summary: Add booking metadata. + description: Add booking metadata. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPostResponseBody" + /bookingmetadata: + get: + summary: Find booking metadata. + description: Find booking metadata. + tags: + - Booking Processes v2 + parameters: + - in: query + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + description: The id of the booking metadata. + - in: query + name: bookingProcessId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the parent booking process. + - in: query + name: description + schema: + type: string + example: Dagkaart + description: The description of the booking. - in: query name: department schema: type: string example: 900 - description: The department. + description: The department of the booking. - in: query name: costType schema: type: string - example: 619031 - description: The cost type. - - in: query - name: description - schema: - type: string - example: O4031_Reisproduct HTM 1 dag Anoniem - description: The description. + example: 84956 + description: The cost type of the booking. - in: query name: documentCode schema: type: string - example: VERK_FACTUUR - description: The document code. + example: FIKO-OPBR + description: The document code of the booking. - in: query - name: updatedBefore + name: hasSeparateTaxLine schema: - type: string - example: 2022-01-01 00:00:00 - description: Timestamp that the metadata was updated before. + type: boolean + example: true + description: Whether the booking has a separate tax line. - in: query - name: updatedAfter + name: hasLinePerIdentifyingField schema: - type: string - example: 2022-01-01 00:00:00 - description: Timestamp that the metadata was updated after. + type: boolean + example: true + description: Whether the booking has a line per identifying field. + - in: query + name: hasLinePerSource + schema: + type: boolean + example: true + description: Whether the booking has a line per source. + - in: query + name: hasLinePerConcession + schema: + type: boolean + example: true + description: Whether the booking has a line per concession. - in: query name: validAt schema: type: string - example: 2024-03-22T09:00:00 - description: Timestamp that the metadata is valid. + example: 2024-01-01T00:00:00.000 + description: Timestamp that the booking metadata is valid. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataGetResponseBody" + /bookingmetadata/{bookingMetadataId}: + parameters: + - in: path + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking metadata. + patch: + summary: Update booking metadata. + description: Update booking metadata. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPatchRequestBody" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPatchResponseBody" + /bookingmetadata/{bookingMetadataId}/bookinggroupfields: + parameters: + - in: path + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking metadata. + post: + summary: Add booking group fields. + description: Add booking group fields. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingGroupFieldsPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingGroupFieldsPostResponseBody" + /bookingmetadata/{bookingMetadataId}/bookinglinemetadata: + parameters: + - in: path + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking metadata. + post: + summary: Add booking line metadata. + description: Add booking line metadata. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingLineMetadataPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingLineMetadataPostResponseBody" + /bookinggroupfields: + get: + summary: Find booking group fields. + description: Find booking group fields. + tags: + - Booking Processes v2 + parameters: - in: query - name: contraAccountMetadataId + name: bookingGroupFieldId schema: type: string format: uuid - example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb - description: Find product metadata that is linked to this contra account. + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the booking group field. + - in: query + name: bookingMetadataId + schema: + type: string + format: uuid + example: 63d4a7e2-62c3-428b-a4bb-e4ee45516f2a + description: The id of the parent booking metadata. + - in: query + name: identifyingFieldValue + schema: + type: string + example: 1737 + description: The identifying field value. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingGroupFieldsGetResponseBody" + /bookinggroupfields/{bookingGroupFieldId}: + parameters: + - in: path + name: bookingGroupFieldId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking group field. + delete: + summary: Delete booking group field. + description: Delete booking group field. + tags: + - Booking Processes v2 + responses: + "200": + description: OK + /bookinglinemetadata: + get: + summary: Find booking line metadata. + description: Find booking line metadata. + tags: + - Booking Processes v2 + parameters: + - in: query + name: bookingLineMetadataId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the booking line metadata. + - in: query + name: bookingMetadataId + schema: + type: string + format: uuid + example: 63d4a7e2-62c3-428b-a4bb-e4ee45516f2a + description: The id of the parent booking metadata. + - in: query + name: name + schema: + type: string + example: Dakaart - BUS + description: The name of the booking line metadata. + - in: query + name: sourceMetadataId + schema: + type: string + example: 9b371ab4-2c47-4aa5-bcf8-6642385278ac + description: The source of the booking line metadata. + - in: query + name: identifyingFieldValue + schema: + type: string + example: 1737 + description: The identifying field value. - in: query name: concessionId schema: @@ -538,279 +818,110 @@ paths: type: integer example: [1, 2] explode: false - description: Find product metadata that is linked to this concession. + description: The name of the 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. - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ProductMetadataGetResponseBody" - - post: - summary: Add product metadata. - description: Add product metadata. - tags: - - Metadata v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ProductMetadataPostRequestBody" - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/ProductMetadataPostResponseBody" - /productmetadata/{productMetadataId}: - parameters: - - in: path - name: productMetadataId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - required: true - description: The id of the product metadata. - patch: - summary: Update product metadata. - description: Update product metadata. - tags: - - Metadata v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ProductMetadataPatchRequestBody" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ProductMetadataPatchResponseBody" - /productmetadata/{productMetadataId}/productcontraaccounts: - parameters: - - in: path - name: productMetadataId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - required: true - description: The id of the product metadata. - post: - summary: Add product contra account. - description: Add product contra account. - tags: - - Metadata v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ProductContraAccountsPostRequestBody" - responses: - "201": - description: Created - content: - application/json: - schema: - $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 + name: lineType schema: type: array items: - type: integer - example: [1, 2] + type: string + example: [summary, analysis, tax] explode: false - description: Find product metadata that is linked to this concession. + description: The type of the line. - in: query - name: sourceMetadataId + name: lineSense schema: - type: string - format: uuid - example: 08d96f94-f468-467e-9068-c86c34f43097 - description: Find product metadata that is linked to this source metadata. + type: array + items: + type: string + example: [debit, credit] + explode: false + description: The sense of the line. - in: query name: costCenter schema: type: string - example: 84955 - description: Find product metadata that is linked to this cost center. + example: 603031 + description: The cost center of the booking line metadata. - in: query - name: validAt + name: artcleName schema: type: string - example: 2024-03-22T09:00:00 - description: Timestamp that the metadata is valid. + example: Dagkaart + description: The article name of the booking line metadata. + - in: query + name: extRef1 + schema: + type: string + example: extRef1 + - in: query + name: extRef2 + schema: + type: string + example: extRef2 + - in: query + name: extRef3 + schema: + type: string + example: extRef3 + - in: query + name: extRef4 + schema: + type: string + example: extRef4 + - in: query + name: extRef5 + schema: + type: string + example: extRef5 + - in: query + name: extRef6 + schema: + type: string + example: extRef6 responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/ProductContraAccountsGetResponseBody" - /productcontraaccounts/{productContraAccountId}: + $ref: "#/components/schemas/BookingLineMetadataGetResponseBody" + /bookinglinemetadata/{bookingLineMetadataId}: parameters: - in: path - name: productContraAccountId + name: bookingLineMetadataId schema: type: string format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 required: true - description: The id of the product contra account. + description: The id of the booking line metadata. patch: - summary: Update product contra account. - description: Update product contra account. + summary: Update booking line metadata. + description: Update booking line metadata. tags: - - Metadata v2 + - Booking Processes v2 requestBody: required: true content: application/json: schema: - $ref: "#/components/schemas/ProductContraAccountsPatchRequestBody" + $ref: "#/components/schemas/BookingLineMetadataPatchRequestBody" responses: "200": description: OK content: application/json: schema: - $ref: "#/components/schemas/ProductContraAccountsPatchResponseBody" - /contraaccountmetadata: - get: - summary: Find contra account metadata. - description: Find contra account metadata. + $ref: "#/components/schemas/BookingLineMetadataPatchResponseBody" + delete: + summary: Delete booking line metadata. + description: Delete booking line metadata. tags: - - Metadata v2 - parameters: - - 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: contraAccountCode - schema: - type: string - example: 123456 - description: The code of the contra account. - - in: query - name: contraAccountNumber - schema: - type: string - example: 220.10419 - description: The number of the contra account. - - in: query - name: validAt - schema: - type: string - format: date-time - example: 2024-03-22T09:00:00 - description: Timestamp that the metadata is valid. + - Booking Processes v2 responses: "200": description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ContraAccountMetadataGetResponseBody" - post: - summary: Add contra account metadata. - description: Add contra account metadata. - tags: - - Metadata v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ContraAccountMetadataPostRequestBody" - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/ContraAccountMetadataPostResponseBody" - /contraaccountmetadata/{contraAccountMetadataId}: - parameters: - - in: path - name: contraAccountMetadataId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - required: true - description: The id of the contra account metadata. - patch: - summary: Update contra account metadata. - description: Update contra account metadata. - tags: - - Metadata v2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ContraAccountMetadataPatchRequestBody" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ContraAccountMetadataPatchResponseBody" /taxmetadata: get: summary: Find tax metadata. @@ -956,12 +1067,6 @@ paths: type: string example: api.htm.nl/v2/account/12345/msgs/abc description: The rejection info of the source. - - in: query - name: validAt - schema: - type: string - example: 2024-01-01T00:00:00.000 - description: Timestamp that the metadata is valid. responses: "200": description: OK @@ -1116,7 +1221,7 @@ paths: type: integer example: [1, 2] explode: false - description: The id of the concession. + description: The name of the concession. - in: query name: percentage schema: @@ -1186,6 +1291,7 @@ paths: get: summary: Find metadata audit trails. description: Find metadata audit trails. + deprecated: true tags: - Audit Trail v2 parameters: @@ -1279,6 +1385,7 @@ paths: post: summary: Add metadata audit trail. description: Add metadata audit trail. + deprecated: true tags: - Audit Trail v2 requestBody: @@ -1370,10 +1477,10 @@ components: - debit - credit example: debit - productCode: + articleNumber: type: string nullable: true - example: HTM-MND-20 + example: 4031 status: type: string enum: @@ -1412,88 +1519,6 @@ components: description: URI for pagination. example: null TransactionItemsPostRequestBody: - type: object - properties: - 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 - productCode: - type: string - nullable: true - example: HTM-MND-20 - status: - type: string - enum: - - created - - succeeded - - failed - - returned to trx-db - - returned to src - - re-entered - example: created - required: - - transactionType - - sourceName - - transactionId - - name - - quantity - - taxCode - - amountExclTax - - amountInclTax - - amountTax - - occurredOn - - type - - status - TransactionItemsPostResponseBody: - type: object - properties: - transactionItemId: - type: string - format: uuid - example: afce35b2-1dff-4ace-98d0-4b9ac405c87d - required: - - transactionItemId - TransactionItemsBulkPostRequestBody: type: object properties: transactionItems: @@ -1544,10 +1569,10 @@ components: - debit - credit example: debit - productCode: + articleNumber: type: string nullable: true - example: HTM-MND-20 + example: 4031 required: - sourceName - transactionType @@ -1560,28 +1585,32 @@ components: - amountTax - occurredOn - type - - productCode - TransactionItemsBulkPostResponseBody: + TransactionItemsPostResponseBody: type: object properties: - summary: - type: object - properties: - created: - type: integer - example: 15 - updated: - type: integer - example: 2 - total: - type: integer - example: 17 - required: - - created - - updated - - total + startTime: + type: string + format: date-time + example: 2025-02-14T05:32:47.0672237Z + status: + type: string + example: Running + clientTrackingId: + type: string + example: 08584620957189579629541919368CU00 + callbackurl: + type: string + format: uri + example: "https://services.api.htm.nl/transactionitems/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c2241509f6225d6d568526b/runs/08584620957189579629541919368CU00/operations/c9f35a54-f5de-4bc6-991b-2219164aa56f?api-version=2022-05-01&sp=%2Fruns%2F08584620957189579629541919368CU00%2Foperations%2Fc9f35a54-f5de-4bc6-991b-2219164aa56f%2Fread&sv=1.0&sig=X8dPLkbtOdndMqNfZDxTEL_3k2MhE42YyL_2ATnSYj0&code=e0W6heo7VrzW-mtYzJlavaP99VZve_9fH-9NhIJW-ceJAzFu_yZ71g%3D%3D" + retryAfter: + type: integer + example: 10 required: - - summary + - startTime + - status + - clientTrackingId + - callbackurl + - retryAfter TransactionItemsBulkBadRequestResponseBody: type: object properties: @@ -1606,7 +1635,7 @@ components: detail: type: string example: Transaction is a duplicate of a transaction already in the system. - pointer: + pointer: type: string example: "#/transactionItems/0" transactionId: @@ -1663,10 +1692,10 @@ components: - debit - credit example: debit - productCode: + articleNumber: type: string nullable: true - example: HTM-MND-20 + example: 4031 status: type: string enum: @@ -1919,6 +1948,555 @@ components: example: null required: - transactionAuditTrails + BookingProcessesGetResponseBody: + type: object + properties: + bookingProcesses: + 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: + type: string + nullable: true + description: URI for pagination. + example: null + required: + - bookingProcesses + BookingProcessesPostRequestBody: + type: object + properties: + name: + type: string + example: Verkooptransacties + transactionType: + type: string + enum: + - sales + example: sales + identifyingFieldName: + type: string + nullable: true + example: articleNumber + required: + - name + - transactionType + BookingProcessesPostResponseBody: + type: object + properties: + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - bookingProcessId + BookingProcessesPatchRequestBody: + type: object + properties: + name: + type: string + nullable: true + example: Verkooptransacties + transactionType: + type: string + nullable: true + enum: + - sales + example: sales + identifyingFieldName: + type: string + nullable: true + example: articleNumber + BookingProcessesPatchResponseBody: + type: object + properties: + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - bookingProcessId + BookingMetadataGetResponseBody: + type: object + properties: + bookingMetadata: + 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 + validTo: + type: string + format: date-time + nullable: true + example: null + required: + - bookingMetadataId + - bookingProcessId + - description + - department + - costType + - documentCode + - hasSeparateTaxLine + - hasLinePerIdentifyingField + - hasLinePerSource + - hasLinePerConcession + - validFrom + href: + type: string + nullable: true + example: null + required: + - bookingMetadata + BookingMetadataPostRequestBody: + type: object + properties: + 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 + validTo: + type: string + format: date-time + nullable: true + example: null + required: + - description + - department + - costType + - documentCode + - hasSeparateTaxLine + - hasLinePerIdentifyingField + - hasLinePerSource + - hasLinePerConcession + - validFrom + BookingMetadataPostResponseBody: + type: object + properties: + bookingMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingMetadataId + BookingMetadataPatchRequestBody: + type: object + properties: + description: + type: string + nullable: true + example: Dagkaart + department: + type: string + nullable: true + example: 900 + costType: + type: string + nullable: true + example: 84956 + documentCode: + type: string + nullable: true + example: FIKO-OPBR + hasSeparateTaxLine: + type: boolean + nullable: true + example: true + hasLinePerIdentifyingField: + type: boolean + nullable: true + example: true + hasLinePerSource: + type: boolean + nullable: true + example: true + hasLinePerConcession: + type: boolean + nullable: true + example: true + validFrom: + type: string + format: date-time + nullable: true + example: 2022-01-01 00:00:00 + validTo: + type: string + format: date-time + nullable: true + example: null + BookingMetadataPatchResponseBody: + type: object + properties: + bookingMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingMetadataId + BookingGroupFieldsPostRequestBody: + type: object + properties: + identifyingFieldValue: + type: string + example: 1737 + required: + - identifyingFieldValue + BookingGroupFieldsPostResponseBody: + type: object + properties: + bookingGroupFieldId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingGroupFieldId + BookingGroupFieldsGetResponseBody: + type: object + properties: + bookingGroupFields: + type: array + items: + type: object + properties: + bookingGroupFieldId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + bookingGroupMetadataId: + type: string + format: uuid + example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 + identifyingFieldValue: + type: string + example: 1737 + required: + - bookingGroupFieldId + - bookingGroupMetadataId + - identifyingFieldValue + href: + type: string + nullable: true + example: null + required: + - bookingGroupFields + BookingLineMetadataPostRequestBody: + type: object + properties: + name: + type: string + example: Dagkaart - BUS + sourceMetadataId: + type: string + format: uuid + example: null + 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: + - name + - lineType + - lineSense + BookingLineMetadataPostResponseBody: + type: object + properties: + bookingLineMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingLineMetadataId + BookingLineMetadataGetResponseBody: + type: object + properties: + bookingLineMetadata: + 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 - BUS + 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: + type: string + nullable: true + example: null + required: + - bookingLineMetadata + BookingLineMetadataPatchRequestBody: + type: object + properties: + name: + type: string + nullable: true + example: Dagkaart - BUS + sourceMetadataId: + type: string + format: uuid + nullable: true + example: null + identifyingFieldValue: + type: string + nullable: true + example: null + concessionId: + type: integer + nullable: true + example: 1 + lineType: + type: string + nullable: true + enum: + - summary + - analysis + - tax + example: summary + lineSense: + type: string + nullable: true + enum: + - debit + - credit + example: credit + costCenter: + type: string + nullable: true + example: 603031 + articleName: + type: string + nullable: true + example: dagkaart + extRef1: + type: string + nullable: true + example: null + extRef2: + type: string + nullable: true + example: null + extRef3: + type: string + nullable: true + example: 2025-02-17 + extRef4: + type: string + nullable: true + example: null + extRef5: + type: string + nullable: true + example: Webshop + extRef6: + type: string + nullable: true + example: null + BookingLineMetadataPatchResponseBody: + type: object + properties: + bookingLineMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingLineMetadataId MetadataAuditTrailsGetResponseBody: type: object properties: @@ -2044,366 +2622,6 @@ 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: @@ -2486,7 +2704,7 @@ components: taxCode: type: string example: V21 - taxPercentageAmount: + taxPercentageAmount: type: integer example: 21 description: @@ -2516,7 +2734,7 @@ components: sourceMetadata: type: array items: - $ref: '#/components/schemas/SourceMetadata' + $ref: "#/components/schemas/SourceMetadata" href: type: string nullable: true @@ -2543,15 +2761,6 @@ components: 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 @@ -2560,7 +2769,6 @@ components: - businessOwner - rejectionProcessing - rejectionInfo - - validFrom SourceMetadataPostResponseBody: type: object properties: @@ -2591,15 +2799,6 @@ components: 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: @@ -2685,10 +2884,11 @@ components: properties: concessionMetadataId: type: string - format: uuid + format: en example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb concession: - $ref: '#/components/schemas/Concession' + type: object + $ref: "#/components/schemas/Concession" percentage: type: number example: 84.021 @@ -2781,33 +2981,6 @@ components: 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: @@ -2816,9 +2989,10 @@ components: example: 1 name: type: string - example: bus + example: RAIL required: - concessionId + - name SourceMetadata: type: object properties: @@ -2844,15 +3018,6 @@ components: 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