DHIL-2644 - Processed review remarks.
This commit is contained in:
parent
e8353b78da
commit
3739eb33bd
@ -13,6 +13,13 @@ paths:
|
||||
tags:
|
||||
- Transactions v2
|
||||
parameters:
|
||||
- in: query
|
||||
name: transactionItemId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 75174a9d-fff4-4682-b66b-ebd93cbe7ea3
|
||||
description: The id of the transaction item.
|
||||
- in: query
|
||||
name: sourceName
|
||||
schema:
|
||||
@ -166,36 +173,6 @@ paths:
|
||||
example: 9834b346-d68c-438d-9bd5-6716422c2657
|
||||
required: true
|
||||
description: The id of the transaction item.
|
||||
get:
|
||||
summary: Get a single transaction item.
|
||||
description: Get a single transaction item.
|
||||
tags:
|
||||
- Transactions v2
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
|
||||
"sourceName": "Verkoopengine",
|
||||
"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",
|
||||
"productCode": "HTM-MND-20",
|
||||
"aggregationReference": "FIKO-123456",
|
||||
"accountingSystemReference": "U4F-123456",
|
||||
}
|
||||
patch:
|
||||
summary: Update a transaction item.
|
||||
description: Update a transaction item.
|
||||
@ -331,7 +308,6 @@ paths:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 498e11fd-86c7-4e26-8ca9-c5ed9049da9e
|
||||
required: true
|
||||
description: The id of the audit trail.
|
||||
- in: query
|
||||
name: transactionItemId
|
||||
@ -339,7 +315,6 @@ paths:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 9834b346-d68c-438d-9bd5-6716422c2657
|
||||
required: true
|
||||
description: The id of the transaction item.
|
||||
- in: query
|
||||
name: user
|
||||
@ -519,7 +494,7 @@ paths:
|
||||
"timestamp": "2022-01-01 00:00:00",
|
||||
"failureReason":
|
||||
{
|
||||
"failureReasonId": "122be602-139d-49f5-b34f-1e3e2de29408",
|
||||
"failureReasonId": 12,
|
||||
"reasonCode": "1234ABCD",
|
||||
"reasonDesc": "description",
|
||||
},
|
||||
@ -530,10 +505,118 @@ paths:
|
||||
],
|
||||
},
|
||||
]
|
||||
/processingfailures/{processingFailureId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: processingFailureId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the processing failure.
|
||||
patch:
|
||||
summary: Update processing failure.
|
||||
description: Update processing failure.
|
||||
tags:
|
||||
- Failures v2
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example: { "status": "open", "occurence": 2 }
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"processingFailureId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
/processingfailures/{processingFailureId}/processingfailureinstances:
|
||||
parameters:
|
||||
- in: path
|
||||
name: processingFailureId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the processing failure.
|
||||
post:
|
||||
summary: Add a processing failure instance to a processing failure.
|
||||
description: Add a processing failure instance to a processing failure.
|
||||
tags:
|
||||
- Failures v2
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"timestamp": "2022-01-01 00:00:00",
|
||||
"failureReasonId": 12,
|
||||
"element": "costCenter",
|
||||
"occurence": 1,
|
||||
"change": "Adapt config",
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"processingFailureInstanceId": "9afa9a6b-5b6a-4b0a-9c9e-4b0a5b6a4b0a",
|
||||
}
|
||||
/processingfailureinstances/{processingFailureInstanceId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: processingFailureInstanceId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the processing failure instance.
|
||||
patch:
|
||||
summary: Update processing failure instance.
|
||||
description: Update processing failure instance.
|
||||
tags:
|
||||
- Failures v2
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"timestamp": "2022-01-01 00:00:00",
|
||||
"occurence": 2,
|
||||
"change": "Adapt config",
|
||||
}
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"processingFailureInstanceId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
|
||||
}
|
||||
/productmetadata:
|
||||
get:
|
||||
summary: Get all product metadata.
|
||||
description: Get all product metadata.
|
||||
summary: Find product metadata.
|
||||
description: Find product metadata.
|
||||
tags:
|
||||
- Metadata v2
|
||||
parameters:
|
||||
@ -581,11 +664,17 @@ paths:
|
||||
example: VERK_FACTUUR
|
||||
description: The document code.
|
||||
- in: query
|
||||
name: timestampUpdated
|
||||
name: updatedBefore
|
||||
schema:
|
||||
type: string
|
||||
example: 2022-01-01 00:00:00
|
||||
description: The timestamp updated.
|
||||
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:
|
||||
@ -811,7 +900,9 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "productContraAccountId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61" }
|
||||
{
|
||||
"productContraAccountId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61",
|
||||
}
|
||||
/productmetadata/{productMetadataId}/metadataaudittrails:
|
||||
parameters:
|
||||
- in: path
|
||||
@ -832,7 +923,20 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/postMetadataAuditTrailRequest"
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"user": "rmeeuws",
|
||||
"timestamp": "2024-10-04T00:00:00",
|
||||
"correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
|
||||
"metadataChanges": [
|
||||
{
|
||||
"fieldName": "department",
|
||||
"oldValue": "900",
|
||||
"newValue": "999",
|
||||
}
|
||||
]
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -969,7 +1073,20 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/postMetadataAuditTrailRequest"
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"user": "rmeeuws",
|
||||
"timestamp": "2024-10-04T00:00:00",
|
||||
"correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
|
||||
"metadataChanges": [
|
||||
{
|
||||
"fieldName": "contraAccountMetadataId",
|
||||
"oldValue": "873810a3-a11a-4d4d-9af7-395520fa207c",
|
||||
"newValue": "9a8eb116-5270-4ef9-81ef-fdc2e72c281a",
|
||||
}
|
||||
]
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1136,7 +1253,20 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/postMetadataAuditTrailRequest"
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"user": "rmeeuws",
|
||||
"timestamp": "2024-10-04T00:00:00",
|
||||
"correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
|
||||
"metadataChanges": [
|
||||
{
|
||||
"fieldName": "taxCode",
|
||||
"oldValue": null,
|
||||
"newValue": "V21",
|
||||
}
|
||||
]
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1157,7 +1287,6 @@ paths:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the source metadata.
|
||||
- in: query
|
||||
name: incomingName
|
||||
@ -1314,7 +1443,20 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/postMetadataAuditTrailRequest"
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"user": "rmeeuws",
|
||||
"timestamp": "2024-10-04T00:00:00",
|
||||
"correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
|
||||
"metadataChanges": [
|
||||
{
|
||||
"fieldName": "businessOwner",
|
||||
"oldValue": "Corneel Verstoep",
|
||||
"newValue": "Mark Verheij",
|
||||
}
|
||||
]
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1439,7 +1581,20 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/postMetadataAuditTrailRequest"
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"user": "rmeeuws",
|
||||
"timestamp": "2024-10-04T00:00:00",
|
||||
"correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
|
||||
"metadataChanges": [
|
||||
{
|
||||
"fieldName": "isOpen",
|
||||
"oldValue": "true",
|
||||
"newValue": "false",
|
||||
}
|
||||
]
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1460,7 +1615,6 @@ paths:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the concession metadata.
|
||||
- in: query
|
||||
name: concessionId
|
||||
@ -1594,7 +1748,20 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/postMetadataAuditTrailRequest"
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"user": "rmeeuws",
|
||||
"timestamp": "2024-10-04T00:00:00",
|
||||
"correlationId": "a03cd0c2-38b5-4619-b9e3-d6e5b842e127",
|
||||
"metadataChanges": [
|
||||
{
|
||||
"fieldName": "percentage",
|
||||
"oldValue": null,
|
||||
"newValue": "23.456",
|
||||
},
|
||||
],
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -1615,7 +1782,6 @@ paths:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the metadata audit trail.
|
||||
- in: query
|
||||
name: productMetadataId
|
||||
@ -1792,34 +1958,6 @@ components:
|
||||
example:
|
||||
- "/account/12345"
|
||||
- "/account/67890"
|
||||
postMetadataAuditTrailRequest:
|
||||
type: object
|
||||
properties:
|
||||
user:
|
||||
type: string
|
||||
example: rmeeuws
|
||||
timestamp:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T00:00:00
|
||||
correlationId:
|
||||
type: string
|
||||
format: uuid
|
||||
example: a03cd0c2-38b5-4619-b9e3-d6e5b842e127
|
||||
metadataChanges:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
fieldName:
|
||||
type: string
|
||||
example: businessOwner
|
||||
oldValue:
|
||||
type: string
|
||||
example: Corneel Verstoep
|
||||
newValue:
|
||||
type: string
|
||||
example: Jan-Willem Vermeij
|
||||
postMetadataAuditTrailResponse:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user