develop #38

Merged
bboterm merged 451 commits from develop into main 2025-11-19 14:28:14 +00:00
Showing only changes of commit 7a50655408 - Show all commits

View File

@ -421,356 +421,6 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ProcessingFailuresPatchResponseBody" $ref: "#/components/schemas/ProcessingFailuresPatchResponseBody"
/productmetadata:
get:
summary: Find product metadata.
description: Find product metadata.
tags:
- Metadata v2
parameters:
- 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: productCode
schema:
type: string
example: 4031
description: The product code.
- in: query
name: department
schema:
type: string
example: 900
description: The department.
- 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.
- in: query
name: documentCode
schema:
type: string
example: VERK_FACTUUR
description: The document code.
- in: query
name: updatedBefore
schema:
type: string
example: 2022-01-01 00:00:00
description: Timestamp that the metadata was updated before.
- in: query
name: updatedAfter
schema:
type: string
example: 2022-01-01 00:00:00
description: Timestamp that the metadata was updated after.
- in: query
name: validAt
schema:
type: string
example: 2024-03-22T09:00:00
description: Timestamp that the metadata is valid.
- in: query
name: contraAccountMetadataId
schema:
type: string
format: uuid
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
description: Find product metadata that is linked to this contra account.
- in: query
name: concessionId
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
description: Find product metadata that is linked to this 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
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
description: Find product metadata that is linked to this 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.
- in: query
name: validAt
schema:
type: string
example: 2024-03-22T09:00:00
description: Timestamp that the metadata is valid.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ProductContraAccountsGetResponseBody"
/productcontraaccounts/{productContraAccountId}:
parameters:
- in: path
name: productContraAccountId
schema:
type: string
format: uuid
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
required: true
description: The id of the product contra account.
patch:
summary: Update product contra account.
description: Update product contra account.
tags:
- Metadata v2
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ProductContraAccountsPatchRequestBody"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ProductContraAccountsPatchResponseBody"
/contraaccountmetadata:
get:
summary: Find contra account metadata.
description: Find contra account 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.
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: /taxmetadata:
get: get:
summary: Find tax metadata. summary: Find tax metadata.
@ -1069,14 +719,14 @@ paths:
example: 37a8095b-19db-498f-9349-5f37d21c5bdf example: 37a8095b-19db-498f-9349-5f37d21c5bdf
description: The id of the concession metadata. description: The id of the concession metadata.
- in: query - in: query
name: concessionId name: concession
schema: schema:
type: array type: array
items: items:
type: integer type: string
example: [1, 2] example: [BUS, RAIL]
explode: false explode: false
description: The id of the concession. description: The concession.
- in: query - in: query
name: percentage name: percentage
schema: schema:
@ -1254,19 +904,6 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/MetadataAuditTrailsPostResponseBody" $ref: "#/components/schemas/MetadataAuditTrailsPostResponseBody"
/concessions:
get:
summary: Get all concessions.
description: Get all concessions.
tags:
- References v2
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ConcessionsGetResponseBody"
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken:
@ -1926,366 +1563,6 @@ components:
example: b6161270-eb08-4242-90ec-967d5db62070 example: b6161270-eb08-4242-90ec-967d5db62070
required: required:
- metadataAuditTrailId - 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: TaxMetadataGetResponseBody:
type: object type: object
properties: properties:
@ -2567,10 +1844,14 @@ components:
properties: properties:
concessionMetadataId: concessionMetadataId:
type: string type: string
format: uuid format: en
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
concession: concession:
$ref: '#/components/schemas/Concession' type: string
enum:
- RAIL
- BUS
example: RAIL
percentage: percentage:
type: number type: number
example: 84.021 example: 84.021
@ -2596,9 +1877,12 @@ components:
ConcessionMetadataPostRequestBody: ConcessionMetadataPostRequestBody:
type: object type: object
properties: properties:
concessionId: concession:
type: integer type: string
example: 1 enum:
- RAIL
- BUS
example: RAIL
percentage: percentage:
type: number type: number
example: 84.021 example: 84.021
@ -2612,7 +1896,7 @@ components:
nullable: true nullable: true
example: null example: null
required: required:
- concessionId - concession
- percentage - percentage
- validFrom - validFrom
ConcessionMetadataPostResponseBody: ConcessionMetadataPostResponseBody:
@ -2627,9 +1911,12 @@ components:
ConcessionMetadataPatchRequestBody: ConcessionMetadataPatchRequestBody:
type: object type: object
properties: properties:
concessionId: concession:
type: integer type: string
example: 1 enum:
- RAIL
- BUS
example: RAIL
percentage: percentage:
type: number type: number
example: 84.021 example: 84.021
@ -2651,56 +1938,6 @@ components:
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
required: required:
- concessionMetadataId - concessionMetadataId
ConcessionsGetResponseBody:
type: object
properties:
concessions:
type: array
items:
$ref: '#/components/schemas/Concession'
href:
type: string
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:
concessionId:
type: integer
example: 1
name:
type: string
example: bus
required:
- concessionId
SourceMetadata: SourceMetadata:
type: object type: object
properties: properties: