feature/OVPAY-1755 #12

Merged
bboterm merged 8 commits from feature/OVPAY-1755 into develop 2025-06-11 13:10:35 +00:00
Showing only changes of commit 1a853a11ef - Show all commits

View File

@ -1321,7 +1321,7 @@ paths:
Update booking metadata: Update booking metadata:
summary: Update booking metadata summary: Update booking metadata
description: | description: |
In this example the booking metadata is updated. The validUntil field is updated to 2024-03-22T09:00:00. In this example the booking metadata is updated. All fields are updated.
value: value:
name: Dagkaarten name: Dagkaarten
description: Dagkaarten nov. 2024 description: Dagkaarten nov. 2024
@ -1332,6 +1332,12 @@ paths:
hasLinePerConcession: true hasLinePerConcession: true
validFrom: 2022-01-01 00:00:00 validFrom: 2022-01-01 00:00:00
validUntil: 2024-03-22T09:00:00 validUntil: 2024-03-22T09:00:00
Update valid until:
summary: Update valid until
description: |
In this example the booking metadata is updated. The validUntil field is updated to 2024-03-22T09:00:00.
value:
validUntil: 2024-03-22T09:00:00
responses: responses:
"200": "200":
description: OK description: OK
@ -1351,7 +1357,7 @@ paths:
x-throttling-tier: Unlimited x-throttling-tier: Unlimited
delete: delete:
summary: Delete booking metadata. summary: Delete booking metadata.
description: | description: |
Delete booking metadata. Note that booking metadata can only be deleted Delete booking metadata. Note that booking metadata can only be deleted
if the validFrom is in the future. if the validFrom is in the future.
tags: tags:
@ -1362,7 +1368,7 @@ paths:
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
x-throttling-tier: Unlimited x-throttling-tier: Unlimited
/bookingmetadata/{bookingMetadataId}/bookinggroupfields: /bookingmetadata/{bookingMetadataId}/bookinggroupfields:
parameters: parameters:
- in: path - in: path
@ -1434,12 +1440,16 @@ paths:
description: In this example a new tax booking line metadata is added to an existing booking. description: In this example a new tax booking line metadata is added to an existing booking.
value: value:
name: Saldoreizen - BTW name: Saldoreizen - BTW
description: BTW 9%
sourceMetadataId: null sourceMetadataId: null
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: false
lineType: tax lineType: tax
lineSense: credit lineSense: credit
costCenter: 603031 department: 140
costType: 15427
costCenter: null
articleName: null articleName: null
extRef1: null extRef1: null
extRef2: null extRef2: null
@ -1452,11 +1462,15 @@ paths:
description: In this example a new yield booking line metadata is added to an existing booking. description: In this example a new yield booking line metadata is added to an existing booking.
value: value:
name: Opbrengst Saldoreizen - RAIL name: Opbrengst Saldoreizen - RAIL
description: Saldoreizen nov. 2024
sourceMetadataId: null sourceMetadataId: null
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false
lineType: analysis lineType: analysis
lineSense: credit lineSense: credit
department: 900
costType: 84956
costCenter: 603031 costCenter: 603031
articleName: Saldoreizen articleName: Saldoreizen
extRef1: null extRef1: null
@ -1465,6 +1479,28 @@ paths:
extRef4: null extRef4: null
extRef5: TLS extRef5: TLS
extRef6: null extRef6: null
Add a new contra account booking line metadata:
summary: Add a new contra account booking line metadata
description: In this example a new contra account booking line metadata is added to an existing booking.
value:
name: Tegenrekening productverkopen
description: ST20 produktverkopen nov 2024
sourceMetadataId: null
identifyingFieldValue: null
concessionId: null
isContraAccount: true
lineType: analysis
lineSense: debet
department: 140
costType: 15427
costCenter: null
articleName: null
extRef1: null
extRef2: null
extRef3: null
extRef4: null
extRef5: null
extRef6: null
responses: responses:
"201": "201":
description: Created description: Created
@ -1683,11 +1719,15 @@ paths:
- bookingLineMetadataId - bookingLineMetadataId
- bookingMetadataId - bookingMetadataId
- name - name
- description
- sourceMetadataId - sourceMetadataId
- identifyingFieldValue - identifyingFieldValue
- concessionId - concessionId
- isContraAccount
- lineType - lineType
- lineSense - lineSense
- department
- costType
- costCenter - costCenter
- articleName - articleName
- extRef1 - extRef1
@ -1712,11 +1752,15 @@ paths:
- bookingLineMetadataId - bookingLineMetadataId
- bookingMetadataId - bookingMetadataId
- name - name
- description
- sourceMetadataId - sourceMetadataId
- identifyingFieldValue - identifyingFieldValue
- concessionId - concessionId
- isContraAccount
- lineType - lineType
- lineSense - lineSense
- department
- costType
- costCenter - costCenter
- articleName - articleName
- extRef1 - extRef1
@ -1759,11 +1803,15 @@ paths:
bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842 bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop - Dagkaart - BUS name: Webshop - Dagkaart - BUS
sourceName: HTM-website description: Dagkaarten nov. 2024 BUS
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900
costType: 84956
costCenter: 603031 costCenter: 603031
articleName: dagkaart articleName: dagkaart
extRef1: null extRef1: null
@ -1777,11 +1825,15 @@ paths:
bookingLineMetadataId: 1bca01db-40d3-4447-9f28-41475ec6877d bookingLineMetadataId: 1bca01db-40d3-4447-9f28-41475ec6877d
bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034 bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
name: TLS - Saldoreizen - RAIL name: TLS - Saldoreizen - RAIL
sourceName: Translink description: Saldoreizen nov. 2024 RAIL
sourceMetadataId: 4dab350d-a47c-4cc0-80e8-404e099f5c24
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900
costType: 84955
costCenter: 603007 costCenter: 603007
articleName: Opbrengst TLS articleName: Opbrengst TLS
extRef1: null extRef1: null
@ -1804,11 +1856,15 @@ paths:
bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842 bookingLineMetadataId: 98dccb4c-f24f-4acd-a036-f4b465124842
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop - Dagkaart - BUS name: Webshop - Dagkaart - BUS
sourceName: HTM-website description: Dagkaarten nov. 2024 BUS
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900
costType: 84956
costCenter: 619031 costCenter: 619031
articleName: dagkaart articleName: dagkaart
extRef1: null extRef1: null
@ -1822,11 +1878,14 @@ paths:
bookingLineMetadataId: a4464b5c-9a8e-4e48-a0a0-5500b1ca0885 bookingLineMetadataId: a4464b5c-9a8e-4e48-a0a0-5500b1ca0885
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Webshop - Dagkaart - RAIL name: Webshop - Dagkaart - RAIL
sourceName: HTM-website description: Dagkaarten nov. 2024 RAIL
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900
costType: 84956
costCenter: 603031 costCenter: 603031
articleName: dagkaart articleName: dagkaart
extRef1: null extRef1: null
@ -1840,11 +1899,15 @@ paths:
bookingLineMetadataId: feaa7b33-ba49-40a2-90f3-5dd70d591f17 bookingLineMetadataId: feaa7b33-ba49-40a2-90f3-5dd70d591f17
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Ticketapp - Dagkaart - BUS name: Ticketapp - Dagkaart - BUS
sourceName: HTM-app description: Dagkaarten nov. 2024 BUS
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900
costType: 84956
costCenter: 619031 costCenter: 619031
articleName: dagkaart articleName: dagkaart
extRef1: null extRef1: null
@ -1858,11 +1921,15 @@ paths:
bookingLineMetadataId: ea6ce4e7-4d52-4b89-bbea-ffe0ef6c48ff bookingLineMetadataId: ea6ce4e7-4d52-4b89-bbea-ffe0ef6c48ff
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Ticketapp - Dagkaart - RAIL name: Ticketapp - Dagkaart - RAIL
sourceName: HTM-app description: Dagkaarten nov. 2024 RAIL
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900
costType: 84956
costCenter: 603031 costCenter: 603031
articleName: dagkaart articleName: dagkaart
extRef1: null extRef1: null
@ -1876,12 +1943,16 @@ paths:
bookingLineMetadataId: 0a8dbb7d-73c8-451e-9028-e4613283c7bd bookingLineMetadataId: 0a8dbb7d-73c8-451e-9028-e4613283c7bd
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Dagkaart - BTW name: Dagkaart - BTW
sourceMetadata: null description: BTW 9%
sourceMetadataId: null
identifyingFieldValue: null identifyingFieldValue: null
concession: null concessionId: null
isContraAccount: false
lineType: tax lineType: tax
lineSense: credit lineSense: credit
costCenter: 1337 department: 140
costType: 15427
costCenter: null
articleName: dagkaart articleName: dagkaart
extRef1: null extRef1: null
extRef2: null extRef2: null
@ -1889,6 +1960,28 @@ paths:
extRef4: null extRef4: null
extRef5: null extRef5: null
extRef6: null extRef6: null
- "@odata.etag": 26c89ff7-2fc3-4cc5-ae80-7e1e90886148
bookingLineMetadataRowId: 16
bookingLineMetadataId: d8c8b3b8-e996-463e-9c32-f0878ebfbcbb
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
name: Dagkaart - Tegenrekening
description: ST20 produktverkopen nov 2024
sourceMetadataId: null
identifyingFieldValue: null
concessionId: null
isContraAccount: true
lineType: analysis
lineSense: credit
department: 220
costType: 10486
costCenter: null
articleName: null
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: null
extRef6: null
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1915,6 +2008,29 @@ paths:
schema: schema:
$ref: "#/components/schemas/BookingLineMetadataPatchRequestBody" $ref: "#/components/schemas/BookingLineMetadataPatchRequestBody"
examples: examples:
Update a booking line:
summary: Update a booking line
description: |
In this example an existing booking line metadata is updated.
value:
name: Ticketapp - Dagkaart - RAIL
description: Dagkaarten nov. 2024 RAIL
sourceMetadataId: 8cddd157-c9ea-4027-9e8b-f1c5201440f1
identifyingFieldValue: null
concessionId: 1
isContraAccount: false
lineType: summary
lineSense: credit
department: 900
costType: 84956
costCenter: 603031
articleName: dagkaart
extRef1: null
extRef2: null
extRef3: 2025-02-17
extRef4: null
extRef5: Webshop
extRef6: null
Update cost center of a booking line: Update cost center of a booking line:
summary: Update cost center of a booking line summary: Update cost center of a booking line
description: | description: |
@ -3534,7 +3650,7 @@ components:
type: string type: string
nullable: true nullable: true
example: Dagkaarten example: Dagkaarten
description: description:
type: string type: string
nullable: true nullable: true
example: Dagkaarten nov. 2024 example: Dagkaarten nov. 2024
@ -3634,6 +3750,9 @@ components:
name: name:
type: string type: string
example: Dagkaart - BUS example: Dagkaart - BUS
description:
type: string
example: Dagkaarten nov. 2024 BUS
sourceMetadataId: sourceMetadataId:
type: string type: string
format: uuid format: uuid
@ -3647,6 +3766,9 @@ components:
type: integer type: integer
example: 1 example: 1
nullable: true nullable: true
isContraAccount:
type: boolean
example: false
lineType: lineType:
type: string type: string
enum: enum:
@ -3660,6 +3782,12 @@ components:
- debit - debit
- credit - credit
example: credit example: credit
department:
type: string
example: 900
costType:
type: string
example: 84956
costCenter: costCenter:
type: string type: string
example: 603031 example: 603031
@ -3694,8 +3822,12 @@ components:
nullable: true nullable: true
required: required:
- name - name
- description
- isContraAccount
- lineType - lineType
- lineSense - lineSense
- department
- costType
BookingLineMetadataPostResponseBody: BookingLineMetadataPostResponseBody:
type: object type: object
properties: properties:
@ -3735,9 +3867,13 @@ components:
name: name:
type: string type: string
example: Dagkaart - RAIL example: Dagkaart - RAIL
sourceName: description:
type: string type: string
example: HTM-website example: Dagkaarten nov. 2024 RAIL
sourceMetadataId:
type: string
format: uuid
example: db7e5899-3904-4b53-bd62-a56aef34c66d
nullable: true nullable: true
identifyingFieldValue: identifyingFieldValue:
type: string type: string
@ -3747,6 +3883,9 @@ components:
type: integer type: integer
example: 1 example: 1
nullable: true nullable: true
isContraAccount:
type: boolean
example: false
lineType: lineType:
type: string type: string
enum: enum:
@ -3760,6 +3899,12 @@ components:
- debit - debit
- credit - credit
example: credit example: credit
department:
type: string
example: 900
costType:
type: string
example: 84956
costCenter: costCenter:
type: string type: string
example: 603031 example: 603031
@ -3796,75 +3941,95 @@ components:
- bookingLineMetadataId - bookingLineMetadataId
- bookingMetadataId - bookingMetadataId
- name - name
- description
- isContraAccount
- lineType - lineType
- lineSense - lineSense
- department
- costType
BookingLineMetadataPatchRequestBody: BookingLineMetadataPatchRequestBody:
type: object type: object
properties: properties:
name: name:
type: string type: string
nullable: true
example: Dagkaart - RAIL example: Dagkaart - RAIL
nullable: true
description:
type: string
example: Dagkaarten nov. 2024 RAIL
nullable: true
sourceMetadataId: sourceMetadataId:
type: string type: string
format: uuid format: uuid
nullable: true
example: null example: null
nullable: true
identifyingFieldValue: identifyingFieldValue:
type: string type: string
nullable: true
example: null example: null
nullable: true
concessionId: concessionId:
type: integer type: integer
nullable: true
example: 1 example: 1
nullable: true
isContraAccount:
type: boolean
example: false
nullable: true
lineType: lineType:
type: string type: string
nullable: true
enum: enum:
- summary - summary
- analysis - analysis
- tax - tax
example: summary example: summary
nullable: true
lineSense: lineSense:
type: string type: string
nullable: true
enum: enum:
- debit - debit
- credit - credit
example: credit example: credit
nullable: true
department:
type: string
example: 900
nullable: true
costType:
type: string
example: 84956
nullable: true
costCenter: costCenter:
type: string type: string
nullable: true
example: 603031 example: 603031
nullable: true
articleName: articleName:
type: string type: string
nullable: true
example: dagkaart example: dagkaart
nullable: true
extRef1: extRef1:
type: string type: string
nullable: true
example: null example: null
nullable: true
extRef2: extRef2:
type: string type: string
nullable: true
example: null example: null
nullable: true
extRef3: extRef3:
type: string type: string
nullable: true
example: 2025-02-17 example: 2025-02-17
nullable: true
extRef4: extRef4:
type: string type: string
nullable: true
example: null example: null
nullable: true
extRef5: extRef5:
type: string type: string
nullable: true
example: Webshop example: Webshop
nullable: true
extRef6: extRef6:
type: string type: string
nullable: true
example: null example: null
nullable: true
BookingLineMetadataPatchResponseBody: BookingLineMetadataPatchResponseBody:
type: object type: object
properties: properties: