Migration¶
Update Transaction Into General Ledger¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/migration
📋 Description: This API will update Transaction into General Ledger based on LedgerTransactionInfo information
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the ledger transaction data, including account details and financial records necessary for the migration of general ledger entries. |
Body Parameters
1{
2 "requestUniqueId": "string",
3 "transactions": [
4 {
5 "id": 0,
6 "requestUniqueId": "string",
7 "createdByApplication": "NLA",
8 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
9 "documentComments": "string",
10 "name": "string",
11 "principalPositionType": "LESSEE",
12 "postingTransactionType": "POST",
13 "postingType": "PAYMENT",
14 "ledgerType": "LIABILITY",
15 "paymentType": "N_A",
16 "parallelCurrencyEnabled": true,
17 "generateInvoiceInAp": true,
18 "generateVendorInvoice": true,
19 "calculateTax": true,
20 "taxCalculationType": "NET",
21 "currencyDetail": {
22 "currencyId": 0,
23 "currencyDisplayId": "string",
24 "currencyDefinitionType": "CONTRACT_CURRENCY",
25 "currencyType": "string"
26 },
27 "classificationInfo": {
28 "accountingStandard": {
29 "id": 0,
30 "displayId": "string"
31 },
32 "leaseClassificationType": "NON_LEASE"
33 },
34 "date": {
35 "documentDate": "2019-08-24T14:15:22Z",
36 "userDocumentDate": "2019-08-24",
37 "postingDate": "2019-08-24",
38 "transactionDate": "2019-08-24",
39 "translationDate": "2019-08-24",
40 "fiscalVariantId": 0,
41 "fiscalVariantDisplayId": "string",
42 "calendarType": "REGULAR_CALENDAR",
43 "fiscalYear": 0,
44 "fiscalPeriod": 0
45 },
46 "automaticReversal": {
47 "id": 0,
48 "postingDate": "2019-08-24",
49 "documentDate": "2019-08-24",
50 "reversalReason": {
51 "id": 0,
52 "displayId": "string"
53 }
54 },
55 "trace": {
56 "previousLedgerTransactionId": 0,
57 "nextLedgerTransactionId": 0,
58 "postExternalType": "SKIP"
59 },
60 "fosReferences": {
61 "id": 0,
62 "system": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "company": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "leaseArea": {
71 "id": 0,
72 "displayId": "string"
73 },
74 "leaseGroup": {
75 "id": 0,
76 "displayId": "string"
77 },
78 "leaseDepartment": {
79 "id": 0,
80 "displayId": "string"
81 },
82 "businessUnit": {
83 "id": 0,
84 "displayId": "string"
85 },
86 "mainCostCenter": {
87 "id": 0,
88 "displayId": "string"
89 },
90 "internalAssetClass": {
91 "id": 0,
92 "displayId": "string"
93 },
94 "documentType": {
95 "id": 0,
96 "displayId": "string"
97 },
98 "depreciationArea": {
99 "id": 0,
100 "displayId": "string"
101 },
102 "reversalReason": {
103 "id": 0,
104 "displayId": "string"
105 },
106 "tradingPartner": {
107 "id": 0,
108 "displayId": "string"
109 },
110 "allocationNumber": {
111 "id": 0,
112 "displayId": "string"
113 },
114 "responsibleCostCenter": {
115 "id": 0,
116 "displayId": "string"
117 },
118 "workBreakdownStructure": {
119 "id": 0,
120 "displayId": "string"
121 },
122 "businessArea": {
123 "id": 0,
124 "displayId": "string"
125 },
126 "functionalArea": {
127 "id": 0,
128 "displayId": "string"
129 },
130 "plant": {
131 "id": 0,
132 "displayId": "string"
133 },
134 "internalOrder": {
135 "id": 0,
136 "displayId": "string"
137 },
138 "network": {
139 "id": 0,
140 "displayId": "string"
141 },
142 "paymentTerm": {
143 "id": 0,
144 "displayId": "string"
145 },
146 "paymentBlock": {
147 "id": 0,
148 "displayId": "string"
149 },
150 "paymentMethod": {
151 "id": 0,
152 "displayId": "string",
153 "type": "string"
154 },
155 "segment": {
156 "id": 0,
157 "displayId": "string"
158 },
159 "purchasingOrganization": {
160 "id": 0,
161 "displayId": "string"
162 },
163 "purchasingOrder": {
164 "id": 0,
165 "displayId": "string"
166 },
167 "ledgerTransactionId": 0
168 },
169 "assetRegisterReferences": {
170 "id": 0,
171 "asset": {
172 "assetId": 0,
173 "assetDisplayId": "string",
174 "assetNumber": "string",
175 "subAssetNumber": "string"
176 },
177 "ledgerTransactionId": 0
178 },
179 "nlaReferences": {
180 "id": 0,
181 "contract": {
182 "id": 0,
183 "displayId": "string"
184 },
185 "leaseComponent": {
186 "id": 0,
187 "displayId": "string"
188 },
189 "activationGroup": {
190 "id": 0,
191 "displayId": "string"
192 },
193 "unit": {
194 "id": 0,
195 "displayId": "string"
196 },
197 "contractExternalId": "string",
198 "journalId": 0,
199 "activationGroupRevisionId": 0,
200 "ledgerTransactionId": 0
201 },
202 "nlaCustomReferences": [
203 {
204 "key": "string",
205 "dataType": "STRING",
206 "value": 0
207 }
208 ],
209 "nreReferences": {
210 "id": 0,
211 "premise": {
212 "id": 0,
213 "displayId": "string"
214 },
215 "location": {
216 "id": 0,
217 "displayId": "string"
218 },
219 "lease": {
220 "id": 0,
221 "displayId": "string"
222 },
223 "ledgerTransactionId": 0
224 },
225 "nreCustomReferences": [
226 {
227 "key": "string",
228 "dataType": "STRING",
229 "value": 0
230 }
231 ],
232 "apReferences": {
233 "id": 0,
234 "invoice": {
235 "id": 0,
236 "displayId": "string",
237 "name": "string"
238 },
239 "vendor": {
240 "id": 0,
241 "displayId": "string",
242 "name": "string"
243 },
244 "ledgerTransactionId": 0
245 },
246 "apCustomReferences": [
247 {
248 "key": "string",
249 "dataType": "STRING",
250 "value": 0
251 }
252 ],
253 "entries": [
254 {
255 "id": 0,
256 "entryType": "D",
257 "amount": 0,
258 "unroundedAmount": 0,
259 "deltaAdjustment": 0,
260 "itemText": "string",
261 "itemNoAcc": 0,
262 "generalLedger": {
263 "id": 0,
264 "displayId": "string",
265 "generalLedgerAccountName": "string",
266 "generalLedgerAccountCode": "string",
267 "openItemManagement": true,
268 "accountCategory": "BALANCESHEET",
269 "shortName": "string",
270 "longName": "string"
271 },
272 "additionalCurrencyEntries": [
273 {
274 "id": 0,
275 "amount": 0,
276 "unroundedAmount": 0,
277 "deltaAdjustment": 0,
278 "itemNoAcc": 0,
279 "currencyDetail": {
280 "currencyId": 0,
281 "currencyDisplayId": "string",
282 "currencyDefinitionType": "CONTRACT_CURRENCY",
283 "currencyType": "string"
284 },
285 "currencyConversionDetail": {
286 "rate": 0,
287 "conversionDate": "2019-08-24",
288 "translationDateType": "DOCUMENT_DATE",
289 "sourceCurrencyType": "CONTRACT_CURRENCY",
290 "sourceCurrency": {
291 "id": 0,
292 "displayId": "string"
293 },
294 "depreciationArea": {
295 "id": 0,
296 "displayId": "string"
297 }
298 },
299 "ledgerEntryId": 0,
300 "ledgerEntryTaxId": 0
301 }
302 ],
303 "tag": "string",
304 "costCenter": {
305 "id": 0,
306 "displayId": "string",
307 "mainCostCenter": true,
308 "allocationPercentage": 0.1
309 },
310 "profitCenter": {
311 "id": 0,
312 "displayId": "string"
313 },
314 "partner": {
315 "id": 0,
316 "displayId": "string"
317 },
318 "transactionType": "string",
319 "nlaCustomReferences": [
320 {
321 "key": "string",
322 "dataType": "STRING",
323 "value": 0
324 }
325 ],
326 "nreCustomReferences": [
327 {
328 "key": "string",
329 "dataType": "STRING",
330 "value": 0
331 }
332 ],
333 "apCustomReferences": [
334 {
335 "key": "string",
336 "dataType": "STRING",
337 "value": 0
338 }
339 ],
340 "taxEntries": [
341 {
342 "id": 0,
343 "entryType": "D",
344 "amount": 0,
345 "unroundedAmount": 0,
346 "deltaAdjustment": 0,
347 "itemText": "string",
348 "itemNoAcc": 0,
349 "generalLedger": {
350 "id": 0,
351 "displayId": "string",
352 "generalLedgerAccountName": "string",
353 "generalLedgerAccountCode": "string",
354 "openItemManagement": true,
355 "accountCategory": "BALANCESHEET",
356 "shortName": "string",
357 "longName": "string"
358 },
359 "additionalCurrencyEntries": [
360 {
361 "id": 0,
362 "amount": 0,
363 "unroundedAmount": 0,
364 "deltaAdjustment": 0,
365 "itemNoAcc": 0,
366 "currencyDetail": {
367 "currencyId": 0,
368 "currencyDisplayId": "string",
369 "currencyDefinitionType": "CONTRACT_CURRENCY",
370 "currencyType": "string"
371 },
372 "currencyConversionDetail": {
373 "rate": 0,
374 "conversionDate": "2019-08-24",
375 "translationDateType": "DOCUMENT_DATE",
376 "sourceCurrencyType": "CONTRACT_CURRENCY",
377 "sourceCurrency": {},
378 "depreciationArea": {}
379 },
380 "ledgerEntryId": 0,
381 "ledgerEntryTaxId": 0
382 }
383 ],
384 "taxRate": 0,
385 "taxBaseAmount": 0,
386 "totalTaxDocumentAmount": 0,
387 "taxExempt": 0,
388 "taxExemptionPercentage": 0,
389 "taxAffected": 0,
390 "taxAccount": "string",
391 "accountingKey": "string",
392 "conditionKey": "string",
393 "taxCode": {
394 "id": 0,
395 "displayId": "string"
396 },
397 "taxJurisdiction": {
398 "id": 0,
399 "displayId": "string"
400 },
401 "taxDetermination": {
402 "id": 0,
403 "displayId": "string"
404 },
405 "financialTermId": 0,
406 "ledgerEntryId": 0
407 }
408 ],
409 "ledgerTransactionId": 0
410 }
411 ],
412 "notes": [
413 {
414 "id": 0,
415 "note": "string"
416 }
417 ],
418 "attachments": [
419 {
420 "id": 0,
421 "fileName": "string",
422 "fileStorageId": "string",
423 "docStoreId": 0
424 }
425 ],
426 "journalVoucherWorkflowHistory": [
427 {
428 "id": 0,
429 "eventType": "SEND_TO_APPROVAL",
430 "eventDate": "2019-08-24T14:15:22Z",
431 "user": "string"
432 }
433 ],
434 "ledgerTransactionGroupId": 0,
435 "accountingDocumentId": 0,
436 "internalPostingStatus": {
437 "documentNumber": "string",
438 "status": "NA",
439 "postingMessage": "string"
440 },
441 "nlaEnrichmentState": {
442 "id": 0,
443 "status": "PENDING",
444 "message": "string",
445 "history": [
446 {
447 "requestingUser": "string",
448 "enrichmentRequestId": 0,
449 "requestedAt": "2019-08-24T14:15:22Z",
450 "enrichedAt": "2019-08-24T14:15:22Z",
451 "requestStatus": "SENT",
452 "applicationStatus": "PENDING",
453 "message": "string"
454 }
455 ]
456 },
457 "nreEnrichmentState": {
458 "id": 0,
459 "status": "PENDING",
460 "message": "string",
461 "history": [
462 {
463 "requestingUser": "string",
464 "enrichmentRequestId": 0,
465 "requestedAt": "2019-08-24T14:15:22Z",
466 "enrichedAt": "2019-08-24T14:15:22Z",
467 "requestStatus": "SENT",
468 "applicationStatus": "PENDING",
469 "message": "string"
470 }
471 ]
472 },
473 "apEnrichmentState": {
474 "id": 0,
475 "status": "PENDING",
476 "message": "string",
477 "history": [
478 {
479 "requestingUser": "string",
480 "enrichmentRequestId": 0,
481 "requestedAt": "2019-08-24T14:15:22Z",
482 "enrichedAt": "2019-08-24T14:15:22Z",
483 "requestStatus": "SENT",
484 "applicationStatus": "PENDING",
485 "message": "string"
486 }
487 ]
488 },
489 "externalPostingStatus": {
490 "documentNumber": "string",
491 "objType": "string",
492 "objKey": "string",
493 "objSys": "string",
494 "username": "string",
495 "status": "NA",
496 "postingMessage": "string",
497 "taskId": 0
498 }
499 }
500 ]
501}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "requestUniqueId": "string",
3 "accountingDocumentId": 0,
4 "transactions": [
5 {
6 "id": 0,
7 "requestUniqueId": "string",
8 "createdByApplication": "NLA",
9 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
10 "documentComments": "string",
11 "name": "string",
12 "principalPositionType": "LESSEE",
13 "postingTransactionType": "POST",
14 "postingType": "PAYMENT",
15 "ledgerType": "LIABILITY",
16 "paymentType": "N_A",
17 "parallelCurrencyEnabled": true,
18 "generateInvoiceInAp": true,
19 "generateVendorInvoice": true,
20 "calculateTax": true,
21 "taxCalculationType": "NET",
22 "currencyDetail": {
23 "currencyId": 0,
24 "currencyDisplayId": "string",
25 "currencyDefinitionType": "CONTRACT_CURRENCY",
26 "currencyType": "string"
27 },
28 "classificationInfo": {
29 "accountingStandard": {
30 "id": 0,
31 "displayId": "string"
32 },
33 "leaseClassificationType": "NON_LEASE"
34 },
35 "date": {
36 "documentDate": "2019-08-24T14:15:22Z",
37 "userDocumentDate": "2019-08-24",
38 "postingDate": "2019-08-24",
39 "transactionDate": "2019-08-24",
40 "translationDate": "2019-08-24",
41 "fiscalVariantId": 0,
42 "fiscalVariantDisplayId": "string",
43 "calendarType": "REGULAR_CALENDAR",
44 "fiscalYear": 0,
45 "fiscalPeriod": 0
46 },
47 "automaticReversal": {
48 "id": 0,
49 "postingDate": "2019-08-24",
50 "documentDate": "2019-08-24",
51 "reversalReason": {
52 "id": 0,
53 "displayId": "string"
54 }
55 },
56 "trace": {
57 "previousLedgerTransactionId": 0,
58 "nextLedgerTransactionId": 0,
59 "postExternalType": "SKIP"
60 },
61 "fosReferences": {
62 "id": 0,
63 "system": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "company": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseArea": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseGroup": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "leaseDepartment": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "businessUnit": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "mainCostCenter": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "internalAssetClass": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "documentType": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "depreciationArea": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "reversalReason": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "tradingPartner": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "allocationNumber": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "responsibleCostCenter": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "workBreakdownStructure": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "businessArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "functionalArea": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "plant": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "internalOrder": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "network": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentTerm": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentBlock": {
148 "id": 0,
149 "displayId": "string"
150 },
151 "paymentMethod": {
152 "id": 0,
153 "displayId": "string",
154 "type": "string"
155 },
156 "segment": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrganization": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "purchasingOrder": {
165 "id": 0,
166 "displayId": "string"
167 },
168 "ledgerTransactionId": 0
169 },
170 "assetRegisterReferences": {
171 "id": 0,
172 "asset": {
173 "assetId": 0,
174 "assetDisplayId": "string",
175 "assetNumber": "string",
176 "subAssetNumber": "string"
177 },
178 "ledgerTransactionId": 0
179 },
180 "nlaReferences": {
181 "id": 0,
182 "contract": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "leaseComponent": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "activationGroup": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "unit": {
195 "id": 0,
196 "displayId": "string"
197 },
198 "contractExternalId": "string",
199 "journalId": 0,
200 "activationGroupRevisionId": 0,
201 "ledgerTransactionId": 0
202 },
203 "nlaCustomReferences": [
204 {
205 "key": "string",
206 "dataType": "STRING",
207 "value": 0
208 }
209 ],
210 "nreReferences": {
211 "id": 0,
212 "premise": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "location": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "lease": {
221 "id": 0,
222 "displayId": "string"
223 },
224 "ledgerTransactionId": 0
225 },
226 "nreCustomReferences": [
227 {
228 "key": "string",
229 "dataType": "STRING",
230 "value": 0
231 }
232 ],
233 "apReferences": {
234 "id": 0,
235 "invoice": {
236 "id": 0,
237 "displayId": "string",
238 "name": "string"
239 },
240 "vendor": {
241 "id": 0,
242 "displayId": "string",
243 "name": "string"
244 },
245 "ledgerTransactionId": 0
246 },
247 "apCustomReferences": [
248 {
249 "key": "string",
250 "dataType": "STRING",
251 "value": 0
252 }
253 ],
254 "entries": [
255 {
256 "id": 0,
257 "entryType": "D",
258 "amount": 0,
259 "unroundedAmount": 0,
260 "deltaAdjustment": 0,
261 "itemText": "string",
262 "itemNoAcc": 0,
263 "generalLedger": {
264 "id": 0,
265 "displayId": "string",
266 "generalLedgerAccountName": "string",
267 "generalLedgerAccountCode": "string",
268 "openItemManagement": true,
269 "accountCategory": "BALANCESHEET",
270 "shortName": "string",
271 "longName": "string"
272 },
273 "additionalCurrencyEntries": [
274 {
275 "id": 0,
276 "amount": 0,
277 "unroundedAmount": 0,
278 "deltaAdjustment": 0,
279 "itemNoAcc": 0,
280 "currencyDetail": {
281 "currencyId": 0,
282 "currencyDisplayId": "string",
283 "currencyDefinitionType": "CONTRACT_CURRENCY",
284 "currencyType": "string"
285 },
286 "currencyConversionDetail": {
287 "rate": 0,
288 "conversionDate": "2019-08-24",
289 "translationDateType": "DOCUMENT_DATE",
290 "sourceCurrencyType": "CONTRACT_CURRENCY",
291 "sourceCurrency": {
292 "id": 0,
293 "displayId": "string"
294 },
295 "depreciationArea": {
296 "id": 0,
297 "displayId": "string"
298 }
299 },
300 "ledgerEntryId": 0,
301 "ledgerEntryTaxId": 0
302 }
303 ],
304 "tag": "string",
305 "costCenter": {
306 "id": 0,
307 "displayId": "string",
308 "mainCostCenter": true,
309 "allocationPercentage": 0.1
310 },
311 "profitCenter": {
312 "id": 0,
313 "displayId": "string"
314 },
315 "partner": {
316 "id": 0,
317 "displayId": "string"
318 },
319 "transactionType": "string",
320 "nlaCustomReferences": [
321 {
322 "key": "string",
323 "dataType": "STRING",
324 "value": 0
325 }
326 ],
327 "nreCustomReferences": [
328 {
329 "key": "string",
330 "dataType": "STRING",
331 "value": 0
332 }
333 ],
334 "apCustomReferences": [
335 {
336 "key": "string",
337 "dataType": "STRING",
338 "value": 0
339 }
340 ],
341 "taxEntries": [
342 {
343 "id": 0,
344 "entryType": "D",
345 "amount": 0,
346 "unroundedAmount": 0,
347 "deltaAdjustment": 0,
348 "itemText": "string",
349 "itemNoAcc": 0,
350 "generalLedger": {
351 "id": 0,
352 "displayId": "string",
353 "generalLedgerAccountName": "string",
354 "generalLedgerAccountCode": "string",
355 "openItemManagement": true,
356 "accountCategory": "BALANCESHEET",
357 "shortName": "string",
358 "longName": "string"
359 },
360 "additionalCurrencyEntries": [
361 {
362 "id": 0,
363 "amount": 0,
364 "unroundedAmount": 0,
365 "deltaAdjustment": 0,
366 "itemNoAcc": 0,
367 "currencyDetail": {
368 "currencyId": 0,
369 "currencyDisplayId": "string",
370 "currencyDefinitionType": "CONTRACT_CURRENCY",
371 "currencyType": "string"
372 },
373 "currencyConversionDetail": {
374 "rate": 0,
375 "conversionDate": "2019-08-24",
376 "translationDateType": "DOCUMENT_DATE",
377 "sourceCurrencyType": "CONTRACT_CURRENCY",
378 "sourceCurrency": {},
379 "depreciationArea": {}
380 },
381 "ledgerEntryId": 0,
382 "ledgerEntryTaxId": 0
383 }
384 ],
385 "taxRate": 0,
386 "taxBaseAmount": 0,
387 "totalTaxDocumentAmount": 0,
388 "taxExempt": 0,
389 "taxExemptionPercentage": 0,
390 "taxAffected": 0,
391 "taxAccount": "string",
392 "accountingKey": "string",
393 "conditionKey": "string",
394 "taxCode": {
395 "id": 0,
396 "displayId": "string"
397 },
398 "taxJurisdiction": {
399 "id": 0,
400 "displayId": "string"
401 },
402 "taxDetermination": {
403 "id": 0,
404 "displayId": "string"
405 },
406 "financialTermId": 0,
407 "ledgerEntryId": 0
408 }
409 ],
410 "ledgerTransactionId": 0
411 }
412 ],
413 "notes": [
414 {
415 "id": 0,
416 "note": "string"
417 }
418 ],
419 "attachments": [
420 {
421 "id": 0,
422 "fileName": "string",
423 "fileStorageId": "string",
424 "docStoreId": 0
425 }
426 ],
427 "journalVoucherWorkflowHistory": [
428 {
429 "id": 0,
430 "eventType": "SEND_TO_APPROVAL",
431 "eventDate": "2019-08-24T14:15:22Z",
432 "user": "string"
433 }
434 ],
435 "ledgerTransactionGroupId": 0,
436 "accountingDocumentId": 0,
437 "internalPostingStatus": {
438 "documentNumber": "string",
439 "status": "NA",
440 "postingMessage": "string"
441 },
442 "nlaEnrichmentState": {
443 "id": 0,
444 "status": "PENDING",
445 "message": "string",
446 "history": [
447 {
448 "requestingUser": "string",
449 "enrichmentRequestId": 0,
450 "requestedAt": "2019-08-24T14:15:22Z",
451 "enrichedAt": "2019-08-24T14:15:22Z",
452 "requestStatus": "SENT",
453 "applicationStatus": "PENDING",
454 "message": "string"
455 }
456 ]
457 },
458 "nreEnrichmentState": {
459 "id": 0,
460 "status": "PENDING",
461 "message": "string",
462 "history": [
463 {
464 "requestingUser": "string",
465 "enrichmentRequestId": 0,
466 "requestedAt": "2019-08-24T14:15:22Z",
467 "enrichedAt": "2019-08-24T14:15:22Z",
468 "requestStatus": "SENT",
469 "applicationStatus": "PENDING",
470 "message": "string"
471 }
472 ]
473 },
474 "apEnrichmentState": {
475 "id": 0,
476 "status": "PENDING",
477 "message": "string",
478 "history": [
479 {
480 "requestingUser": "string",
481 "enrichmentRequestId": 0,
482 "requestedAt": "2019-08-24T14:15:22Z",
483 "enrichedAt": "2019-08-24T14:15:22Z",
484 "requestStatus": "SENT",
485 "applicationStatus": "PENDING",
486 "message": "string"
487 }
488 ]
489 },
490 "externalPostingStatus": {
491 "documentNumber": "string",
492 "objType": "string",
493 "objKey": "string",
494 "objSys": "string",
495 "username": "string",
496 "status": "NA",
497 "postingMessage": "string",
498 "taskId": 0
499 }
500 }
501 ],
502 "success": true,
503 "message": "string"
504}
Migration - Search Migrated Ledger Transactions¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/migration/search
📋 Description: Submits a request to search for ledger transactions during the migration process, enabling users to locate specific financial records associated with ledger entries and accounts efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the criteria for searching ledger transactions, including account details and transaction parameters essential for accurate financial record migration. |
Body Parameters
1{
2 "unitId": 0,
3 "accountingStandardId": 0,
4 "leaseClassificationType": "NON_LEASE",
5 "periodStartDate": "2019-08-24",
6 "periodEndDate": "2019-08-24"
7}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "requestUniqueId": "string",
5 "createdByApplication": "NLA",
6 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
7 "documentComments": "string",
8 "name": "string",
9 "principalPositionType": "LESSEE",
10 "postingTransactionType": "POST",
11 "postingType": "PAYMENT",
12 "ledgerType": "LIABILITY",
13 "paymentType": "N_A",
14 "parallelCurrencyEnabled": true,
15 "generateInvoiceInAp": true,
16 "generateVendorInvoice": true,
17 "calculateTax": true,
18 "taxCalculationType": "NET",
19 "currencyDetail": {
20 "currencyId": 0,
21 "currencyDisplayId": "string",
22 "currencyDefinitionType": "CONTRACT_CURRENCY",
23 "currencyType": "string"
24 },
25 "classificationInfo": {
26 "accountingStandard": {
27 "id": 0,
28 "displayId": "string"
29 },
30 "leaseClassificationType": "NON_LEASE"
31 },
32 "date": {
33 "documentDate": "2019-08-24T14:15:22Z",
34 "userDocumentDate": "2019-08-24",
35 "postingDate": "2019-08-24",
36 "transactionDate": "2019-08-24",
37 "translationDate": "2019-08-24",
38 "fiscalVariantId": 0,
39 "fiscalVariantDisplayId": "string",
40 "calendarType": "REGULAR_CALENDAR",
41 "fiscalYear": 0,
42 "fiscalPeriod": 0
43 },
44 "automaticReversal": {
45 "id": 0,
46 "postingDate": "2019-08-24",
47 "documentDate": "2019-08-24",
48 "reversalReason": {
49 "id": 0,
50 "displayId": "string"
51 }
52 },
53 "trace": {
54 "previousLedgerTransactionId": 0,
55 "nextLedgerTransactionId": 0,
56 "postExternalType": "SKIP"
57 },
58 "fosReferences": {
59 "id": 0,
60 "system": {
61 "id": 0,
62 "displayId": "string"
63 },
64 "company": {
65 "id": 0,
66 "displayId": "string"
67 },
68 "leaseArea": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "leaseGroup": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "leaseDepartment": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "businessUnit": {
81 "id": 0,
82 "displayId": "string"
83 },
84 "mainCostCenter": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "internalAssetClass": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "documentType": {
93 "id": 0,
94 "displayId": "string"
95 },
96 "depreciationArea": {
97 "id": 0,
98 "displayId": "string"
99 },
100 "reversalReason": {
101 "id": 0,
102 "displayId": "string"
103 },
104 "tradingPartner": {
105 "id": 0,
106 "displayId": "string"
107 },
108 "allocationNumber": {
109 "id": 0,
110 "displayId": "string"
111 },
112 "responsibleCostCenter": {
113 "id": 0,
114 "displayId": "string"
115 },
116 "workBreakdownStructure": {
117 "id": 0,
118 "displayId": "string"
119 },
120 "businessArea": {
121 "id": 0,
122 "displayId": "string"
123 },
124 "functionalArea": {
125 "id": 0,
126 "displayId": "string"
127 },
128 "plant": {
129 "id": 0,
130 "displayId": "string"
131 },
132 "internalOrder": {
133 "id": 0,
134 "displayId": "string"
135 },
136 "network": {
137 "id": 0,
138 "displayId": "string"
139 },
140 "paymentTerm": {
141 "id": 0,
142 "displayId": "string"
143 },
144 "paymentBlock": {
145 "id": 0,
146 "displayId": "string"
147 },
148 "paymentMethod": {
149 "id": 0,
150 "displayId": "string",
151 "type": "string"
152 },
153 "segment": {
154 "id": 0,
155 "displayId": "string"
156 },
157 "purchasingOrganization": {
158 "id": 0,
159 "displayId": "string"
160 },
161 "purchasingOrder": {
162 "id": 0,
163 "displayId": "string"
164 },
165 "ledgerTransactionId": 0
166 },
167 "assetRegisterReferences": {
168 "id": 0,
169 "asset": {
170 "assetId": 0,
171 "assetDisplayId": "string",
172 "assetNumber": "string",
173 "subAssetNumber": "string"
174 },
175 "ledgerTransactionId": 0
176 },
177 "nlaReferences": {
178 "id": 0,
179 "contract": {
180 "id": 0,
181 "displayId": "string"
182 },
183 "leaseComponent": {
184 "id": 0,
185 "displayId": "string"
186 },
187 "activationGroup": {
188 "id": 0,
189 "displayId": "string"
190 },
191 "unit": {
192 "id": 0,
193 "displayId": "string"
194 },
195 "contractExternalId": "string",
196 "journalId": 0,
197 "activationGroupRevisionId": 0,
198 "ledgerTransactionId": 0
199 },
200 "nlaCustomReferences": [
201 {
202 "key": "string",
203 "dataType": "STRING",
204 "value": 0
205 }
206 ],
207 "nreReferences": {
208 "id": 0,
209 "premise": {
210 "id": 0,
211 "displayId": "string"
212 },
213 "location": {
214 "id": 0,
215 "displayId": "string"
216 },
217 "lease": {
218 "id": 0,
219 "displayId": "string"
220 },
221 "ledgerTransactionId": 0
222 },
223 "nreCustomReferences": [
224 {
225 "key": "string",
226 "dataType": "STRING",
227 "value": 0
228 }
229 ],
230 "apReferences": {
231 "id": 0,
232 "invoice": {
233 "id": 0,
234 "displayId": "string",
235 "name": "string"
236 },
237 "vendor": {
238 "id": 0,
239 "displayId": "string",
240 "name": "string"
241 },
242 "ledgerTransactionId": 0
243 },
244 "apCustomReferences": [
245 {
246 "key": "string",
247 "dataType": "STRING",
248 "value": 0
249 }
250 ],
251 "entries": [
252 {
253 "id": 0,
254 "entryType": "D",
255 "amount": 0,
256 "unroundedAmount": 0,
257 "deltaAdjustment": 0,
258 "itemText": "string",
259 "itemNoAcc": 0,
260 "generalLedger": {
261 "id": 0,
262 "displayId": "string",
263 "generalLedgerAccountName": "string",
264 "generalLedgerAccountCode": "string",
265 "openItemManagement": true,
266 "accountCategory": "BALANCESHEET",
267 "shortName": "string",
268 "longName": "string"
269 },
270 "additionalCurrencyEntries": [
271 {
272 "id": 0,
273 "amount": 0,
274 "unroundedAmount": 0,
275 "deltaAdjustment": 0,
276 "itemNoAcc": 0,
277 "currencyDetail": {
278 "currencyId": 0,
279 "currencyDisplayId": "string",
280 "currencyDefinitionType": "CONTRACT_CURRENCY",
281 "currencyType": "string"
282 },
283 "currencyConversionDetail": {
284 "rate": 0,
285 "conversionDate": "2019-08-24",
286 "translationDateType": "DOCUMENT_DATE",
287 "sourceCurrencyType": "CONTRACT_CURRENCY",
288 "sourceCurrency": {
289 "id": 0,
290 "displayId": "string"
291 },
292 "depreciationArea": {
293 "id": 0,
294 "displayId": "string"
295 }
296 },
297 "ledgerEntryId": 0,
298 "ledgerEntryTaxId": 0
299 }
300 ],
301 "tag": "string",
302 "costCenter": {
303 "id": 0,
304 "displayId": "string",
305 "mainCostCenter": true,
306 "allocationPercentage": 0.1
307 },
308 "profitCenter": {
309 "id": 0,
310 "displayId": "string"
311 },
312 "partner": {
313 "id": 0,
314 "displayId": "string"
315 },
316 "transactionType": "string",
317 "nlaCustomReferences": [
318 {
319 "key": "string",
320 "dataType": "STRING",
321 "value": 0
322 }
323 ],
324 "nreCustomReferences": [
325 {
326 "key": "string",
327 "dataType": "STRING",
328 "value": 0
329 }
330 ],
331 "apCustomReferences": [
332 {
333 "key": "string",
334 "dataType": "STRING",
335 "value": 0
336 }
337 ],
338 "taxEntries": [
339 {
340 "id": 0,
341 "entryType": "D",
342 "amount": 0,
343 "unroundedAmount": 0,
344 "deltaAdjustment": 0,
345 "itemText": "string",
346 "itemNoAcc": 0,
347 "generalLedger": {
348 "id": 0,
349 "displayId": "string",
350 "generalLedgerAccountName": "string",
351 "generalLedgerAccountCode": "string",
352 "openItemManagement": true,
353 "accountCategory": "BALANCESHEET",
354 "shortName": "string",
355 "longName": "string"
356 },
357 "additionalCurrencyEntries": [
358 {
359 "id": 0,
360 "amount": 0,
361 "unroundedAmount": 0,
362 "deltaAdjustment": 0,
363 "itemNoAcc": 0,
364 "currencyDetail": {
365 "currencyId": 0,
366 "currencyDisplayId": "string",
367 "currencyDefinitionType": "CONTRACT_CURRENCY",
368 "currencyType": "string"
369 },
370 "currencyConversionDetail": {
371 "rate": 0,
372 "conversionDate": "2019-08-24",
373 "translationDateType": "DOCUMENT_DATE",
374 "sourceCurrencyType": "CONTRACT_CURRENCY",
375 "sourceCurrency": {
376 "id": 0,
377 "displayId": "string"
378 },
379 "depreciationArea": {
380 "id": 0,
381 "displayId": "string"
382 }
383 },
384 "ledgerEntryId": 0,
385 "ledgerEntryTaxId": 0
386 }
387 ],
388 "taxRate": 0,
389 "taxBaseAmount": 0,
390 "totalTaxDocumentAmount": 0,
391 "taxExempt": 0,
392 "taxExemptionPercentage": 0,
393 "taxAffected": 0,
394 "taxAccount": "string",
395 "accountingKey": "string",
396 "conditionKey": "string",
397 "taxCode": {
398 "id": 0,
399 "displayId": "string"
400 },
401 "taxJurisdiction": {
402 "id": 0,
403 "displayId": "string"
404 },
405 "taxDetermination": {
406 "id": 0,
407 "displayId": "string"
408 },
409 "financialTermId": 0,
410 "ledgerEntryId": 0
411 }
412 ],
413 "ledgerTransactionId": 0
414 }
415 ],
416 "notes": [
417 {
418 "id": 0,
419 "note": "string"
420 }
421 ],
422 "attachments": [
423 {
424 "id": 0,
425 "fileName": "string",
426 "fileStorageId": "string",
427 "docStoreId": 0
428 }
429 ],
430 "journalVoucherWorkflowHistory": [
431 {
432 "id": 0,
433 "eventType": "SEND_TO_APPROVAL",
434 "eventDate": "2019-08-24T14:15:22Z",
435 "user": "string"
436 }
437 ],
438 "ledgerTransactionGroupId": 0,
439 "accountingDocumentId": 0,
440 "internalPostingStatus": {
441 "documentNumber": "string",
442 "status": "NA",
443 "postingMessage": "string"
444 },
445 "nlaEnrichmentState": {
446 "id": 0,
447 "status": "PENDING",
448 "message": "string",
449 "history": [
450 {
451 "requestingUser": "string",
452 "enrichmentRequestId": 0,
453 "requestedAt": "2019-08-24T14:15:22Z",
454 "enrichedAt": "2019-08-24T14:15:22Z",
455 "requestStatus": "SENT",
456 "applicationStatus": "PENDING",
457 "message": "string"
458 }
459 ]
460 },
461 "nreEnrichmentState": {
462 "id": 0,
463 "status": "PENDING",
464 "message": "string",
465 "history": [
466 {
467 "requestingUser": "string",
468 "enrichmentRequestId": 0,
469 "requestedAt": "2019-08-24T14:15:22Z",
470 "enrichedAt": "2019-08-24T14:15:22Z",
471 "requestStatus": "SENT",
472 "applicationStatus": "PENDING",
473 "message": "string"
474 }
475 ]
476 },
477 "apEnrichmentState": {
478 "id": 0,
479 "status": "PENDING",
480 "message": "string",
481 "history": [
482 {
483 "requestingUser": "string",
484 "enrichmentRequestId": 0,
485 "requestedAt": "2019-08-24T14:15:22Z",
486 "enrichedAt": "2019-08-24T14:15:22Z",
487 "requestStatus": "SENT",
488 "applicationStatus": "PENDING",
489 "message": "string"
490 }
491 ]
492 },
493 "externalPostingStatus": {
494 "documentNumber": "string",
495 "objType": "string",
496 "objKey": "string",
497 "objSys": "string",
498 "username": "string",
499 "status": "NA",
500 "postingMessage": "string",
501 "taskId": 0
502 }
503 }
504]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data structure representing detailed information about a ledger transaction, including associated accounts and financial records, essential for accurate ledger entry management and reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» requestUniqueId |
string |
false |
none |
Unique identifier for the request unique |
» createdByApplication |
string |
false |
none |
Identifies the application that initiated the ledger entry, ensuring traceability of financial records and transactions within the General Ledger. |
» applicationReferenceId |
string |
true |
none |
Any application MUST send a unique reference in order to ignore duplicate postings. |
» documentComments |
string |
false |
none |
Comments associated with the ledger entry, providing additional context or notes related to the transaction within the financial record. |
» name |
string |
false |
none |
Name of the resource |
» principalPositionType |
string |
false |
none |
Type of the principal position |
» postingTransactionType |
string |
false |
none |
Type of the posting transaction |
» postingType |
string |
false |
none |
Type of the posting |
» ledgerType |
string |
false |
none |
Type of the ledger |
» paymentType |
string |
false |
none |
none |
» parallelCurrencyEnabled |
boolean |
false |
none |
Indicates whether this feature is enabled |
» generateInvoiceInAp |
boolean |
false |
none |
Boolean flag indicating generateInvoiceInAp status |
» generateVendorInvoice |
boolean |
false |
none |
Boolean flag indicating generateVendorInvoice status |
» calculateTax |
boolean |
false |
none |
Boolean flag indicating calculateTax status |
» taxCalculationType |
string |
false |
none |
Type of the tax calculation |
» currencyDetail |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the currency |
»» currencyDisplayId |
string |
false |
none |
Unique identifier for the currency display |
»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»» currencyType |
string |
false |
none |
Type of the currency |
» classificationInfo |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»» leaseClassificationType |
string |
false |
none |
Type of the lease classification |
» date |
false |
none |
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 |
string(date-time) |
false |
none |
Date of the document |
»» userDocumentDate |
string(date) |
false |
none |
Date of the user document |
»» postingDate |
string(date) |
false |
none |
Date of the posting |
»» transactionDate |
string(date) |
false |
none |
Date of the transaction |
»» translationDate |
string(date) |
false |
none |
Date of the translation |
»» fiscalVariantId |
integer(int64) |
false |
none |
Unique identifier for the fiscal variant |
»» fiscalVariantDisplayId |
string |
false |
none |
Unique identifier for the fiscal variant display |
»» calendarType |
string |
false |
none |
Type of the calendar |
»» fiscalYear |
integer(int32) |
false |
none |
Numeric value representing fiscalYear |
»» fiscalPeriod |
integer(int32) |
false |
none |
Numeric value representing fiscalPeriod |
» automaticReversal |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» postingDate |
string(date) |
false |
none |
Date of the posting |
»» documentDate |
string(date) |
false |
none |
Date of the document |
»» reversalReason |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the previous ledger transaction |
»» nextLedgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the next ledger transaction |
»» postExternalType |
string |
false |
none |
Type of the post external |
» fosReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» system |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» type |
string |
true |
none |
Type of the resource |
»» segment |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» assetRegisterReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» asset |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the asset |
»»» assetDisplayId |
string |
false |
none |
Unique identifier for the asset display |
»»» assetNumber |
string |
false |
none |
Unique identifier for the asset associated with ledger entries, transactions, and financial records within the General Ledger. |
»»» subAssetNumber |
string |
false |
none |
Unique identifier for a sub-asset within the General Ledger, used to track and manage financial records related to ledger entries and transactions. |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» nlaReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» contract |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
string |
false |
none |
Unique identifier for the contract external |
»» journalId |
integer(int64) |
false |
none |
Unique identifier for the journal |
»» activationGroupRevisionId |
integer(int64) |
false |
none |
Unique identifier for the activation group revision |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» nlaCustomReferences |
[oneOf] |
false |
none |
List of nlaCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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 |
string |
false |
none |
Unique identifier for the ledger entry, facilitating accurate tracking and management of financial records within the General Ledger. |
»»»» dataType |
string |
false |
none |
Type of the data |
»»»» value |
object |
false |
none |
Object containing value details |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
string(date) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
number(double) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
integer(int32) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
integer(int64) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
string |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» nreReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» premise |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» nreCustomReferences |
[oneOf] |
false |
none |
List of nreCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» apReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» invoice |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»»» name |
string |
false |
none |
none |
»» vendor |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»»» name |
string |
false |
none |
none |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» apCustomReferences |
[oneOf] |
false |
none |
List of apCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» entries |
false |
none |
List of entries items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» entryType |
string |
true |
none |
Type of the entry |
»» amount |
number |
true |
none |
Amount value |
»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»» itemText |
string |
false |
none |
Descriptive text associated with a ledger entry, providing context for the transaction within the financial record. |
»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»» generalLedger |
true |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»»» openItemManagement |
boolean |
true |
none |
Boolean flag indicating openItemManagement status |
»»» accountCategory |
string |
true |
none |
Category of the account |
»»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»»» longName |
string |
false |
none |
Name of the long |
»» additionalCurrencyEntries |
false |
none |
List of additionalCurrencyEntries items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» amount |
number |
false |
none |
Amount value |
»»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»»» currencyDetail |
false |
none |
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 |
false |
none |
Data transfer object representing the details of currency conversion for ledger entries, facilitating accurate transaction recording and financial reporting within accounts. |
|
»»»» rate |
number |
false |
none |
Rate value |
»»»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»»»» translationDateType |
string |
false |
none |
Type of the translation date |
»»»» sourceCurrencyType |
string |
false |
none |
Type of the source currency |
»»»» sourceCurrency |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the ledger entry |
»»» ledgerEntryTaxId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry tax |
»» tag |
string |
false |
none |
Tag is a string field used to categorize and identify ledger entries within financial records, facilitating efficient transaction tracking and account management. |
»» costCenter |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» mainCostCenter |
boolean |
false |
none |
Boolean flag indicating mainCostCenter status |
»»» allocationPercentage |
number(double) |
false |
none |
Percentage of allocation |
»» profitCenter |
false |
none |
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 |
false |
none |
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 |
string |
false |
none |
Type of the transaction |
»» nlaCustomReferences |
[oneOf] |
false |
none |
List of nlaCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» nreCustomReferences |
[oneOf] |
false |
none |
List of nreCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» apCustomReferences |
[oneOf] |
false |
none |
List of apCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» taxEntries |
false |
none |
List of taxEntries items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» entryType |
string |
true |
none |
Type of the entry |
»»» amount |
number |
true |
none |
Amount value |
»»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»»» itemText |
string |
false |
none |
Descriptive text associated with a ledger entry, providing context for the transaction within the financial record. |
»»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»»» generalLedger |
true |
none |
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 |
false |
none |
List of additionalCurrencyEntries items |
|
»»» taxRate |
number |
false |
none |
Rate of tax |
»»» taxBaseAmount |
number |
false |
none |
Amount of tax base |
»»» totalTaxDocumentAmount |
number |
false |
none |
Amount of total tax document |
»»» taxExempt |
number |
false |
none |
Value for taxExempt field |
»»» taxExemptionPercentage |
number |
false |
none |
Percentage of tax exemption |
»»» taxAffected |
number |
false |
none |
Value for taxAffected field |
»»» taxAccount |
string |
false |
none |
Number of ledger entry items |
»»» accountingKey |
string |
false |
none |
Unique identifier for the accounting entry associated with a ledger transaction, facilitating accurate financial record management. |
»»» conditionKey |
string |
false |
none |
Represents the specific condition associated with a ledger entry, facilitating accurate tracking and categorization of financial transactions within the general ledger. |
»»» taxCode |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the financial term |
»»» ledgerEntryId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» notes |
false |
none |
List of notes items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» note |
string |
false |
none |
Textual annotation associated with a ledger entry, providing additional context for the transaction within the financial record. |
» attachments |
false |
none |
List of attachments items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fileName |
string |
false |
none |
Name of the file |
»» fileStorageId |
string |
false |
none |
Unique identifier for the file storage |
»» docStoreId |
integer(int64) |
false |
none |
Unique identifier for the doc store |
» journalVoucherWorkflowHistory |
false |
none |
List of journalVoucherWorkflowHistory items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» eventType |
string |
false |
none |
Type of the event |
»» eventDate |
string(date-time) |
false |
none |
Date of the event |
»» user |
string |
false |
none |
User information related to accounting |
» ledgerTransactionGroupId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction group |
» accountingDocumentId |
integer(int64) |
false |
none |
Unique identifier for the accounting document |
» internalPostingStatus |
false |
none |
Data transfer object representing the status of internal postings within the General Ledger, encompassing ledger entries, transactions, and associated financial records to ensure accurate account management. |
|
»» documentNumber |
string |
false |
none |
Unique identifier for the financial record associated with a ledger entry or transaction within the General Ledger. |
»» status |
string |
false |
none |
Status of the resource |
»» postingMessage |
string |
false |
none |
Descriptive message associated with the posting status of a ledger entry, providing context for the transaction within the financial record. |
» nlaEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» status |
string |
false |
none |
Status of the resource |
»» message |
string |
false |
none |
Textual representation of the message associated with a ledger entry, providing context for the transaction or financial record. |
»» history |
false |
none |
List of history items |
|
»»» requestingUser |
string |
false |
none |
User information related to accounting |
»»» enrichmentRequestId |
integer(int64) |
false |
none |
Unique identifier for the enrichment request |
»»» requestedAt |
string(date-time) |
false |
none |
Timestamp indicating when the enrichment request was initiated, relevant for tracking ledger entries and financial transactions. |
»»» enrichedAt |
string(date-time) |
false |
none |
Timestamp indicating when the ledger entry was enriched, providing a record of the transaction’s enhancement within the financial context. |
»»» requestStatus |
string |
false |
none |
Status of the request |
»»» applicationStatus |
string |
false |
none |
Status of the application |
»»» message |
string |
false |
none |
Textual representation of the message associated with a ledger entry, providing context for the transaction within the financial record. |
» nreEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
» apEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
» externalPostingStatus |
false |
none |
Data structure representing the status of external postings within the General Ledger, encompassing ledger entries, transactions, accounts, and financial records to ensure accurate tracking and reporting of financial activities. |
|
»» documentNumber |
string |
false |
none |
Unique identifier for the financial document associated with a ledger entry, facilitating accurate tracking of transactions and account records. |
»» objType |
string |
false |
none |
Type of the obj |
»» objKey |
string |
false |
none |
Unique identifier for the external posting status associated with ledger entries and financial records within the General Ledger. |
»» objSys |
string |
false |
none |
Represents the system-generated status of an external posting related to ledger entries, transactions, accounts, and financial records. |
»» username |
string |
false |
none |
Human-readable name of the ledger entry |
»» status |
string |
false |
none |
Status of the resource |
»» postingMessage |
string |
false |
none |
Textual representation of the posting message associated with a ledger entry, providing context for the transaction within financial records. |
»» taskId |
integer(int64) |
false |
none |
Unique identifier for the task |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
applicationStatus |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
createdByApplication |
ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
dataType |
BIG_DECIMAL, BOOLEAN, DATE, DATETIME, DOUBLE, INTEGER, LONG, STRING |
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 |
ledgerType |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, FX_REMEASUREMENT, GRV, IDC, IMPAIRMENT, INCENTIVE, INVOICE_POSTING, 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 |
postExternalType |
POST, SKIP |
postingTransactionType |
POST, REVERSE |
postingType |
ACCRUAL, CHARGE, DEPRECIATION, FX_REMEASUREMENT, INVOICE_POSTING, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
principalPositionType |
LESSEE, LESSOR |
requestStatus |
FAILED, SENT |
sourceCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A |
status |
, ARCHIVED, DONE, ENRICHED, ENRICHING, FAILED, OPEN, PENDING, PROCESSING, SCHEDULED, SKIPPED |
taxCalculationType |
NET |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Bulk Transaction Into General Ledger¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/migration/bulk
📋 Description: This API will update Transaction into General Ledger based on LedgerTransactionInfo information
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk ledger transaction data, including account details and financial records, for migration into the general ledger. |
Body Parameters
1[
2 {
3 "requestUniqueId": "string",
4 "transactions": [
5 {
6 "id": 0,
7 "requestUniqueId": "string",
8 "createdByApplication": "NLA",
9 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
10 "documentComments": "string",
11 "name": "string",
12 "principalPositionType": "LESSEE",
13 "postingTransactionType": "POST",
14 "postingType": "PAYMENT",
15 "ledgerType": "LIABILITY",
16 "paymentType": "N_A",
17 "parallelCurrencyEnabled": true,
18 "generateInvoiceInAp": true,
19 "generateVendorInvoice": true,
20 "calculateTax": true,
21 "taxCalculationType": "NET",
22 "currencyDetail": {
23 "currencyId": 0,
24 "currencyDisplayId": "string",
25 "currencyDefinitionType": "CONTRACT_CURRENCY",
26 "currencyType": "string"
27 },
28 "classificationInfo": {
29 "accountingStandard": {
30 "id": 0,
31 "displayId": "string"
32 },
33 "leaseClassificationType": "NON_LEASE"
34 },
35 "date": {
36 "documentDate": "2019-08-24T14:15:22Z",
37 "userDocumentDate": "2019-08-24",
38 "postingDate": "2019-08-24",
39 "transactionDate": "2019-08-24",
40 "translationDate": "2019-08-24",
41 "fiscalVariantId": 0,
42 "fiscalVariantDisplayId": "string",
43 "calendarType": "REGULAR_CALENDAR",
44 "fiscalYear": 0,
45 "fiscalPeriod": 0
46 },
47 "automaticReversal": {
48 "id": 0,
49 "postingDate": "2019-08-24",
50 "documentDate": "2019-08-24",
51 "reversalReason": {
52 "id": 0,
53 "displayId": "string"
54 }
55 },
56 "trace": {
57 "previousLedgerTransactionId": 0,
58 "nextLedgerTransactionId": 0,
59 "postExternalType": "SKIP"
60 },
61 "fosReferences": {
62 "id": 0,
63 "system": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "company": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseArea": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseGroup": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "leaseDepartment": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "businessUnit": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "mainCostCenter": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "internalAssetClass": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "documentType": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "depreciationArea": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "reversalReason": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "tradingPartner": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "allocationNumber": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "responsibleCostCenter": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "workBreakdownStructure": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "businessArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "functionalArea": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "plant": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "internalOrder": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "network": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentTerm": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentBlock": {
148 "id": 0,
149 "displayId": "string"
150 },
151 "paymentMethod": {
152 "id": 0,
153 "displayId": "string",
154 "type": "string"
155 },
156 "segment": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrganization": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "purchasingOrder": {
165 "id": 0,
166 "displayId": "string"
167 },
168 "ledgerTransactionId": 0
169 },
170 "assetRegisterReferences": {
171 "id": 0,
172 "asset": {
173 "assetId": 0,
174 "assetDisplayId": "string",
175 "assetNumber": "string",
176 "subAssetNumber": "string"
177 },
178 "ledgerTransactionId": 0
179 },
180 "nlaReferences": {
181 "id": 0,
182 "contract": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "leaseComponent": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "activationGroup": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "unit": {
195 "id": 0,
196 "displayId": "string"
197 },
198 "contractExternalId": "string",
199 "journalId": 0,
200 "activationGroupRevisionId": 0,
201 "ledgerTransactionId": 0
202 },
203 "nlaCustomReferences": [
204 {
205 "key": "string",
206 "dataType": "STRING",
207 "value": 0
208 }
209 ],
210 "nreReferences": {
211 "id": 0,
212 "premise": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "location": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "lease": {
221 "id": 0,
222 "displayId": "string"
223 },
224 "ledgerTransactionId": 0
225 },
226 "nreCustomReferences": [
227 {
228 "key": "string",
229 "dataType": "STRING",
230 "value": 0
231 }
232 ],
233 "apReferences": {
234 "id": 0,
235 "invoice": {
236 "id": 0,
237 "displayId": "string",
238 "name": "string"
239 },
240 "vendor": {
241 "id": 0,
242 "displayId": "string",
243 "name": "string"
244 },
245 "ledgerTransactionId": 0
246 },
247 "apCustomReferences": [
248 {
249 "key": "string",
250 "dataType": "STRING",
251 "value": 0
252 }
253 ],
254 "entries": [
255 {
256 "id": 0,
257 "entryType": "D",
258 "amount": 0,
259 "unroundedAmount": 0,
260 "deltaAdjustment": 0,
261 "itemText": "string",
262 "itemNoAcc": 0,
263 "generalLedger": {
264 "id": 0,
265 "displayId": "string",
266 "generalLedgerAccountName": "string",
267 "generalLedgerAccountCode": "string",
268 "openItemManagement": true,
269 "accountCategory": "BALANCESHEET",
270 "shortName": "string",
271 "longName": "string"
272 },
273 "additionalCurrencyEntries": [
274 {
275 "id": 0,
276 "amount": 0,
277 "unroundedAmount": 0,
278 "deltaAdjustment": 0,
279 "itemNoAcc": 0,
280 "currencyDetail": {
281 "currencyId": 0,
282 "currencyDisplayId": "string",
283 "currencyDefinitionType": "CONTRACT_CURRENCY",
284 "currencyType": "string"
285 },
286 "currencyConversionDetail": {
287 "rate": 0,
288 "conversionDate": "2019-08-24",
289 "translationDateType": "DOCUMENT_DATE",
290 "sourceCurrencyType": "CONTRACT_CURRENCY",
291 "sourceCurrency": {
292 "id": 0,
293 "displayId": "string"
294 },
295 "depreciationArea": {
296 "id": 0,
297 "displayId": "string"
298 }
299 },
300 "ledgerEntryId": 0,
301 "ledgerEntryTaxId": 0
302 }
303 ],
304 "tag": "string",
305 "costCenter": {
306 "id": 0,
307 "displayId": "string",
308 "mainCostCenter": true,
309 "allocationPercentage": 0.1
310 },
311 "profitCenter": {
312 "id": 0,
313 "displayId": "string"
314 },
315 "partner": {
316 "id": 0,
317 "displayId": "string"
318 },
319 "transactionType": "string",
320 "nlaCustomReferences": [
321 {
322 "key": "string",
323 "dataType": "STRING",
324 "value": 0
325 }
326 ],
327 "nreCustomReferences": [
328 {
329 "key": "string",
330 "dataType": "STRING",
331 "value": 0
332 }
333 ],
334 "apCustomReferences": [
335 {
336 "key": "string",
337 "dataType": "STRING",
338 "value": 0
339 }
340 ],
341 "taxEntries": [
342 {
343 "id": 0,
344 "entryType": "D",
345 "amount": 0,
346 "unroundedAmount": 0,
347 "deltaAdjustment": 0,
348 "itemText": "string",
349 "itemNoAcc": 0,
350 "generalLedger": {
351 "id": 0,
352 "displayId": "string",
353 "generalLedgerAccountName": "string",
354 "generalLedgerAccountCode": "string",
355 "openItemManagement": true,
356 "accountCategory": "BALANCESHEET",
357 "shortName": "string",
358 "longName": "string"
359 },
360 "additionalCurrencyEntries": [
361 {
362 "id": 0,
363 "amount": 0,
364 "unroundedAmount": 0,
365 "deltaAdjustment": 0,
366 "itemNoAcc": 0,
367 "currencyDetail": {},
368 "currencyConversionDetail": {},
369 "ledgerEntryId": 0,
370 "ledgerEntryTaxId": 0
371 }
372 ],
373 "taxRate": 0,
374 "taxBaseAmount": 0,
375 "totalTaxDocumentAmount": 0,
376 "taxExempt": 0,
377 "taxExemptionPercentage": 0,
378 "taxAffected": 0,
379 "taxAccount": "string",
380 "accountingKey": "string",
381 "conditionKey": "string",
382 "taxCode": {
383 "id": 0,
384 "displayId": "string"
385 },
386 "taxJurisdiction": {
387 "id": 0,
388 "displayId": "string"
389 },
390 "taxDetermination": {
391 "id": 0,
392 "displayId": "string"
393 },
394 "financialTermId": 0,
395 "ledgerEntryId": 0
396 }
397 ],
398 "ledgerTransactionId": 0
399 }
400 ],
401 "notes": [
402 {
403 "id": 0,
404 "note": "string"
405 }
406 ],
407 "attachments": [
408 {
409 "id": 0,
410 "fileName": "string",
411 "fileStorageId": "string",
412 "docStoreId": 0
413 }
414 ],
415 "journalVoucherWorkflowHistory": [
416 {
417 "id": 0,
418 "eventType": "SEND_TO_APPROVAL",
419 "eventDate": "2019-08-24T14:15:22Z",
420 "user": "string"
421 }
422 ],
423 "ledgerTransactionGroupId": 0,
424 "accountingDocumentId": 0,
425 "internalPostingStatus": {
426 "documentNumber": "string",
427 "status": "NA",
428 "postingMessage": "string"
429 },
430 "nlaEnrichmentState": {
431 "id": 0,
432 "status": "PENDING",
433 "message": "string",
434 "history": [
435 {
436 "requestingUser": "string",
437 "enrichmentRequestId": 0,
438 "requestedAt": "2019-08-24T14:15:22Z",
439 "enrichedAt": "2019-08-24T14:15:22Z",
440 "requestStatus": "SENT",
441 "applicationStatus": "PENDING",
442 "message": "string"
443 }
444 ]
445 },
446 "nreEnrichmentState": {
447 "id": 0,
448 "status": "PENDING",
449 "message": "string",
450 "history": [
451 {
452 "requestingUser": "string",
453 "enrichmentRequestId": 0,
454 "requestedAt": "2019-08-24T14:15:22Z",
455 "enrichedAt": "2019-08-24T14:15:22Z",
456 "requestStatus": "SENT",
457 "applicationStatus": "PENDING",
458 "message": "string"
459 }
460 ]
461 },
462 "apEnrichmentState": {
463 "id": 0,
464 "status": "PENDING",
465 "message": "string",
466 "history": [
467 {
468 "requestingUser": "string",
469 "enrichmentRequestId": 0,
470 "requestedAt": "2019-08-24T14:15:22Z",
471 "enrichedAt": "2019-08-24T14:15:22Z",
472 "requestStatus": "SENT",
473 "applicationStatus": "PENDING",
474 "message": "string"
475 }
476 ]
477 },
478 "externalPostingStatus": {
479 "documentNumber": "string",
480 "objType": "string",
481 "objKey": "string",
482 "objSys": "string",
483 "username": "string",
484 "status": "NA",
485 "postingMessage": "string",
486 "taskId": 0
487 }
488 }
489 ]
490 }
491]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "requestUniqueId": "string",
4 "accountingDocumentId": 0,
5 "transactions": [
6 {
7 "id": 0,
8 "requestUniqueId": "string",
9 "createdByApplication": "NLA",
10 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
11 "documentComments": "string",
12 "name": "string",
13 "principalPositionType": "LESSEE",
14 "postingTransactionType": "POST",
15 "postingType": "PAYMENT",
16 "ledgerType": "LIABILITY",
17 "paymentType": "N_A",
18 "parallelCurrencyEnabled": true,
19 "generateInvoiceInAp": true,
20 "generateVendorInvoice": true,
21 "calculateTax": true,
22 "taxCalculationType": "NET",
23 "currencyDetail": {
24 "currencyId": 0,
25 "currencyDisplayId": "string",
26 "currencyDefinitionType": "CONTRACT_CURRENCY",
27 "currencyType": "string"
28 },
29 "classificationInfo": {
30 "accountingStandard": {
31 "id": 0,
32 "displayId": "string"
33 },
34 "leaseClassificationType": "NON_LEASE"
35 },
36 "date": {
37 "documentDate": "2019-08-24T14:15:22Z",
38 "userDocumentDate": "2019-08-24",
39 "postingDate": "2019-08-24",
40 "transactionDate": "2019-08-24",
41 "translationDate": "2019-08-24",
42 "fiscalVariantId": 0,
43 "fiscalVariantDisplayId": "string",
44 "calendarType": "REGULAR_CALENDAR",
45 "fiscalYear": 0,
46 "fiscalPeriod": 0
47 },
48 "automaticReversal": {
49 "id": 0,
50 "postingDate": "2019-08-24",
51 "documentDate": "2019-08-24",
52 "reversalReason": {
53 "id": 0,
54 "displayId": "string"
55 }
56 },
57 "trace": {
58 "previousLedgerTransactionId": 0,
59 "nextLedgerTransactionId": 0,
60 "postExternalType": "SKIP"
61 },
62 "fosReferences": {
63 "id": 0,
64 "system": {
65 "id": 0,
66 "displayId": "string"
67 },
68 "company": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "leaseArea": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "leaseGroup": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "leaseDepartment": {
81 "id": 0,
82 "displayId": "string"
83 },
84 "businessUnit": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "mainCostCenter": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "internalAssetClass": {
93 "id": 0,
94 "displayId": "string"
95 },
96 "documentType": {
97 "id": 0,
98 "displayId": "string"
99 },
100 "depreciationArea": {
101 "id": 0,
102 "displayId": "string"
103 },
104 "reversalReason": {
105 "id": 0,
106 "displayId": "string"
107 },
108 "tradingPartner": {
109 "id": 0,
110 "displayId": "string"
111 },
112 "allocationNumber": {
113 "id": 0,
114 "displayId": "string"
115 },
116 "responsibleCostCenter": {
117 "id": 0,
118 "displayId": "string"
119 },
120 "workBreakdownStructure": {
121 "id": 0,
122 "displayId": "string"
123 },
124 "businessArea": {
125 "id": 0,
126 "displayId": "string"
127 },
128 "functionalArea": {
129 "id": 0,
130 "displayId": "string"
131 },
132 "plant": {
133 "id": 0,
134 "displayId": "string"
135 },
136 "internalOrder": {
137 "id": 0,
138 "displayId": "string"
139 },
140 "network": {
141 "id": 0,
142 "displayId": "string"
143 },
144 "paymentTerm": {
145 "id": 0,
146 "displayId": "string"
147 },
148 "paymentBlock": {
149 "id": 0,
150 "displayId": "string"
151 },
152 "paymentMethod": {
153 "id": 0,
154 "displayId": "string",
155 "type": "string"
156 },
157 "segment": {
158 "id": 0,
159 "displayId": "string"
160 },
161 "purchasingOrganization": {
162 "id": 0,
163 "displayId": "string"
164 },
165 "purchasingOrder": {
166 "id": 0,
167 "displayId": "string"
168 },
169 "ledgerTransactionId": 0
170 },
171 "assetRegisterReferences": {
172 "id": 0,
173 "asset": {
174 "assetId": 0,
175 "assetDisplayId": "string",
176 "assetNumber": "string",
177 "subAssetNumber": "string"
178 },
179 "ledgerTransactionId": 0
180 },
181 "nlaReferences": {
182 "id": 0,
183 "contract": {
184 "id": 0,
185 "displayId": "string"
186 },
187 "leaseComponent": {
188 "id": 0,
189 "displayId": "string"
190 },
191 "activationGroup": {
192 "id": 0,
193 "displayId": "string"
194 },
195 "unit": {
196 "id": 0,
197 "displayId": "string"
198 },
199 "contractExternalId": "string",
200 "journalId": 0,
201 "activationGroupRevisionId": 0,
202 "ledgerTransactionId": 0
203 },
204 "nlaCustomReferences": [
205 {
206 "key": "string",
207 "dataType": "STRING",
208 "value": 0
209 }
210 ],
211 "nreReferences": {
212 "id": 0,
213 "premise": {
214 "id": 0,
215 "displayId": "string"
216 },
217 "location": {
218 "id": 0,
219 "displayId": "string"
220 },
221 "lease": {
222 "id": 0,
223 "displayId": "string"
224 },
225 "ledgerTransactionId": 0
226 },
227 "nreCustomReferences": [
228 {
229 "key": "string",
230 "dataType": "STRING",
231 "value": 0
232 }
233 ],
234 "apReferences": {
235 "id": 0,
236 "invoice": {
237 "id": 0,
238 "displayId": "string",
239 "name": "string"
240 },
241 "vendor": {
242 "id": 0,
243 "displayId": "string",
244 "name": "string"
245 },
246 "ledgerTransactionId": 0
247 },
248 "apCustomReferences": [
249 {
250 "key": "string",
251 "dataType": "STRING",
252 "value": 0
253 }
254 ],
255 "entries": [
256 {
257 "id": 0,
258 "entryType": "D",
259 "amount": 0,
260 "unroundedAmount": 0,
261 "deltaAdjustment": 0,
262 "itemText": "string",
263 "itemNoAcc": 0,
264 "generalLedger": {
265 "id": 0,
266 "displayId": "string",
267 "generalLedgerAccountName": "string",
268 "generalLedgerAccountCode": "string",
269 "openItemManagement": true,
270 "accountCategory": "BALANCESHEET",
271 "shortName": "string",
272 "longName": "string"
273 },
274 "additionalCurrencyEntries": [
275 {
276 "id": 0,
277 "amount": 0,
278 "unroundedAmount": 0,
279 "deltaAdjustment": 0,
280 "itemNoAcc": 0,
281 "currencyDetail": {
282 "currencyId": 0,
283 "currencyDisplayId": "string",
284 "currencyDefinitionType": "CONTRACT_CURRENCY",
285 "currencyType": "string"
286 },
287 "currencyConversionDetail": {
288 "rate": 0,
289 "conversionDate": "2019-08-24",
290 "translationDateType": "DOCUMENT_DATE",
291 "sourceCurrencyType": "CONTRACT_CURRENCY",
292 "sourceCurrency": {
293 "id": 0,
294 "displayId": "string"
295 },
296 "depreciationArea": {
297 "id": 0,
298 "displayId": "string"
299 }
300 },
301 "ledgerEntryId": 0,
302 "ledgerEntryTaxId": 0
303 }
304 ],
305 "tag": "string",
306 "costCenter": {
307 "id": 0,
308 "displayId": "string",
309 "mainCostCenter": true,
310 "allocationPercentage": 0.1
311 },
312 "profitCenter": {
313 "id": 0,
314 "displayId": "string"
315 },
316 "partner": {
317 "id": 0,
318 "displayId": "string"
319 },
320 "transactionType": "string",
321 "nlaCustomReferences": [
322 {
323 "key": "string",
324 "dataType": "STRING",
325 "value": 0
326 }
327 ],
328 "nreCustomReferences": [
329 {
330 "key": "string",
331 "dataType": "STRING",
332 "value": 0
333 }
334 ],
335 "apCustomReferences": [
336 {
337 "key": "string",
338 "dataType": "STRING",
339 "value": 0
340 }
341 ],
342 "taxEntries": [
343 {
344 "id": 0,
345 "entryType": "D",
346 "amount": 0,
347 "unroundedAmount": 0,
348 "deltaAdjustment": 0,
349 "itemText": "string",
350 "itemNoAcc": 0,
351 "generalLedger": {
352 "id": 0,
353 "displayId": "string",
354 "generalLedgerAccountName": "string",
355 "generalLedgerAccountCode": "string",
356 "openItemManagement": true,
357 "accountCategory": "BALANCESHEET",
358 "shortName": "string",
359 "longName": "string"
360 },
361 "additionalCurrencyEntries": [
362 {
363 "id": 0,
364 "amount": 0,
365 "unroundedAmount": 0,
366 "deltaAdjustment": 0,
367 "itemNoAcc": 0,
368 "currencyDetail": {},
369 "currencyConversionDetail": {},
370 "ledgerEntryId": 0,
371 "ledgerEntryTaxId": 0
372 }
373 ],
374 "taxRate": 0,
375 "taxBaseAmount": 0,
376 "totalTaxDocumentAmount": 0,
377 "taxExempt": 0,
378 "taxExemptionPercentage": 0,
379 "taxAffected": 0,
380 "taxAccount": "string",
381 "accountingKey": "string",
382 "conditionKey": "string",
383 "taxCode": {
384 "id": 0,
385 "displayId": "string"
386 },
387 "taxJurisdiction": {
388 "id": 0,
389 "displayId": "string"
390 },
391 "taxDetermination": {
392 "id": 0,
393 "displayId": "string"
394 },
395 "financialTermId": 0,
396 "ledgerEntryId": 0
397 }
398 ],
399 "ledgerTransactionId": 0
400 }
401 ],
402 "notes": [
403 {
404 "id": 0,
405 "note": "string"
406 }
407 ],
408 "attachments": [
409 {
410 "id": 0,
411 "fileName": "string",
412 "fileStorageId": "string",
413 "docStoreId": 0
414 }
415 ],
416 "journalVoucherWorkflowHistory": [
417 {
418 "id": 0,
419 "eventType": "SEND_TO_APPROVAL",
420 "eventDate": "2019-08-24T14:15:22Z",
421 "user": "string"
422 }
423 ],
424 "ledgerTransactionGroupId": 0,
425 "accountingDocumentId": 0,
426 "internalPostingStatus": {
427 "documentNumber": "string",
428 "status": "NA",
429 "postingMessage": "string"
430 },
431 "nlaEnrichmentState": {
432 "id": 0,
433 "status": "PENDING",
434 "message": "string",
435 "history": [
436 {
437 "requestingUser": "string",
438 "enrichmentRequestId": 0,
439 "requestedAt": "2019-08-24T14:15:22Z",
440 "enrichedAt": "2019-08-24T14:15:22Z",
441 "requestStatus": "SENT",
442 "applicationStatus": "PENDING",
443 "message": "string"
444 }
445 ]
446 },
447 "nreEnrichmentState": {
448 "id": 0,
449 "status": "PENDING",
450 "message": "string",
451 "history": [
452 {
453 "requestingUser": "string",
454 "enrichmentRequestId": 0,
455 "requestedAt": "2019-08-24T14:15:22Z",
456 "enrichedAt": "2019-08-24T14:15:22Z",
457 "requestStatus": "SENT",
458 "applicationStatus": "PENDING",
459 "message": "string"
460 }
461 ]
462 },
463 "apEnrichmentState": {
464 "id": 0,
465 "status": "PENDING",
466 "message": "string",
467 "history": [
468 {
469 "requestingUser": "string",
470 "enrichmentRequestId": 0,
471 "requestedAt": "2019-08-24T14:15:22Z",
472 "enrichedAt": "2019-08-24T14:15:22Z",
473 "requestStatus": "SENT",
474 "applicationStatus": "PENDING",
475 "message": "string"
476 }
477 ]
478 },
479 "externalPostingStatus": {
480 "documentNumber": "string",
481 "objType": "string",
482 "objKey": "string",
483 "objSys": "string",
484 "username": "string",
485 "status": "NA",
486 "postingMessage": "string",
487 "taskId": 0
488 }
489 }
490 ],
491 "success": true,
492 "message": "string"
493 }
494]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the results of a ledger transaction migration, encapsulating the status and details of the migrated financial records, ensuring accurate integration of ledger entries and transactions within the general ledger.] |
|
» requestUniqueId |
string |
false |
none |
Unique identifier for the request unique |
» accountingDocumentId |
integer(int64) |
false |
none |
Unique identifier for the accounting document |
» transactions |
false |
none |
List of transactions items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» requestUniqueId |
string |
false |
none |
Unique identifier for the request unique |
»» createdByApplication |
string |
false |
none |
Identifies the application that initiated the ledger entry, ensuring traceability of financial records and transactions within the General Ledger. |
»» applicationReferenceId |
string |
true |
none |
Any application MUST send a unique reference in order to ignore duplicate postings. |
»» documentComments |
string |
false |
none |
Comments associated with the ledger entry, providing additional context or notes related to the transaction within the financial record. |
»» name |
string |
false |
none |
Name of the resource |
»» principalPositionType |
string |
false |
none |
Type of the principal position |
»» postingTransactionType |
string |
false |
none |
Type of the posting transaction |
»» postingType |
string |
false |
none |
Type of the posting |
»» ledgerType |
string |
false |
none |
Type of the ledger |
»» paymentType |
string |
false |
none |
none |
»» parallelCurrencyEnabled |
boolean |
false |
none |
Indicates whether this feature is enabled |
»» generateInvoiceInAp |
boolean |
false |
none |
Boolean flag indicating generateInvoiceInAp status |
»» generateVendorInvoice |
boolean |
false |
none |
Boolean flag indicating generateVendorInvoice status |
»» calculateTax |
boolean |
false |
none |
Boolean flag indicating calculateTax status |
»» taxCalculationType |
string |
false |
none |
Type of the tax calculation |
»» currencyDetail |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the currency |
»»» currencyDisplayId |
string |
false |
none |
Unique identifier for the currency display |
»»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»»» currencyType |
string |
false |
none |
Type of the currency |
»» classificationInfo |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» leaseClassificationType |
string |
false |
none |
Type of the lease classification |
»» date |
false |
none |
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 |
string(date-time) |
false |
none |
Date of the document |
»»» userDocumentDate |
string(date) |
false |
none |
Date of the user document |
»»» postingDate |
string(date) |
false |
none |
Date of the posting |
»»» transactionDate |
string(date) |
false |
none |
Date of the transaction |
»»» translationDate |
string(date) |
false |
none |
Date of the translation |
»»» fiscalVariantId |
integer(int64) |
false |
none |
Unique identifier for the fiscal variant |
»»» fiscalVariantDisplayId |
string |
false |
none |
Unique identifier for the fiscal variant display |
»»» calendarType |
string |
false |
none |
Type of the calendar |
»»» fiscalYear |
integer(int32) |
false |
none |
Numeric value representing fiscalYear |
»»» fiscalPeriod |
integer(int32) |
false |
none |
Numeric value representing fiscalPeriod |
»» automaticReversal |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» postingDate |
string(date) |
false |
none |
Date of the posting |
»»» documentDate |
string(date) |
false |
none |
Date of the document |
»»» reversalReason |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the previous ledger transaction |
»»» nextLedgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the next ledger transaction |
»»» postExternalType |
string |
false |
none |
Type of the post external |
»» fosReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» system |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» type |
string |
true |
none |
Type of the resource |
»»» segment |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
»» assetRegisterReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» asset |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the asset |
»»»» assetDisplayId |
string |
false |
none |
Unique identifier for the asset display |
»»»» assetNumber |
string |
false |
none |
Unique identifier for the asset associated with ledger entries, transactions, and financial records within the General Ledger. |
»»»» subAssetNumber |
string |
false |
none |
Unique identifier for a sub-asset within the General Ledger, used to track and manage financial records related to ledger entries and transactions. |
»»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
»» nlaReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» contract |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
string |
false |
none |
Unique identifier for the contract external |
»»» journalId |
integer(int64) |
false |
none |
Unique identifier for the journal |
»»» activationGroupRevisionId |
integer(int64) |
false |
none |
Unique identifier for the activation group revision |
»»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
»» nlaCustomReferences |
[oneOf] |
false |
none |
List of nlaCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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 |
string |
false |
none |
Unique identifier for the ledger entry, facilitating accurate tracking and management of financial records within the General Ledger. |
»»»»» dataType |
string |
false |
none |
Type of the data |
»»»»» value |
object |
false |
none |
Object containing value details |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
object |
false |
none |
none |
»»»»» value |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
object |
false |
none |
none |
»»»»» value |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
object |
false |
none |
none |
»»»»» value |
string(date) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
object |
false |
none |
none |
»»»»» value |
number(double) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
object |
false |
none |
none |
»»»»» value |
integer(int32) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
object |
false |
none |
none |
»»»»» value |
integer(int64) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
object |
false |
none |
none |
»»»»» value |
string |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» nreReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» premise |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
»» nreCustomReferences |
[oneOf] |
false |
none |
List of nreCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» apReferences |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» invoice |
false |
none |
none |
|
»»»» id |
integer(int64) |
false |
none |
none |
»»»» displayId |
string |
false |
none |
none |
»»»» name |
string |
false |
none |
none |
»»» vendor |
false |
none |
none |
|
»»»» id |
integer(int64) |
false |
none |
none |
»»»» displayId |
string |
false |
none |
none |
»»»» name |
string |
false |
none |
none |
»»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
»» apCustomReferences |
[oneOf] |
false |
none |
List of apCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» entries |
false |
none |
List of entries items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» entryType |
string |
true |
none |
Type of the entry |
»»» amount |
number |
true |
none |
Amount value |
»»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»»» itemText |
string |
false |
none |
Descriptive text associated with a ledger entry, providing context for the transaction within the financial record. |
»»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»»» generalLedger |
true |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»»»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»»»» openItemManagement |
boolean |
true |
none |
Boolean flag indicating openItemManagement status |
»»»» accountCategory |
string |
true |
none |
Category of the account |
»»»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»»»» longName |
string |
false |
none |
Name of the long |
»»» additionalCurrencyEntries |
false |
none |
List of additionalCurrencyEntries items |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» amount |
number |
false |
none |
Amount value |
»»»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»»»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»»»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»»»» currencyDetail |
false |
none |
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 |
false |
none |
Data transfer object representing the details of currency conversion for ledger entries, facilitating accurate transaction recording and financial reporting within accounts. |
|
»»»»» rate |
number |
false |
none |
Rate value |
»»»»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»»»»» translationDateType |
string |
false |
none |
Type of the translation date |
»»»»» sourceCurrencyType |
string |
false |
none |
Type of the source currency |
»»»»» sourceCurrency |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the ledger entry |
»»»» ledgerEntryTaxId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry tax |
»»» tag |
string |
false |
none |
Tag is a string field used to categorize and identify ledger entries within financial records, facilitating efficient transaction tracking and account management. |
»»» costCenter |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» mainCostCenter |
boolean |
false |
none |
Boolean flag indicating mainCostCenter status |
»»»» allocationPercentage |
number(double) |
false |
none |
Percentage of allocation |
»»» profitCenter |
false |
none |
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 |
false |
none |
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 |
string |
false |
none |
Type of the transaction |
»»» nlaCustomReferences |
[oneOf] |
false |
none |
List of nlaCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» nreCustomReferences |
[oneOf] |
false |
none |
List of nreCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» apCustomReferences |
[oneOf] |
false |
none |
List of apCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»» anonymous |
false |
none |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» taxEntries |
false |
none |
List of taxEntries items |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» entryType |
string |
true |
none |
Type of the entry |
»»»» amount |
number |
true |
none |
Amount value |
»»»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»»»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»»»» itemText |
string |
false |
none |
Descriptive text associated with a ledger entry, providing context for the transaction within the financial record. |
»»»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»»»» generalLedger |
true |
none |
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 |
false |
none |
List of additionalCurrencyEntries items |
|
»»»» taxRate |
number |
false |
none |
Rate of tax |
»»»» taxBaseAmount |
number |
false |
none |
Amount of tax base |
»»»» totalTaxDocumentAmount |
number |
false |
none |
Amount of total tax document |
»»»» taxExempt |
number |
false |
none |
Value for taxExempt field |
»»»» taxExemptionPercentage |
number |
false |
none |
Percentage of tax exemption |
»»»» taxAffected |
number |
false |
none |
Value for taxAffected field |
»»»» taxAccount |
string |
false |
none |
Number of ledger entry items |
»»»» accountingKey |
string |
false |
none |
Unique identifier for the accounting entry associated with a ledger transaction, facilitating accurate financial record management. |
»»»» conditionKey |
string |
false |
none |
Represents the specific condition associated with a ledger entry, facilitating accurate tracking and categorization of financial transactions within the general ledger. |
»»»» taxCode |
false |
none |
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 |
false |
none |
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 |
false |
none |
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 |
integer(int64) |
false |
none |
Unique identifier for the financial term |
»»»» ledgerEntryId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry |
»»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
»» notes |
false |
none |
List of notes items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» note |
string |
false |
none |
Textual annotation associated with a ledger entry, providing additional context for the transaction within the financial record. |
»» attachments |
false |
none |
List of attachments items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» fileName |
string |
false |
none |
Name of the file |
»»» fileStorageId |
string |
false |
none |
Unique identifier for the file storage |
»»» docStoreId |
integer(int64) |
false |
none |
Unique identifier for the doc store |
»» journalVoucherWorkflowHistory |
false |
none |
List of journalVoucherWorkflowHistory items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» eventType |
string |
false |
none |
Type of the event |
»»» eventDate |
string(date-time) |
false |
none |
Date of the event |
»»» user |
string |
false |
none |
User information related to accounting |
»» ledgerTransactionGroupId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction group |
»» accountingDocumentId |
integer(int64) |
false |
none |
Unique identifier for the accounting document |
»» internalPostingStatus |
false |
none |
Data transfer object representing the status of internal postings within the General Ledger, encompassing ledger entries, transactions, and associated financial records to ensure accurate account management. |
|
»»» documentNumber |
string |
false |
none |
Unique identifier for the financial record associated with a ledger entry or transaction within the General Ledger. |
»»» status |
string |
false |
none |
Status of the resource |
»»» postingMessage |
string |
false |
none |
Descriptive message associated with the posting status of a ledger entry, providing context for the transaction within the financial record. |
»» nlaEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» status |
string |
false |
none |
Status of the resource |
»»» message |
string |
false |
none |
Textual representation of the message associated with a ledger entry, providing context for the transaction or financial record. |
»»» history |
false |
none |
List of history items |
|
»»»» requestingUser |
string |
false |
none |
User information related to accounting |
»»»» enrichmentRequestId |
integer(int64) |
false |
none |
Unique identifier for the enrichment request |
»»»» requestedAt |
string(date-time) |
false |
none |
Timestamp indicating when the enrichment request was initiated, relevant for tracking ledger entries and financial transactions. |
»»»» enrichedAt |
string(date-time) |
false |
none |
Timestamp indicating when the ledger entry was enriched, providing a record of the transaction’s enhancement within the financial context. |
»»»» requestStatus |
string |
false |
none |
Status of the request |
»»»» applicationStatus |
string |
false |
none |
Status of the application |
»»»» message |
string |
false |
none |
Textual representation of the message associated with a ledger entry, providing context for the transaction within the financial record. |
»» nreEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
»» apEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
»» externalPostingStatus |
false |
none |
Data structure representing the status of external postings within the General Ledger, encompassing ledger entries, transactions, accounts, and financial records to ensure accurate tracking and reporting of financial activities. |
|
»»» documentNumber |
string |
false |
none |
Unique identifier for the financial document associated with a ledger entry, facilitating accurate tracking of transactions and account records. |
»»» objType |
string |
false |
none |
Type of the obj |
»»» objKey |
string |
false |
none |
Unique identifier for the external posting status associated with ledger entries and financial records within the General Ledger. |
»»» objSys |
string |
false |
none |
Represents the system-generated status of an external posting related to ledger entries, transactions, accounts, and financial records. |
»»» username |
string |
false |
none |
Human-readable name of the ledger entry |
»»» status |
string |
false |
none |
Status of the resource |
»»» postingMessage |
string |
false |
none |
Textual representation of the posting message associated with a ledger entry, providing context for the transaction within financial records. |
»»» taskId |
integer(int64) |
false |
none |
Unique identifier for the task |
» success |
boolean |
false |
none |
Boolean flag indicating success status |
» message |
string |
false |
none |
Descriptive text providing details about the outcome of the ledger transaction migration, relevant to ledger entries and financial records. |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
applicationStatus |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
createdByApplication |
ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
dataType |
BIG_DECIMAL, BOOLEAN, DATE, DATETIME, DOUBLE, INTEGER, LONG, STRING |
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 |
ledgerType |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, FX_REMEASUREMENT, GRV, IDC, IMPAIRMENT, INCENTIVE, INVOICE_POSTING, 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 |
postExternalType |
POST, SKIP |
postingTransactionType |
POST, REVERSE |
postingType |
ACCRUAL, CHARGE, DEPRECIATION, FX_REMEASUREMENT, INVOICE_POSTING, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
principalPositionType |
LESSEE, LESSOR |
requestStatus |
FAILED, SENT |
sourceCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A |
status |
, ARCHIVED, DONE, ENRICHED, ENRICHING, FAILED, OPEN, PENDING, PROCESSING, SCHEDULED, SKIPPED |
taxCalculationType |
NET |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Migration - Get Earliest Migrated Ledger Transaction¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/migration/earliest
📋 Description: Retrieves the earliest ledger transaction records from the General Ledger, providing essential financial data for account reconciliation and analysis.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
unitId |
query |
integer(int64) |
true |
Unique identifier for the unit |
accountingStandardId |
query |
integer(int64) |
true |
Unique identifier for the accounting standard |
leaseClassification |
query |
string |
true |
Specifies the classification of the lease associated with the ledger entry, facilitating accurate financial record management and transaction categorization. |
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}