LedgerTransactionInfo¶
Example Json Object
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 "parallelCurrencyEnabled": true,
13 "generateInvoiceInAp": true,
14 "generateVendorInvoice": true,
15 "calculateTax": true,
16 "taxCalculationType": "NET",
17 "currencyDetail": {
18 "currencyId": 0,
19 "currencyDisplayId": "string",
20 "currencyDefinitionType": "CONTRACT_CURRENCY",
21 "currencyType": "string"
22 },
23 "classificationInfo": {
24 "accountingStandard": {
25 "id": 0,
26 "displayId": "string"
27 },
28 "leaseClassificationType": "NON_LEASE"
29 },
30 "date": {
31 "documentDate": "2019-08-24T14:15:22Z",
32 "userDocumentDate": "2019-08-24",
33 "postingDate": "2019-08-24",
34 "transactionDate": "2019-08-24",
35 "translationDate": "2019-08-24",
36 "fiscalVariantId": 0,
37 "fiscalVariantDisplayId": "string",
38 "calendarType": "REGULAR_CALENDAR",
39 "fiscalYear": 0,
40 "fiscalPeriod": 0
41 },
42 "automaticReversal": {
43 "id": 0,
44 "postingDate": "2019-08-24",
45 "documentDate": "2019-08-24",
46 "reversalReason": {
47 "id": 0,
48 "displayId": "string"
49 }
50 },
51 "trace": {
52 "previousLedgerTransactionId": 0,
53 "nextLedgerTransactionId": 0,
54 "postExternalType": "SKIP"
55 },
56 "fosReferences": {
57 "id": 0,
58 "system": {
59 "id": 0,
60 "displayId": "string"
61 },
62 "company": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "leaseArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "leaseGroup": {
71 "id": 0,
72 "displayId": "string"
73 },
74 "leaseDepartment": {
75 "id": 0,
76 "displayId": "string"
77 },
78 "businessUnit": {
79 "id": 0,
80 "displayId": "string"
81 },
82 "mainCostCenter": {
83 "id": 0,
84 "displayId": "string"
85 },
86 "internalAssetClass": {
87 "id": 0,
88 "displayId": "string"
89 },
90 "documentType": {
91 "id": 0,
92 "displayId": "string"
93 },
94 "depreciationArea": {
95 "id": 0,
96 "displayId": "string"
97 },
98 "reversalReason": {
99 "id": 0,
100 "displayId": "string"
101 },
102 "tradingPartner": {
103 "id": 0,
104 "displayId": "string"
105 },
106 "allocationNumber": {
107 "id": 0,
108 "displayId": "string"
109 },
110 "responsibleCostCenter": {
111 "id": 0,
112 "displayId": "string"
113 },
114 "workBreakdownStructure": {
115 "id": 0,
116 "displayId": "string"
117 },
118 "businessArea": {
119 "id": 0,
120 "displayId": "string"
121 },
122 "functionalArea": {
123 "id": 0,
124 "displayId": "string"
125 },
126 "plant": {
127 "id": 0,
128 "displayId": "string"
129 },
130 "internalOrder": {
131 "id": 0,
132 "displayId": "string"
133 },
134 "network": {
135 "id": 0,
136 "displayId": "string"
137 },
138 "paymentTerm": {
139 "id": 0,
140 "displayId": "string"
141 },
142 "paymentBlock": {
143 "id": 0,
144 "displayId": "string"
145 },
146 "paymentMethod": {
147 "id": 0,
148 "displayId": "string",
149 "type": "string"
150 },
151 "segment": {
152 "id": 0,
153 "displayId": "string"
154 },
155 "purchasingOrganization": {
156 "id": 0,
157 "displayId": "string"
158 },
159 "purchasingOrder": {
160 "id": 0,
161 "displayId": "string"
162 },
163 "ledgerTransactionId": 0
164 },
165 "assetRegisterReferences": {
166 "id": 0,
167 "asset": {
168 "assetId": 0,
169 "assetDisplayId": "string",
170 "assetNumber": "string",
171 "subAssetNumber": "string"
172 },
173 "ledgerTransactionId": 0
174 },
175 "nlaReferences": {
176 "id": 0,
177 "contract": {
178 "id": 0,
179 "displayId": "string"
180 },
181 "leaseComponent": {
182 "id": 0,
183 "displayId": "string"
184 },
185 "activationGroup": {
186 "id": 0,
187 "displayId": "string"
188 },
189 "unit": {
190 "id": 0,
191 "displayId": "string"
192 },
193 "contractExternalId": "string",
194 "journalId": 0,
195 "activationGroupRevisionId": 0,
196 "ledgerTransactionId": 0
197 },
198 "nlaCustomReferences": [
199 {
200 "key": "string",
201 "dataType": "STRING",
202 "value": 0
203 }
204 ],
205 "nreReferences": {
206 "id": 0,
207 "premise": {
208 "id": 0,
209 "displayId": "string"
210 },
211 "location": {
212 "id": 0,
213 "displayId": "string"
214 },
215 "lease": {
216 "id": 0,
217 "displayId": "string"
218 },
219 "ledgerTransactionId": 0
220 },
221 "nreCustomReferences": [
222 {
223 "key": "string",
224 "dataType": "STRING",
225 "value": 0
226 }
227 ],
228 "apReferences": {
229 "id": 0,
230 "invoice": {
231 "id": 0,
232 "displayId": "string"
233 },
234 "ledgerTransactionId": 0
235 },
236 "apCustomReferences": [
237 {
238 "key": "string",
239 "dataType": "STRING",
240 "value": 0
241 }
242 ],
243 "entries": [
244 {
245 "id": 0,
246 "entryType": "D",
247 "amount": 0,
248 "unroundedAmount": 0,
249 "deltaAdjustment": 0,
250 "itemText": "string",
251 "itemNoAcc": 0,
252 "generalLedger": {
253 "id": 0,
254 "displayId": "string",
255 "generalLedgerAccountName": "string",
256 "generalLedgerAccountCode": "string",
257 "openItemManagement": true,
258 "accountCategory": "BALANCESHEET",
259 "shortName": "string",
260 "longName": "string"
261 },
262 "additionalCurrencyEntries": [
263 {
264 "id": 0,
265 "amount": 0,
266 "unroundedAmount": 0,
267 "deltaAdjustment": 0,
268 "itemNoAcc": 0,
269 "currencyDetail": {
270 "currencyId": 0,
271 "currencyDisplayId": "string",
272 "currencyDefinitionType": "CONTRACT_CURRENCY",
273 "currencyType": "string"
274 },
275 "currencyConversionDetail": {
276 "rate": 0,
277 "conversionDate": "2019-08-24",
278 "translationDateType": "DOCUMENT_DATE",
279 "sourceCurrencyType": "CONTRACT_CURRENCY",
280 "sourceCurrency": {
281 "id": 0,
282 "displayId": "string"
283 },
284 "depreciationArea": {
285 "id": 0,
286 "displayId": "string"
287 }
288 },
289 "ledgerEntryId": 0,
290 "ledgerEntryTaxId": 0
291 }
292 ],
293 "tag": "string",
294 "costCenter": {
295 "id": 0,
296 "displayId": "string",
297 "mainCostCenter": true,
298 "allocationPercentage": 0.1
299 },
300 "profitCenter": {
301 "id": 0,
302 "displayId": "string"
303 },
304 "vendor": {
305 "id": 0,
306 "displayId": "string"
307 },
308 "transactionType": "string",
309 "nlaCustomReferences": [
310 {
311 "key": "string",
312 "dataType": "STRING",
313 "value": 0
314 }
315 ],
316 "nreCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "apCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "taxEntries": [
331 {
332 "id": 0,
333 "entryType": "D",
334 "amount": 0,
335 "unroundedAmount": 0,
336 "deltaAdjustment": 0,
337 "itemText": "string",
338 "itemNoAcc": 0,
339 "generalLedger": {
340 "id": 0,
341 "displayId": "string",
342 "generalLedgerAccountName": "string",
343 "generalLedgerAccountCode": "string",
344 "openItemManagement": true,
345 "accountCategory": "BALANCESHEET",
346 "shortName": "string",
347 "longName": "string"
348 },
349 "additionalCurrencyEntries": [
350 {
351 "id": 0,
352 "amount": 0,
353 "unroundedAmount": 0,
354 "deltaAdjustment": 0,
355 "itemNoAcc": 0,
356 "currencyDetail": {
357 "currencyId": 0,
358 "currencyDisplayId": "string",
359 "currencyDefinitionType": "CONTRACT_CURRENCY",
360 "currencyType": "string"
361 },
362 "currencyConversionDetail": {
363 "rate": 0,
364 "conversionDate": "2019-08-24",
365 "translationDateType": "DOCUMENT_DATE",
366 "sourceCurrencyType": "CONTRACT_CURRENCY",
367 "sourceCurrency": {
368 "id": 0,
369 "displayId": "string"
370 },
371 "depreciationArea": {
372 "id": 0,
373 "displayId": "string"
374 }
375 },
376 "ledgerEntryId": 0,
377 "ledgerEntryTaxId": 0
378 }
379 ],
380 "taxRate": 0,
381 "taxBaseAmount": 0,
382 "totalTaxDocumentAmount": 0,
383 "taxExempt": 0,
384 "taxExemptionPercentage": 0,
385 "taxAffected": 0,
386 "taxAccount": "string",
387 "accountingKey": "string",
388 "conditionKey": "string",
389 "taxCode": {
390 "id": 0,
391 "displayId": "string"
392 },
393 "taxJurisdiction": {
394 "id": 0,
395 "displayId": "string"
396 },
397 "taxDetermination": {
398 "id": 0,
399 "displayId": "string"
400 },
401 "financialTermId": 0,
402 "ledgerEntryId": 0
403 }
404 ],
405 "ledgerTransactionId": 0
406 }
407 ],
408 "notes": [
409 {
410 "id": 0,
411 "note": "string"
412 }
413 ],
414 "attachments": [
415 {
416 "id": 0,
417 "fileName": "string",
418 "fileStorageId": "string",
419 "docStoreId": 0
420 }
421 ],
422 "journalVoucherWorkflowHistory": [
423 {
424 "id": 0,
425 "eventType": "SEND_TO_APPROVAL",
426 "eventDate": "2019-08-24T14:15:22Z",
427 "user": "string"
428 }
429 ],
430 "ledgerTransactionGroupId": 0,
431 "accountingDocumentId": 0,
432 "internalPostingStatus": {
433 "documentNumber": "string",
434 "status": "NA",
435 "postingMessage": "string"
436 },
437 "nlaEnrichmentState": {
438 "id": 0,
439 "status": "PENDING",
440 "message": "string",
441 "history": [
442 {
443 "requestingUser": "string",
444 "enrichmentRequestId": 0,
445 "requestedAt": "2019-08-24T14:15:22Z",
446 "enrichedAt": "2019-08-24T14:15:22Z",
447 "requestStatus": "SENT",
448 "applicationStatus": "PENDING",
449 "message": "string"
450 }
451 ]
452 },
453 "nreEnrichmentState": {
454 "id": 0,
455 "status": "PENDING",
456 "message": "string",
457 "history": [
458 {
459 "requestingUser": "string",
460 "enrichmentRequestId": 0,
461 "requestedAt": "2019-08-24T14:15:22Z",
462 "enrichedAt": "2019-08-24T14:15:22Z",
463 "requestStatus": "SENT",
464 "applicationStatus": "PENDING",
465 "message": "string"
466 }
467 ]
468 },
469 "apEnrichmentState": {
470 "id": 0,
471 "status": "PENDING",
472 "message": "string",
473 "history": [
474 {
475 "requestingUser": "string",
476 "enrichmentRequestId": 0,
477 "requestedAt": "2019-08-24T14:15:22Z",
478 "enrichedAt": "2019-08-24T14:15:22Z",
479 "requestStatus": "SENT",
480 "applicationStatus": "PENDING",
481 "message": "string"
482 }
483 ]
484 },
485 "externalPostingStatus": {
486 "documentNumber": "string",
487 "objType": "string",
488 "objKey": "string",
489 "objSys": "string",
490 "username": "string",
491 "status": "NA",
492 "postingMessage": "string",
493 "taskId": 0
494 }
495}
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
none |
requestUniqueId |
string |
true |
none |
none |
createdByApplication |
string |
true |
none |
none |
applicationReferenceId |
string |
true |
none |
Any application MUST send a unique reference in order to ignore duplicate postings. |
documentComments |
string |
false |
none |
none |
name |
string |
false |
none |
none |
principalPositionType |
string |
false |
none |
none |
postingTransactionType |
string |
false |
none |
none |
postingType |
string |
true |
none |
none |
ledgerType |
string |
true |
none |
none |
parallelCurrencyEnabled |
boolean |
false |
none |
none |
generateInvoiceInAp |
boolean |
false |
none |
none |
generateVendorInvoice |
boolean |
false |
none |
none |
calculateTax |
boolean |
false |
none |
none |
taxCalculationType |
string |
false |
none |
none |
currencyDetail |
false |
none |
none |
|
classificationInfo |
false |
none |
none |
|
date |
false |
none |
none |
|
automaticReversal |
false |
none |
none |
|
trace |
false |
none |
none |
|
fosReferences |
false |
none |
none |
|
assetRegisterReferences |
false |
none |
none |
|
nlaReferences |
false |
none |
none |
|
nlaCustomReferences |
[oneOf] |
false |
none |
none |
📄 Description: oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
nreReferences |
false |
none |
none |
|
nreCustomReferences |
[oneOf] |
false |
none |
none |
📄 Description: oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
apReferences |
false |
none |
none |
|
apCustomReferences |
[oneOf] |
false |
none |
none |
📄 Description: oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
none |
📄 Description: continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
entries |
false |
none |
none |
|
notes |
false |
none |
none |
|
attachments |
false |
none |
none |
|
journalVoucherWorkflowHistory |
false |
none |
none |
|
ledgerTransactionGroupId |
integer(int64) |
false |
none |
none |
accountingDocumentId |
integer(int64) |
false |
none |
none |
internalPostingStatus |
false |
none |
none |
|
nlaEnrichmentState |
false |
none |
none |
|
nreEnrichmentState |
false |
none |
none |
|
apEnrichmentState |
false |
none |
none |
|
externalPostingStatus |
false |
none |
none |
Enumerated Values
Attribute |
Value |
|---|---|
createdByApplication |
ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE |
ledgerType |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER |
postingTransactionType |
POST, REVERSE |
postingType |
ACCRUAL, CHARGE, DEPRECIATION, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
principalPositionType |
LESSEE, LESSOR |
taxCalculationType |
NET |