ResponseListLedgerTransactionDto¶
Example Json Object
1{
2 "code": "UPDATED",
3 "message": "string",
4 "defaultMessage": "string",
5 "debugMessage": "string",
6 "errors": {
7 "all": [
8 {
9 "type": "GENERIC",
10 "source": {},
11 "errorMessage": "string",
12 "field": "string",
13 "errorKey": "string"
14 }
15 ]
16 },
17 "object": [
18 {
19 "id": 0,
20 "displayId": "string",
21 "createdByApplication": "NLA",
22 "postingTransactionType": "POST",
23 "postingType": "PAYMENT",
24 "ledgerType": "LIABILITY",
25 "paymentType": "N_A",
26 "applicationReferenceId": "string",
27 "documentComments": "string",
28 "documentDate": "2019-08-24",
29 "userDocumentDate": "2019-08-24",
30 "postingDate": "2019-08-24",
31 "transactionDate": "2019-08-24",
32 "fiscalYear": 0,
33 "fiscalPeriod": 0,
34 "currencyDetail": {
35 "currencyId": 0,
36 "currencyDisplayId": "string",
37 "currencyDefinitionType": "CONTRACT_CURRENCY",
38 "currencyType": "string"
39 },
40 "company": {
41 "id": 0,
42 "displayId": "string"
43 },
44 "vendorId": 0,
45 "vendorDisplayId": "string",
46 "vendorName": "string",
47 "invoiceId": 0,
48 "invoicePaymentId": 0,
49 "workspaceId": 0,
50 "clearingLedgerTransactionId": 0,
51 "currency": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string",
56 "decimalPoints": 0
57 },
58 "accountingStandard": {
59 "id": 0,
60 "displayId": "string"
61 },
62 "leaseClassificationType": "NON_LEASE",
63 "generateVendorInvoice": true,
64 "splitLeasePayment": true,
65 "parallelCurrencyEnabled": true,
66 "calculateTax": true,
67 "taxCalculationType": "NET",
68 "principalPositionType": "LESSEE",
69 "nlaReferences": {
70 "id": 0,
71 "contract": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseComponent": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "activationGroup": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "unit": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "contractExternalId": "string",
88 "journalId": 0,
89 "activationGroupRevisionId": 0,
90 "ledgerTransactionId": 0
91 },
92 "nreReferences": {
93 "id": 0,
94 "premise": {
95 "id": 0,
96 "displayId": "string"
97 },
98 "location": {
99 "id": 0,
100 "displayId": "string"
101 },
102 "lease": {
103 "id": 0,
104 "displayId": "string"
105 },
106 "ledgerTransactionId": 0
107 },
108 "fosReferences": {
109 "id": 0,
110 "system": {
111 "id": 0,
112 "displayId": "string"
113 },
114 "company": {
115 "id": 0,
116 "displayId": "string"
117 },
118 "leaseArea": {
119 "id": 0,
120 "displayId": "string"
121 },
122 "leaseGroup": {
123 "id": 0,
124 "displayId": "string"
125 },
126 "leaseDepartment": {
127 "id": 0,
128 "displayId": "string"
129 },
130 "businessUnit": {
131 "id": 0,
132 "displayId": "string"
133 },
134 "mainCostCenter": {
135 "id": 0,
136 "displayId": "string"
137 },
138 "internalAssetClass": {
139 "id": 0,
140 "displayId": "string"
141 },
142 "documentType": {
143 "id": 0,
144 "displayId": "string"
145 },
146 "depreciationArea": {
147 "id": 0,
148 "displayId": "string"
149 },
150 "reversalReason": {
151 "id": 0,
152 "displayId": "string"
153 },
154 "tradingPartner": {
155 "id": 0,
156 "displayId": "string"
157 },
158 "allocationNumber": {
159 "id": 0,
160 "displayId": "string"
161 },
162 "responsibleCostCenter": {
163 "id": 0,
164 "displayId": "string"
165 },
166 "workBreakdownStructure": {
167 "id": 0,
168 "displayId": "string"
169 },
170 "businessArea": {
171 "id": 0,
172 "displayId": "string"
173 },
174 "functionalArea": {
175 "id": 0,
176 "displayId": "string"
177 },
178 "plant": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "internalOrder": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "network": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "paymentTerm": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "paymentBlock": {
195 "id": 0,
196 "displayId": "string"
197 },
198 "paymentMethod": {
199 "id": 0,
200 "displayId": "string",
201 "name": "string",
202 "type": "string"
203 },
204 "segment": {
205 "id": 0,
206 "displayId": "string"
207 },
208 "purchasingOrganization": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "purchasingOrder": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "ledgerTransactionId": 0
217 },
218 "apReferences": {
219 "id": 0,
220 "invoice": {
221 "id": 0,
222 "displayId": "string",
223 "name": "string"
224 },
225 "vendor": {
226 "id": 0,
227 "displayId": "string",
228 "name": "string"
229 },
230 "ledgerTransactionId": 0
231 },
232 "assetRegisterReferences": {
233 "id": 0,
234 "asset": {
235 "assetId": 0,
236 "assetDisplayId": "string",
237 "assetNumber": "string",
238 "subAssetNumber": "string"
239 },
240 "ledgerTransactionId": 0
241 },
242 "ledgerTransactionGroupId": 0,
243 "accountingDocumentId": 0,
244 "entries": [
245 {
246 "id": 0,
247 "displayId": "string",
248 "itemText": "string",
249 "entryType": "D",
250 "amount": 0,
251 "unroundedAmount": 0,
252 "deltaAdjustment": 0,
253 "generalLedger": {
254 "id": 0,
255 "displayId": "string",
256 "generalLedgerAccountName": "string",
257 "generalLedgerAccountCode": "string",
258 "openItemManagement": true,
259 "accountCategory": "BALANCESHEET",
260 "shortName": "string",
261 "longName": "string"
262 },
263 "costCenter": {
264 "id": 0,
265 "displayId": "string",
266 "mainCostCenter": true,
267 "allocationPercentage": 0.1
268 },
269 "profitCenter": {
270 "id": 0,
271 "displayId": "string"
272 },
273 "vendor": {
274 "id": 0,
275 "displayId": "string",
276 "name": "string"
277 },
278 "taxEntries": [
279 {
280 "id": 0,
281 "displayId": "string",
282 "itemText": "string",
283 "entryType": "D",
284 "amount": 0,
285 "unroundedAmount": 0,
286 "deltaAdjustment": 0,
287 "generalLedger": {
288 "id": 0,
289 "displayId": "string",
290 "generalLedgerAccountName": "string",
291 "generalLedgerAccountCode": "string",
292 "openItemManagement": true,
293 "accountCategory": "BALANCESHEET",
294 "shortName": "string",
295 "longName": "string"
296 },
297 "taxBaseAmount": 0,
298 "totalTaxDocumentAmount": 0,
299 "taxExempt": 0,
300 "taxAffected": 0,
301 "vendor": {
302 "id": 0,
303 "displayId": "string",
304 "status": "CREATED",
305 "name": "string",
306 "erpSystemDisplayId": "string"
307 },
308 "ledgerEntryId": 0,
309 "additionalCurrencies": [
310 {
311 "id": 0,
312 "displayId": "string",
313 "entryType": "D",
314 "amount": 0,
315 "unroundedAmount": 0,
316 "deltaAdjustment": 0,
317 "currency": {
318 "id": 0,
319 "displayId": "string"
320 },
321 "currencyDefinitionType": "CONTRACT_CURRENCY",
322 "currencyType": "string",
323 "rate": 0,
324 "conversionDate": "2019-08-24",
325 "translationDateType": "DOCUMENT_DATE",
326 "sourceCurrencyType": "CONTRACT_CURRENCY",
327 "sourceCurrency": {
328 "id": 0,
329 "displayId": "string"
330 },
331 "depreciationArea": {
332 "id": 0,
333 "displayId": "string"
334 },
335 "ledgerEntryId": 0,
336 "ledgerEntryTaxId": 0,
337 "allowsSystemGenerateNewId": true,
338 "numberRangeIdentifierValue": "string",
339 "numberRangeIdentifierType": {
340 "name": "string"
341 },
342 "numberRangeType": {
343 "name": "string"
344 }
345 }
346 ],
347 "allowsSystemGenerateNewId": true,
348 "numberRangeIdentifierValue": "string",
349 "numberRangeIdentifierType": {
350 "name": "string"
351 },
352 "numberRangeType": {
353 "name": "string"
354 }
355 }
356 ],
357 "additionalCurrencies": [
358 {
359 "id": 0,
360 "displayId": "string",
361 "entryType": "D",
362 "amount": 0,
363 "unroundedAmount": 0,
364 "deltaAdjustment": 0,
365 "currency": {
366 "id": 0,
367 "displayId": "string"
368 },
369 "currencyDefinitionType": "CONTRACT_CURRENCY",
370 "currencyType": "string",
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 "ledgerEntryId": 0,
384 "ledgerEntryTaxId": 0,
385 "allowsSystemGenerateNewId": true,
386 "numberRangeIdentifierValue": "string",
387 "numberRangeIdentifierType": {
388 "name": "string"
389 },
390 "numberRangeType": {
391 "name": "string"
392 }
393 }
394 ],
395 "ledgerTransactionId": 0,
396 "expenseCategory": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "expenseCategoryType": "PAYMENT"
402 },
403 "allowsSystemGenerateNewId": true,
404 "numberRangeIdentifierValue": "string",
405 "numberRangeIdentifierType": {
406 "name": "string"
407 },
408 "numberRangeType": {
409 "name": "string"
410 }
411 }
412 ],
413 "notes": [
414 {
415 "id": 0,
416 "note": "string"
417 }
418 ],
419 "reasonCode": {
420 "id": 0,
421 "name": "string"
422 },
423 "internalPostingStatus": {
424 "documentNumber": "string",
425 "status": "NA",
426 "postingMessage": "string"
427 },
428 "externalPostingStatus": {
429 "documentNumber": "string",
430 "objType": "string",
431 "objKey": "string",
432 "objSys": "string",
433 "username": "string",
434 "status": "NA",
435 "postingMessage": "string",
436 "taskId": 0
437 },
438 "nlaEnrichmentState": {
439 "id": 0,
440 "status": "PENDING",
441 "message": "string",
442 "history": [
443 {
444 "requestingUser": "string",
445 "enrichmentRequestId": 0,
446 "requestedAt": "2019-08-24T14:15:22Z",
447 "enrichedAt": "2019-08-24T14:15:22Z",
448 "requestStatus": "SENT",
449 "applicationStatus": "PENDING",
450 "message": "string"
451 }
452 ]
453 },
454 "nreEnrichmentState": {
455 "id": 0,
456 "status": "PENDING",
457 "message": "string",
458 "history": [
459 {
460 "requestingUser": "string",
461 "enrichmentRequestId": 0,
462 "requestedAt": "2019-08-24T14:15:22Z",
463 "enrichedAt": "2019-08-24T14:15:22Z",
464 "requestStatus": "SENT",
465 "applicationStatus": "PENDING",
466 "message": "string"
467 }
468 ]
469 },
470 "apEnrichmentState": {
471 "id": 0,
472 "status": "PENDING",
473 "message": "string",
474 "history": [
475 {
476 "requestingUser": "string",
477 "enrichmentRequestId": 0,
478 "requestedAt": "2019-08-24T14:15:22Z",
479 "enrichedAt": "2019-08-24T14:15:22Z",
480 "requestStatus": "SENT",
481 "applicationStatus": "PENDING",
482 "message": "string"
483 }
484 ]
485 },
486 "allowsSystemGenerateNewId": true,
487 "numberRangeIdentifierValue": "string",
488 "numberRangeIdentifierType": {
489 "name": "string"
490 },
491 "numberRangeType": {
492 "name": "string"
493 }
494 }
495 ]
496}
📄 Description: Data transfer object representing a list of ledger transactions, providing essential details for financial reporting and analysis within the enterprise. This schema facilitates the efficient retrieval and management of transaction data for informed decision-making.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
code |
string |
false |
none |
Code identifier for the resource |
message |
string |
false |
write-only |
Contains the detailed message or description related to the ledger transaction, providing essential context for transaction processing and auditing. |
defaultMessage |
string |
false |
write-only |
Default message displayed for ledger transactions, providing essential context for users reviewing transaction details. |
debugMessage |
string |
false |
write-only |
Provides a detailed message for debugging purposes, assisting in the identification and resolution of issues within the ledger transaction response. |
errors |
false |
none |
Collection of error messages related to ledger transaction processing, providing insights for troubleshooting and resolution. |
|
object |
false |
none |
An array of ledger transaction objects that provides detailed information on financial transactions for comprehensive reporting and analysis. |
Enumerated Values
Attribute |
Value |
|---|---|
code |
API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED |