Journal Voucher¶
Request Approval¶
HTTP Request
POST /api/v1/general-ledger/journal-vouchers/send-to-approval/{transaction_id}
📋 Description: Submits a journal voucher for approval within the General Ledger, ensuring that all ledger entries related to the specified transaction are reviewed and authorized in accordance with financial record management protocols.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transaction_id |
path |
integer(int64) |
true |
Unique identifier for the ledger entry transaction, used to route the specified journal voucher for approval within the financial record management process. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "requestUniqueId": "string",
4 "createdByApplication": "NLA",
5 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
6 "documentComments": "string",
7 "name": "string",
8 "principalPositionType": "LESSEE",
9 "postingTransactionType": "POST",
10 "postingType": "PAYMENT",
11 "ledgerType": "LIABILITY",
12 "paymentType": "N_A",
13 "parallelCurrencyEnabled": true,
14 "generateInvoiceInAp": true,
15 "generateVendorInvoice": true,
16 "calculateTax": true,
17 "taxCalculationType": "NET",
18 "currencyDetail": {
19 "currencyId": 0,
20 "currencyDisplayId": "string",
21 "currencyDefinitionType": "CONTRACT_CURRENCY",
22 "currencyType": "string"
23 },
24 "classificationInfo": {
25 "accountingStandard": {
26 "id": 0,
27 "displayId": "string"
28 },
29 "leaseClassificationType": "NON_LEASE"
30 },
31 "date": {
32 "documentDate": "2019-08-24T14:15:22Z",
33 "userDocumentDate": "2019-08-24",
34 "postingDate": "2019-08-24",
35 "transactionDate": "2019-08-24",
36 "translationDate": "2019-08-24",
37 "fiscalVariantId": 0,
38 "fiscalVariantDisplayId": "string",
39 "calendarType": "REGULAR_CALENDAR",
40 "fiscalYear": 0,
41 "fiscalPeriod": 0
42 },
43 "automaticReversal": {
44 "id": 0,
45 "postingDate": "2019-08-24",
46 "documentDate": "2019-08-24",
47 "reversalReason": {
48 "id": 0,
49 "displayId": "string"
50 }
51 },
52 "trace": {
53 "previousLedgerTransactionId": 0,
54 "nextLedgerTransactionId": 0,
55 "postExternalType": "SKIP"
56 },
57 "fosReferences": {
58 "id": 0,
59 "system": {
60 "id": 0,
61 "displayId": "string"
62 },
63 "company": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "leaseArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseGroup": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseDepartment": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "businessUnit": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "mainCostCenter": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "internalAssetClass": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "documentType": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "depreciationArea": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "reversalReason": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "tradingPartner": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "allocationNumber": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "responsibleCostCenter": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "workBreakdownStructure": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "businessArea": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "functionalArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "plant": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "internalOrder": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "network": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "paymentTerm": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentBlock": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentMethod": {
148 "id": 0,
149 "displayId": "string",
150 "type": "string"
151 },
152 "segment": {
153 "id": 0,
154 "displayId": "string"
155 },
156 "purchasingOrganization": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrder": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "ledgerTransactionId": 0
165 },
166 "assetRegisterReferences": {
167 "id": 0,
168 "asset": {
169 "assetId": 0,
170 "assetDisplayId": "string",
171 "assetNumber": "string",
172 "subAssetNumber": "string"
173 },
174 "ledgerTransactionId": 0
175 },
176 "nlaReferences": {
177 "id": 0,
178 "contract": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "leaseComponent": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "activationGroup": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "unit": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "contractExternalId": "string",
195 "journalId": 0,
196 "activationGroupRevisionId": 0,
197 "ledgerTransactionId": 0
198 },
199 "nlaCustomReferences": [
200 {
201 "key": "string",
202 "dataType": "STRING",
203 "value": 0
204 }
205 ],
206 "nreReferences": {
207 "id": 0,
208 "premise": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "location": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "lease": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "ledgerTransactionId": 0
221 },
222 "nreCustomReferences": [
223 {
224 "key": "string",
225 "dataType": "STRING",
226 "value": 0
227 }
228 ],
229 "apReferences": {
230 "id": 0,
231 "invoice": {
232 "id": 0,
233 "displayId": "string",
234 "name": "string"
235 },
236 "vendor": {
237 "id": 0,
238 "displayId": "string",
239 "name": "string"
240 },
241 "ledgerTransactionId": 0
242 },
243 "apCustomReferences": [
244 {
245 "key": "string",
246 "dataType": "STRING",
247 "value": 0
248 }
249 ],
250 "entries": [
251 {
252 "id": 0,
253 "entryType": "D",
254 "amount": 0,
255 "unroundedAmount": 0,
256 "deltaAdjustment": 0,
257 "itemText": "string",
258 "itemNoAcc": 0,
259 "generalLedger": {
260 "id": 0,
261 "displayId": "string",
262 "generalLedgerAccountName": "string",
263 "generalLedgerAccountCode": "string",
264 "openItemManagement": true,
265 "accountCategory": "BALANCESHEET",
266 "shortName": "string",
267 "longName": "string"
268 },
269 "additionalCurrencyEntries": [
270 {
271 "id": 0,
272 "amount": 0,
273 "unroundedAmount": 0,
274 "deltaAdjustment": 0,
275 "itemNoAcc": 0,
276 "currencyDetail": {
277 "currencyId": 0,
278 "currencyDisplayId": "string",
279 "currencyDefinitionType": "CONTRACT_CURRENCY",
280 "currencyType": "string"
281 },
282 "currencyConversionDetail": {
283 "rate": 0,
284 "conversionDate": "2019-08-24",
285 "translationDateType": "DOCUMENT_DATE",
286 "sourceCurrencyType": "CONTRACT_CURRENCY",
287 "sourceCurrency": {
288 "id": 0,
289 "displayId": "string"
290 },
291 "depreciationArea": {
292 "id": 0,
293 "displayId": "string"
294 }
295 },
296 "ledgerEntryId": 0,
297 "ledgerEntryTaxId": 0
298 }
299 ],
300 "tag": "string",
301 "costCenter": {
302 "id": 0,
303 "displayId": "string",
304 "mainCostCenter": true,
305 "allocationPercentage": 0.1
306 },
307 "profitCenter": {
308 "id": 0,
309 "displayId": "string"
310 },
311 "partner": {
312 "id": 0,
313 "displayId": "string"
314 },
315 "transactionType": "string",
316 "nlaCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "nreCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "apCustomReferences": [
331 {
332 "key": "string",
333 "dataType": "STRING",
334 "value": 0
335 }
336 ],
337 "taxEntries": [
338 {
339 "id": 0,
340 "entryType": "D",
341 "amount": 0,
342 "unroundedAmount": 0,
343 "deltaAdjustment": 0,
344 "itemText": "string",
345 "itemNoAcc": 0,
346 "generalLedger": {
347 "id": 0,
348 "displayId": "string",
349 "generalLedgerAccountName": "string",
350 "generalLedgerAccountCode": "string",
351 "openItemManagement": true,
352 "accountCategory": "BALANCESHEET",
353 "shortName": "string",
354 "longName": "string"
355 },
356 "additionalCurrencyEntries": [
357 {
358 "id": 0,
359 "amount": 0,
360 "unroundedAmount": 0,
361 "deltaAdjustment": 0,
362 "itemNoAcc": 0,
363 "currencyDetail": {
364 "currencyId": 0,
365 "currencyDisplayId": "string",
366 "currencyDefinitionType": "CONTRACT_CURRENCY",
367 "currencyType": "string"
368 },
369 "currencyConversionDetail": {
370 "rate": 0,
371 "conversionDate": "2019-08-24",
372 "translationDateType": "DOCUMENT_DATE",
373 "sourceCurrencyType": "CONTRACT_CURRENCY",
374 "sourceCurrency": {
375 "id": 0,
376 "displayId": "string"
377 },
378 "depreciationArea": {
379 "id": 0,
380 "displayId": "string"
381 }
382 },
383 "ledgerEntryId": 0,
384 "ledgerEntryTaxId": 0
385 }
386 ],
387 "taxRate": 0,
388 "taxBaseAmount": 0,
389 "totalTaxDocumentAmount": 0,
390 "taxExempt": 0,
391 "taxExemptionPercentage": 0,
392 "taxAffected": 0,
393 "taxAccount": "string",
394 "accountingKey": "string",
395 "conditionKey": "string",
396 "taxCode": {
397 "id": 0,
398 "displayId": "string"
399 },
400 "taxJurisdiction": {
401 "id": 0,
402 "displayId": "string"
403 },
404 "taxDetermination": {
405 "id": 0,
406 "displayId": "string"
407 },
408 "financialTermId": 0,
409 "ledgerEntryId": 0
410 }
411 ],
412 "ledgerTransactionId": 0
413 }
414 ],
415 "notes": [
416 {
417 "id": 0,
418 "note": "string"
419 }
420 ],
421 "attachments": [
422 {
423 "id": 0,
424 "fileName": "string",
425 "fileStorageId": "string",
426 "docStoreId": 0
427 }
428 ],
429 "journalVoucherWorkflowHistory": [
430 {
431 "id": 0,
432 "eventType": "SEND_TO_APPROVAL",
433 "eventDate": "2019-08-24T14:15:22Z",
434 "user": "string"
435 }
436 ],
437 "ledgerTransactionGroupId": 0,
438 "accountingDocumentId": 0,
439 "internalPostingStatus": {
440 "documentNumber": "string",
441 "status": "NA",
442 "postingMessage": "string"
443 },
444 "nlaEnrichmentState": {
445 "id": 0,
446 "status": "PENDING",
447 "message": "string",
448 "history": [
449 {
450 "requestingUser": "string",
451 "enrichmentRequestId": 0,
452 "requestedAt": "2019-08-24T14:15:22Z",
453 "enrichedAt": "2019-08-24T14:15:22Z",
454 "requestStatus": "SENT",
455 "applicationStatus": "PENDING",
456 "message": "string"
457 }
458 ]
459 },
460 "nreEnrichmentState": {
461 "id": 0,
462 "status": "PENDING",
463 "message": "string",
464 "history": [
465 {
466 "requestingUser": "string",
467 "enrichmentRequestId": 0,
468 "requestedAt": "2019-08-24T14:15:22Z",
469 "enrichedAt": "2019-08-24T14:15:22Z",
470 "requestStatus": "SENT",
471 "applicationStatus": "PENDING",
472 "message": "string"
473 }
474 ]
475 },
476 "apEnrichmentState": {
477 "id": 0,
478 "status": "PENDING",
479 "message": "string",
480 "history": [
481 {
482 "requestingUser": "string",
483 "enrichmentRequestId": 0,
484 "requestedAt": "2019-08-24T14:15:22Z",
485 "enrichedAt": "2019-08-24T14:15:22Z",
486 "requestStatus": "SENT",
487 "applicationStatus": "PENDING",
488 "message": "string"
489 }
490 ]
491 },
492 "externalPostingStatus": {
493 "documentNumber": "string",
494 "objType": "string",
495 "objKey": "string",
496 "objSys": "string",
497 "username": "string",
498 "status": "NA",
499 "postingMessage": "string",
500 "taskId": 0
501 }
502}
Update¶
HTTP Request
POST /api/v1/general-ledger/journal-vouchers/save/{transaction_id}
📋 Description: Saves a journal voucher associated with a specified transaction ID in the General Ledger, ensuring accurate ledger entry and financial record management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transaction_id |
path |
integer(int64) |
true |
Unique identifier for the financial transaction associated with the ledger entry, facilitating accurate recording and retrieval of journal vouchers in the General Ledger. |
files |
query |
array[string] |
false |
Array of file attachments related to the ledger entry, essential for supporting documentation of the transaction and ensuring accurate financial record-keeping. |
body |
body |
object |
false |
Request body containing the journal voucher data, including transaction details, account information, and financial records associated with the specified transaction ID. |
» request |
body |
true |
Data transfer object representing a ledger transaction, encapsulating details of financial entries associated with accounts and their corresponding records within the general ledger. |
|
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» requestUniqueId |
body |
string |
false |
Unique identifier for the request unique |
»» createdByApplication |
body |
string |
false |
Text value for createdByApplication in LedgerTransactionDto |
»» applicationReferenceId |
body |
string |
true |
Any application MUST send a unique reference in order to ignore duplicate postings. |
»» documentComments |
body |
string |
false |
Text value for documentComments in LedgerTransactionDto |
»» name |
body |
string |
false |
Name of the resource |
»» principalPositionType |
body |
string |
false |
Type of the principal position |
»» postingTransactionType |
body |
string |
false |
Type of the posting transaction |
»» postingType |
body |
string |
false |
Type of the posting |
»» ledgerType |
body |
string |
false |
Type of the ledger |
»» paymentType |
body |
string |
false |
none |
»» parallelCurrencyEnabled |
body |
boolean |
false |
Indicates whether this feature is enabled |
»» generateInvoiceInAp |
body |
boolean |
false |
Boolean flag indicating generateInvoiceInAp status |
»» generateVendorInvoice |
body |
boolean |
false |
Boolean flag indicating generateVendorInvoice status |
»» calculateTax |
body |
boolean |
false |
Boolean flag indicating calculateTax status |
»» taxCalculationType |
body |
string |
false |
Type of the tax calculation |
»» currencyDetail |
body |
false |
Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management. |
|
»»» currencyId |
body |
integer(int64) |
false |
Unique identifier for the currency |
»»» currencyDisplayId |
body |
string |
false |
Unique identifier for the currency display |
»»» currencyDefinitionType |
body |
string |
false |
Type of the currency definition |
»»» currencyType |
body |
string |
false |
Type of the currency |
»» classificationInfo |
body |
false |
Data structure representing classification details for ledger entries, encompassing transaction types, associated accounts, and relevant financial records to facilitate accurate financial reporting and analysis. |
|
»»» accountingStandard |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» leaseClassificationType |
body |
string |
false |
Type of the lease classification |
»» date |
body |
false |
Data structure representing the date associated with a ledger transaction, crucial for maintaining accurate financial records and facilitating effective account management within the General Ledger. |
|
»»» documentDate |
body |
string(date-time) |
false |
Date of the document |
»»» userDocumentDate |
body |
string(date) |
false |
Date of the user document |
»»» postingDate |
body |
string(date) |
false |
Date of the posting |
»»» transactionDate |
body |
string(date) |
false |
Date of the transaction |
»»» translationDate |
body |
string(date) |
false |
Date of the translation |
»»» fiscalVariantId |
body |
integer(int64) |
false |
Unique identifier for the fiscal variant |
»»» fiscalVariantDisplayId |
body |
string |
false |
Unique identifier for the fiscal variant display |
»»» calendarType |
body |
string |
false |
Type of the calendar |
»»» fiscalYear |
body |
integer(int32) |
false |
Numeric value representing fiscalYear |
»»» fiscalPeriod |
body |
integer(int32) |
false |
Numeric value representing fiscalPeriod |
»» automaticReversal |
body |
false |
Data transfer object representing an automatic reversal of journal vouchers within the General Ledger, facilitating accurate financial record management and ensuring the integrity of ledger entries and transactions. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» postingDate |
body |
string(date) |
false |
Date of the posting |
»»» documentDate |
body |
string(date) |
false |
Date of the document |
»»» reversalReason |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» trace |
body |
false |
Data transfer object representing a detailed trace of ledger transactions, capturing essential information related to each financial record, including associated accounts and ledger entries. |
|
»»» previousLedgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the previous ledger transaction |
»»» nextLedgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the next ledger transaction |
»»» postExternalType |
body |
string |
false |
Type of the post external |
»» fosReferences |
body |
false |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» system |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» company |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseGroup |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseDepartment |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» businessUnit |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» mainCostCenter |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» internalAssetClass |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» documentType |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» depreciationArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» reversalReason |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» tradingPartner |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» allocationNumber |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» responsibleCostCenter |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» workBreakdownStructure |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» businessArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» functionalArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» plant |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» internalOrder |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» network |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» paymentTerm |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» paymentBlock |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» paymentMethod |
body |
false |
Data transfer object representing the unique identifier for a payment method used in ledger entries and financial transactions, facilitating accurate tracking and management of accounts and financial records. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» type |
body |
string |
true |
Type of the resource |
»»» segment |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» purchasingOrganization |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» purchasingOrder |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» assetRegisterReferences |
body |
false |
Data transfer object representing the references associated with ledger transactions in the asset register, facilitating accurate tracking and management of financial records within the general ledger. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» asset |
body |
false |
Data structure representing detailed information about an asset within the General Ledger, including its associated ledger entries, transactions, and account details, essential for accurate financial record management. |
|
»»»» assetId |
body |
integer(int64) |
false |
Unique identifier for the asset |
»»»» assetDisplayId |
body |
string |
false |
Unique identifier for the asset display |
»»»» assetNumber |
body |
string |
false |
Text value for assetNumber in AssetInfo |
»»»» subAssetNumber |
body |
string |
false |
Text value for subAssetNumber in AssetInfo |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» nlaReferences |
body |
false |
Data transfer object representing references associated with ledger transactions, facilitating the management of financial records and ensuring accurate accounting entries within the General Ledger. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» contract |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseComponent |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» activationGroup |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» unit |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» contractExternalId |
body |
string |
false |
Unique identifier for the contract external |
»»» journalId |
body |
integer(int64) |
false |
Unique identifier for the journal |
»»» activationGroupRevisionId |
body |
integer(int64) |
false |
Unique identifier for the activation group revision |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» nlaCustomReferences |
body |
[oneOf] |
false |
List of nlaCustomReferences items |
»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»»» key |
body |
string |
false |
Text value for key in CustomApplicationReferenceDto |
»»»»» dataType |
body |
string |
false |
Type of the data |
»»»»» value |
body |
object |
false |
Object containing value details |
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
number |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
boolean |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
string(date) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
number(double) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
integer(int32) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
integer(int64) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
string |
false |
none |
»» nreReferences |
body |
false |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» premise |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» location |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» lease |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» nreCustomReferences |
body |
[oneOf] |
false |
List of nreCustomReferences items |
»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»» apReferences |
body |
false |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records for accurate transaction tracking and reporting within the General Ledger domain. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» invoice |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» name |
body |
string |
false |
none |
»»» vendor |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» name |
body |
string |
false |
none |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» apCustomReferences |
body |
[oneOf] |
false |
List of apCustomReferences items |
»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»» entries |
body |
false |
List of entries items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» entryType |
body |
string |
true |
Type of the entry |
»»» amount |
body |
number |
true |
Amount value |
»»» unroundedAmount |
body |
number |
false |
Amount of unrounded |
»»» deltaAdjustment |
body |
number |
false |
Value for deltaAdjustment field |
»»» itemText |
body |
string |
false |
Text value for itemText in LedgerEntryDto |
»»» itemNoAcc |
body |
integer(int32) |
false |
Numeric value representing itemNoAcc |
»»» generalLedger |
body |
true |
Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» generalLedgerAccountName |
body |
string |
true |
Name of the general ledger account |
»»»» generalLedgerAccountCode |
body |
string |
true |
Code for the general ledger account |
»»»» openItemManagement |
body |
boolean |
true |
Boolean flag indicating openItemManagement status |
»»»» accountCategory |
body |
string |
true |
Category of the account |
»»»» shortName |
body |
string |
false |
Abbreviated name of the resource |
»»»» longName |
body |
string |
false |
Name of the long |
»»» additionalCurrencyEntries |
body |
false |
List of additionalCurrencyEntries items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» amount |
body |
number |
false |
Amount value |
»»»» unroundedAmount |
body |
number |
false |
Amount of unrounded |
»»»» deltaAdjustment |
body |
number |
false |
Value for deltaAdjustment field |
»»»» itemNoAcc |
body |
integer(int32) |
false |
Numeric value representing itemNoAcc |
»»»» currencyDetail |
body |
false |
Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management. |
|
»»»» currencyConversionDetail |
body |
false |
Data transfer object representing the details of currency conversion for ledger entries, facilitating accurate transaction recording and financial reporting within accounts. |
|
»»»»» rate |
body |
number |
false |
Rate value |
»»»»» conversionDate |
body |
string(date) |
false |
Date of the conversion |
»»»»» translationDateType |
body |
string |
false |
Type of the translation date |
»»»»» sourceCurrencyType |
body |
string |
false |
Type of the source currency |
»»»»» sourceCurrency |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»»» depreciationArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» ledgerEntryId |
body |
integer(int64) |
false |
Unique identifier for the ledger entry |
»»»» ledgerEntryTaxId |
body |
integer(int64) |
false |
Unique identifier for the ledger entry tax |
»»» tag |
body |
string |
false |
Text value for tag in LedgerEntryDto |
»»» costCenter |
body |
false |
Data structure representing the allocation of costs to specific cost centers within the General Ledger, facilitating accurate tracking and reporting of financial transactions and ledger entries. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» mainCostCenter |
body |
boolean |
false |
Boolean flag indicating mainCostCenter status |
»»»» allocationPercentage |
body |
number(double) |
false |
Percentage of allocation |
»»» profitCenter |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» partner |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» transactionType |
body |
string |
false |
Type of the transaction |
»»» nlaCustomReferences |
body |
[oneOf] |
false |
List of nlaCustomReferences items |
»»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»» nreCustomReferences |
body |
[oneOf] |
false |
List of nreCustomReferences items |
»»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»» apCustomReferences |
body |
[oneOf] |
false |
List of apCustomReferences items |
»»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»» taxEntries |
body |
false |
List of taxEntries items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» entryType |
body |
string |
true |
Type of the entry |
»»»» amount |
body |
number |
true |
Amount value |
»»»» unroundedAmount |
body |
number |
false |
Amount of unrounded |
»»»» deltaAdjustment |
body |
number |
false |
Value for deltaAdjustment field |
»»»» itemText |
body |
string |
false |
Text value for itemText in LedgerEntryTaxDto |
»»»» itemNoAcc |
body |
integer(int32) |
false |
Numeric value representing itemNoAcc |
»»»» generalLedger |
body |
true |
Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain. |
|
»»»» additionalCurrencyEntries |
body |
false |
List of additionalCurrencyEntries items |
|
»»»» taxRate |
body |
number |
false |
Rate of tax |
»»»» taxBaseAmount |
body |
number |
false |
Amount of tax base |
»»»» totalTaxDocumentAmount |
body |
number |
false |
Amount of total tax document |
»»»» taxExempt |
body |
number |
false |
Value for taxExempt field |
»»»» taxExemptionPercentage |
body |
number |
false |
Percentage of tax exemption |
»»»» taxAffected |
body |
number |
false |
Value for taxAffected field |
»»»» taxAccount |
body |
string |
false |
Number of ledger entry items |
»»»» accountingKey |
body |
string |
false |
Text value for accountingKey in LedgerEntryTaxDto |
»»»» conditionKey |
body |
string |
false |
Represents the specific condition associated with a ledger entry, facilitating accurate tracking and categorization of financial transactions within the general ledger. |
»»»» taxCode |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» taxJurisdiction |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» taxDetermination |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» financialTermId |
body |
integer(int64) |
false |
Unique identifier for the financial term |
»»»» ledgerEntryId |
body |
integer(int64) |
false |
Unique identifier for the ledger entry |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» notes |
body |
false |
List of notes items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» note |
body |
string |
false |
Text value for note in LedgerTransactionNoteDto |
»» attachments |
body |
false |
List of attachments items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» fileName |
body |
string |
false |
Name of the file |
»»» fileStorageId |
body |
string |
false |
Unique identifier for the file storage |
»»» docStoreId |
body |
integer(int64) |
false |
Unique identifier for the doc store |
»» journalVoucherWorkflowHistory |
body |
false |
List of journalVoucherWorkflowHistory items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» eventType |
body |
string |
false |
Type of the event |
»»» eventDate |
body |
string(date-time) |
false |
Date of the event |
»»» user |
body |
string |
false |
User information related to accounting |
»» ledgerTransactionGroupId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction group |
»» accountingDocumentId |
body |
integer(int64) |
false |
Unique identifier for the accounting document |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» applicationReferenceId |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» createdByApplication |
ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE |
»» ledgerType |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER |
»» paymentType |
CLEARING, N_A, PAYMENT |
»» postingTransactionType |
POST, REVERSE |
»» postingType |
ACCRUAL, CHARGE, DEPRECIATION, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
»» principalPositionType |
LESSEE, LESSOR |
»» taxCalculationType |
NET |
»»» calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
»»» currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
»»» entryType |
C, D |
»»» eventType |
APPROVED, ARCHIVED, REWORK, SEND_TO_APPROVAL |
»»» leaseClassificationType |
DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM |
»»» postExternalType |
POST, SKIP |
»»»» accountCategory |
BALANCESHEET, PROFITANDLOSS |
»»»» entryType |
C, D |
»»»»» dataType |
BIG_DECIMAL, BOOLEAN, DATE, DATETIME, DOUBLE, INTEGER, LONG, STRING |
»»»»» sourceCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A |
»»»»» translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Body Parameters
1{
2 "request": {
3 "accountingDocumentId": 0,
4 "apCustomReferences": [
5 {
6 "dataType": "STRING",
7 "key": "string",
8 "value": 0
9 }
10 ],
11 "apReferences": {
12 "id": 0,
13 "invoice": {
14 "displayId": "string",
15 "id": 0,
16 "name": "string"
17 },
18 "ledgerTransactionId": 0,
19 "vendor": {
20 "displayId": "string",
21 "id": 0,
22 "name": "string"
23 }
24 },
25 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
26 "assetRegisterReferences": {
27 "asset": {
28 "assetDisplayId": "string",
29 "assetId": 0,
30 "assetNumber": "string",
31 "subAssetNumber": "string"
32 },
33 "id": 0,
34 "ledgerTransactionId": 0
35 },
36 "attachments": [
37 {
38 "docStoreId": 0,
39 "fileName": "string",
40 "fileStorageId": "string",
41 "id": 0
42 }
43 ],
44 "automaticReversal": {
45 "documentDate": "2019-08-24",
46 "id": 0,
47 "postingDate": "2019-08-24",
48 "reversalReason": {
49 "displayId": "string",
50 "id": 0
51 }
52 },
53 "calculateTax": true,
54 "classificationInfo": {
55 "accountingStandard": {
56 "displayId": "string",
57 "id": 0
58 },
59 "leaseClassificationType": "NON_LEASE"
60 },
61 "createdByApplication": "NLA",
62 "currencyDetail": {
63 "currencyDefinitionType": "CONTRACT_CURRENCY",
64 "currencyDisplayId": "string",
65 "currencyId": 0,
66 "currencyType": "string"
67 },
68 "date": {
69 "calendarType": "REGULAR_CALENDAR",
70 "documentDate": "2019-08-24 14:15:22+00:00",
71 "fiscalPeriod": 0,
72 "fiscalVariantDisplayId": "string",
73 "fiscalVariantId": 0,
74 "fiscalYear": 0,
75 "postingDate": "2019-08-24",
76 "transactionDate": "2019-08-24",
77 "translationDate": "2019-08-24",
78 "userDocumentDate": "2019-08-24"
79 },
80 "documentComments": "string",
81 "entries": [
82 {
83 "additionalCurrencyEntries": [
84 {
85 "amount": 0,
86 "currencyConversionDetail": {
87 "conversionDate": "2019-08-24",
88 "depreciationArea": {
89 "displayId": "string",
90 "id": 0
91 },
92 "rate": 0,
93 "sourceCurrency": {
94 "displayId": "string",
95 "id": 0
96 },
97 "sourceCurrencyType": "CONTRACT_CURRENCY",
98 "translationDateType": "DOCUMENT_DATE"
99 },
100 "currencyDetail": {
101 "currencyDefinitionType": "CONTRACT_CURRENCY",
102 "currencyDisplayId": "string",
103 "currencyId": 0,
104 "currencyType": "string"
105 },
106 "deltaAdjustment": 0,
107 "id": 0,
108 "itemNoAcc": 0,
109 "ledgerEntryId": 0,
110 "ledgerEntryTaxId": 0,
111 "unroundedAmount": 0
112 }
113 ],
114 "amount": 0,
115 "apCustomReferences": [
116 {
117 "dataType": "STRING",
118 "key": "string",
119 "value": 0
120 }
121 ],
122 "costCenter": {
123 "allocationPercentage": 0.1,
124 "displayId": "string",
125 "id": 0,
126 "mainCostCenter": true
127 },
128 "deltaAdjustment": 0,
129 "entryType": "D",
130 "generalLedger": {
131 "accountCategory": "BALANCESHEET",
132 "displayId": "string",
133 "generalLedgerAccountCode": "string",
134 "generalLedgerAccountName": "string",
135 "id": 0,
136 "longName": "string",
137 "openItemManagement": true,
138 "shortName": "string"
139 },
140 "id": 0,
141 "itemNoAcc": 0,
142 "itemText": "string",
143 "ledgerTransactionId": 0,
144 "nlaCustomReferences": [
145 {
146 "dataType": "STRING",
147 "key": "string",
148 "value": 0
149 }
150 ],
151 "nreCustomReferences": [
152 {
153 "dataType": "STRING",
154 "key": "string",
155 "value": 0
156 }
157 ],
158 "partner": {
159 "displayId": "string",
160 "id": 0
161 },
162 "profitCenter": {
163 "displayId": "string",
164 "id": 0
165 },
166 "tag": "string",
167 "taxEntries": [
168 {
169 "accountingKey": "string",
170 "additionalCurrencyEntries": [
171 {
172 "amount": 0,
173 "currencyConversionDetail": {
174 "conversionDate": "2019-08-24",
175 "depreciationArea": {
176 "displayId": "string",
177 "id": 0
178 },
179 "rate": 0,
180 "sourceCurrency": {
181 "displayId": "string",
182 "id": 0
183 },
184 "sourceCurrencyType": "CONTRACT_CURRENCY",
185 "translationDateType": "DOCUMENT_DATE"
186 },
187 "currencyDetail": {
188 "currencyDefinitionType": "CONTRACT_CURRENCY",
189 "currencyDisplayId": "string",
190 "currencyId": 0,
191 "currencyType": "string"
192 },
193 "deltaAdjustment": 0,
194 "id": 0,
195 "itemNoAcc": 0,
196 "ledgerEntryId": 0,
197 "ledgerEntryTaxId": 0,
198 "unroundedAmount": 0
199 }
200 ],
201 "amount": 0,
202 "conditionKey": "string",
203 "deltaAdjustment": 0,
204 "entryType": "D",
205 "financialTermId": 0,
206 "generalLedger": {
207 "accountCategory": "BALANCESHEET",
208 "displayId": "string",
209 "generalLedgerAccountCode": "string",
210 "generalLedgerAccountName": "string",
211 "id": 0,
212 "longName": "string",
213 "openItemManagement": true,
214 "shortName": "string"
215 },
216 "id": 0,
217 "itemNoAcc": 0,
218 "itemText": "string",
219 "ledgerEntryId": 0,
220 "taxAccount": "string",
221 "taxAffected": 0,
222 "taxBaseAmount": 0,
223 "taxCode": {
224 "displayId": "string",
225 "id": 0
226 },
227 "taxDetermination": {
228 "displayId": "string",
229 "id": 0
230 },
231 "taxExempt": 0,
232 "taxExemptionPercentage": 0,
233 "taxJurisdiction": {
234 "displayId": "string",
235 "id": 0
236 },
237 "taxRate": 0,
238 "totalTaxDocumentAmount": 0,
239 "unroundedAmount": 0
240 }
241 ],
242 "transactionType": "string",
243 "unroundedAmount": 0
244 }
245 ],
246 "fosReferences": {
247 "allocationNumber": {
248 "displayId": "string",
249 "id": 0
250 },
251 "businessArea": {
252 "displayId": "string",
253 "id": 0
254 },
255 "businessUnit": {
256 "displayId": "string",
257 "id": 0
258 },
259 "company": {
260 "displayId": "string",
261 "id": 0
262 },
263 "depreciationArea": {
264 "displayId": "string",
265 "id": 0
266 },
267 "documentType": {
268 "displayId": "string",
269 "id": 0
270 },
271 "functionalArea": {
272 "displayId": "string",
273 "id": 0
274 },
275 "id": 0,
276 "internalAssetClass": {
277 "displayId": "string",
278 "id": 0
279 },
280 "internalOrder": {
281 "displayId": "string",
282 "id": 0
283 },
284 "leaseArea": {
285 "displayId": "string",
286 "id": 0
287 },
288 "leaseDepartment": {
289 "displayId": "string",
290 "id": 0
291 },
292 "leaseGroup": {
293 "displayId": "string",
294 "id": 0
295 },
296 "ledgerTransactionId": 0,
297 "mainCostCenter": {
298 "displayId": "string",
299 "id": 0
300 },
301 "network": {
302 "displayId": "string",
303 "id": 0
304 },
305 "paymentBlock": {
306 "displayId": "string",
307 "id": 0
308 },
309 "paymentMethod": {
310 "displayId": "string",
311 "id": 0,
312 "type": "string"
313 },
314 "paymentTerm": {
315 "displayId": "string",
316 "id": 0
317 },
318 "plant": {
319 "displayId": "string",
320 "id": 0
321 },
322 "purchasingOrder": {
323 "displayId": "string",
324 "id": 0
325 },
326 "purchasingOrganization": {
327 "displayId": "string",
328 "id": 0
329 },
330 "responsibleCostCenter": {
331 "displayId": "string",
332 "id": 0
333 },
334 "reversalReason": {
335 "displayId": "string",
336 "id": 0
337 },
338 "segment": {
339 "displayId": "string",
340 "id": 0
341 },
342 "system": {
343 "displayId": "string",
344 "id": 0
345 },
346 "tradingPartner": {
347 "displayId": "string",
348 "id": 0
349 },
350 "workBreakdownStructure": {
351 "displayId": "string",
352 "id": 0
353 }
354 },
355 "generateInvoiceInAp": true,
356 "generateVendorInvoice": true,
357 "id": 0,
358 "journalVoucherWorkflowHistory": [
359 {
360 "eventDate": "2019-08-24 14:15:22+00:00",
361 "eventType": "SEND_TO_APPROVAL",
362 "id": 0,
363 "user": "string"
364 }
365 ],
366 "ledgerTransactionGroupId": 0,
367 "ledgerType": "LIABILITY",
368 "name": "string",
369 "nlaCustomReferences": [
370 {
371 "dataType": "STRING",
372 "key": "string",
373 "value": 0
374 }
375 ],
376 "nlaReferences": {
377 "activationGroup": {
378 "displayId": "string",
379 "id": 0
380 },
381 "activationGroupRevisionId": 0,
382 "contract": {
383 "displayId": "string",
384 "id": 0
385 },
386 "contractExternalId": "string",
387 "id": 0,
388 "journalId": 0,
389 "leaseComponent": {
390 "displayId": "string",
391 "id": 0
392 },
393 "ledgerTransactionId": 0,
394 "unit": {
395 "displayId": "string",
396 "id": 0
397 }
398 },
399 "notes": [
400 {
401 "id": 0,
402 "note": "string"
403 }
404 ],
405 "nreCustomReferences": [
406 {
407 "dataType": "STRING",
408 "key": "string",
409 "value": 0
410 }
411 ],
412 "nreReferences": {
413 "id": 0,
414 "lease": {
415 "displayId": "string",
416 "id": 0
417 },
418 "ledgerTransactionId": 0,
419 "location": {
420 "displayId": "string",
421 "id": 0
422 },
423 "premise": {
424 "displayId": "string",
425 "id": 0
426 }
427 },
428 "parallelCurrencyEnabled": true,
429 "paymentType": "N_A",
430 "postingTransactionType": "POST",
431 "postingType": "PAYMENT",
432 "principalPositionType": "LESSEE",
433 "requestUniqueId": "string",
434 "taxCalculationType": "NET",
435 "trace": {
436 "nextLedgerTransactionId": 0,
437 "postExternalType": "SKIP",
438 "previousLedgerTransactionId": 0
439 }
440 }
441}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "requestUniqueId": "string",
4 "createdByApplication": "NLA",
5 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
6 "documentComments": "string",
7 "name": "string",
8 "principalPositionType": "LESSEE",
9 "postingTransactionType": "POST",
10 "postingType": "PAYMENT",
11 "ledgerType": "LIABILITY",
12 "paymentType": "N_A",
13 "parallelCurrencyEnabled": true,
14 "generateInvoiceInAp": true,
15 "generateVendorInvoice": true,
16 "calculateTax": true,
17 "taxCalculationType": "NET",
18 "currencyDetail": {
19 "currencyId": 0,
20 "currencyDisplayId": "string",
21 "currencyDefinitionType": "CONTRACT_CURRENCY",
22 "currencyType": "string"
23 },
24 "classificationInfo": {
25 "accountingStandard": {
26 "id": 0,
27 "displayId": "string"
28 },
29 "leaseClassificationType": "NON_LEASE"
30 },
31 "date": {
32 "documentDate": "2019-08-24T14:15:22Z",
33 "userDocumentDate": "2019-08-24",
34 "postingDate": "2019-08-24",
35 "transactionDate": "2019-08-24",
36 "translationDate": "2019-08-24",
37 "fiscalVariantId": 0,
38 "fiscalVariantDisplayId": "string",
39 "calendarType": "REGULAR_CALENDAR",
40 "fiscalYear": 0,
41 "fiscalPeriod": 0
42 },
43 "automaticReversal": {
44 "id": 0,
45 "postingDate": "2019-08-24",
46 "documentDate": "2019-08-24",
47 "reversalReason": {
48 "id": 0,
49 "displayId": "string"
50 }
51 },
52 "trace": {
53 "previousLedgerTransactionId": 0,
54 "nextLedgerTransactionId": 0,
55 "postExternalType": "SKIP"
56 },
57 "fosReferences": {
58 "id": 0,
59 "system": {
60 "id": 0,
61 "displayId": "string"
62 },
63 "company": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "leaseArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseGroup": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseDepartment": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "businessUnit": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "mainCostCenter": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "internalAssetClass": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "documentType": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "depreciationArea": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "reversalReason": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "tradingPartner": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "allocationNumber": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "responsibleCostCenter": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "workBreakdownStructure": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "businessArea": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "functionalArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "plant": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "internalOrder": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "network": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "paymentTerm": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentBlock": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentMethod": {
148 "id": 0,
149 "displayId": "string",
150 "type": "string"
151 },
152 "segment": {
153 "id": 0,
154 "displayId": "string"
155 },
156 "purchasingOrganization": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrder": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "ledgerTransactionId": 0
165 },
166 "assetRegisterReferences": {
167 "id": 0,
168 "asset": {
169 "assetId": 0,
170 "assetDisplayId": "string",
171 "assetNumber": "string",
172 "subAssetNumber": "string"
173 },
174 "ledgerTransactionId": 0
175 },
176 "nlaReferences": {
177 "id": 0,
178 "contract": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "leaseComponent": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "activationGroup": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "unit": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "contractExternalId": "string",
195 "journalId": 0,
196 "activationGroupRevisionId": 0,
197 "ledgerTransactionId": 0
198 },
199 "nlaCustomReferences": [
200 {
201 "key": "string",
202 "dataType": "STRING",
203 "value": 0
204 }
205 ],
206 "nreReferences": {
207 "id": 0,
208 "premise": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "location": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "lease": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "ledgerTransactionId": 0
221 },
222 "nreCustomReferences": [
223 {
224 "key": "string",
225 "dataType": "STRING",
226 "value": 0
227 }
228 ],
229 "apReferences": {
230 "id": 0,
231 "invoice": {
232 "id": 0,
233 "displayId": "string",
234 "name": "string"
235 },
236 "vendor": {
237 "id": 0,
238 "displayId": "string",
239 "name": "string"
240 },
241 "ledgerTransactionId": 0
242 },
243 "apCustomReferences": [
244 {
245 "key": "string",
246 "dataType": "STRING",
247 "value": 0
248 }
249 ],
250 "entries": [
251 {
252 "id": 0,
253 "entryType": "D",
254 "amount": 0,
255 "unroundedAmount": 0,
256 "deltaAdjustment": 0,
257 "itemText": "string",
258 "itemNoAcc": 0,
259 "generalLedger": {
260 "id": 0,
261 "displayId": "string",
262 "generalLedgerAccountName": "string",
263 "generalLedgerAccountCode": "string",
264 "openItemManagement": true,
265 "accountCategory": "BALANCESHEET",
266 "shortName": "string",
267 "longName": "string"
268 },
269 "additionalCurrencyEntries": [
270 {
271 "id": 0,
272 "amount": 0,
273 "unroundedAmount": 0,
274 "deltaAdjustment": 0,
275 "itemNoAcc": 0,
276 "currencyDetail": {
277 "currencyId": 0,
278 "currencyDisplayId": "string",
279 "currencyDefinitionType": "CONTRACT_CURRENCY",
280 "currencyType": "string"
281 },
282 "currencyConversionDetail": {
283 "rate": 0,
284 "conversionDate": "2019-08-24",
285 "translationDateType": "DOCUMENT_DATE",
286 "sourceCurrencyType": "CONTRACT_CURRENCY",
287 "sourceCurrency": {
288 "id": 0,
289 "displayId": "string"
290 },
291 "depreciationArea": {
292 "id": 0,
293 "displayId": "string"
294 }
295 },
296 "ledgerEntryId": 0,
297 "ledgerEntryTaxId": 0
298 }
299 ],
300 "tag": "string",
301 "costCenter": {
302 "id": 0,
303 "displayId": "string",
304 "mainCostCenter": true,
305 "allocationPercentage": 0.1
306 },
307 "profitCenter": {
308 "id": 0,
309 "displayId": "string"
310 },
311 "partner": {
312 "id": 0,
313 "displayId": "string"
314 },
315 "transactionType": "string",
316 "nlaCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "nreCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "apCustomReferences": [
331 {
332 "key": "string",
333 "dataType": "STRING",
334 "value": 0
335 }
336 ],
337 "taxEntries": [
338 {
339 "id": 0,
340 "entryType": "D",
341 "amount": 0,
342 "unroundedAmount": 0,
343 "deltaAdjustment": 0,
344 "itemText": "string",
345 "itemNoAcc": 0,
346 "generalLedger": {
347 "id": 0,
348 "displayId": "string",
349 "generalLedgerAccountName": "string",
350 "generalLedgerAccountCode": "string",
351 "openItemManagement": true,
352 "accountCategory": "BALANCESHEET",
353 "shortName": "string",
354 "longName": "string"
355 },
356 "additionalCurrencyEntries": [
357 {
358 "id": 0,
359 "amount": 0,
360 "unroundedAmount": 0,
361 "deltaAdjustment": 0,
362 "itemNoAcc": 0,
363 "currencyDetail": {
364 "currencyId": 0,
365 "currencyDisplayId": "string",
366 "currencyDefinitionType": "CONTRACT_CURRENCY",
367 "currencyType": "string"
368 },
369 "currencyConversionDetail": {
370 "rate": 0,
371 "conversionDate": "2019-08-24",
372 "translationDateType": "DOCUMENT_DATE",
373 "sourceCurrencyType": "CONTRACT_CURRENCY",
374 "sourceCurrency": {
375 "id": 0,
376 "displayId": "string"
377 },
378 "depreciationArea": {
379 "id": 0,
380 "displayId": "string"
381 }
382 },
383 "ledgerEntryId": 0,
384 "ledgerEntryTaxId": 0
385 }
386 ],
387 "taxRate": 0,
388 "taxBaseAmount": 0,
389 "totalTaxDocumentAmount": 0,
390 "taxExempt": 0,
391 "taxExemptionPercentage": 0,
392 "taxAffected": 0,
393 "taxAccount": "string",
394 "accountingKey": "string",
395 "conditionKey": "string",
396 "taxCode": {
397 "id": 0,
398 "displayId": "string"
399 },
400 "taxJurisdiction": {
401 "id": 0,
402 "displayId": "string"
403 },
404 "taxDetermination": {
405 "id": 0,
406 "displayId": "string"
407 },
408 "financialTermId": 0,
409 "ledgerEntryId": 0
410 }
411 ],
412 "ledgerTransactionId": 0
413 }
414 ],
415 "notes": [
416 {
417 "id": 0,
418 "note": "string"
419 }
420 ],
421 "attachments": [
422 {
423 "id": 0,
424 "fileName": "string",
425 "fileStorageId": "string",
426 "docStoreId": 0
427 }
428 ],
429 "journalVoucherWorkflowHistory": [
430 {
431 "id": 0,
432 "eventType": "SEND_TO_APPROVAL",
433 "eventDate": "2019-08-24T14:15:22Z",
434 "user": "string"
435 }
436 ],
437 "ledgerTransactionGroupId": 0,
438 "accountingDocumentId": 0,
439 "internalPostingStatus": {
440 "documentNumber": "string",
441 "status": "NA",
442 "postingMessage": "string"
443 },
444 "nlaEnrichmentState": {
445 "id": 0,
446 "status": "PENDING",
447 "message": "string",
448 "history": [
449 {
450 "requestingUser": "string",
451 "enrichmentRequestId": 0,
452 "requestedAt": "2019-08-24T14:15:22Z",
453 "enrichedAt": "2019-08-24T14:15:22Z",
454 "requestStatus": "SENT",
455 "applicationStatus": "PENDING",
456 "message": "string"
457 }
458 ]
459 },
460 "nreEnrichmentState": {
461 "id": 0,
462 "status": "PENDING",
463 "message": "string",
464 "history": [
465 {
466 "requestingUser": "string",
467 "enrichmentRequestId": 0,
468 "requestedAt": "2019-08-24T14:15:22Z",
469 "enrichedAt": "2019-08-24T14:15:22Z",
470 "requestStatus": "SENT",
471 "applicationStatus": "PENDING",
472 "message": "string"
473 }
474 ]
475 },
476 "apEnrichmentState": {
477 "id": 0,
478 "status": "PENDING",
479 "message": "string",
480 "history": [
481 {
482 "requestingUser": "string",
483 "enrichmentRequestId": 0,
484 "requestedAt": "2019-08-24T14:15:22Z",
485 "enrichedAt": "2019-08-24T14:15:22Z",
486 "requestStatus": "SENT",
487 "applicationStatus": "PENDING",
488 "message": "string"
489 }
490 ]
491 },
492 "externalPostingStatus": {
493 "documentNumber": "string",
494 "objType": "string",
495 "objKey": "string",
496 "objSys": "string",
497 "username": "string",
498 "status": "NA",
499 "postingMessage": "string",
500 "taskId": 0
501 }
502}
Rework Journal Voucher¶
HTTP Request
POST /api/v1/general-ledger/journal-vouchers/rework/{transaction_id}
📋 Description: Submits a request to rework a specific journal voucher identified by the transaction ID, allowing for adjustments to ledger entries and ensuring accurate financial records within the General Ledger.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transaction_id |
path |
integer(int64) |
true |
Unique identifier for the financial transaction associated with the journal voucher, essential for reworking ledger entries in the General Ledger. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "requestUniqueId": "string",
4 "createdByApplication": "NLA",
5 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
6 "documentComments": "string",
7 "name": "string",
8 "principalPositionType": "LESSEE",
9 "postingTransactionType": "POST",
10 "postingType": "PAYMENT",
11 "ledgerType": "LIABILITY",
12 "paymentType": "N_A",
13 "parallelCurrencyEnabled": true,
14 "generateInvoiceInAp": true,
15 "generateVendorInvoice": true,
16 "calculateTax": true,
17 "taxCalculationType": "NET",
18 "currencyDetail": {
19 "currencyId": 0,
20 "currencyDisplayId": "string",
21 "currencyDefinitionType": "CONTRACT_CURRENCY",
22 "currencyType": "string"
23 },
24 "classificationInfo": {
25 "accountingStandard": {
26 "id": 0,
27 "displayId": "string"
28 },
29 "leaseClassificationType": "NON_LEASE"
30 },
31 "date": {
32 "documentDate": "2019-08-24T14:15:22Z",
33 "userDocumentDate": "2019-08-24",
34 "postingDate": "2019-08-24",
35 "transactionDate": "2019-08-24",
36 "translationDate": "2019-08-24",
37 "fiscalVariantId": 0,
38 "fiscalVariantDisplayId": "string",
39 "calendarType": "REGULAR_CALENDAR",
40 "fiscalYear": 0,
41 "fiscalPeriod": 0
42 },
43 "automaticReversal": {
44 "id": 0,
45 "postingDate": "2019-08-24",
46 "documentDate": "2019-08-24",
47 "reversalReason": {
48 "id": 0,
49 "displayId": "string"
50 }
51 },
52 "trace": {
53 "previousLedgerTransactionId": 0,
54 "nextLedgerTransactionId": 0,
55 "postExternalType": "SKIP"
56 },
57 "fosReferences": {
58 "id": 0,
59 "system": {
60 "id": 0,
61 "displayId": "string"
62 },
63 "company": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "leaseArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseGroup": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseDepartment": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "businessUnit": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "mainCostCenter": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "internalAssetClass": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "documentType": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "depreciationArea": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "reversalReason": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "tradingPartner": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "allocationNumber": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "responsibleCostCenter": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "workBreakdownStructure": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "businessArea": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "functionalArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "plant": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "internalOrder": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "network": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "paymentTerm": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentBlock": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentMethod": {
148 "id": 0,
149 "displayId": "string",
150 "type": "string"
151 },
152 "segment": {
153 "id": 0,
154 "displayId": "string"
155 },
156 "purchasingOrganization": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrder": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "ledgerTransactionId": 0
165 },
166 "assetRegisterReferences": {
167 "id": 0,
168 "asset": {
169 "assetId": 0,
170 "assetDisplayId": "string",
171 "assetNumber": "string",
172 "subAssetNumber": "string"
173 },
174 "ledgerTransactionId": 0
175 },
176 "nlaReferences": {
177 "id": 0,
178 "contract": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "leaseComponent": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "activationGroup": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "unit": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "contractExternalId": "string",
195 "journalId": 0,
196 "activationGroupRevisionId": 0,
197 "ledgerTransactionId": 0
198 },
199 "nlaCustomReferences": [
200 {
201 "key": "string",
202 "dataType": "STRING",
203 "value": 0
204 }
205 ],
206 "nreReferences": {
207 "id": 0,
208 "premise": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "location": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "lease": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "ledgerTransactionId": 0
221 },
222 "nreCustomReferences": [
223 {
224 "key": "string",
225 "dataType": "STRING",
226 "value": 0
227 }
228 ],
229 "apReferences": {
230 "id": 0,
231 "invoice": {
232 "id": 0,
233 "displayId": "string",
234 "name": "string"
235 },
236 "vendor": {
237 "id": 0,
238 "displayId": "string",
239 "name": "string"
240 },
241 "ledgerTransactionId": 0
242 },
243 "apCustomReferences": [
244 {
245 "key": "string",
246 "dataType": "STRING",
247 "value": 0
248 }
249 ],
250 "entries": [
251 {
252 "id": 0,
253 "entryType": "D",
254 "amount": 0,
255 "unroundedAmount": 0,
256 "deltaAdjustment": 0,
257 "itemText": "string",
258 "itemNoAcc": 0,
259 "generalLedger": {
260 "id": 0,
261 "displayId": "string",
262 "generalLedgerAccountName": "string",
263 "generalLedgerAccountCode": "string",
264 "openItemManagement": true,
265 "accountCategory": "BALANCESHEET",
266 "shortName": "string",
267 "longName": "string"
268 },
269 "additionalCurrencyEntries": [
270 {
271 "id": 0,
272 "amount": 0,
273 "unroundedAmount": 0,
274 "deltaAdjustment": 0,
275 "itemNoAcc": 0,
276 "currencyDetail": {
277 "currencyId": 0,
278 "currencyDisplayId": "string",
279 "currencyDefinitionType": "CONTRACT_CURRENCY",
280 "currencyType": "string"
281 },
282 "currencyConversionDetail": {
283 "rate": 0,
284 "conversionDate": "2019-08-24",
285 "translationDateType": "DOCUMENT_DATE",
286 "sourceCurrencyType": "CONTRACT_CURRENCY",
287 "sourceCurrency": {
288 "id": 0,
289 "displayId": "string"
290 },
291 "depreciationArea": {
292 "id": 0,
293 "displayId": "string"
294 }
295 },
296 "ledgerEntryId": 0,
297 "ledgerEntryTaxId": 0
298 }
299 ],
300 "tag": "string",
301 "costCenter": {
302 "id": 0,
303 "displayId": "string",
304 "mainCostCenter": true,
305 "allocationPercentage": 0.1
306 },
307 "profitCenter": {
308 "id": 0,
309 "displayId": "string"
310 },
311 "partner": {
312 "id": 0,
313 "displayId": "string"
314 },
315 "transactionType": "string",
316 "nlaCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "nreCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "apCustomReferences": [
331 {
332 "key": "string",
333 "dataType": "STRING",
334 "value": 0
335 }
336 ],
337 "taxEntries": [
338 {
339 "id": 0,
340 "entryType": "D",
341 "amount": 0,
342 "unroundedAmount": 0,
343 "deltaAdjustment": 0,
344 "itemText": "string",
345 "itemNoAcc": 0,
346 "generalLedger": {
347 "id": 0,
348 "displayId": "string",
349 "generalLedgerAccountName": "string",
350 "generalLedgerAccountCode": "string",
351 "openItemManagement": true,
352 "accountCategory": "BALANCESHEET",
353 "shortName": "string",
354 "longName": "string"
355 },
356 "additionalCurrencyEntries": [
357 {
358 "id": 0,
359 "amount": 0,
360 "unroundedAmount": 0,
361 "deltaAdjustment": 0,
362 "itemNoAcc": 0,
363 "currencyDetail": {
364 "currencyId": 0,
365 "currencyDisplayId": "string",
366 "currencyDefinitionType": "CONTRACT_CURRENCY",
367 "currencyType": "string"
368 },
369 "currencyConversionDetail": {
370 "rate": 0,
371 "conversionDate": "2019-08-24",
372 "translationDateType": "DOCUMENT_DATE",
373 "sourceCurrencyType": "CONTRACT_CURRENCY",
374 "sourceCurrency": {
375 "id": 0,
376 "displayId": "string"
377 },
378 "depreciationArea": {
379 "id": 0,
380 "displayId": "string"
381 }
382 },
383 "ledgerEntryId": 0,
384 "ledgerEntryTaxId": 0
385 }
386 ],
387 "taxRate": 0,
388 "taxBaseAmount": 0,
389 "totalTaxDocumentAmount": 0,
390 "taxExempt": 0,
391 "taxExemptionPercentage": 0,
392 "taxAffected": 0,
393 "taxAccount": "string",
394 "accountingKey": "string",
395 "conditionKey": "string",
396 "taxCode": {
397 "id": 0,
398 "displayId": "string"
399 },
400 "taxJurisdiction": {
401 "id": 0,
402 "displayId": "string"
403 },
404 "taxDetermination": {
405 "id": 0,
406 "displayId": "string"
407 },
408 "financialTermId": 0,
409 "ledgerEntryId": 0
410 }
411 ],
412 "ledgerTransactionId": 0
413 }
414 ],
415 "notes": [
416 {
417 "id": 0,
418 "note": "string"
419 }
420 ],
421 "attachments": [
422 {
423 "id": 0,
424 "fileName": "string",
425 "fileStorageId": "string",
426 "docStoreId": 0
427 }
428 ],
429 "journalVoucherWorkflowHistory": [
430 {
431 "id": 0,
432 "eventType": "SEND_TO_APPROVAL",
433 "eventDate": "2019-08-24T14:15:22Z",
434 "user": "string"
435 }
436 ],
437 "ledgerTransactionGroupId": 0,
438 "accountingDocumentId": 0,
439 "internalPostingStatus": {
440 "documentNumber": "string",
441 "status": "NA",
442 "postingMessage": "string"
443 },
444 "nlaEnrichmentState": {
445 "id": 0,
446 "status": "PENDING",
447 "message": "string",
448 "history": [
449 {
450 "requestingUser": "string",
451 "enrichmentRequestId": 0,
452 "requestedAt": "2019-08-24T14:15:22Z",
453 "enrichedAt": "2019-08-24T14:15:22Z",
454 "requestStatus": "SENT",
455 "applicationStatus": "PENDING",
456 "message": "string"
457 }
458 ]
459 },
460 "nreEnrichmentState": {
461 "id": 0,
462 "status": "PENDING",
463 "message": "string",
464 "history": [
465 {
466 "requestingUser": "string",
467 "enrichmentRequestId": 0,
468 "requestedAt": "2019-08-24T14:15:22Z",
469 "enrichedAt": "2019-08-24T14:15:22Z",
470 "requestStatus": "SENT",
471 "applicationStatus": "PENDING",
472 "message": "string"
473 }
474 ]
475 },
476 "apEnrichmentState": {
477 "id": 0,
478 "status": "PENDING",
479 "message": "string",
480 "history": [
481 {
482 "requestingUser": "string",
483 "enrichmentRequestId": 0,
484 "requestedAt": "2019-08-24T14:15:22Z",
485 "enrichedAt": "2019-08-24T14:15:22Z",
486 "requestStatus": "SENT",
487 "applicationStatus": "PENDING",
488 "message": "string"
489 }
490 ]
491 },
492 "externalPostingStatus": {
493 "documentNumber": "string",
494 "objType": "string",
495 "objKey": "string",
496 "objSys": "string",
497 "username": "string",
498 "status": "NA",
499 "postingMessage": "string",
500 "taskId": 0
501 }
502}
Create¶
HTTP Request
POST /api/v1/general-ledger/journal-vouchers/create
📋 Description: Creates a new journal voucher entry in the general ledger, facilitating accurate financial record-keeping and transaction management for accounts.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
files |
query |
array[string] |
false |
An array of file attachments related to the ledger entry, enabling the inclusion of supporting documentation for the transaction in the financial record. |
body |
body |
object |
true |
Request body containing the journal voucher data, including transaction details, account information, and associated financial records for ledger entry creation. |
» request |
body |
true |
Data transfer object representing a ledger transaction, encapsulating details of financial entries associated with accounts and their corresponding records within the general ledger. |
|
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» requestUniqueId |
body |
string |
false |
Unique identifier for the request unique |
»» createdByApplication |
body |
string |
false |
Text value for createdByApplication in LedgerTransactionDto |
»» applicationReferenceId |
body |
string |
true |
Any application MUST send a unique reference in order to ignore duplicate postings. |
»» documentComments |
body |
string |
false |
Text value for documentComments in LedgerTransactionDto |
»» name |
body |
string |
false |
Name of the resource |
»» principalPositionType |
body |
string |
false |
Type of the principal position |
»» postingTransactionType |
body |
string |
false |
Type of the posting transaction |
»» postingType |
body |
string |
false |
Type of the posting |
»» ledgerType |
body |
string |
false |
Type of the ledger |
»» paymentType |
body |
string |
false |
none |
»» parallelCurrencyEnabled |
body |
boolean |
false |
Indicates whether this feature is enabled |
»» generateInvoiceInAp |
body |
boolean |
false |
Boolean flag indicating generateInvoiceInAp status |
»» generateVendorInvoice |
body |
boolean |
false |
Boolean flag indicating generateVendorInvoice status |
»» calculateTax |
body |
boolean |
false |
Boolean flag indicating calculateTax status |
»» taxCalculationType |
body |
string |
false |
Type of the tax calculation |
»» currencyDetail |
body |
false |
Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management. |
|
»»» currencyId |
body |
integer(int64) |
false |
Unique identifier for the currency |
»»» currencyDisplayId |
body |
string |
false |
Unique identifier for the currency display |
»»» currencyDefinitionType |
body |
string |
false |
Type of the currency definition |
»»» currencyType |
body |
string |
false |
Type of the currency |
»» classificationInfo |
body |
false |
Data structure representing classification details for ledger entries, encompassing transaction types, associated accounts, and relevant financial records to facilitate accurate financial reporting and analysis. |
|
»»» accountingStandard |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» leaseClassificationType |
body |
string |
false |
Type of the lease classification |
»» date |
body |
false |
Data structure representing the date associated with a ledger transaction, crucial for maintaining accurate financial records and facilitating effective account management within the General Ledger. |
|
»»» documentDate |
body |
string(date-time) |
false |
Date of the document |
»»» userDocumentDate |
body |
string(date) |
false |
Date of the user document |
»»» postingDate |
body |
string(date) |
false |
Date of the posting |
»»» transactionDate |
body |
string(date) |
false |
Date of the transaction |
»»» translationDate |
body |
string(date) |
false |
Date of the translation |
»»» fiscalVariantId |
body |
integer(int64) |
false |
Unique identifier for the fiscal variant |
»»» fiscalVariantDisplayId |
body |
string |
false |
Unique identifier for the fiscal variant display |
»»» calendarType |
body |
string |
false |
Type of the calendar |
»»» fiscalYear |
body |
integer(int32) |
false |
Numeric value representing fiscalYear |
»»» fiscalPeriod |
body |
integer(int32) |
false |
Numeric value representing fiscalPeriod |
»» automaticReversal |
body |
false |
Data transfer object representing an automatic reversal of journal vouchers within the General Ledger, facilitating accurate financial record management and ensuring the integrity of ledger entries and transactions. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» postingDate |
body |
string(date) |
false |
Date of the posting |
»»» documentDate |
body |
string(date) |
false |
Date of the document |
»»» reversalReason |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» trace |
body |
false |
Data transfer object representing a detailed trace of ledger transactions, capturing essential information related to each financial record, including associated accounts and ledger entries. |
|
»»» previousLedgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the previous ledger transaction |
»»» nextLedgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the next ledger transaction |
»»» postExternalType |
body |
string |
false |
Type of the post external |
»» fosReferences |
body |
false |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» system |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» company |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseGroup |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseDepartment |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» businessUnit |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» mainCostCenter |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» internalAssetClass |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» documentType |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» depreciationArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» reversalReason |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» tradingPartner |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» allocationNumber |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» responsibleCostCenter |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» workBreakdownStructure |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» businessArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» functionalArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» plant |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» internalOrder |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» network |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» paymentTerm |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» paymentBlock |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» paymentMethod |
body |
false |
Data transfer object representing the unique identifier for a payment method used in ledger entries and financial transactions, facilitating accurate tracking and management of accounts and financial records. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» type |
body |
string |
true |
Type of the resource |
»»» segment |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» purchasingOrganization |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» purchasingOrder |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» assetRegisterReferences |
body |
false |
Data transfer object representing the references associated with ledger transactions in the asset register, facilitating accurate tracking and management of financial records within the general ledger. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» asset |
body |
false |
Data structure representing detailed information about an asset within the General Ledger, including its associated ledger entries, transactions, and account details, essential for accurate financial record management. |
|
»»»» assetId |
body |
integer(int64) |
false |
Unique identifier for the asset |
»»»» assetDisplayId |
body |
string |
false |
Unique identifier for the asset display |
»»»» assetNumber |
body |
string |
false |
Text value for assetNumber in AssetInfo |
»»»» subAssetNumber |
body |
string |
false |
Text value for subAssetNumber in AssetInfo |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» nlaReferences |
body |
false |
Data transfer object representing references associated with ledger transactions, facilitating the management of financial records and ensuring accurate accounting entries within the General Ledger. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» contract |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» leaseComponent |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» activationGroup |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» unit |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» contractExternalId |
body |
string |
false |
Unique identifier for the contract external |
»»» journalId |
body |
integer(int64) |
false |
Unique identifier for the journal |
»»» activationGroupRevisionId |
body |
integer(int64) |
false |
Unique identifier for the activation group revision |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» nlaCustomReferences |
body |
[oneOf] |
false |
List of nlaCustomReferences items |
»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»»» key |
body |
string |
false |
Text value for key in CustomApplicationReferenceDto |
»»»»» dataType |
body |
string |
false |
Type of the data |
»»»»» value |
body |
object |
false |
Object containing value details |
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
number |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
boolean |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
string(date) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
number(double) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
integer(int32) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
integer(int64) |
false |
none |
»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
object |
false |
none |
»»»»» value |
body |
string |
false |
none |
»» nreReferences |
body |
false |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» premise |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» location |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» lease |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» nreCustomReferences |
body |
[oneOf] |
false |
List of nreCustomReferences items |
»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»» apReferences |
body |
false |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records for accurate transaction tracking and reporting within the General Ledger domain. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» invoice |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» name |
body |
string |
false |
none |
»»» vendor |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» name |
body |
string |
false |
none |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» apCustomReferences |
body |
[oneOf] |
false |
List of apCustomReferences items |
»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»» entries |
body |
false |
List of entries items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» entryType |
body |
string |
true |
Type of the entry |
»»» amount |
body |
number |
true |
Amount value |
»»» unroundedAmount |
body |
number |
false |
Amount of unrounded |
»»» deltaAdjustment |
body |
number |
false |
Value for deltaAdjustment field |
»»» itemText |
body |
string |
false |
Text value for itemText in LedgerEntryDto |
»»» itemNoAcc |
body |
integer(int32) |
false |
Numeric value representing itemNoAcc |
»»» generalLedger |
body |
true |
Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» generalLedgerAccountName |
body |
string |
true |
Name of the general ledger account |
»»»» generalLedgerAccountCode |
body |
string |
true |
Code for the general ledger account |
»»»» openItemManagement |
body |
boolean |
true |
Boolean flag indicating openItemManagement status |
»»»» accountCategory |
body |
string |
true |
Category of the account |
»»»» shortName |
body |
string |
false |
Abbreviated name of the resource |
»»»» longName |
body |
string |
false |
Name of the long |
»»» additionalCurrencyEntries |
body |
false |
List of additionalCurrencyEntries items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» amount |
body |
number |
false |
Amount value |
»»»» unroundedAmount |
body |
number |
false |
Amount of unrounded |
»»»» deltaAdjustment |
body |
number |
false |
Value for deltaAdjustment field |
»»»» itemNoAcc |
body |
integer(int32) |
false |
Numeric value representing itemNoAcc |
»»»» currencyDetail |
body |
false |
Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management. |
|
»»»» currencyConversionDetail |
body |
false |
Data transfer object representing the details of currency conversion for ledger entries, facilitating accurate transaction recording and financial reporting within accounts. |
|
»»»»» rate |
body |
number |
false |
Rate value |
»»»»» conversionDate |
body |
string(date) |
false |
Date of the conversion |
»»»»» translationDateType |
body |
string |
false |
Type of the translation date |
»»»»» sourceCurrencyType |
body |
string |
false |
Type of the source currency |
»»»»» sourceCurrency |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»»» depreciationArea |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» ledgerEntryId |
body |
integer(int64) |
false |
Unique identifier for the ledger entry |
»»»» ledgerEntryTaxId |
body |
integer(int64) |
false |
Unique identifier for the ledger entry tax |
»»» tag |
body |
string |
false |
Text value for tag in LedgerEntryDto |
»»» costCenter |
body |
false |
Data structure representing the allocation of costs to specific cost centers within the General Ledger, facilitating accurate tracking and reporting of financial transactions and ledger entries. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» mainCostCenter |
body |
boolean |
false |
Boolean flag indicating mainCostCenter status |
»»»» allocationPercentage |
body |
number(double) |
false |
Percentage of allocation |
»»» profitCenter |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» partner |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» transactionType |
body |
string |
false |
Type of the transaction |
»»» nlaCustomReferences |
body |
[oneOf] |
false |
List of nlaCustomReferences items |
»»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»» nreCustomReferences |
body |
[oneOf] |
false |
List of nreCustomReferences items |
»»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»» apCustomReferences |
body |
[oneOf] |
false |
List of apCustomReferences items |
»»»» anonymous |
body |
false |
Data transfer object representing a financial record in the General Ledger, specifically designed to capture and manage ledger entries and transactions involving monetary values as BigDecimal types. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a boolean reference for custom applications within the General Ledger, facilitating the management of ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference date for custom applications within the General Ledger, facilitating accurate ledger entries and financial transactions by ensuring proper alignment of accounting records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for a custom application within the General Ledger, facilitating the management of ledger entries, transactions, and associated financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom application reference as an integer, utilized in the General Ledger domain to uniquely identify ledger entries, transactions, and accounts within financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a reference for custom applications within the General Ledger, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» anonymous |
body |
false |
Data transfer object representing a custom reference string associated with ledger entries, transactions, and accounts within the General Ledger, facilitating the identification and tracking of financial records. |
|
»»» taxEntries |
body |
false |
List of taxEntries items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» entryType |
body |
string |
true |
Type of the entry |
»»»» amount |
body |
number |
true |
Amount value |
»»»» unroundedAmount |
body |
number |
false |
Amount of unrounded |
»»»» deltaAdjustment |
body |
number |
false |
Value for deltaAdjustment field |
»»»» itemText |
body |
string |
false |
Text value for itemText in LedgerEntryTaxDto |
»»»» itemNoAcc |
body |
integer(int32) |
false |
Numeric value representing itemNoAcc |
»»»» generalLedger |
body |
true |
Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain. |
|
»»»» additionalCurrencyEntries |
body |
false |
List of additionalCurrencyEntries items |
|
»»»» taxRate |
body |
number |
false |
Rate of tax |
»»»» taxBaseAmount |
body |
number |
false |
Amount of tax base |
»»»» totalTaxDocumentAmount |
body |
number |
false |
Amount of total tax document |
»»»» taxExempt |
body |
number |
false |
Value for taxExempt field |
»»»» taxExemptionPercentage |
body |
number |
false |
Percentage of tax exemption |
»»»» taxAffected |
body |
number |
false |
Value for taxAffected field |
»»»» taxAccount |
body |
string |
false |
Number of ledger entry items |
»»»» accountingKey |
body |
string |
false |
Text value for accountingKey in LedgerEntryTaxDto |
»»»» conditionKey |
body |
string |
false |
Represents the specific condition associated with a ledger entry, facilitating accurate tracking and categorization of financial transactions within the general ledger. |
»»»» taxCode |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» taxJurisdiction |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» taxDetermination |
body |
false |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» financialTermId |
body |
integer(int64) |
false |
Unique identifier for the financial term |
»»»» ledgerEntryId |
body |
integer(int64) |
false |
Unique identifier for the ledger entry |
»»» ledgerTransactionId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction |
»» notes |
body |
false |
List of notes items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» note |
body |
string |
false |
Text value for note in LedgerTransactionNoteDto |
»» attachments |
body |
false |
List of attachments items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» fileName |
body |
string |
false |
Name of the file |
»»» fileStorageId |
body |
string |
false |
Unique identifier for the file storage |
»»» docStoreId |
body |
integer(int64) |
false |
Unique identifier for the doc store |
»» journalVoucherWorkflowHistory |
body |
false |
List of journalVoucherWorkflowHistory items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» eventType |
body |
string |
false |
Type of the event |
»»» eventDate |
body |
string(date-time) |
false |
Date of the event |
»»» user |
body |
string |
false |
User information related to accounting |
»» ledgerTransactionGroupId |
body |
integer(int64) |
false |
Unique identifier for the ledger transaction group |
»» accountingDocumentId |
body |
integer(int64) |
false |
Unique identifier for the accounting document |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» applicationReferenceId |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» createdByApplication |
ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE |
»» ledgerType |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER |
»» paymentType |
CLEARING, N_A, PAYMENT |
»» postingTransactionType |
POST, REVERSE |
»» postingType |
ACCRUAL, CHARGE, DEPRECIATION, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
»» principalPositionType |
LESSEE, LESSOR |
»» taxCalculationType |
NET |
»»» calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
»»» currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
»»» entryType |
C, D |
»»» eventType |
APPROVED, ARCHIVED, REWORK, SEND_TO_APPROVAL |
»»» leaseClassificationType |
DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM |
»»» postExternalType |
POST, SKIP |
»»»» accountCategory |
BALANCESHEET, PROFITANDLOSS |
»»»» entryType |
C, D |
»»»»» dataType |
BIG_DECIMAL, BOOLEAN, DATE, DATETIME, DOUBLE, INTEGER, LONG, STRING |
»»»»» sourceCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A |
»»»»» translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Body Parameters
1{
2 "request": {
3 "accountingDocumentId": 0,
4 "apCustomReferences": [
5 {
6 "dataType": "STRING",
7 "key": "string",
8 "value": 0
9 }
10 ],
11 "apReferences": {
12 "id": 0,
13 "invoice": {
14 "displayId": "string",
15 "id": 0,
16 "name": "string"
17 },
18 "ledgerTransactionId": 0,
19 "vendor": {
20 "displayId": "string",
21 "id": 0,
22 "name": "string"
23 }
24 },
25 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
26 "assetRegisterReferences": {
27 "asset": {
28 "assetDisplayId": "string",
29 "assetId": 0,
30 "assetNumber": "string",
31 "subAssetNumber": "string"
32 },
33 "id": 0,
34 "ledgerTransactionId": 0
35 },
36 "attachments": [
37 {
38 "docStoreId": 0,
39 "fileName": "string",
40 "fileStorageId": "string",
41 "id": 0
42 }
43 ],
44 "automaticReversal": {
45 "documentDate": "2019-08-24",
46 "id": 0,
47 "postingDate": "2019-08-24",
48 "reversalReason": {
49 "displayId": "string",
50 "id": 0
51 }
52 },
53 "calculateTax": true,
54 "classificationInfo": {
55 "accountingStandard": {
56 "displayId": "string",
57 "id": 0
58 },
59 "leaseClassificationType": "NON_LEASE"
60 },
61 "createdByApplication": "NLA",
62 "currencyDetail": {
63 "currencyDefinitionType": "CONTRACT_CURRENCY",
64 "currencyDisplayId": "string",
65 "currencyId": 0,
66 "currencyType": "string"
67 },
68 "date": {
69 "calendarType": "REGULAR_CALENDAR",
70 "documentDate": "2019-08-24 14:15:22+00:00",
71 "fiscalPeriod": 0,
72 "fiscalVariantDisplayId": "string",
73 "fiscalVariantId": 0,
74 "fiscalYear": 0,
75 "postingDate": "2019-08-24",
76 "transactionDate": "2019-08-24",
77 "translationDate": "2019-08-24",
78 "userDocumentDate": "2019-08-24"
79 },
80 "documentComments": "string",
81 "entries": [
82 {
83 "additionalCurrencyEntries": [
84 {
85 "amount": 0,
86 "currencyConversionDetail": {
87 "conversionDate": "2019-08-24",
88 "depreciationArea": {
89 "displayId": "string",
90 "id": 0
91 },
92 "rate": 0,
93 "sourceCurrency": {
94 "displayId": "string",
95 "id": 0
96 },
97 "sourceCurrencyType": "CONTRACT_CURRENCY",
98 "translationDateType": "DOCUMENT_DATE"
99 },
100 "currencyDetail": {
101 "currencyDefinitionType": "CONTRACT_CURRENCY",
102 "currencyDisplayId": "string",
103 "currencyId": 0,
104 "currencyType": "string"
105 },
106 "deltaAdjustment": 0,
107 "id": 0,
108 "itemNoAcc": 0,
109 "ledgerEntryId": 0,
110 "ledgerEntryTaxId": 0,
111 "unroundedAmount": 0
112 }
113 ],
114 "amount": 0,
115 "apCustomReferences": [
116 {
117 "dataType": "STRING",
118 "key": "string",
119 "value": 0
120 }
121 ],
122 "costCenter": {
123 "allocationPercentage": 0.1,
124 "displayId": "string",
125 "id": 0,
126 "mainCostCenter": true
127 },
128 "deltaAdjustment": 0,
129 "entryType": "D",
130 "generalLedger": {
131 "accountCategory": "BALANCESHEET",
132 "displayId": "string",
133 "generalLedgerAccountCode": "string",
134 "generalLedgerAccountName": "string",
135 "id": 0,
136 "longName": "string",
137 "openItemManagement": true,
138 "shortName": "string"
139 },
140 "id": 0,
141 "itemNoAcc": 0,
142 "itemText": "string",
143 "ledgerTransactionId": 0,
144 "nlaCustomReferences": [
145 {
146 "dataType": "STRING",
147 "key": "string",
148 "value": 0
149 }
150 ],
151 "nreCustomReferences": [
152 {
153 "dataType": "STRING",
154 "key": "string",
155 "value": 0
156 }
157 ],
158 "partner": {
159 "displayId": "string",
160 "id": 0
161 },
162 "profitCenter": {
163 "displayId": "string",
164 "id": 0
165 },
166 "tag": "string",
167 "taxEntries": [
168 {
169 "accountingKey": "string",
170 "additionalCurrencyEntries": [
171 {
172 "amount": 0,
173 "currencyConversionDetail": {
174 "conversionDate": "2019-08-24",
175 "depreciationArea": {
176 "displayId": "string",
177 "id": 0
178 },
179 "rate": 0,
180 "sourceCurrency": {
181 "displayId": "string",
182 "id": 0
183 },
184 "sourceCurrencyType": "CONTRACT_CURRENCY",
185 "translationDateType": "DOCUMENT_DATE"
186 },
187 "currencyDetail": {
188 "currencyDefinitionType": "CONTRACT_CURRENCY",
189 "currencyDisplayId": "string",
190 "currencyId": 0,
191 "currencyType": "string"
192 },
193 "deltaAdjustment": 0,
194 "id": 0,
195 "itemNoAcc": 0,
196 "ledgerEntryId": 0,
197 "ledgerEntryTaxId": 0,
198 "unroundedAmount": 0
199 }
200 ],
201 "amount": 0,
202 "conditionKey": "string",
203 "deltaAdjustment": 0,
204 "entryType": "D",
205 "financialTermId": 0,
206 "generalLedger": {
207 "accountCategory": "BALANCESHEET",
208 "displayId": "string",
209 "generalLedgerAccountCode": "string",
210 "generalLedgerAccountName": "string",
211 "id": 0,
212 "longName": "string",
213 "openItemManagement": true,
214 "shortName": "string"
215 },
216 "id": 0,
217 "itemNoAcc": 0,
218 "itemText": "string",
219 "ledgerEntryId": 0,
220 "taxAccount": "string",
221 "taxAffected": 0,
222 "taxBaseAmount": 0,
223 "taxCode": {
224 "displayId": "string",
225 "id": 0
226 },
227 "taxDetermination": {
228 "displayId": "string",
229 "id": 0
230 },
231 "taxExempt": 0,
232 "taxExemptionPercentage": 0,
233 "taxJurisdiction": {
234 "displayId": "string",
235 "id": 0
236 },
237 "taxRate": 0,
238 "totalTaxDocumentAmount": 0,
239 "unroundedAmount": 0
240 }
241 ],
242 "transactionType": "string",
243 "unroundedAmount": 0
244 }
245 ],
246 "fosReferences": {
247 "allocationNumber": {
248 "displayId": "string",
249 "id": 0
250 },
251 "businessArea": {
252 "displayId": "string",
253 "id": 0
254 },
255 "businessUnit": {
256 "displayId": "string",
257 "id": 0
258 },
259 "company": {
260 "displayId": "string",
261 "id": 0
262 },
263 "depreciationArea": {
264 "displayId": "string",
265 "id": 0
266 },
267 "documentType": {
268 "displayId": "string",
269 "id": 0
270 },
271 "functionalArea": {
272 "displayId": "string",
273 "id": 0
274 },
275 "id": 0,
276 "internalAssetClass": {
277 "displayId": "string",
278 "id": 0
279 },
280 "internalOrder": {
281 "displayId": "string",
282 "id": 0
283 },
284 "leaseArea": {
285 "displayId": "string",
286 "id": 0
287 },
288 "leaseDepartment": {
289 "displayId": "string",
290 "id": 0
291 },
292 "leaseGroup": {
293 "displayId": "string",
294 "id": 0
295 },
296 "ledgerTransactionId": 0,
297 "mainCostCenter": {
298 "displayId": "string",
299 "id": 0
300 },
301 "network": {
302 "displayId": "string",
303 "id": 0
304 },
305 "paymentBlock": {
306 "displayId": "string",
307 "id": 0
308 },
309 "paymentMethod": {
310 "displayId": "string",
311 "id": 0,
312 "type": "string"
313 },
314 "paymentTerm": {
315 "displayId": "string",
316 "id": 0
317 },
318 "plant": {
319 "displayId": "string",
320 "id": 0
321 },
322 "purchasingOrder": {
323 "displayId": "string",
324 "id": 0
325 },
326 "purchasingOrganization": {
327 "displayId": "string",
328 "id": 0
329 },
330 "responsibleCostCenter": {
331 "displayId": "string",
332 "id": 0
333 },
334 "reversalReason": {
335 "displayId": "string",
336 "id": 0
337 },
338 "segment": {
339 "displayId": "string",
340 "id": 0
341 },
342 "system": {
343 "displayId": "string",
344 "id": 0
345 },
346 "tradingPartner": {
347 "displayId": "string",
348 "id": 0
349 },
350 "workBreakdownStructure": {
351 "displayId": "string",
352 "id": 0
353 }
354 },
355 "generateInvoiceInAp": true,
356 "generateVendorInvoice": true,
357 "id": 0,
358 "journalVoucherWorkflowHistory": [
359 {
360 "eventDate": "2019-08-24 14:15:22+00:00",
361 "eventType": "SEND_TO_APPROVAL",
362 "id": 0,
363 "user": "string"
364 }
365 ],
366 "ledgerTransactionGroupId": 0,
367 "ledgerType": "LIABILITY",
368 "name": "string",
369 "nlaCustomReferences": [
370 {
371 "dataType": "STRING",
372 "key": "string",
373 "value": 0
374 }
375 ],
376 "nlaReferences": {
377 "activationGroup": {
378 "displayId": "string",
379 "id": 0
380 },
381 "activationGroupRevisionId": 0,
382 "contract": {
383 "displayId": "string",
384 "id": 0
385 },
386 "contractExternalId": "string",
387 "id": 0,
388 "journalId": 0,
389 "leaseComponent": {
390 "displayId": "string",
391 "id": 0
392 },
393 "ledgerTransactionId": 0,
394 "unit": {
395 "displayId": "string",
396 "id": 0
397 }
398 },
399 "notes": [
400 {
401 "id": 0,
402 "note": "string"
403 }
404 ],
405 "nreCustomReferences": [
406 {
407 "dataType": "STRING",
408 "key": "string",
409 "value": 0
410 }
411 ],
412 "nreReferences": {
413 "id": 0,
414 "lease": {
415 "displayId": "string",
416 "id": 0
417 },
418 "ledgerTransactionId": 0,
419 "location": {
420 "displayId": "string",
421 "id": 0
422 },
423 "premise": {
424 "displayId": "string",
425 "id": 0
426 }
427 },
428 "parallelCurrencyEnabled": true,
429 "paymentType": "N_A",
430 "postingTransactionType": "POST",
431 "postingType": "PAYMENT",
432 "principalPositionType": "LESSEE",
433 "requestUniqueId": "string",
434 "taxCalculationType": "NET",
435 "trace": {
436 "nextLedgerTransactionId": 0,
437 "postExternalType": "SKIP",
438 "previousLedgerTransactionId": 0
439 }
440 }
441}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "requestUniqueId": "string",
4 "createdByApplication": "NLA",
5 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
6 "documentComments": "string",
7 "name": "string",
8 "principalPositionType": "LESSEE",
9 "postingTransactionType": "POST",
10 "postingType": "PAYMENT",
11 "ledgerType": "LIABILITY",
12 "paymentType": "N_A",
13 "parallelCurrencyEnabled": true,
14 "generateInvoiceInAp": true,
15 "generateVendorInvoice": true,
16 "calculateTax": true,
17 "taxCalculationType": "NET",
18 "currencyDetail": {
19 "currencyId": 0,
20 "currencyDisplayId": "string",
21 "currencyDefinitionType": "CONTRACT_CURRENCY",
22 "currencyType": "string"
23 },
24 "classificationInfo": {
25 "accountingStandard": {
26 "id": 0,
27 "displayId": "string"
28 },
29 "leaseClassificationType": "NON_LEASE"
30 },
31 "date": {
32 "documentDate": "2019-08-24T14:15:22Z",
33 "userDocumentDate": "2019-08-24",
34 "postingDate": "2019-08-24",
35 "transactionDate": "2019-08-24",
36 "translationDate": "2019-08-24",
37 "fiscalVariantId": 0,
38 "fiscalVariantDisplayId": "string",
39 "calendarType": "REGULAR_CALENDAR",
40 "fiscalYear": 0,
41 "fiscalPeriod": 0
42 },
43 "automaticReversal": {
44 "id": 0,
45 "postingDate": "2019-08-24",
46 "documentDate": "2019-08-24",
47 "reversalReason": {
48 "id": 0,
49 "displayId": "string"
50 }
51 },
52 "trace": {
53 "previousLedgerTransactionId": 0,
54 "nextLedgerTransactionId": 0,
55 "postExternalType": "SKIP"
56 },
57 "fosReferences": {
58 "id": 0,
59 "system": {
60 "id": 0,
61 "displayId": "string"
62 },
63 "company": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "leaseArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseGroup": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseDepartment": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "businessUnit": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "mainCostCenter": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "internalAssetClass": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "documentType": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "depreciationArea": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "reversalReason": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "tradingPartner": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "allocationNumber": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "responsibleCostCenter": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "workBreakdownStructure": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "businessArea": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "functionalArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "plant": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "internalOrder": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "network": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "paymentTerm": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentBlock": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentMethod": {
148 "id": 0,
149 "displayId": "string",
150 "type": "string"
151 },
152 "segment": {
153 "id": 0,
154 "displayId": "string"
155 },
156 "purchasingOrganization": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrder": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "ledgerTransactionId": 0
165 },
166 "assetRegisterReferences": {
167 "id": 0,
168 "asset": {
169 "assetId": 0,
170 "assetDisplayId": "string",
171 "assetNumber": "string",
172 "subAssetNumber": "string"
173 },
174 "ledgerTransactionId": 0
175 },
176 "nlaReferences": {
177 "id": 0,
178 "contract": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "leaseComponent": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "activationGroup": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "unit": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "contractExternalId": "string",
195 "journalId": 0,
196 "activationGroupRevisionId": 0,
197 "ledgerTransactionId": 0
198 },
199 "nlaCustomReferences": [
200 {
201 "key": "string",
202 "dataType": "STRING",
203 "value": 0
204 }
205 ],
206 "nreReferences": {
207 "id": 0,
208 "premise": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "location": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "lease": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "ledgerTransactionId": 0
221 },
222 "nreCustomReferences": [
223 {
224 "key": "string",
225 "dataType": "STRING",
226 "value": 0
227 }
228 ],
229 "apReferences": {
230 "id": 0,
231 "invoice": {
232 "id": 0,
233 "displayId": "string",
234 "name": "string"
235 },
236 "vendor": {
237 "id": 0,
238 "displayId": "string",
239 "name": "string"
240 },
241 "ledgerTransactionId": 0
242 },
243 "apCustomReferences": [
244 {
245 "key": "string",
246 "dataType": "STRING",
247 "value": 0
248 }
249 ],
250 "entries": [
251 {
252 "id": 0,
253 "entryType": "D",
254 "amount": 0,
255 "unroundedAmount": 0,
256 "deltaAdjustment": 0,
257 "itemText": "string",
258 "itemNoAcc": 0,
259 "generalLedger": {
260 "id": 0,
261 "displayId": "string",
262 "generalLedgerAccountName": "string",
263 "generalLedgerAccountCode": "string",
264 "openItemManagement": true,
265 "accountCategory": "BALANCESHEET",
266 "shortName": "string",
267 "longName": "string"
268 },
269 "additionalCurrencyEntries": [
270 {
271 "id": 0,
272 "amount": 0,
273 "unroundedAmount": 0,
274 "deltaAdjustment": 0,
275 "itemNoAcc": 0,
276 "currencyDetail": {
277 "currencyId": 0,
278 "currencyDisplayId": "string",
279 "currencyDefinitionType": "CONTRACT_CURRENCY",
280 "currencyType": "string"
281 },
282 "currencyConversionDetail": {
283 "rate": 0,
284 "conversionDate": "2019-08-24",
285 "translationDateType": "DOCUMENT_DATE",
286 "sourceCurrencyType": "CONTRACT_CURRENCY",
287 "sourceCurrency": {
288 "id": 0,
289 "displayId": "string"
290 },
291 "depreciationArea": {
292 "id": 0,
293 "displayId": "string"
294 }
295 },
296 "ledgerEntryId": 0,
297 "ledgerEntryTaxId": 0
298 }
299 ],
300 "tag": "string",
301 "costCenter": {
302 "id": 0,
303 "displayId": "string",
304 "mainCostCenter": true,
305 "allocationPercentage": 0.1
306 },
307 "profitCenter": {
308 "id": 0,
309 "displayId": "string"
310 },
311 "partner": {
312 "id": 0,
313 "displayId": "string"
314 },
315 "transactionType": "string",
316 "nlaCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "nreCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "apCustomReferences": [
331 {
332 "key": "string",
333 "dataType": "STRING",
334 "value": 0
335 }
336 ],
337 "taxEntries": [
338 {
339 "id": 0,
340 "entryType": "D",
341 "amount": 0,
342 "unroundedAmount": 0,
343 "deltaAdjustment": 0,
344 "itemText": "string",
345 "itemNoAcc": 0,
346 "generalLedger": {
347 "id": 0,
348 "displayId": "string",
349 "generalLedgerAccountName": "string",
350 "generalLedgerAccountCode": "string",
351 "openItemManagement": true,
352 "accountCategory": "BALANCESHEET",
353 "shortName": "string",
354 "longName": "string"
355 },
356 "additionalCurrencyEntries": [
357 {
358 "id": 0,
359 "amount": 0,
360 "unroundedAmount": 0,
361 "deltaAdjustment": 0,
362 "itemNoAcc": 0,
363 "currencyDetail": {
364 "currencyId": 0,
365 "currencyDisplayId": "string",
366 "currencyDefinitionType": "CONTRACT_CURRENCY",
367 "currencyType": "string"
368 },
369 "currencyConversionDetail": {
370 "rate": 0,
371 "conversionDate": "2019-08-24",
372 "translationDateType": "DOCUMENT_DATE",
373 "sourceCurrencyType": "CONTRACT_CURRENCY",
374 "sourceCurrency": {
375 "id": 0,
376 "displayId": "string"
377 },
378 "depreciationArea": {
379 "id": 0,
380 "displayId": "string"
381 }
382 },
383 "ledgerEntryId": 0,
384 "ledgerEntryTaxId": 0
385 }
386 ],
387 "taxRate": 0,
388 "taxBaseAmount": 0,
389 "totalTaxDocumentAmount": 0,
390 "taxExempt": 0,
391 "taxExemptionPercentage": 0,
392 "taxAffected": 0,
393 "taxAccount": "string",
394 "accountingKey": "string",
395 "conditionKey": "string",
396 "taxCode": {
397 "id": 0,
398 "displayId": "string"
399 },
400 "taxJurisdiction": {
401 "id": 0,
402 "displayId": "string"
403 },
404 "taxDetermination": {
405 "id": 0,
406 "displayId": "string"
407 },
408 "financialTermId": 0,
409 "ledgerEntryId": 0
410 }
411 ],
412 "ledgerTransactionId": 0
413 }
414 ],
415 "notes": [
416 {
417 "id": 0,
418 "note": "string"
419 }
420 ],
421 "attachments": [
422 {
423 "id": 0,
424 "fileName": "string",
425 "fileStorageId": "string",
426 "docStoreId": 0
427 }
428 ],
429 "journalVoucherWorkflowHistory": [
430 {
431 "id": 0,
432 "eventType": "SEND_TO_APPROVAL",
433 "eventDate": "2019-08-24T14:15:22Z",
434 "user": "string"
435 }
436 ],
437 "ledgerTransactionGroupId": 0,
438 "accountingDocumentId": 0,
439 "internalPostingStatus": {
440 "documentNumber": "string",
441 "status": "NA",
442 "postingMessage": "string"
443 },
444 "nlaEnrichmentState": {
445 "id": 0,
446 "status": "PENDING",
447 "message": "string",
448 "history": [
449 {
450 "requestingUser": "string",
451 "enrichmentRequestId": 0,
452 "requestedAt": "2019-08-24T14:15:22Z",
453 "enrichedAt": "2019-08-24T14:15:22Z",
454 "requestStatus": "SENT",
455 "applicationStatus": "PENDING",
456 "message": "string"
457 }
458 ]
459 },
460 "nreEnrichmentState": {
461 "id": 0,
462 "status": "PENDING",
463 "message": "string",
464 "history": [
465 {
466 "requestingUser": "string",
467 "enrichmentRequestId": 0,
468 "requestedAt": "2019-08-24T14:15:22Z",
469 "enrichedAt": "2019-08-24T14:15:22Z",
470 "requestStatus": "SENT",
471 "applicationStatus": "PENDING",
472 "message": "string"
473 }
474 ]
475 },
476 "apEnrichmentState": {
477 "id": 0,
478 "status": "PENDING",
479 "message": "string",
480 "history": [
481 {
482 "requestingUser": "string",
483 "enrichmentRequestId": 0,
484 "requestedAt": "2019-08-24T14:15:22Z",
485 "enrichedAt": "2019-08-24T14:15:22Z",
486 "requestStatus": "SENT",
487 "applicationStatus": "PENDING",
488 "message": "string"
489 }
490 ]
491 },
492 "externalPostingStatus": {
493 "documentNumber": "string",
494 "objType": "string",
495 "objKey": "string",
496 "objSys": "string",
497 "username": "string",
498 "status": "NA",
499 "postingMessage": "string",
500 "taskId": 0
501 }
502}
Archive¶
HTTP Request
POST /api/v1/general-ledger/journal-vouchers/archive
📋 Description: Archives journal vouchers within the General Ledger, ensuring that financial records are maintained accurately and efficiently for ledger entries and transactions.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing the journal voucher data, including transaction details and associated account information, for archiving within the general ledger. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Approve Journal Voucher¶
HTTP Request
POST /api/v1/general-ledger/journal-vouchers/approve/{transaction_id}
📋 Description: Approves a specified journal voucher transaction in the General Ledger, ensuring that the financial record is accurately reflected in the ledger entries and associated accounts.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transaction_id |
path |
integer(int64) |
true |
Unique identifier for the financial transaction being approved in the general ledger, ensuring accurate ledger entry and record-keeping. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "requestUniqueId": "string",
4 "createdByApplication": "NLA",
5 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
6 "documentComments": "string",
7 "name": "string",
8 "principalPositionType": "LESSEE",
9 "postingTransactionType": "POST",
10 "postingType": "PAYMENT",
11 "ledgerType": "LIABILITY",
12 "paymentType": "N_A",
13 "parallelCurrencyEnabled": true,
14 "generateInvoiceInAp": true,
15 "generateVendorInvoice": true,
16 "calculateTax": true,
17 "taxCalculationType": "NET",
18 "currencyDetail": {
19 "currencyId": 0,
20 "currencyDisplayId": "string",
21 "currencyDefinitionType": "CONTRACT_CURRENCY",
22 "currencyType": "string"
23 },
24 "classificationInfo": {
25 "accountingStandard": {
26 "id": 0,
27 "displayId": "string"
28 },
29 "leaseClassificationType": "NON_LEASE"
30 },
31 "date": {
32 "documentDate": "2019-08-24T14:15:22Z",
33 "userDocumentDate": "2019-08-24",
34 "postingDate": "2019-08-24",
35 "transactionDate": "2019-08-24",
36 "translationDate": "2019-08-24",
37 "fiscalVariantId": 0,
38 "fiscalVariantDisplayId": "string",
39 "calendarType": "REGULAR_CALENDAR",
40 "fiscalYear": 0,
41 "fiscalPeriod": 0
42 },
43 "automaticReversal": {
44 "id": 0,
45 "postingDate": "2019-08-24",
46 "documentDate": "2019-08-24",
47 "reversalReason": {
48 "id": 0,
49 "displayId": "string"
50 }
51 },
52 "trace": {
53 "previousLedgerTransactionId": 0,
54 "nextLedgerTransactionId": 0,
55 "postExternalType": "SKIP"
56 },
57 "fosReferences": {
58 "id": 0,
59 "system": {
60 "id": 0,
61 "displayId": "string"
62 },
63 "company": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "leaseArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseGroup": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseDepartment": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "businessUnit": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "mainCostCenter": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "internalAssetClass": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "documentType": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "depreciationArea": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "reversalReason": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "tradingPartner": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "allocationNumber": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "responsibleCostCenter": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "workBreakdownStructure": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "businessArea": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "functionalArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "plant": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "internalOrder": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "network": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "paymentTerm": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentBlock": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentMethod": {
148 "id": 0,
149 "displayId": "string",
150 "type": "string"
151 },
152 "segment": {
153 "id": 0,
154 "displayId": "string"
155 },
156 "purchasingOrganization": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrder": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "ledgerTransactionId": 0
165 },
166 "assetRegisterReferences": {
167 "id": 0,
168 "asset": {
169 "assetId": 0,
170 "assetDisplayId": "string",
171 "assetNumber": "string",
172 "subAssetNumber": "string"
173 },
174 "ledgerTransactionId": 0
175 },
176 "nlaReferences": {
177 "id": 0,
178 "contract": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "leaseComponent": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "activationGroup": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "unit": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "contractExternalId": "string",
195 "journalId": 0,
196 "activationGroupRevisionId": 0,
197 "ledgerTransactionId": 0
198 },
199 "nlaCustomReferences": [
200 {
201 "key": "string",
202 "dataType": "STRING",
203 "value": 0
204 }
205 ],
206 "nreReferences": {
207 "id": 0,
208 "premise": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "location": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "lease": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "ledgerTransactionId": 0
221 },
222 "nreCustomReferences": [
223 {
224 "key": "string",
225 "dataType": "STRING",
226 "value": 0
227 }
228 ],
229 "apReferences": {
230 "id": 0,
231 "invoice": {
232 "id": 0,
233 "displayId": "string",
234 "name": "string"
235 },
236 "vendor": {
237 "id": 0,
238 "displayId": "string",
239 "name": "string"
240 },
241 "ledgerTransactionId": 0
242 },
243 "apCustomReferences": [
244 {
245 "key": "string",
246 "dataType": "STRING",
247 "value": 0
248 }
249 ],
250 "entries": [
251 {
252 "id": 0,
253 "entryType": "D",
254 "amount": 0,
255 "unroundedAmount": 0,
256 "deltaAdjustment": 0,
257 "itemText": "string",
258 "itemNoAcc": 0,
259 "generalLedger": {
260 "id": 0,
261 "displayId": "string",
262 "generalLedgerAccountName": "string",
263 "generalLedgerAccountCode": "string",
264 "openItemManagement": true,
265 "accountCategory": "BALANCESHEET",
266 "shortName": "string",
267 "longName": "string"
268 },
269 "additionalCurrencyEntries": [
270 {
271 "id": 0,
272 "amount": 0,
273 "unroundedAmount": 0,
274 "deltaAdjustment": 0,
275 "itemNoAcc": 0,
276 "currencyDetail": {
277 "currencyId": 0,
278 "currencyDisplayId": "string",
279 "currencyDefinitionType": "CONTRACT_CURRENCY",
280 "currencyType": "string"
281 },
282 "currencyConversionDetail": {
283 "rate": 0,
284 "conversionDate": "2019-08-24",
285 "translationDateType": "DOCUMENT_DATE",
286 "sourceCurrencyType": "CONTRACT_CURRENCY",
287 "sourceCurrency": {
288 "id": 0,
289 "displayId": "string"
290 },
291 "depreciationArea": {
292 "id": 0,
293 "displayId": "string"
294 }
295 },
296 "ledgerEntryId": 0,
297 "ledgerEntryTaxId": 0
298 }
299 ],
300 "tag": "string",
301 "costCenter": {
302 "id": 0,
303 "displayId": "string",
304 "mainCostCenter": true,
305 "allocationPercentage": 0.1
306 },
307 "profitCenter": {
308 "id": 0,
309 "displayId": "string"
310 },
311 "partner": {
312 "id": 0,
313 "displayId": "string"
314 },
315 "transactionType": "string",
316 "nlaCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "nreCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "apCustomReferences": [
331 {
332 "key": "string",
333 "dataType": "STRING",
334 "value": 0
335 }
336 ],
337 "taxEntries": [
338 {
339 "id": 0,
340 "entryType": "D",
341 "amount": 0,
342 "unroundedAmount": 0,
343 "deltaAdjustment": 0,
344 "itemText": "string",
345 "itemNoAcc": 0,
346 "generalLedger": {
347 "id": 0,
348 "displayId": "string",
349 "generalLedgerAccountName": "string",
350 "generalLedgerAccountCode": "string",
351 "openItemManagement": true,
352 "accountCategory": "BALANCESHEET",
353 "shortName": "string",
354 "longName": "string"
355 },
356 "additionalCurrencyEntries": [
357 {
358 "id": 0,
359 "amount": 0,
360 "unroundedAmount": 0,
361 "deltaAdjustment": 0,
362 "itemNoAcc": 0,
363 "currencyDetail": {
364 "currencyId": 0,
365 "currencyDisplayId": "string",
366 "currencyDefinitionType": "CONTRACT_CURRENCY",
367 "currencyType": "string"
368 },
369 "currencyConversionDetail": {
370 "rate": 0,
371 "conversionDate": "2019-08-24",
372 "translationDateType": "DOCUMENT_DATE",
373 "sourceCurrencyType": "CONTRACT_CURRENCY",
374 "sourceCurrency": {
375 "id": 0,
376 "displayId": "string"
377 },
378 "depreciationArea": {
379 "id": 0,
380 "displayId": "string"
381 }
382 },
383 "ledgerEntryId": 0,
384 "ledgerEntryTaxId": 0
385 }
386 ],
387 "taxRate": 0,
388 "taxBaseAmount": 0,
389 "totalTaxDocumentAmount": 0,
390 "taxExempt": 0,
391 "taxExemptionPercentage": 0,
392 "taxAffected": 0,
393 "taxAccount": "string",
394 "accountingKey": "string",
395 "conditionKey": "string",
396 "taxCode": {
397 "id": 0,
398 "displayId": "string"
399 },
400 "taxJurisdiction": {
401 "id": 0,
402 "displayId": "string"
403 },
404 "taxDetermination": {
405 "id": 0,
406 "displayId": "string"
407 },
408 "financialTermId": 0,
409 "ledgerEntryId": 0
410 }
411 ],
412 "ledgerTransactionId": 0
413 }
414 ],
415 "notes": [
416 {
417 "id": 0,
418 "note": "string"
419 }
420 ],
421 "attachments": [
422 {
423 "id": 0,
424 "fileName": "string",
425 "fileStorageId": "string",
426 "docStoreId": 0
427 }
428 ],
429 "journalVoucherWorkflowHistory": [
430 {
431 "id": 0,
432 "eventType": "SEND_TO_APPROVAL",
433 "eventDate": "2019-08-24T14:15:22Z",
434 "user": "string"
435 }
436 ],
437 "ledgerTransactionGroupId": 0,
438 "accountingDocumentId": 0,
439 "internalPostingStatus": {
440 "documentNumber": "string",
441 "status": "NA",
442 "postingMessage": "string"
443 },
444 "nlaEnrichmentState": {
445 "id": 0,
446 "status": "PENDING",
447 "message": "string",
448 "history": [
449 {
450 "requestingUser": "string",
451 "enrichmentRequestId": 0,
452 "requestedAt": "2019-08-24T14:15:22Z",
453 "enrichedAt": "2019-08-24T14:15:22Z",
454 "requestStatus": "SENT",
455 "applicationStatus": "PENDING",
456 "message": "string"
457 }
458 ]
459 },
460 "nreEnrichmentState": {
461 "id": 0,
462 "status": "PENDING",
463 "message": "string",
464 "history": [
465 {
466 "requestingUser": "string",
467 "enrichmentRequestId": 0,
468 "requestedAt": "2019-08-24T14:15:22Z",
469 "enrichedAt": "2019-08-24T14:15:22Z",
470 "requestStatus": "SENT",
471 "applicationStatus": "PENDING",
472 "message": "string"
473 }
474 ]
475 },
476 "apEnrichmentState": {
477 "id": 0,
478 "status": "PENDING",
479 "message": "string",
480 "history": [
481 {
482 "requestingUser": "string",
483 "enrichmentRequestId": 0,
484 "requestedAt": "2019-08-24T14:15:22Z",
485 "enrichedAt": "2019-08-24T14:15:22Z",
486 "requestStatus": "SENT",
487 "applicationStatus": "PENDING",
488 "message": "string"
489 }
490 ]
491 },
492 "externalPostingStatus": {
493 "documentNumber": "string",
494 "objType": "string",
495 "objKey": "string",
496 "objSys": "string",
497 "username": "string",
498 "status": "NA",
499 "postingMessage": "string",
500 "taskId": 0
501 }
502}
Download File¶
HTTP Request
GET /api/v1/general-ledger/journal-vouchers/download/{id}
📋 Description: Downloads the specified journal voucher from the General Ledger, providing access to detailed financial records associated with ledger entries and transactions. This operation enables users to efficiently manage and review account-related documentation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Notes¶
HTTP Request
DELETE /api/v1/general-ledger/journal-vouchers/notes
📋 Description: Deletes specified notes associated with journal vouchers in the General Ledger, ensuring accurate financial records by removing unnecessary or outdated ledger entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing the identifiers of the journal voucher notes to be deleted from the general ledger, ensuring accurate financial record management. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Files¶
HTTP Request
DELETE /api/v1/general-ledger/journal-vouchers/files
📋 Description: Deletes specified journal voucher files from the General Ledger, ensuring the removal of outdated or incorrect financial records associated with ledger entries and transactions.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing the identifiers of the journal voucher files to be deleted from the general ledger, ensuring accurate management of financial records and transactions. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |