Merge pull request 'features/OVPAY2790-journalentryFiko' (#65) from features/OVPAY2790-journalentryFiko into develop
Reviewed-on: #65
This commit is contained in:
commit
c1bb52277e
@ -49,6 +49,8 @@ paths:
|
||||
- status
|
||||
- aggregationReference
|
||||
- accountingSystemReference
|
||||
- createdOn
|
||||
- lastUpdatedOn
|
||||
- name: $select
|
||||
in: query
|
||||
description: Select properties to be returned
|
||||
@ -79,6 +81,8 @@ paths:
|
||||
- status
|
||||
- aggregationReference
|
||||
- accountingSystemReference
|
||||
- createdOn
|
||||
- lastUpdatedOn
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -117,7 +121,9 @@ paths:
|
||||
articleNumber: "4031"
|
||||
status: created
|
||||
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
|
||||
transactionItemRowId: 3232
|
||||
transactionItemId: 1c1fc1c8-57f4-4336-9b43-a974eae5afbf
|
||||
@ -136,7 +142,9 @@ paths:
|
||||
articleNumber: "4051"
|
||||
status: failed
|
||||
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
|
||||
transactionItemRowId: 3233
|
||||
transactionItemId: 3f58441e-dc8f-4956-9bc5-c952312476db
|
||||
@ -155,7 +163,9 @@ paths:
|
||||
articleNumber: "4051"
|
||||
status: returned to src
|
||||
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
|
||||
transactionItemRowId: 3234
|
||||
transactionItemId: 4418825f-3f9b-45bc-b662-dc3cd4ce6599
|
||||
@ -174,7 +184,9 @@ paths:
|
||||
articleNumber: "4051"
|
||||
status: returned to trx-db
|
||||
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
|
||||
transactionItemRowId: 3235
|
||||
transactionItemId: 2ddc1831-cf7b-4a77-8aa1-11aaf8e98d9f
|
||||
@ -193,7 +205,9 @@ paths:
|
||||
articleNumber: "4051"
|
||||
status: re-entered
|
||||
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
|
||||
transactionItemRowId: 3236
|
||||
transactionItemId: 5ab2513d-f334-4cf8-8895-4e7269374a4b
|
||||
@ -212,7 +226,9 @@ paths:
|
||||
articleNumber: "1737"
|
||||
status: succeeded
|
||||
aggregationReference: FIKO-6a4fca8cd6
|
||||
accountingSystemReference: U4F-123456
|
||||
accountingSystemReference: U4F-123456
|
||||
createdOn: 2024-11-04T00:00:00Z
|
||||
lastUpdatedOn: 2024-11-04T04:00:00Z
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
@ -434,7 +450,7 @@ paths:
|
||||
summary: Add a processing failure.
|
||||
description: Add a processing failure.
|
||||
tags:
|
||||
- Failures v2.2
|
||||
- Failures v2.3
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
@ -455,6 +471,7 @@ paths:
|
||||
reasonCode: "012"
|
||||
reasonDescription: Transaction date is in the future.
|
||||
resolved: false
|
||||
journalEntryId: 0e53b984-16b2-4ef7-b669-29bcdad2a3ce
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -472,67 +489,6 @@ paths:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/transactionitems/{transactionItemId}/transactionaudittrails:
|
||||
parameters:
|
||||
- in: path
|
||||
name: transactionItemId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 9834b346-d68c-438d-9bd5-6716422c2657
|
||||
required: true
|
||||
description: The id of the transaction item to process.
|
||||
post:
|
||||
summary: Add an audit trail entry.
|
||||
description: Add an audit trail entry.
|
||||
tags:
|
||||
- Audit Trail v2.2
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/TransactionAuditTrailsPostRequestBody"
|
||||
examples:
|
||||
Add new transaction audit trail for created transaction item:
|
||||
summary: Add new transaction audit trail for created transaction item
|
||||
description: Add a new audit trail record for a newly created transaction item.
|
||||
value:
|
||||
user: fiko
|
||||
timestamp: 2022-01-01 12:34:00
|
||||
action: create
|
||||
status: created
|
||||
description: Transaction item created.
|
||||
correlationId: null
|
||||
Add new transaction audit trail for updated transaction item:
|
||||
summary: Add new transaction audit trail for updated transaction item
|
||||
description: Add a new audit trail record for an updated transaction item.
|
||||
value:
|
||||
user: ad.vogelaar
|
||||
timestamp: 2022-01-02 12:34:00
|
||||
action: update
|
||||
status: return to src
|
||||
description: Transaction item returned to source.
|
||||
correlationId: 0dc216ea-58e7-4a5e-aa18-449f0304209c
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/TransactionAuditTrailsPostResponseBody"
|
||||
examples:
|
||||
Transaction audit trail record created:
|
||||
summary: Transaction audit trail record created
|
||||
description: |
|
||||
A new audit trail record for this transaction item was successfully created.
|
||||
The transactionAuditTrailId is returned as a reference for the consumer.
|
||||
value:
|
||||
transactionAuditTrailId: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/Odata/TransactionAuditTrail:
|
||||
get:
|
||||
summary: Find audit trail entries.
|
||||
@ -564,6 +520,7 @@ paths:
|
||||
- action
|
||||
- status
|
||||
- correlationId
|
||||
- journalEntryId
|
||||
- name: $select
|
||||
in: query
|
||||
description: Select properties to be returned
|
||||
@ -584,6 +541,7 @@ paths:
|
||||
- action
|
||||
- status
|
||||
- correlationId
|
||||
- journalEntryId
|
||||
- name: $expand
|
||||
in: query
|
||||
description: Expand related entities
|
||||
@ -597,6 +555,7 @@ paths:
|
||||
type: string
|
||||
enum:
|
||||
- TransactionItem
|
||||
- JournalEntry
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -627,6 +586,7 @@ paths:
|
||||
status: created
|
||||
description: Transaction created.
|
||||
correlationId: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": 1ce407d3-4725-46b8-92b2-47282ccd38f5
|
||||
transactionAuditTrailRowId: 8219
|
||||
transactionAuditTrailId: 1d234fc1-eb16-41d3-b2e0-e400e17b017f
|
||||
@ -637,6 +597,7 @@ paths:
|
||||
status: created
|
||||
description: Transaction created.
|
||||
correlationId: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": c8dec28b-bb85-4cb2-8a56-4a95fb2ed7bb
|
||||
transactionAuditTrailRowId: 8220
|
||||
transactionAuditTrailId: f4798a84-489d-4533-9dfe-42423c70f6b6
|
||||
@ -647,6 +608,7 @@ paths:
|
||||
status: return to src
|
||||
description: Transaction retunred to source.
|
||||
correlationId: a3891560-3084-42cb-867c-f289e7cda47d
|
||||
journalEntryId: null
|
||||
- "@odata.etag": 967ddfa0-835e-4954-a4af-2eb11de325dc
|
||||
transactionAuditTrailRowId: 8221
|
||||
transactionAuditTrailId: cc80d58d-6ee7-409a-8c14-b1f807e67c10
|
||||
@ -657,6 +619,7 @@ paths:
|
||||
status: failed
|
||||
description: Validation XYZ failed.
|
||||
correlationId: null
|
||||
journalEntryId: a062f64f-f39e-48e7-9793-efbfa86d2827
|
||||
List containing multiple transaction audit trails of one transaction item:
|
||||
summary: List containing multiple audit trails of one transaction item
|
||||
description: List containing multiple audit trail records of one transaction item (with id `d667d293-aa82-4c9e-9b10-77cffc9058a1`).
|
||||
@ -673,6 +636,7 @@ paths:
|
||||
status: re-entered
|
||||
description: Transaction re-entered.
|
||||
correlationId: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": 1ce407d3-4725-46b8-92b2-47282ccd38f5
|
||||
transactionAuditTrailRowId: 8219
|
||||
transactionAuditTrailId: b2192e6c-ab79-4000-a04d-d8f4d574a82f
|
||||
@ -683,6 +647,7 @@ paths:
|
||||
status: return to src
|
||||
description: Transaction retunred to source.
|
||||
correlationId: a3891560-3084-42cb-867c-f289e7cda47d
|
||||
journalEntryId: null
|
||||
- "@odata.etag": c8dec28b-bb85-4cb2-8a56-4a95fb2ed7bb
|
||||
transactionAuditTrailRowId: 8220
|
||||
transactionAuditTrailId: 1d759985-7f1a-48bd-8dd1-efa30ce26423
|
||||
@ -693,6 +658,7 @@ paths:
|
||||
status: failed
|
||||
description: Validation XYZ failed.
|
||||
correlationId: null
|
||||
journalEntryId: b479507a-a65d-48b5-8476-87c88ba3c560
|
||||
- "@odata.etag": 967ddfa0-835e-4954-a4af-2eb11de325dc
|
||||
transactionAuditTrailRowId: 8221
|
||||
transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d
|
||||
@ -703,6 +669,7 @@ paths:
|
||||
status: created
|
||||
description: Transaction created.
|
||||
correlationId: null
|
||||
journalEntryId: null
|
||||
List containing multiple audit trails of different failed transactions:
|
||||
summary: List containing multiple audit trails of different failed transactions
|
||||
description: List containing multiple audit trails of different failed transactions (status = failed).
|
||||
@ -719,6 +686,7 @@ paths:
|
||||
status: failed
|
||||
description: Validation XYZ failed.
|
||||
correlationId: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": 1ce407d3-4725-46b8-92b2-47282ccd38f5
|
||||
transactionAuditTrailRowId: 8219
|
||||
transactionAuditTrailId: 1d234fc1-eb16-41d3-b2e0-e400e17b017f
|
||||
@ -729,6 +697,7 @@ paths:
|
||||
status: failed
|
||||
description: Validation XYZ failed.
|
||||
correlationId: null
|
||||
journalEntryId: 43a98533-bb01-4aad-8d61-005051125969
|
||||
- "@odata.etag": c8dec28b-bb85-4cb2-8a56-4a95fb2ed7bb
|
||||
transactionAuditTrailRowId: 8220
|
||||
transactionAuditTrailId: f4798a84-489d-4533-9dfe-42423c70f6b6
|
||||
@ -739,6 +708,7 @@ paths:
|
||||
status: failed
|
||||
description: Validation XYZ failed.
|
||||
correlationId: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": 967ddfa0-835e-4954-a4af-2eb11de325dc
|
||||
transactionAuditTrailRowId: 8221
|
||||
transactionAuditTrailId: cc80d58d-6ee7-409a-8c14-b1f807e67c10
|
||||
@ -749,6 +719,7 @@ paths:
|
||||
status: failed
|
||||
description: Validation XYZ failed.
|
||||
correlationId: null
|
||||
journalEntryId: null
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
@ -786,6 +757,7 @@ paths:
|
||||
- reasonDescription
|
||||
- resolved
|
||||
- change
|
||||
- journalEntryId
|
||||
- name: $select
|
||||
in: query
|
||||
description: Select properties to be returned
|
||||
@ -808,6 +780,7 @@ paths:
|
||||
- reasonDescription
|
||||
- resolved
|
||||
- change
|
||||
- journalEntryId
|
||||
- name: $expand
|
||||
in: query
|
||||
description: Expand related entities
|
||||
@ -820,7 +793,8 @@ paths:
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- TransactionItem
|
||||
- TransactionItem
|
||||
- JournalEntry
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -856,6 +830,7 @@ paths:
|
||||
reasonDescription: Cost type does not exist.
|
||||
resolved: false
|
||||
change: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": ff49829d-a5de-4c1a-b331-15fd9c71dfe9
|
||||
processingFailureRowId: 10
|
||||
processingFailureId: ccc06dc9-956d-47d8-bde7-9644ddde2193
|
||||
@ -866,7 +841,8 @@ paths:
|
||||
reasonCode: "002"
|
||||
reasonDescription: Cost center does not exist.
|
||||
resolved: true
|
||||
change: Adapt config
|
||||
change: Adapt config
|
||||
journalEntryId: null
|
||||
- "@odata.etag": 5d5d3351-d3f1-49b2-905f-4dbbe1cc30e3
|
||||
processingFailureRowId: 11
|
||||
processingFailureId: 96bf8d44-0030-4509-b24e-2d62299779c5
|
||||
@ -877,7 +853,8 @@ paths:
|
||||
reasonCode: "001"
|
||||
reasonDescription: Department does not exist.
|
||||
resolved: true
|
||||
change: Adapt config
|
||||
change: Adapt config
|
||||
journalEntryId: null
|
||||
List of unfiltered processing failures:
|
||||
summary: List of unfiltered processing failures
|
||||
description: |
|
||||
@ -896,7 +873,8 @@ paths:
|
||||
reasonCode: "009"
|
||||
reasonDescription: Transaction date is in the future
|
||||
resolved: false
|
||||
change: null
|
||||
change: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": 584d3a8a-48bc-45f9-99be-8dd70399e6e4
|
||||
processingFailureRowId: 10
|
||||
processingFailureId: 76aa82e1-a10f-4664-a84f-1f30d60884b3
|
||||
@ -907,7 +885,8 @@ paths:
|
||||
reasonCode: "002"
|
||||
reasonDescription: Cost center does not exist.
|
||||
resolved: false
|
||||
change: null
|
||||
change: null
|
||||
journalEntryId: null
|
||||
- "@odata.etag": df4ade9b-1bda-4d91-a5ba-4dbe067568a0
|
||||
processingFailureRowId: 11
|
||||
processingFailureId: 25d2dd6f-ae17-44a7-b7a5-43eaf6de78e1
|
||||
@ -918,7 +897,8 @@ paths:
|
||||
reasonCode: "001"
|
||||
reasonDescription: Department does not exist.
|
||||
resolved: false
|
||||
change: null
|
||||
change: null
|
||||
journalEntryId: null
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
@ -969,6 +949,415 @@ paths:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/Odata/JournalEntries:
|
||||
get:
|
||||
summary: Find journalEntry.
|
||||
description: Find journalEntry.
|
||||
tags:
|
||||
- Odata
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/top"
|
||||
- $ref: "#/components/parameters/skip"
|
||||
- $ref: "#/components/parameters/filter"
|
||||
- $ref: "#/components/parameters/count"
|
||||
- name: $orderby
|
||||
in: query
|
||||
description: Order items by property values
|
||||
required: false
|
||||
style: form
|
||||
explode: false
|
||||
schema:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- journalEntryId
|
||||
- aggregationReference
|
||||
- accountingSystemReference
|
||||
- name: $select
|
||||
in: query
|
||||
description: Select properties to be returned
|
||||
required: false
|
||||
style: form
|
||||
explode: false
|
||||
schema:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- journalEntryId
|
||||
- aggregationReference
|
||||
- accountingSystemReference
|
||||
- data
|
||||
- response
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/JournalEntryGetResponseBody"
|
||||
examples:
|
||||
List containing all journal entries:
|
||||
summary: List containing all journal entries
|
||||
description: Returns a list containing all journal entries (no filters applied).
|
||||
value:
|
||||
"@odata.context": "$metadata#JournalEntry"
|
||||
value:
|
||||
- "@odata.etag": 8f085711-eeae-44ed-bac1-06779bedb480
|
||||
journalEntryId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
|
||||
aggregationReference: FIKO-123456
|
||||
accountingSystemReference: null
|
||||
data: {
|
||||
"transaction": {
|
||||
"header": {
|
||||
"key": {
|
||||
"cmpCode": "1HTM",
|
||||
"code": "OPBR-FIKO"
|
||||
},
|
||||
"timeStamp": 0,
|
||||
"inputDate": "2026-07-20T00:00:00Z",
|
||||
"period": "2026/6",
|
||||
"curCode": "EUR",
|
||||
"date": "2026-07-20T00:00:00Z",
|
||||
"originalCompany": "1HTM",
|
||||
"originalCode": "OPBR-FIKO",
|
||||
"completionWorkflow": {
|
||||
"completionStatus": "wfl_no_completion"
|
||||
},
|
||||
"salesInvoiceStatus": "salesinv_notyetinv"
|
||||
},
|
||||
"lines": {
|
||||
"line": [
|
||||
{
|
||||
"number": 1,
|
||||
"accountCode": "100.99999.D150000001",
|
||||
"docValue": 100.00,
|
||||
"lineType": "summary",
|
||||
"lineSense": "debit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"description": "test",
|
||||
"extRef1": "99999991",
|
||||
"extRef2": "99999",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
|
||||
},
|
||||
{
|
||||
"number": 2,
|
||||
"accountCode": "642.41236.609311",
|
||||
"docValue": 100.00,
|
||||
"userStatus": "",
|
||||
"lineType": "analysis",
|
||||
"lineSense": "credit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
response: {
|
||||
"status": "failed",
|
||||
"message": [
|
||||
{
|
||||
"code": "352",
|
||||
"reason": "Documentregel 1 kan niet geboekt worden."
|
||||
},
|
||||
{
|
||||
"code": "159",
|
||||
"reason": "Element 99999 (niveau 2) is niet toegestaan in linkerlijst van element D150000001 (niveau 3)."
|
||||
}
|
||||
],
|
||||
"hints": [],
|
||||
"paths": [
|
||||
"/InputRequest/PostToBooks/Request/Transaction/Lines/Line[1]/AccountCode"
|
||||
]
|
||||
}
|
||||
- "@odata.etag": 66c033af-fc67-4eb2-9d17-d74a0166470f
|
||||
journalEntryId: 36a34bd8-2b84-4c89-87a4-22e809f6ed4a
|
||||
aggregationReference: FIKO-123457
|
||||
accountingSystemReference: "OPBR-FIKO10000090"
|
||||
data: {
|
||||
"transaction": {
|
||||
"header": {
|
||||
"key": {
|
||||
"cmpCode": "1HTM",
|
||||
"code": "OPBR-FIKO"
|
||||
},
|
||||
"timeStamp": 0,
|
||||
"inputDate": "2026-07-20T00:00:00Z",
|
||||
"period": "2026/6",
|
||||
"curCode": "EUR",
|
||||
"date": "2026-07-20T00:00:00Z",
|
||||
"originalCompany": "1HTM",
|
||||
"originalCode": "OPBR-FIKO",
|
||||
"completionWorkflow": {
|
||||
"completionStatus": "wfl_no_completion"
|
||||
},
|
||||
"salesInvoiceStatus": "salesinv_notyetinv"
|
||||
},
|
||||
"lines": {
|
||||
"line": [
|
||||
{
|
||||
"number": 1,
|
||||
"accountCode": "100.99999.D150000001",
|
||||
"docValue": 100.00,
|
||||
"lineType": "summary",
|
||||
"lineSense": "debit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"description": "test",
|
||||
"extRef1": "99999991",
|
||||
"extRef2": "99999",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
|
||||
},
|
||||
{
|
||||
"number": 2,
|
||||
"accountCode": "642.41236.609311",
|
||||
"docValue": 100.00,
|
||||
"userStatus": "",
|
||||
"lineType": "analysis",
|
||||
"lineSense": "credit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
response: {
|
||||
"key": {
|
||||
"$type": "finance_transaction_txnKey",
|
||||
"cmpCode": "1HTM",
|
||||
"code": "OPBR-FIKO",
|
||||
"number": " 10000090"
|
||||
},
|
||||
"suppliedNumber": ""
|
||||
}
|
||||
- "@odata.etag": 159f526c-3c88-48a1-93a0-e16430500bef
|
||||
journalEntryId: 6097121f-f300-4c0b-ab8d-0a24685bda92
|
||||
aggregationReference: FIKO-123458
|
||||
accountingSystemReference: null
|
||||
data: {
|
||||
"transaction": {
|
||||
"header": {
|
||||
"key": {
|
||||
"cmpCode": "1HTM",
|
||||
"code": "OPBR-FIKO"
|
||||
},
|
||||
"timeStamp": 0,
|
||||
"inputDate": "2026-07-20T00:00:00Z",
|
||||
"period": "2026/6",
|
||||
"curCode": "EUR",
|
||||
"date": "2026-07-20T00:00:00Z",
|
||||
"originalCompany": "1HTM",
|
||||
"originalCode": "OPBR-FIKO",
|
||||
"completionWorkflow": {
|
||||
"completionStatus": "wfl_no_completion"
|
||||
},
|
||||
"salesInvoiceStatus": "salesinv_notyetinv"
|
||||
},
|
||||
"lines": {
|
||||
"line": [
|
||||
{
|
||||
"number": 1,
|
||||
"accountCode": "100.99999.D150000001",
|
||||
"docValue": 100.00,
|
||||
"lineType": "summary",
|
||||
"lineSense": "debit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"description": "test",
|
||||
"extRef1": "99999991",
|
||||
"extRef2": "99999",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
|
||||
},
|
||||
{
|
||||
"number": 2,
|
||||
"accountCode": "642.41236.609311",
|
||||
"docValue": 100.00,
|
||||
"userStatus": "",
|
||||
"lineType": "analysis",
|
||||
"lineSense": "credit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
response: null
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/journalEntries:
|
||||
post:
|
||||
summary: Add a journalEntry.
|
||||
description: Add a journalEntry.
|
||||
tags:
|
||||
- journalEntries v1.0
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/JournalEntryPostRequestBody"
|
||||
examples:
|
||||
Add a new journalEntry:
|
||||
summary: Add a new journalEntry
|
||||
description: In this example we add a new journalEntry.
|
||||
value:
|
||||
aggregationReference: FIKO-123456
|
||||
data: {
|
||||
"transaction": {
|
||||
"header": {
|
||||
"key": {
|
||||
"cmpCode": "1HTM",
|
||||
"code": "OPBR-FIKO"
|
||||
},
|
||||
"timeStamp": 0,
|
||||
"inputDate": "2026-07-20T00:00:00Z",
|
||||
"period": "2026/6",
|
||||
"curCode": "EUR",
|
||||
"date": "2026-07-20T00:00:00Z",
|
||||
"originalCompany": "1HTM",
|
||||
"originalCode": "OPBR-FIKO",
|
||||
"completionWorkflow": {
|
||||
"completionStatus": "wfl_no_completion"
|
||||
},
|
||||
"salesInvoiceStatus": "salesinv_notyetinv"
|
||||
},
|
||||
"lines": {
|
||||
"line": [
|
||||
{
|
||||
"number": 1,
|
||||
"accountCode": "100.99999.D150000001",
|
||||
"docValue": 100.00,
|
||||
"lineType": "summary",
|
||||
"lineSense": "debit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"description": "test",
|
||||
"extRef1": "99999991",
|
||||
"extRef2": "99999",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
|
||||
},
|
||||
{
|
||||
"number": 2,
|
||||
"accountCode": "642.41236.609311",
|
||||
"docValue": 100.00,
|
||||
"userStatus": "",
|
||||
"lineType": "analysis",
|
||||
"lineSense": "credit",
|
||||
"lineOrigin": "dl_orig_defined",
|
||||
"sepaPaymentCategoryPurposeCode": "none",
|
||||
"sepaPaymentPurposeCode": "none"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/JournalEntryPostResponseBody"
|
||||
examples:
|
||||
Journalentry created successfully:
|
||||
summary: Journalentry created successfully
|
||||
description: TheJournalentry was successfully added to the database.
|
||||
value:
|
||||
journalEntryId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/journalEntries/{journalEntryId}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: journalEntryId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
required: true
|
||||
description: The id of the journalEntry.
|
||||
patch:
|
||||
summary: Update journalEntry.
|
||||
description: Update journalEntry.
|
||||
tags:
|
||||
- journalEntries v1.0
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/JournalEntryPatchRequestBody"
|
||||
examples:
|
||||
Update an journalEntry after error:
|
||||
summary: Update an journalEntry after error
|
||||
description: Update an journalEntry after error by logging the response
|
||||
value:
|
||||
response: {
|
||||
"status": "failed",
|
||||
"message": [
|
||||
{
|
||||
"code": "352",
|
||||
"reason": "Documentregel 1 kan niet geboekt worden."
|
||||
},
|
||||
{
|
||||
"code": "159",
|
||||
"reason": "Element 99999 (niveau 2) is niet toegestaan in linkerlijst van element D150000001 (niveau 3)."
|
||||
}
|
||||
],
|
||||
"hints": [],
|
||||
"paths": [
|
||||
"/InputRequest/PostToBooks/Request/Transaction/Lines/Line[1]/AccountCode"
|
||||
]
|
||||
}
|
||||
Update an journalEntry after success:
|
||||
summary: Update an journalEntry after succesfull call
|
||||
description: Update an journalEntry after uccesfull call bij logging the response and the accountingSystemReference.
|
||||
value:
|
||||
accountingSystemReference: "OPBR-FIKO10000090"
|
||||
response: {
|
||||
"key": {
|
||||
"$type": "finance_transaction_txnKey",
|
||||
"cmpCode": "1HTM",
|
||||
"code": "OPBR-FIKO",
|
||||
"number": " 10000090"
|
||||
},
|
||||
"suppliedNumber": ""
|
||||
}
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/JournalEntryPatchResponseBody"
|
||||
examples:
|
||||
JournalEntry updated successfully:
|
||||
summary: JournalEntry updated successfully
|
||||
description: The journalEntry was successfully updated in the database.
|
||||
value:
|
||||
journalEntryId: 5bbf5abc-4da5-4bb4-894e-a7f553789a20
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/Odata/BookingProcess:
|
||||
get:
|
||||
summary: Find booking processes.
|
||||
@ -3316,6 +3705,16 @@ components:
|
||||
- occurredOn
|
||||
- type
|
||||
- status
|
||||
createdOn:
|
||||
type: string
|
||||
nullable: false
|
||||
format: datetime
|
||||
example: "2026-07-20T00:00:00Z"
|
||||
updatedOn:
|
||||
type: string
|
||||
nullable: false
|
||||
format: datetime
|
||||
example: "2026-07-25T00:00:00Z"
|
||||
TransactionItemsBulkRequestBody:
|
||||
type: object
|
||||
properties:
|
||||
@ -3551,6 +3950,11 @@ components:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Adapt config
|
||||
journalEntryId:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
example: b51b377d-6c82-4c4f-9ed3-1068ab6e30c9
|
||||
required:
|
||||
- timestamp
|
||||
- element
|
||||
@ -3617,6 +4021,11 @@ components:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Adapt config
|
||||
journalEntryId:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
example: b51b377d-6c82-4c4f-9ed3-1068ab6e30c9
|
||||
required:
|
||||
- processingFailureId
|
||||
- transactionItemId
|
||||
@ -3681,6 +4090,11 @@ components:
|
||||
format: uuid
|
||||
nullable: true
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
journalEntryId:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
example: b51b377d-6c82-4c4f-9ed3-1068ab6e30c9
|
||||
required:
|
||||
- user
|
||||
- timestamp
|
||||
@ -3754,6 +4168,11 @@ components:
|
||||
format: uuid
|
||||
nullable: true
|
||||
example: a3891560-3084-42cb-867c-f289e7cda47d
|
||||
journalEntryId:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
example: b51b377d-6c82-4c4f-9ed3-1068ab6e30c9
|
||||
required:
|
||||
- transactionAuditTrailId
|
||||
- transactionItemId
|
||||
@ -3761,6 +4180,89 @@ components:
|
||||
- timestamp
|
||||
- action
|
||||
- status
|
||||
JournalEntryGetResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
"@odata.context":
|
||||
type: string
|
||||
example: $metadata#JournalEntry
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/JournalEntry"
|
||||
JournalEntry:
|
||||
type: object
|
||||
properties:
|
||||
"@odata.etag":
|
||||
type: string
|
||||
example: 333d6b7d-b709-3b89-89e0-bcb3d5fdddfc
|
||||
journalEntryId:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 8871d779-512c-4d4d-9a8a-dee7c635179d
|
||||
aggregationReference:
|
||||
type: string
|
||||
example: FIKO-123456
|
||||
accountingSystemReference:
|
||||
type: string
|
||||
nullable: true
|
||||
example: U4F-123456
|
||||
data:
|
||||
type: object
|
||||
example: {}
|
||||
responses:
|
||||
type: object
|
||||
nullable: true
|
||||
example: {}
|
||||
required:
|
||||
- journalEntryId
|
||||
- aggregationReference
|
||||
- data
|
||||
JournalEntryPostRequestBody:
|
||||
type: object
|
||||
properties:
|
||||
aggregationReference:
|
||||
type: string
|
||||
example: FIKO-123456
|
||||
accountingSystemReference:
|
||||
type: string
|
||||
nullable: true
|
||||
example: U4F-123456
|
||||
data:
|
||||
type: object
|
||||
example: {}
|
||||
responses:
|
||||
type: object
|
||||
nullable: true
|
||||
example: {}
|
||||
required:
|
||||
- aggregationReference
|
||||
- data
|
||||
JournalEntryPostResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
journalEntryId:
|
||||
type: string
|
||||
format: uuid
|
||||
example: c97a8123-8d0e-41ea-9737-35843ebe2385
|
||||
JournalEntryPatchRequestBody:
|
||||
type: object
|
||||
properties:
|
||||
accountingSystemReference:
|
||||
type: string
|
||||
nullable: true
|
||||
example: U4F-123456
|
||||
responses:
|
||||
type: object
|
||||
nullable: true
|
||||
example: {}
|
||||
JournalEntryPatchResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
journalEntryId:
|
||||
type: string
|
||||
format: uuid
|
||||
example: c97a8123-8d0e-41ea-9737-35843ebe2385
|
||||
BookingProcessesGetResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user