ResponseLedgerTransactionDto

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    "id": 0,
 19    "displayId": "string",
 20    "createdByApplication": "NLA",
 21    "postingTransactionType": "POST",
 22    "postingType": "PAYMENT",
 23    "ledgerType": "LIABILITY",
 24    "paymentType": "N_A",
 25    "applicationReferenceId": "string",
 26    "documentComments": "string",
 27    "documentDate": "2019-08-24",
 28    "userDocumentDate": "2019-08-24",
 29    "postingDate": "2019-08-24",
 30    "transactionDate": "2019-08-24",
 31    "fiscalYear": 0,
 32    "fiscalPeriod": 0,
 33    "currencyDetail": {
 34      "currencyId": 0,
 35      "currencyDisplayId": "string",
 36      "currencyDefinitionType": "CONTRACT_CURRENCY",
 37      "currencyType": "string"
 38    },
 39    "company": {
 40      "id": 0,
 41      "displayId": "string"
 42    },
 43    "vendorId": 0,
 44    "vendorDisplayId": "string",
 45    "vendorName": "string",
 46    "invoiceId": 0,
 47    "invoicePaymentId": 0,
 48    "workspaceId": 0,
 49    "clearingLedgerTransactionId": 0,
 50    "currency": {
 51      "id": 0,
 52      "displayId": "string",
 53      "status": "CREATED",
 54      "name": "string",
 55      "decimalPoints": 0
 56    },
 57    "accountingStandard": {
 58      "id": 0,
 59      "displayId": "string"
 60    },
 61    "leaseClassificationType": "NON_LEASE",
 62    "generateVendorInvoice": true,
 63    "splitLeasePayment": true,
 64    "parallelCurrencyEnabled": true,
 65    "calculateTax": true,
 66    "taxCalculationType": "NET",
 67    "principalPositionType": "LESSEE",
 68    "nlaReferences": {
 69      "id": 0,
 70      "contract": {
 71        "id": 0,
 72        "displayId": "string"
 73      },
 74      "leaseComponent": {
 75        "id": 0,
 76        "displayId": "string"
 77      },
 78      "activationGroup": {
 79        "id": 0,
 80        "displayId": "string"
 81      },
 82      "unit": {
 83        "id": 0,
 84        "displayId": "string"
 85      },
 86      "contractExternalId": "string",
 87      "journalId": 0,
 88      "activationGroupRevisionId": 0,
 89      "ledgerTransactionId": 0
 90    },
 91    "nreReferences": {
 92      "id": 0,
 93      "premise": {
 94        "id": 0,
 95        "displayId": "string"
 96      },
 97      "location": {
 98        "id": 0,
 99        "displayId": "string"
100      },
101      "lease": {
102        "id": 0,
103        "displayId": "string"
104      },
105      "ledgerTransactionId": 0
106    },
107    "fosReferences": {
108      "id": 0,
109      "system": {
110        "id": 0,
111        "displayId": "string"
112      },
113      "company": {
114        "id": 0,
115        "displayId": "string"
116      },
117      "leaseArea": {
118        "id": 0,
119        "displayId": "string"
120      },
121      "leaseGroup": {
122        "id": 0,
123        "displayId": "string"
124      },
125      "leaseDepartment": {
126        "id": 0,
127        "displayId": "string"
128      },
129      "businessUnit": {
130        "id": 0,
131        "displayId": "string"
132      },
133      "mainCostCenter": {
134        "id": 0,
135        "displayId": "string"
136      },
137      "internalAssetClass": {
138        "id": 0,
139        "displayId": "string"
140      },
141      "documentType": {
142        "id": 0,
143        "displayId": "string"
144      },
145      "depreciationArea": {
146        "id": 0,
147        "displayId": "string"
148      },
149      "reversalReason": {
150        "id": 0,
151        "displayId": "string"
152      },
153      "tradingPartner": {
154        "id": 0,
155        "displayId": "string"
156      },
157      "allocationNumber": {
158        "id": 0,
159        "displayId": "string"
160      },
161      "responsibleCostCenter": {
162        "id": 0,
163        "displayId": "string"
164      },
165      "workBreakdownStructure": {
166        "id": 0,
167        "displayId": "string"
168      },
169      "businessArea": {
170        "id": 0,
171        "displayId": "string"
172      },
173      "functionalArea": {
174        "id": 0,
175        "displayId": "string"
176      },
177      "plant": {
178        "id": 0,
179        "displayId": "string"
180      },
181      "internalOrder": {
182        "id": 0,
183        "displayId": "string"
184      },
185      "network": {
186        "id": 0,
187        "displayId": "string"
188      },
189      "paymentTerm": {
190        "id": 0,
191        "displayId": "string"
192      },
193      "paymentBlock": {
194        "id": 0,
195        "displayId": "string"
196      },
197      "paymentMethod": {
198        "id": 0,
199        "displayId": "string",
200        "name": "string",
201        "type": "string"
202      },
203      "segment": {
204        "id": 0,
205        "displayId": "string"
206      },
207      "purchasingOrganization": {
208        "id": 0,
209        "displayId": "string"
210      },
211      "purchasingOrder": {
212        "id": 0,
213        "displayId": "string"
214      },
215      "ledgerTransactionId": 0
216    },
217    "apReferences": {
218      "id": 0,
219      "invoice": {
220        "id": 0,
221        "displayId": "string",
222        "name": "string"
223      },
224      "vendor": {
225        "id": 0,
226        "displayId": "string",
227        "name": "string"
228      },
229      "ledgerTransactionId": 0
230    },
231    "assetRegisterReferences": {
232      "id": 0,
233      "asset": {
234        "assetId": 0,
235        "assetDisplayId": "string",
236        "assetNumber": "string",
237        "subAssetNumber": "string"
238      },
239      "ledgerTransactionId": 0
240    },
241    "ledgerTransactionGroupId": 0,
242    "accountingDocumentId": 0,
243    "entries": [
244      {
245        "id": 0,
246        "displayId": "string",
247        "itemText": "string",
248        "entryType": "D",
249        "amount": 0,
250        "unroundedAmount": 0,
251        "deltaAdjustment": 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        "costCenter": {
263          "id": 0,
264          "displayId": "string",
265          "mainCostCenter": true,
266          "allocationPercentage": 0.1
267        },
268        "profitCenter": {
269          "id": 0,
270          "displayId": "string"
271        },
272        "vendor": {
273          "id": 0,
274          "displayId": "string",
275          "name": "string"
276        },
277        "taxEntries": [
278          {
279            "id": 0,
280            "displayId": "string",
281            "itemText": "string",
282            "entryType": "D",
283            "amount": 0,
284            "unroundedAmount": 0,
285            "deltaAdjustment": 0,
286            "generalLedger": {
287              "id": 0,
288              "displayId": "string",
289              "generalLedgerAccountName": "string",
290              "generalLedgerAccountCode": "string",
291              "openItemManagement": true,
292              "accountCategory": "BALANCESHEET",
293              "shortName": "string",
294              "longName": "string"
295            },
296            "taxBaseAmount": 0,
297            "totalTaxDocumentAmount": 0,
298            "taxExempt": 0,
299            "taxAffected": 0,
300            "vendor": {
301              "id": 0,
302              "displayId": "string",
303              "status": "CREATED",
304              "name": "string",
305              "erpSystemDisplayId": "string"
306            },
307            "ledgerEntryId": 0,
308            "additionalCurrencies": [
309              {
310                "id": 0,
311                "displayId": "string",
312                "entryType": "D",
313                "amount": 0,
314                "unroundedAmount": 0,
315                "deltaAdjustment": 0,
316                "currency": {
317                  "id": 0,
318                  "displayId": "string"
319                },
320                "currencyDefinitionType": "CONTRACT_CURRENCY",
321                "currencyType": "string",
322                "rate": 0,
323                "conversionDate": "2019-08-24",
324                "translationDateType": "DOCUMENT_DATE",
325                "sourceCurrencyType": "CONTRACT_CURRENCY",
326                "sourceCurrency": {
327                  "id": 0,
328                  "displayId": "string"
329                },
330                "depreciationArea": {
331                  "id": 0,
332                  "displayId": "string"
333                },
334                "ledgerEntryId": 0,
335                "ledgerEntryTaxId": 0,
336                "allowsSystemGenerateNewId": true,
337                "numberRangeIdentifierValue": "string",
338                "numberRangeIdentifierType": {
339                  "name": "string"
340                },
341                "numberRangeType": {
342                  "name": "string"
343                }
344              }
345            ],
346            "allowsSystemGenerateNewId": true,
347            "numberRangeIdentifierValue": "string",
348            "numberRangeIdentifierType": {
349              "name": "string"
350            },
351            "numberRangeType": {
352              "name": "string"
353            }
354          }
355        ],
356        "additionalCurrencies": [
357          {
358            "id": 0,
359            "displayId": "string",
360            "entryType": "D",
361            "amount": 0,
362            "unroundedAmount": 0,
363            "deltaAdjustment": 0,
364            "currency": {
365              "id": 0,
366              "displayId": "string"
367            },
368            "currencyDefinitionType": "CONTRACT_CURRENCY",
369            "currencyType": "string",
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            "ledgerEntryId": 0,
383            "ledgerEntryTaxId": 0,
384            "allowsSystemGenerateNewId": true,
385            "numberRangeIdentifierValue": "string",
386            "numberRangeIdentifierType": {
387              "name": "string"
388            },
389            "numberRangeType": {
390              "name": "string"
391            }
392          }
393        ],
394        "ledgerTransactionId": 0,
395        "expenseCategory": {
396          "id": 0,
397          "displayId": "string",
398          "status": "CREATED",
399          "name": "string",
400          "expenseCategoryType": "PAYMENT"
401        },
402        "allowsSystemGenerateNewId": true,
403        "numberRangeIdentifierValue": "string",
404        "numberRangeIdentifierType": {
405          "name": "string"
406        },
407        "numberRangeType": {
408          "name": "string"
409        }
410      }
411    ],
412    "notes": [
413      {
414        "id": 0,
415        "note": "string"
416      }
417    ],
418    "reasonCode": {
419      "id": 0,
420      "name": "string"
421    },
422    "internalPostingStatus": {
423      "documentNumber": "string",
424      "status": "NA",
425      "postingMessage": "string"
426    },
427    "externalPostingStatus": {
428      "documentNumber": "string",
429      "objType": "string",
430      "objKey": "string",
431      "objSys": "string",
432      "username": "string",
433      "status": "NA",
434      "postingMessage": "string",
435      "taskId": 0
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    "allowsSystemGenerateNewId": true,
486    "numberRangeIdentifierValue": "string",
487    "numberRangeIdentifierType": {
488      "name": "string"
489    },
490    "numberRangeType": {
491      "name": "string"
492    }
493  }
494}

📄 Description: Data transfer object representing a ledger transaction, capturing essential details such as transaction type, amount, and timestamps for accurate financial tracking and reporting.

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 context for the transaction’s purpose and significance.

defaultMessage

string

false

write-only

Default message to be displayed for the ledger transaction, providing essential context for users reviewing transaction details.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the ledger transaction.

errors

Errors

false

none

Collection of error messages encountered during the processing of ledger transactions, providing insights for troubleshooting and resolution.

object

LedgerTransactionDto

false

none

Represents the detailed information of a ledger transaction, facilitating financial tracking and reporting within the system.

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