HTM/ovpay
6
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

updates to processingFailure and transactionAuditTrail POST calls and GETS, consistency

Browse Source
This commit is contained in:
Mirjam Herald 2026-07-31 09:48:25 +02:00
parent f0c216be9b
commit f7975ed5a1
1 changed files with 50 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
src/openapi/fiko/fiko-crud.yaml
View File

@ -49,6 +49,8 @@ paths:
- status - status
- aggregationReference - aggregationReference
- accountingSystemReference - accountingSystemReference
- createdOn
- lastUpdatedOn
- name: $select - name: $select
in: query in: query
description: Select properties to be returned description: Select properties to be returned
@ -79,6 +81,8 @@ paths:
- status - status
- aggregationReference - aggregationReference
- accountingSystemReference - accountingSystemReference
- createdOn
- lastUpdatedOn
responses: responses:
"200": "200":
description: OK description: OK
@ -118,6 +122,8 @@ paths:
status: created status: created
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
createdOn: 2024-11-04T00:00:00Z
lastUpdatedOn: 2024-11-04T04:00:00Z
- "@odata.etag": e671c8a1-b918-4867-bf12-5289822479c3 - "@odata.etag": e671c8a1-b918-4867-bf12-5289822479c3
transactionItemRowId: 3232 transactionItemRowId: 3232
transactionItemId: 1c1fc1c8-57f4-4336-9b43-a974eae5afbf transactionItemId: 1c1fc1c8-57f4-4336-9b43-a974eae5afbf
@ -137,6 +143,8 @@ paths:
status: failed status: failed
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
createdOn: 2024-11-04T00:00:00Z
lastUpdatedOn: 2024-11-04T04:00:00Z
- "@odata.etag": be2715d4-4eff-4562-9bf3-5c43ad23e2c8 - "@odata.etag": be2715d4-4eff-4562-9bf3-5c43ad23e2c8
transactionItemRowId: 3233 transactionItemRowId: 3233
transactionItemId: 3f58441e-dc8f-4956-9bc5-c952312476db transactionItemId: 3f58441e-dc8f-4956-9bc5-c952312476db
@ -156,6 +164,8 @@ paths:
status: returned to src status: returned to src
aggregationReference: FIKO-171f40609e aggregationReference: FIKO-171f40609e
accountingSystemReference: null accountingSystemReference: null
createdOn: 2024-11-04T00:00:00Z
lastUpdatedOn: 2024-11-04T04:00:00Z
- "@odata.etag": 52130c4d-e944-4454-a73e-8d55449a4bd1 - "@odata.etag": 52130c4d-e944-4454-a73e-8d55449a4bd1
transactionItemRowId: 3234 transactionItemRowId: 3234
transactionItemId: 4418825f-3f9b-45bc-b662-dc3cd4ce6599 transactionItemId: 4418825f-3f9b-45bc-b662-dc3cd4ce6599
@ -175,6 +185,8 @@ paths:
status: returned to trx-db status: returned to trx-db
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
createdOn: 2024-11-04T00:00:00Z
lastUpdatedOn: 2024-11-04T04:00:00Z
- "@odata.etag": 7da305e1-85cd-4250-ad77-8b54b2649cfb - "@odata.etag": 7da305e1-85cd-4250-ad77-8b54b2649cfb
transactionItemRowId: 3235 transactionItemRowId: 3235
transactionItemId: 2ddc1831-cf7b-4a77-8aa1-11aaf8e98d9f transactionItemId: 2ddc1831-cf7b-4a77-8aa1-11aaf8e98d9f
@ -194,6 +206,8 @@ paths:
status: re-entered status: re-entered
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
createdOn: 2024-11-04T00:00:00Z
lastUpdatedOn: 2024-11-04T04:00:00Z
- "@odata.etag": c3b17d21-0506-474d-b3d4-7ff654f368b9 - "@odata.etag": c3b17d21-0506-474d-b3d4-7ff654f368b9
transactionItemRowId: 3236 transactionItemRowId: 3236
transactionItemId: 5ab2513d-f334-4cf8-8895-4e7269374a4b transactionItemId: 5ab2513d-f334-4cf8-8895-4e7269374a4b
@ -213,6 +227,8 @@ paths:
status: succeeded status: succeeded
aggregationReference: FIKO-6a4fca8cd6 aggregationReference: FIKO-6a4fca8cd6
accountingSystemReference: U4F-123456 accountingSystemReference: U4F-123456
createdOn: 2024-11-04T00:00:00Z
lastUpdatedOn: 2024-11-04T04:00:00Z
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -576,6 +592,7 @@ paths:
- action - action
- status - status
- correlationId - correlationId
- journalEntryId
- name: $select - name: $select
in: query in: query
description: Select properties to be returned description: Select properties to be returned
@ -596,6 +613,7 @@ paths:
- action - action
- status - status
- correlationId - correlationId
- journalEntryId
- name: $expand - name: $expand
in: query in: query
description: Expand related entities description: Expand related entities
@ -609,6 +627,7 @@ paths:
type: string type: string
enum: enum:
- TransactionItem - TransactionItem
- JournalEntry
responses: responses:
"200": "200":
description: OK description: OK
@ -810,6 +829,7 @@ paths:
- reasonDescription - reasonDescription
- resolved - resolved
- change - change
- journalEntryId
- name: $select - name: $select
in: query in: query
description: Select properties to be returned description: Select properties to be returned
@ -832,6 +852,7 @@ paths:
- reasonDescription - reasonDescription
- resolved - resolved
- change - change
- journalEntryId
- name: $expand - name: $expand
in: query in: query
description: Expand related entities description: Expand related entities
@ -845,6 +866,7 @@ paths:
type: string type: string
enum: enum:
- TransactionItem - TransactionItem
- JournalEntry
responses: responses:
"200": "200":
description: OK description: OK
@ -880,6 +902,7 @@ paths:
reasonDescription: Cost type does not exist. reasonDescription: Cost type does not exist.
resolved: false resolved: false
change: null change: null
journalEntryId: null
- "@odata.etag": ff49829d-a5de-4c1a-b331-15fd9c71dfe9 - "@odata.etag": ff49829d-a5de-4c1a-b331-15fd9c71dfe9
processingFailureRowId: 10 processingFailureRowId: 10
processingFailureId: ccc06dc9-956d-47d8-bde7-9644ddde2193 processingFailureId: ccc06dc9-956d-47d8-bde7-9644ddde2193
@ -891,6 +914,7 @@ paths:
reasonDescription: Cost center does not exist. reasonDescription: Cost center does not exist.
resolved: true resolved: true
change: Adapt config change: Adapt config
journalEntryId: null
- "@odata.etag": 5d5d3351-d3f1-49b2-905f-4dbbe1cc30e3 - "@odata.etag": 5d5d3351-d3f1-49b2-905f-4dbbe1cc30e3
processingFailureRowId: 11 processingFailureRowId: 11
processingFailureId: 96bf8d44-0030-4509-b24e-2d62299779c5 processingFailureId: 96bf8d44-0030-4509-b24e-2d62299779c5
@ -902,6 +926,7 @@ paths:
reasonDescription: Department does not exist. reasonDescription: Department does not exist.
resolved: true resolved: true
change: Adapt config change: Adapt config
journalEntryId: null
List of unfiltered processing failures: List of unfiltered processing failures:
summary: List of unfiltered processing failures summary: List of unfiltered processing failures
description: | description: |
@ -921,6 +946,7 @@ paths:
reasonDescription: Transaction date is in the future reasonDescription: Transaction date is in the future
resolved: false resolved: false
change: null change: null
journalEntryId: null
- "@odata.etag": 584d3a8a-48bc-45f9-99be-8dd70399e6e4 - "@odata.etag": 584d3a8a-48bc-45f9-99be-8dd70399e6e4
processingFailureRowId: 10 processingFailureRowId: 10
processingFailureId: 76aa82e1-a10f-4664-a84f-1f30d60884b3 processingFailureId: 76aa82e1-a10f-4664-a84f-1f30d60884b3
@ -932,6 +958,7 @@ paths:
reasonDescription: Cost center does not exist. reasonDescription: Cost center does not exist.
resolved: false resolved: false
change: null change: null
journalEntryId: null
- "@odata.etag": df4ade9b-1bda-4d91-a5ba-4dbe067568a0 - "@odata.etag": df4ade9b-1bda-4d91-a5ba-4dbe067568a0
processingFailureRowId: 11 processingFailureRowId: 11
processingFailureId: 25d2dd6f-ae17-44a7-b7a5-43eaf6de78e1 processingFailureId: 25d2dd6f-ae17-44a7-b7a5-43eaf6de78e1
@ -943,6 +970,7 @@ paths:
reasonDescription: Department does not exist. reasonDescription: Department does not exist.
resolved: false resolved: false
change: null change: null
journalEntryId: null
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -995,8 +1023,8 @@ paths:
x-throttling-tier: Unlimited x-throttling-tier: Unlimited
/Odata/JournalEntry: /Odata/JournalEntry:
get: get:
summary: Find journal entry. summary: Find journalEntry.
description: Find journal entry. description: Find journalEntry.
tags: tags:
- Odata - Odata
parameters: parameters:
@ -1245,8 +1273,8 @@ paths:
x-throttling-tier: Unlimited x-throttling-tier: Unlimited
/journalEntry: /journalEntry:
post: post:
summary: Add a journal entry. summary: Add a journalEntry.
description: Add a journal entry. description: Add a journalEntry.
tags: tags:
- journalEntry v1.0 - journalEntry v1.0
requestBody: requestBody:
@ -1256,9 +1284,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/JournalEntryPostRequestBody" $ref: "#/components/schemas/JournalEntryPostRequestBody"
examples: examples:
Add a new journal entry: Add a new journalEntry:
summary: Add a new journal entry summary: Add a new journalEntry
description: In this example we add a new journal entry. description: In this example we add a new journalEntry.
value: value:
aggregationReference: FIKO-123456 aggregationReference: FIKO-123456
data: { data: {
@ -1352,7 +1380,7 @@ paths:
examples: examples:
Update an journalEntry after error: Update an journalEntry after error:
summary: Update an journalEntry after error summary: Update an journalEntry after error
description: Update an journalEntry after error bij logging the response description: Update an journalEntry after error by logging the response
value: value:
response: { response: {
"status": "failed", "status": "failed",
@ -1372,8 +1400,8 @@ paths:
] ]
} }
Update an journalEntry after success: Update an journalEntry after success:
summary: Update an journalEntry after error summary: Update an journalEntry after succesfull call
description: Update an journalEntry after error bij logging the response description: Update an journalEntry after uccesfull call bij logging the response and the accountingSystemReference.
value: value:
accountingSystemReference: "OPBR-FIKO10000090" accountingSystemReference: "OPBR-FIKO10000090"
response: { response: {