develop #38
@ -986,6 +986,15 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingProcessesPostRequestBody"
|
||||
examples:
|
||||
Add a new booking process:
|
||||
summary: Add a new booking process
|
||||
description: |
|
||||
This example shows how a new booking process for purchase orders can be added.
|
||||
value:
|
||||
name: Inkooptransacties
|
||||
transactionType: purchase
|
||||
identifyingFieldName: articleNumber
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -993,6 +1002,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingProcessesPostResponseBody"
|
||||
examples:
|
||||
New booking process added successfully:
|
||||
summary: New booking process added successfully
|
||||
description: The new booking process was successfully added to the database.
|
||||
value:
|
||||
bookingProcessId: 03105285-3c4c-477a-821c-0fae801d9d26
|
||||
/bookingprocesses/{bookingProcessId}:
|
||||
parameters:
|
||||
- in: path
|
||||
@ -1014,6 +1029,13 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingProcessesPatchRequestBody"
|
||||
examples:
|
||||
Update a booking process:
|
||||
summary: Update a booking process
|
||||
description: |
|
||||
This example shows how a booking process can be updated.
|
||||
value:
|
||||
identifyingFieldName: orderNumber
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -1021,6 +1043,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingProcessesPatchResponseBody"
|
||||
examples:
|
||||
Booking process successfully updated:
|
||||
summary: Booking process successfully updated
|
||||
description: The booking process was successfully updated in the database.
|
||||
value:
|
||||
bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
/bookingprocesses/{bookingProcessId}/bookingmetadata:
|
||||
parameters:
|
||||
- in: path
|
||||
@ -1042,6 +1070,22 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingMetadataPostRequestBody"
|
||||
examples:
|
||||
Add a new booking metadata:
|
||||
summary: Add a new booking metadata
|
||||
description: |
|
||||
This example shows how a new booking metadata for a booking process can be added.
|
||||
value:
|
||||
description: Saldoreizen
|
||||
department: 900
|
||||
costType: 84955
|
||||
documentCode: OPBR-FIKO
|
||||
hasSeparateTaxLine: true
|
||||
hasLinePerIdentifyingField: false
|
||||
hasLinePerSource: true
|
||||
hasLinePerConcession: true
|
||||
validFrom: 2024-03-22T09:00:00
|
||||
validUntil: null
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1049,6 +1093,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingMetadataPostResponseBody"
|
||||
examples:
|
||||
New booking metadata added successfully:
|
||||
summary: New booking metadata added successfully
|
||||
description: The new booking metadata was successfully added to the database.
|
||||
value:
|
||||
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
|
||||
/bookingmetadata:
|
||||
get:
|
||||
summary: Find booking metadata.
|
||||
@ -1148,7 +1198,7 @@ paths:
|
||||
hasLinePerSource: true
|
||||
hasLinePerConcession: true
|
||||
validFrom: 2022-01-01 00:00:00
|
||||
validTo: null
|
||||
validUntil: null
|
||||
- bookingMetadataId: bd290c3f-4a27-4898-911e-1aadacc4a034
|
||||
bookingProcessId: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
description: Saldoreizen
|
||||
@ -1160,7 +1210,7 @@ paths:
|
||||
hasLinePerSource: true
|
||||
hasLinePerConcession: true
|
||||
validFrom: 2022-01-01 00:00:00
|
||||
validTo: null
|
||||
validUntil: null
|
||||
href: null
|
||||
/bookingmetadata/{bookingMetadataId}:
|
||||
parameters:
|
||||
@ -1183,6 +1233,13 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingMetadataPatchRequestBody"
|
||||
examples:
|
||||
Update booking metadata:
|
||||
summary: Update booking metadata
|
||||
description: |
|
||||
In this example the booking metadata is updated. The validUntil field is updated to 2024-03-22T09:00:00.
|
||||
value:
|
||||
validUntil: 2024-03-22T09:00:00
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -1190,6 +1247,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingMetadataPatchResponseBody"
|
||||
examples:
|
||||
Booking metadata updated successfully:
|
||||
summary: Booking metadata updated successfully
|
||||
description: The booking metadata was successfully updated in the database.
|
||||
value:
|
||||
bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
|
||||
/bookingmetadata/{bookingMetadataId}/bookinggroupfields:
|
||||
parameters:
|
||||
- in: path
|
||||
@ -1211,6 +1274,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingGroupFieldsPostRequestBody"
|
||||
examples:
|
||||
Add a new booking group field:
|
||||
summary: Add a new booking group field
|
||||
description: Add a new booking group field to an existing booking.
|
||||
value:
|
||||
identifyingFieldValue: 4135
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1218,6 +1287,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingGroupFieldsPostResponseBody"
|
||||
examples:
|
||||
New booking group field added successfully:
|
||||
summary: New booking group field added successfully
|
||||
description: The new booking group field was successfully added to the database.
|
||||
value:
|
||||
bookingGroupFieldId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
|
||||
/bookingmetadata/{bookingMetadataId}/bookinglinemetadata:
|
||||
parameters:
|
||||
- in: path
|
||||
@ -1239,6 +1314,43 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingLineMetadataPostRequestBody"
|
||||
examples:
|
||||
Add a new tax booking line metadata:
|
||||
summary: Add a new tax booking line metadata
|
||||
description: In this example a new tax booking line metadata is added to an existing booking.
|
||||
value:
|
||||
name: Saldoreizen - BTW
|
||||
sourceMetadataId: null
|
||||
identifyingFieldValue: null
|
||||
concessionId: null
|
||||
lineType: tax
|
||||
lineSense: credit
|
||||
costCenter: 603031
|
||||
articleName: null
|
||||
extRef1: null
|
||||
extRef2: null
|
||||
extRef3: null
|
||||
extRef4: null
|
||||
extRef5: TLS
|
||||
extRef6: null
|
||||
Add a new yield booking line metadata:
|
||||
summary: Add a new yield booking line metadata
|
||||
description: In this example a new yield booking line metadata is added to an existing booking.
|
||||
value:
|
||||
name: Opbrengst Saldoreizen - RAIL
|
||||
sourceMetadataId: null
|
||||
identifyingFieldValue: null
|
||||
concessionId: 1
|
||||
lineType: analysis
|
||||
lineSense: credit
|
||||
costCenter: 603031
|
||||
articleName: Saldoreizen
|
||||
extRef1: null
|
||||
extRef2: null
|
||||
extRef3: 2025-02-17
|
||||
extRef4: null
|
||||
extRef5: TLS
|
||||
extRef6: null
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1246,6 +1358,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingLineMetadataPostResponseBody"
|
||||
examples:
|
||||
New booking line metadata added successfully:
|
||||
summary: New booking line metadata added successfully
|
||||
description: The new booking line metadata was successfully added to the database.
|
||||
value:
|
||||
bookingLineMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
|
||||
/bookinggroupfields:
|
||||
get:
|
||||
summary: Find booking group fields.
|
||||
@ -1679,6 +1797,13 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingLineMetadataPatchRequestBody"
|
||||
examples:
|
||||
Update cost center of a booking line:
|
||||
summary: Update cost center of a booking line
|
||||
description: |
|
||||
In this example the cost center of an existing booking line metadata is updated.
|
||||
value:
|
||||
costCenter: 84957
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -1686,6 +1811,12 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BookingLineMetadataPatchResponseBody"
|
||||
examples:
|
||||
Booking line metadata updated successfully:
|
||||
summary: Booking line metadata updated successfully
|
||||
description: The booking line metadata was successfully updated in the database.
|
||||
value:
|
||||
bookingLineMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
|
||||
delete:
|
||||
summary: Delete booking line metadata.
|
||||
description: Delete booking line metadata.
|
||||
@ -2999,7 +3130,7 @@ components:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2022-01-01 00:00:00
|
||||
validTo:
|
||||
validUntil:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
@ -3053,7 +3184,7 @@ components:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2022-01-01 00:00:00
|
||||
validTo:
|
||||
validUntil:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
@ -3117,7 +3248,7 @@ components:
|
||||
format: date-time
|
||||
nullable: true
|
||||
example: 2022-01-01 00:00:00
|
||||
validTo:
|
||||
validUntil:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
@ -3272,7 +3403,7 @@ components:
|
||||
example: 12b4d128-0ab8-4a4a-944d-25b83de38b27
|
||||
name:
|
||||
type: string
|
||||
example: Dagkaart - BUS
|
||||
example: Dagkaart - RAIL
|
||||
sourceMetadata:
|
||||
type: object
|
||||
$ref: "#/components/schemas/SourceMetadata"
|
||||
@ -3346,7 +3477,7 @@ components:
|
||||
name:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Dagkaart - BUS
|
||||
example: Dagkaart - RAIL
|
||||
sourceMetadataId:
|
||||
type: string
|
||||
format: uuid
|
||||
|
||||
Loading…
Reference in New Issue
Block a user