OVPAY-879 - Added bodies for creating trx.

This commit is contained in:
Bas Boterman 2024-12-02 14:03:58 +01:00
parent 24a4ac14d2
commit c000bf1e6e

View File

@ -123,6 +123,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"transactionItems":
[ [
{ {
"transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d", "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
@ -141,7 +143,26 @@ paths:
"aggregationReference": "FIKO-123456", "aggregationReference": "FIKO-123456",
"accountingSystemReference": "U4F-123456", "accountingSystemReference": "U4F-123456",
}, },
] {
"transactionItemId": "e63cc37b-4d87-4278-8eb5-1477e07edf3d",
"sourceName": "Verkoopengine",
"transactionId": "1001237",
"transactionLineId": "1",
"name": "HTM Maandkorting 20%",
"quantity": 1,
"taxCode": "V21",
"amountExclTax": 100,
"amountInclTax": 121,
"amountTax": 21,
"occurredOn": "2024-10-04T00:05:00Z",
"type": "debit",
"productCode": "HTM-MND-20",
"aggregationReference": "FIKO-123456",
"accountingSystemReference": "U4F-123456",
},
],
"href": null,
}
post: post:
summary: Add a finanicial transaction item. summary: Add a finanicial transaction item.
description: Add a finanicial transaction item. description: Add a finanicial transaction item.
@ -153,7 +174,23 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: "TBD" example:
{
"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",
}
responses: responses:
"201": "201":
description: Created description: Created
@ -163,6 +200,69 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d" } { "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d" }
/transactionitems/bulk:
post:
summary: Add one ore more finanicial transaction items in bulk.
description: Add one ore more finanicial transaction items in bulk.
tags:
- Transactions v2
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
[
{
"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": null,
"accountingSystemReference": null,
},
{
"sourceName": "Verkoopengine",
"transactionId": "1001237",
"transactionLineId": "1",
"name": "HTM Maandkorting 20%",
"quantity": 1,
"taxCode": "V21",
"amountExclTax": 100,
"amountInclTax": 121,
"amountTax": 21,
"occurredOn": "2024-10-04T00:05:00Z",
"type": "debit",
"productCode": "HTM-MND-20",
"aggregationReference": null,
"accountingSystemReference": null,
},
]
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
[
{
"transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
},
{
"transactionItemId": "e63cc37b-4d87-4278-8eb5-1477e07edf3d",
},
]
/transactionitems/{transactionItemId}: /transactionitems/{transactionItemId}:
parameters: parameters:
- in: path - in: path
@ -362,6 +462,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"transactionAuditTrails":
[ [
{ {
"transactionAuditTrailId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d", "transactionAuditTrailId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
@ -372,7 +474,18 @@ paths:
"description": "Transaction created.", "description": "Transaction created.",
"correlationId": "a3891560-3084-42cb-867c-f289e7cda47d", "correlationId": "a3891560-3084-42cb-867c-f289e7cda47d",
}, },
] {
"transactionAuditTrailId": "e63cc37b-4d87-4278-8eb5-1477e07edf3d",
"transactionItemId": "d667d293-aa82-4c9e-9b10-77cffc9058a1",
"user": "fiko",
"timestamp": "2022-01-01 00:01:00",
"action": "processed",
"description": "Transaction processed.",
"correlationId": "3e9d7d4b-8adf-4e7f-8251-be308f16d3de",
},
],
"href": null,
}
/processingfailures: /processingfailures:
get: get:
summary: Find processing failures. summary: Find processing failures.
@ -472,6 +585,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"processingFailures":
[ [
{ {
"processingFailureId": "37a8095b-19db-498f-9349-5f37d21c5bdf", "processingFailureId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
@ -504,7 +619,9 @@ paths:
}, },
], ],
}, },
] ],
"href": null,
}
/processingfailures/{processingFailureId}: /processingfailures/{processingFailureId}:
parameters: parameters:
- in: path - in: path
@ -709,6 +826,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"productMetadata":
[
{ {
"productMetadataId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61", "productMetadataId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61",
"productCode": "4031", "productCode": "4031",
@ -731,7 +851,8 @@ paths:
"validFrom": "2024-03-22T09:00:00", "validFrom": "2024-03-22T09:00:00",
"validUntil": null, "validUntil": null,
}, },
"concession": { "concessionId": 2, "name": "bus" }, "concession":
{ "concessionId": 2, "name": "bus" },
"sourceMetadata": "sourceMetadata":
{ {
"sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", "sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0",
@ -756,7 +877,8 @@ paths:
"validFrom": "2024-03-22T09:00:00", "validFrom": "2024-03-22T09:00:00",
"validUntil": null, "validUntil": null,
}, },
"concession": { "concessionId": 1, "name": "bus" }, "concession":
{ "concessionId": 1, "name": "bus" },
"sourceMetadata": "sourceMetadata":
{ {
"sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", "sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0",
@ -773,6 +895,9 @@ paths:
"validUntil": null, "validUntil": null,
}, },
], ],
},
],
"href": null,
} }
post: post:
summary: Add product metadata. summary: Add product metadata.
@ -988,6 +1113,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"contraAccountMetadata":
[ [
{ {
"contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", "contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
@ -996,7 +1123,9 @@ paths:
"validFrom": "2024-03-22T09:00:00", "validFrom": "2024-03-22T09:00:00",
"validUntil": null, "validUntil": null,
}, },
] ],
"href": null,
}
post: post:
summary: Add contra account metadata. summary: Add contra account metadata.
description: Add contra account metadata. description: Add contra account metadata.
@ -1153,6 +1282,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"taxMetadata":
[ [
{ {
"taxMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", "taxMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0",
@ -1178,7 +1309,9 @@ paths:
"validFrom": "2024-01-01T00:00:00.000", "validFrom": "2024-01-01T00:00:00.000",
"validUntil": null, "validUntil": null,
}, },
] ],
"href": null,
}
post: post:
summary: Add tax metadata. summary: Add tax metadata.
description: Add tax metadata. description: Add tax metadata.
@ -1351,6 +1484,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"sourceMetadata":
[ [
{ {
"sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0", "sourceMetadataId": "bc4ea24a-27a5-40e8-bbbc-57a105afaaa0",
@ -1363,7 +1498,9 @@ paths:
"validFrom": "2024-01-01T00:00:00.000", "validFrom": "2024-01-01T00:00:00.000",
"validUntil": null, "validUntil": null,
}, },
] ],
"href": null,
}
post: post:
summary: Add source metadata. summary: Add source metadata.
description: Add source metadata. description: Add source metadata.
@ -1512,13 +1649,22 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"accountingPeriodMetadata":
[ [
{ {
"accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", "accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
"accountingPeriod": "2024-01", "accountingPeriod": "2024-01",
"isOpen": false,
},
{
"accountingPeriodMetadataId": "0302c651-f040-4cbc-8a4d-90dc82f29a32",
"accountingPeriod": "2024-02",
"isOpen": true, "isOpen": true,
}, },
] ],
"href": null,
}
post: post:
summary: Add accounting period metadata. summary: Add accounting period metadata.
description: Add accounting period metadata. description: Add accounting period metadata.
@ -1659,6 +1805,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"concessionMetadata":
[ [
{ {
"concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", "concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
@ -1674,7 +1822,9 @@ paths:
"validFrom": "2024-01-01T00:00:00.000", "validFrom": "2024-01-01T00:00:00.000",
"validUntil": null, "validUntil": null,
}, },
] ],
"href": null,
}
post: post:
summary: Add concession metadata. summary: Add concession metadata.
description: Add concession metadata. description: Add concession metadata.
@ -1873,6 +2023,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"metadataAuditTrails":
[
{ {
"metadataAuditTrailId": "37a8095b-19db-498f-9349-5f37d21c5bdf", "metadataAuditTrailId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
"productMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf", "productMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
@ -1893,6 +2046,9 @@ paths:
"newValue": "Jan-Willem Vermeij", "newValue": "Jan-Willem Vermeij",
}, },
], ],
},
],
"href": null,
} }
/concessions: /concessions:
get: get:
@ -1908,11 +2064,15 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"concessions":
[ [
{ "concessionId": 1, "name": "rail" }, { "concessionId": 1, "name": "rail" },
{ "concessionId": 2, "name": "bus" }, { "concessionId": 2, "name": "bus" },
{ "concessionId": 3, "name": "not_applicable" }, { "concessionId": 3, "name": "not_applicable" },
] ],
"href": null,
}
/failurereasons: /failurereasons:
get: get:
summary: Get all failure reasons. summary: Get all failure reasons.
@ -1927,6 +2087,8 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{
"failureReasons":
[ [
{ {
"failureReasonId": 1, "failureReasonId": 1,
@ -1938,7 +2100,9 @@ paths:
"reasonCode": "003", "reasonCode": "003",
"reasonDesc": "Accouting period closed", "reasonDesc": "Accouting period closed",
}, },
] ],
"href": null,
}
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken: