OVPAY-1518 - Updated examples to Odata.

This commit is contained in:
Bas Boterman 2025-03-18 16:48:09 +01:00
parent f43626dcc7
commit 57e37d5736

View File

@ -86,7 +86,133 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/TransactionItemsGetResponseBody" $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:
"@odata.context": "$metadata#TransactionItem"
value: []
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:
"@odata.context": "$metadata#TransactionItem"
value:
- "@odata.etag": 6962e56b-c7dd-3336-9627-6687f007ee07
transactionItemRowId: 3231
transactionItemId: afce35b2-1dff-4ace-98d0-4b9ac405c87d
transactionType: sales
sourceName: HTM-website
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
- "@odata.etag": e671c8a1-b918-4867-bf12-5289822479c3
transactionItemRowId: 3232
transactionItemId: 1c1fc1c8-57f4-4336-9b43-a974eae5afbf
transactionType: sales
sourceName: HTM-website
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
- "@odata.etag": be2715d4-4eff-4562-9bf3-5c43ad23e2c8
transactionItemRowId: 3233
transactionItemId: 3f58441e-dc8f-4956-9bc5-c952312476db
transactionType: sales
sourceName: HTM-website
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
- "@odata.etag": 52130c4d-e944-4454-a73e-8d55449a4bd1
transactionItemRowId: 3234
transactionItemId: 4418825f-3f9b-45bc-b662-dc3cd4ce6599
transactionType: sales
sourceName: HTM-website
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
- "@odata.etag": 7da305e1-85cd-4250-ad77-8b54b2649cfb
transactionItemRowId: 3235
transactionItemId: 2ddc1831-cf7b-4a77-8aa1-11aaf8e98d9f
transactionType: sales
sourceName: HTM-website
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
- "@odata.etag": c3b17d21-0506-474d-b3d4-7ff654f368b9
transactionItemRowId: 3236
transactionItemId: 5ab2513d-f334-4cf8-8895-4e7269374a4b
transactionType: sales
sourceName: HTM-website
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
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -110,7 +236,7 @@ paths:
value: value:
transactionItems: transactionItems:
- transactionType: sales - transactionType: sales
sourceName: Verkoopengine sourceName: HTM-website
transactionId: 1001236 transactionId: 1001236
transactionLineId: 1 transactionLineId: 1
name: HTM Maandkorting 20% name: HTM Maandkorting 20%
@ -128,7 +254,7 @@ paths:
value: value:
transactionItems: transactionItems:
- transactionType: sales - transactionType: sales
sourceName: Verkoopengine sourceName: HTM-website
transactionId: 1001236 transactionId: 1001236
transactionLineId: 1 transactionLineId: 1
name: HTM Maandkorting 20% name: HTM Maandkorting 20%
@ -141,7 +267,7 @@ paths:
type: debit type: debit
articleNumber: 4031 articleNumber: 4031
- transactionType: sales - transactionType: sales
sourceName: Verkoopengine sourceName: HTM-website
transactionId: 1001237 transactionId: 1001237
transactionLineId: 1 transactionLineId: 1
name: HTM Maandkorting 20% name: HTM Maandkorting 20%
@ -478,7 +604,151 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/TransactionAuditTrailsGetResponseBody" $ref: "#/components/schemas/TransactionAuditTrailsGetResponseBody"
examples:
No transaction item audit trails:
summary: No transaction audit trails were found
description: No transaction audit trails that match the search criteria were found.
value:
"@odata.context": "$metadata#TransactionAuditTrail"
value: []
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:
"@odata.context": "$metadata#TransactionAuditTrail"
value:
- "@odata.etag": 0d22aa9e-2183-4f2d-aa5b-98c362683529
transactionAuditTrailRowId: 8218
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
- "@odata.etag": 1ce407d3-4725-46b8-92b2-47282ccd38f5
transactionAuditTrailRowId: 8219
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
- "@odata.etag": c8dec28b-bb85-4cb2-8a56-4a95fb2ed7bb
transactionAuditTrailRowId: 8220
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
- "@odata.etag": 967ddfa0-835e-4954-a4af-2eb11de325dc
transactionAuditTrailRowId: 8221
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
? 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:
"@odata.context": "$metadata#TransactionAuditTrail"
value:
- "@odata.etag": 0d22aa9e-2183-4f2d-aa5b-98c362683529
transactionAuditTrailRowId: 8218
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
- "@odata.etag": 1ce407d3-4725-46b8-92b2-47282ccd38f5
transactionAuditTrailRowId: 8219
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
- "@odata.etag": c8dec28b-bb85-4cb2-8a56-4a95fb2ed7bb
transactionAuditTrailRowId: 8220
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
- "@odata.etag": 967ddfa0-835e-4954-a4af-2eb11de325dc
transactionAuditTrailRowId: 8221
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
? List containing multiple audit trails of different failed transactions
: summary: List containing multiple audit trails of different failed transactions
description: List containing multiple audit trails of different failed transactions (status = failed).
value:
"@odata.context": "$metadata#TransactionAuditTrail"
value:
- "@odata.etag": 0d22aa9e-2183-4f2d-aa5b-98c362683529
transactionAuditTrailRowId: 8218
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
- "@odata.etag": 1ce407d3-4725-46b8-92b2-47282ccd38f5
transactionAuditTrailRowId: 8219
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
- "@odata.etag": c8dec28b-bb85-4cb2-8a56-4a95fb2ed7bb
transactionAuditTrailRowId: 8220
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
- "@odata.etag": 967ddfa0-835e-4954-a4af-2eb11de325dc
transactionAuditTrailRowId: 8221
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
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -558,7 +828,97 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ProcessingFailuresGetResponseBody" $ref: "#/components/schemas/ProcessingFailuresGetResponseBody"
examples:
No processing failures were found:
summary: No processing failures were found
description: No processing failures were found (for example for a single transaction item).
value:
"@odata.context": "$metadata#ProcessingFailure"
value: []
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:
"@odata.context": "$metadata#ProcessingFailure"
value:
- "@odata.etag": 0d22aa9e-2183-4f2d-aa5b-98c362683529
processingFailureRowId: 9
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
- "@odata.etag": ff49829d-a5de-4c1a-b331-15fd9c71dfe9
processingFailureRowId: 10
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
- "@odata.etag": 5d5d3351-d3f1-49b2-905f-4dbbe1cc30e3
processingFailureRowId: 11
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
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:
"@odata.context": "$metadata#ProcessingFailure"
value:
- "@odata.etag": 0d22aa9e-2183-4f2d-aa5b-98c362683529
processingFailureRowId: 9
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
- "@odata.etag": 584d3a8a-48bc-45f9-99be-8dd70399e6e4
processingFailureRowId: 10
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
- "@odata.etag": df4ade9b-1bda-4d91-a5ba-4dbe067568a0
processingFailureRowId: 11
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
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -661,7 +1021,25 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingProcessesGetResponseBody" $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:
"@odata.context": "$metadata#BookingProcess"
value:
- "@odata.etag": df4ade9b-1bda-4d91-a5ba-4dbe067568a0
bookingProcessRowId: 10
bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
name: Verkooptransacties
transactionType: sales
identifyingFieldName: articleNumber
- "@odata.etag": 97c65a01-f5ac-4081-b731-137622c4630d
bookingProcessRowId: 11
bookingProcessId: 03105285-3c4c-477a-821c-0fae801d9d26
name: Inkooptransacties
transactionType: purchase
identifyingFieldName: null
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -884,7 +1262,41 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingMetadataGetResponseBody" $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:
"@odata.context": "$metadata#BookingMetadata"
value:
- "@odata.etag": 6962e56b-c7dd-3336-9627-6687f007ee07
bookingMetadataRowId: 13
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
- "@odata.etag": 2fc41131-e875-4365-b4b4-f5babc7349b1
bookingMetadataRowId: 14
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
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1116,7 +1528,91 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingGroupFieldsGetResponseBody" $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:
"@odata.context": "$metadata#BookingGroupField"
value:
- "@odata.etag": 2e52e353-bf49-4296-8dc3-bd5e6096be4e
bookingGroupFieldRowId: 8
bookingGroupFieldId: b34d0fc2-96fc-409b-93b6-ae51fb8c694a
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1737
- "@odata.etag": 3f285dc2-6ae3-4613-a759-68fada2afcdf
bookingGroupFieldRowId: 9
bookingGroupFieldId: 3b9005f4-42c4-4e2b-b472-ba7d0926fe77
bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
identifyingFieldValue: 1748
- "@odata.etag": f6f303f9-6685-44be-9c44-aec14a59e461
bookingGroupFieldRowId: 10
bookingGroupFieldId: ae773282-ac9b-4a0b-a487-b4061ea2a42f
bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
identifyingFieldValue: 1750
- "@odata.etag": 39d5bf02-0ac3-47a2-8ba4-e00a18108e98
bookingGroupFieldRowId: 11
bookingGroupFieldId: fe1aca8c-3ef5-4e15-962b-202d28d3d761
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1757
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:
"@odata.context": "$metadata#BookingGroupField"
value:
- "@odata.etag": 2e52e353-bf49-4296-8dc3-bd5e6096be4e
bookingGroupFieldRowId: 8
bookingGroupFieldId: b34d0fc2-96fc-409b-93b6-ae51fb8c694a
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1737
- "@odata.etag": d269b9e9-2f8e-4c3d-9874-599d2e7553aa
bookingGroupFieldRowId: 9
bookingGroupFieldId: fe1aca8c-3ef5-4e15-962b-202d28d3d761
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 1757
- "@odata.etag": 8110f2ee-a37a-4e56-a3d8-5ae113675923
bookingGroupFieldRowId: 10
bookingGroupFieldId: fede01e0-86c5-47d0-9466-3093132148e5
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4031
- "@odata.etag": 89e9ef54-138a-479d-a4ce-5e01d3f8bb14
bookingGroupFieldRowId: 11
bookingGroupFieldId: d7c25182-b64e-4e47-8998-19ddb65b8f2c
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4032
- "@odata.etag": ab2242f7-b891-40fe-86c0-34e0f4453316
bookingGroupFieldRowId: 12
bookingGroupFieldId: ea02d3eb-29e6-42fd-b7eb-dfbfd2231090
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4033
- "@odata.etag": 9244dd72-fcc0-4578-97cc-9dcc55429eb4
bookingGroupFieldRowId: 13
bookingGroupFieldId: a73407a6-ff8c-4924-a7ac-5cd605e1793c
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4034
- "@odata.etag": 057281d9-65ef-46b9-b7d3-efee2968a438
bookingGroupFieldRowId: 14
bookingGroupFieldId: d9af4bf1-4e85-4eb6-ae5d-d2020b18d63c
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4051
- "@odata.etag": 95e91fe2-e990-4b9e-a146-b44142d66b90
bookingGroupFieldRowId: 15
bookingGroupFieldId: c1ba494b-249a-475b-a542-19918aa36778
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4053
- "@odata.etag": c346c96d-acac-4e2b-a652-219983fc5bca
bookingGroupFieldRowId: 16
bookingGroupFieldId: 69be1be0-c600-492d-aec1-8490409371da
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4054
- "@odata.etag": 39635b84-551e-4927-9787-28f6868d3b18
bookingGroupFieldRowId: 17
bookingGroupFieldId: d7d00ec1-6d53-44e9-bcd8-01f6a523f771
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
identifyingFieldValue: 4055
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1234,7 +1730,148 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/BookingLineMetadataGetResponseBody" $ref: "#/components/schemas/BookingLineMetadataGetResponseBody"
examples:
List containing two different booking lines:
summary: List containing two different booking lines
description: List containing two different booking line metadata records, for two different booking processes (no filters applied).
value:
"@odata.context": "$metadata#BookingLineMetadata"
value:
- "@odata.etag": 511fb29c-47d6-4af9-bc54-cbbf3de27dae
bookingLineMetadataRowId: 10
bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop - Dagkaart - BUS
sourceName: HTM-website
identifyingFieldValue: null
concessionId: 2
lineType: summary
lineSense: credit
costCenter: 603031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- "@odata.etag": 42b91a85-0771-4cde-92ff-fe4a42bb6cf7
bookingLineMetadataRowId: 11
bookingLineMetadataId: 1bca01db-40d3-4447-9f28-41475ec6877d
bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
name: TLS - Saldoreizen - RAIL
sourceName: Translink
identifyingFieldValue: null
concessionId: 1
lineType: summary
lineSense: credit
costCenter: 603007
articleName: Opbrengst TLS
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: TLS
extRef6: 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:
"@odata.context": "$metadata#BookingLineMetadata"
value:
- "@odata.etag": 42b91a85-0771-4cde-92ff-fe4a42bb6cf7
bookingLineMetadataRowId: 11
bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop - Dagkaart - BUS
sourceName: HTM-website
identifyingFieldValue: null
concessionId: 2
lineType: summary
lineSense: credit
costCenter: 619031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- "@odata.etag": 8513d1aa-5cba-4765-81ca-56ca1272cc05
bookingLineMetadataRowId: 12
bookingLineMetadataId: a4464b5c-9a8e-4e48-a0a0-5500b1ca0885
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop - Dagkaart - RAIL
sourceName: HTM-website
identifyingFieldValue: null
concessionId: 1
lineType: summary
lineSense: credit
costCenter: 603031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- "@odata.etag": 63e1c54d-7c6b-4b77-ab7f-86a5e9ce9e53
bookingLineMetadataRowId: 13
bookingLineMetadataId: feaa7b33-ba49-40a2-90f3-5dd70d591f17
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Ticketapp - Dagkaart - BUS
sourceName: HTM-app
identifyingFieldValue: null
concessionId: 2
lineType: summary
lineSense: credit
costCenter: 619031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- "@odata.etag": 576446b0-b3c4-4a63-bff4-939d44104572
bookingLineMetadataRowId: 14
bookingLineMetadataId: ea6ce4e7-4d52-4b89-bbea-ffe0ef6c48ff
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Ticketapp - Dagkaart - RAIL
sourceName: HTM-app
identifyingFieldValue: null
concessionId: 1
lineType: summary
lineSense: credit
costCenter: 603031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
- "@odata.etag": cbd3968b-8e73-4c43-847b-a680e43e67cb
bookingLineMetadataRowId: 15
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
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1352,7 +1989,61 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/TaxMetadataGetResponseBody" $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:
"@odata.context": "$metadata#TaxMetadata"
value:
- "@odata.etag": 4a758689-c28f-47d1-a230-e5422e9ad3be
taxMetadataRowId: 13
taxMetadataId: 2d444740-4131-4169-bb47-2d125641dc87
taxCode: V0
texPercantageAmount: 0
description: BTW VERKOOP NUL
validFrom: 2024-03-22T09:00:00
validUntil: null
- "@odata.etag": f848cce9-7fbe-4371-a70c-085fefe4613e
taxMetadataRowId: 14
taxMetadataId: b5f879d1-043d-4357-9655-2eeca8ebe9bf
taxCode: V09
taxPercentageAmount: 9
description: BTW VERKOOP LAAG 9%
validFrom: 2024-03-22T09:00:00
validUntil: null
- "@odata.etag": db06ae45-710d-4a4b-958b-cba61a8ba027
taxMetadataRowId: 15
taxMetadataId: 62e1abe7-d76f-4364-9207-591c0601ba55
taxCode: V21
taxPercentageAmount: 21
description: BTW VERKOOP HOOG 21%
validFrom: 2024-03-22T09:00:00
validUntil: null
- "@odata.etag": 3bc97433-06f8-431c-b931-f5e33641bf88
taxMetadataRowId: 16
taxMetadataId: 9a253fc3-e562-4c4a-925c-d9caf0dcc549
taxCode: ?0
taxPercentageAmount: 0
description: BTW DEBIT NUL
validFrom: 2024-03-22T09:00:00
validUntil: null
- "@odata.etag": 2262ab02-57a8-4425-a823-88d3c8d956bf
taxMetadataRowId: 17
taxMetadataId: 6243b848-5ca3-44e0-9860-4fb3a817f148
taxCode: ?09
taxPercentageAmount: 9
description: BTW DEBIT laag 9%
validFrom: 2024-03-22T09:00:00
validUntil: null
- "@odata.etag": 261794fa-11fa-47a2-9429-1e671638cb9d
taxMetadataRowId: 18
taxMetadataId: 0240d6e4-6037-4da0-ac10-1fde0229d439
taxCode: ?21
taxPercentageAmount: 21
description: BTW DEBIT hoog 21%
validFrom: 2024-03-22T09:00:00
validUntil: null
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1498,7 +2189,40 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/SourceMetadataGetResponseBody" $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:
"@odata.context": "$metadata#SourceMetadata"
value:
- "@odata.etag": 309ac952-12ad-4f13-a19d-f7443b8a1e93
sourceMetadataRowId: 2
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
- "@odata.etag": 4b743da5-4195-4b2e-a11b-6e5393a94c0a
sourceMetadataRowId: 3
sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc
incomingName: HTM-app
incomingEntity: OrderLine
outgoingName: ticketapp
businessOwner: Danny Negen
rejectionProcessing: mail
rejectionInfo: d.negen@htm.nl
- "@odata.etag": 502e2f58-b4e1-4dd0-947a-db6eea726e3a
sourceMetadataRowId: 4
sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209
incomingName: SMP
incomingEntity: OrderLine
outgoingName: balieverkoop
businessOwner: Guus Geluk
rejectionProcessing: mail
rejectionInfo: ao@htm.nl
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1637,7 +2361,28 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/AccountingPeriodMetadataGetResponseBody" $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:
"@odata.context": "$metadata#AccountingPeriodMetadata"
value:
- "@odata.etag": 8f085711-eeae-44ed-bac1-06779bedb480
accountingPeriodMetadataRowId: 1
accountingPeriodMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
accountingPeriod: 2025/01
isOpen: true
- "@odata.etag": 66c033af-fc67-4eb2-9d17-d74a0166470f
accountingPeriodMetadataRowId: 2
accountingPeriodMetadataId: 36a34bd8-2b84-4c89-87a4-22e809f6ed4a
accountingPeriod: 2024/12
isOpen: false
- "@odata.etag": fc1aa814-ede9-4f99-b09b-b969c8738003
accountingPeriodMetadataRowId: 3
accountingPeriodMetadataId: 33b4889b-0036-4870-87df-be43f9316cdf
accountingPeriod: 2024/11
isOpen: false
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1789,7 +2534,55 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ConcessionMetadataGetResponseBody" $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:
"@odata.context": "$metadata#ConcessionMetadata"
value:
- "@odata.etag": 8a7c6124-574b-4725-9105-834924437087
concessionMetadataRowId: 14
concessionMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
concessionId: 1
percentage: 84.021
validFrom: 2025-01-01T00:00:00.000
validUntil: null
- "@odata.etag": 90d4cf7b-86c8-4111-975b-af332b1507e5
concessionMetadataRowId: 15
concessionMetadataId: 39720be0-af88-486a-b5e2-faea7eb5b352
concessionId: 2
percentage: 15.979
validFrom: 2025-01-01T00:00:00.000
validUntil: null
- "@odata.etag": 08b684af-7fe5-44ee-ad99-dab0f57c42bb
concessionMetadataRowId: 16
concessionMetadataId: 274db383-96dd-410e-a07e-0b9e3040ac91
concessionId: 1
percentage: 83.021
validFrom: 2024-12-01T00:00:00.000
validUntil: 2024-12-31T23:59:59.999
- "@odata.etag": 640270c1-8dff-468e-9a5b-459e57b3ae13
concessionMetadataRowId: 17
concessionMetadataId: 03959bc5-83f2-4ac7-9bf5-67e0f2a6eace
concessionId: 2
percentage: 16.979
validFrom: 2024-12-01T00:00:00.000
validUntil: 2024-12-31T23:59:59.999
- "@odata.etag": a03c2a52-d65d-40c6-828b-18ce07df1d68
concessionMetadataRowId: 18
concessionMetadataId: d5b7d8f6-5cb8-482e-9d9a-68909dc7b5d3
concessionId: 1
percentage: 85.021
validFrom: 2024-11-01T00:00:00.000
validUntil: 2024-11-30T23:59:59.999
- "@odata.etag": 4eb2fbe7-8dca-4ac9-a59d-379d56611bb4
concessionMetadataRowId: 19
concessionMetadataId: 5ee5f86f-ab00-4630-b130-4714fd060d1a
concessionId: 2
percentage: 14.979
validFrom: 2024-11-01T00:00:00.000
validUntil: 2024-11-30T23:59:59.999
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1934,7 +2727,21 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ConcessionsGetResponseBody" $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:
"@odata.context": "$metadata#Concession"
value:
- "@odata.etag": 6962e56b-c7dd-3336-9627-6687f007ee07
concessionRowId: 1
concessionId: 1
name: RAIL
- "@odata.etag": b4eb7b82-9ecb-424f-a3e3-c532f0b763a4
concessionRowId: 2
concessionId: 2
name: BUS
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1979,7 +2786,7 @@ components:
example: sales example: sales
sourceName: sourceName:
type: string type: string
example: Verkoopengine example: HTM-website
transactionId: transactionId:
type: string type: string
example: 1001236 example: 1001236
@ -2066,7 +2873,7 @@ components:
example: sales example: sales
sourceName: sourceName:
type: string type: string
example: Verkoopengine example: HTM-website
transactionId: transactionId:
type: string type: string
example: 1001236 example: 1001236
@ -2925,7 +3732,7 @@ components:
example: Dagkaart - RAIL example: Dagkaart - RAIL
sourceName: sourceName:
type: string type: string
example: Verkoopengine example: HTM-website
nullable: true nullable: true
identifyingFieldValue: identifyingFieldValue:
type: string type: string
@ -3324,7 +4131,7 @@ components:
example: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0 example: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0
incomingName: incomingName:
type: string type: string
example: VerkoopEngine example: HTM-website
incomingEntity: incomingEntity:
type: string type: string
example: OrderLine example: OrderLine
@ -3354,7 +4161,7 @@ components:
properties: properties:
incomingName: incomingName:
type: string type: string
example: VerkoopEngine example: HTM-website
incomingEntity: incomingEntity:
type: string type: string
example: OrderLine example: OrderLine
@ -3391,7 +4198,7 @@ components:
properties: properties:
incomingName: incomingName:
type: string type: string
example: VerkoopEngine example: HTM-website
incomingEntity: incomingEntity:
type: string type: string
example: OrderLine example: OrderLine