added new API's
This commit is contained in:
parent
17f52cd914
commit
f4e7bd9385
@ -969,6 +969,416 @@ paths:
|
|||||||
- default: []
|
- default: []
|
||||||
x-auth-type: Application & Application User
|
x-auth-type: Application & Application User
|
||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
|
/Odata/JournalEntry:
|
||||||
|
get:
|
||||||
|
summary: Find journal entry.
|
||||||
|
description: Find journal entry.
|
||||||
|
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
|
||||||
|
/journalEntry:
|
||||||
|
post:
|
||||||
|
summary: Add a journal entry.
|
||||||
|
description: Add a journal entry.
|
||||||
|
tags:
|
||||||
|
- journalEntry v1.0
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/JournalEntryPostRequestBody"
|
||||||
|
examples:
|
||||||
|
Add a new journal entry:
|
||||||
|
summary: Add a new journal entry
|
||||||
|
description: In this example we add a new journal entry.
|
||||||
|
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
|
||||||
|
/journalEntry/{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:
|
||||||
|
- journalEntry 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 bij 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 error
|
||||||
|
description: Update an journalEntry after error bij logging the response
|
||||||
|
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:
|
/Odata/BookingProcess:
|
||||||
get:
|
get:
|
||||||
summary: Find booking processes.
|
summary: Find booking processes.
|
||||||
@ -3761,6 +4171,89 @@ components:
|
|||||||
- timestamp
|
- timestamp
|
||||||
- action
|
- action
|
||||||
- status
|
- 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
|
||||||
|
examples: {}
|
||||||
|
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
|
||||||
|
examples: {}
|
||||||
|
JournalEntryPatchResponseBody:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
journalEntryId:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: c97a8123-8d0e-41ea-9737-35843ebe2385
|
||||||
BookingProcessesGetResponseBody:
|
BookingProcessesGetResponseBody:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user