DHIL-2644 - Added more metadata.
This commit is contained in:
parent
088420d8db
commit
3dc7cc9765
@ -221,7 +221,7 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "transactionItemId": "d667d293-aa82-4c9e-9b10-77cffc9058a1" }
|
||||
/transactionItems/{transactionItemId}/processingfailures:
|
||||
/transactionitems/{transactionItemId}/processingfailures:
|
||||
parameters:
|
||||
- in: path
|
||||
name: transactionItemId
|
||||
@ -278,7 +278,7 @@ paths:
|
||||
{
|
||||
"processingFailureId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
|
||||
}
|
||||
/transactionItems/{transactionItemId}/transactionAuditTrail:
|
||||
/transactionitems/{transactionItemId}/transactionaudittrail:
|
||||
parameters:
|
||||
- in: path
|
||||
name: transactionItemId
|
||||
@ -474,7 +474,7 @@ paths:
|
||||
],
|
||||
},
|
||||
]
|
||||
/productMetadata:
|
||||
/productmetadata:
|
||||
post:
|
||||
summary: Add product metadata.
|
||||
description: Add product metadata.
|
||||
@ -507,7 +507,7 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "productMetadataId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61" }
|
||||
/contraAccountMetadata:
|
||||
/contraaccountmetadata:
|
||||
get:
|
||||
summary: Get contra account metadata.
|
||||
description: Get contra account metadata.
|
||||
@ -533,14 +533,7 @@ paths:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-03-22T09:00:00
|
||||
description: The valid from date of the metadata.
|
||||
- in: query
|
||||
name: validUntil
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-03-22T09:00:00
|
||||
description: The valid until date of the metadata.
|
||||
description: Timestamp that the metadata is valid.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -585,7 +578,7 @@ paths:
|
||||
{
|
||||
"contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
/contraAccountMetadata/{contraAccountMetadataId}:
|
||||
/contraaccountmetadata/{contraAccountMetadataId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: contraAccountMetadataId
|
||||
@ -623,7 +616,7 @@ paths:
|
||||
{
|
||||
"contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
/taxMetadata:
|
||||
/taxmetadata:
|
||||
get:
|
||||
summary: Get tax metadata.
|
||||
description: Get tax metadata.
|
||||
@ -661,7 +654,7 @@ paths:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-03-22T09:00:00
|
||||
description: Date that the tax metadata is valid.
|
||||
description: Timestamp that the metadata is valid.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -724,7 +717,7 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "taxMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" }
|
||||
/taxMetadata/{taxMetadataId}:
|
||||
/taxmetadata/{taxMetadataId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: taxMetadataId
|
||||
@ -762,12 +755,63 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "taxMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" }
|
||||
/sourceMetadata:
|
||||
/sourcemetadata:
|
||||
get:
|
||||
summary: Get source metadata.
|
||||
description: Get source metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
parameters:
|
||||
- in: query
|
||||
name: sourceMetadataId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the source metadata.
|
||||
- in: query
|
||||
name: incomingName
|
||||
schema:
|
||||
type: string
|
||||
example: VerkoopEngine
|
||||
description: The name of the source.
|
||||
- in: query
|
||||
name: incomingEntity
|
||||
schema:
|
||||
type: string
|
||||
example: OrderLine
|
||||
description: The entity of the source.
|
||||
- in: query
|
||||
name: outgoingName
|
||||
schema:
|
||||
type: string
|
||||
example: Website Verkopen
|
||||
description: The name of the destination.
|
||||
- in: query
|
||||
name: businessOwner
|
||||
schema:
|
||||
type: string
|
||||
example: Corneel Verstoep
|
||||
description: The business owner of the source.
|
||||
- in: query
|
||||
name: rejectionProcessing
|
||||
schema:
|
||||
type: string
|
||||
example: system
|
||||
description: The rejection processing of the source.
|
||||
- in: query
|
||||
name: rejectionInfo
|
||||
schema:
|
||||
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
|
||||
@ -820,7 +864,7 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "sourceMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" }
|
||||
/sourceMetadata/{sourceMetadataId}:
|
||||
/sourcemetadata/{sourceMetadataId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: sourceMetadataId
|
||||
@ -861,6 +905,228 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "sourceMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" }
|
||||
/accountingperiodmetadata:
|
||||
get:
|
||||
summary: Get accounting period metadata.
|
||||
description: Get accounting period metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
parameters:
|
||||
- in: query
|
||||
name: accountingPeriodMetadataId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
description: The id of the accounting period metadata.
|
||||
- in: query
|
||||
name: accountingPeriod
|
||||
schema:
|
||||
type: string
|
||||
example: 2024-01
|
||||
description: The accounting period.
|
||||
- in: query
|
||||
name: isOpen
|
||||
schema:
|
||||
type: boolean
|
||||
example: true
|
||||
description: Whether the accounting period is open.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
[
|
||||
{
|
||||
"accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
"accountingPeriod": "2024-01",
|
||||
"isOpen": true,
|
||||
},
|
||||
]
|
||||
post:
|
||||
summary: Add accounting period metadata.
|
||||
description: Add accounting period metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example: { "accountingPeriod": "2024-01", "isOpen": true }
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
/accountingperiodmetadata/{accountingPeriodMetadataId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: accountingPeriodMetadataId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the accounting period metadata.
|
||||
patch:
|
||||
summary: Update accounting period metadata.
|
||||
description: Update accounting period metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example: { "accountingPeriod": "2024-01", "isOpen": true }
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
/concessionmetadata:
|
||||
get:
|
||||
summary: Get concession metadata.
|
||||
description: Get concession metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
parameters:
|
||||
- in: query
|
||||
name: concessionMetadataId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the concession metadata.
|
||||
- in: query
|
||||
name: concessionId
|
||||
schema:
|
||||
type: integer
|
||||
example: 1
|
||||
description: The id of the concession.
|
||||
- in: query
|
||||
name: percentage
|
||||
schema:
|
||||
type: number
|
||||
example: 84.021
|
||||
description: The percentage of the concession.
|
||||
- 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
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
[
|
||||
{
|
||||
"concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
"concession": { "concessionId": 1, "name": "RAIL" },
|
||||
"percentage": 84.021,
|
||||
"validFrom": "2024-01-01T00:00:00.000",
|
||||
"validUntil": null,
|
||||
},
|
||||
{
|
||||
"concessionMetadataId": "5ac3a5a8-4b9b-4a6a-9b1f-86ae8d6d4a9b",
|
||||
"concession": { "concessionId": 2, "name": "BUS" },
|
||||
"percentage": 15.979,
|
||||
"validFrom": "2024-01-01T00:00:00.000",
|
||||
"validUntil": null,
|
||||
},
|
||||
]
|
||||
post:
|
||||
summary: Add concession metadata.
|
||||
description: Add concession metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"concessionId": 2,
|
||||
"percentage": 15.979,
|
||||
"validFrom": "2024-01-01T00:00:00.000",
|
||||
"validUntil": null,
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
/concessionmetadata/{concessionMetadataId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: concessionMetadataId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the concession metadata.
|
||||
patch:
|
||||
summary: Update concession metadata.
|
||||
description: Update concession metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"concessionId": 2,
|
||||
"percentage": 15.979,
|
||||
"validFrom": "2024-01-01T00:00:00.000",
|
||||
"validUntil": null,
|
||||
}
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerToken:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user