LedgerTransactionDto

Example Json Object

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

📄 Description: Data transfer object representing a ledger transaction, encapsulating essential details such as transaction type, amount, date, and associated accounts, facilitating accurate financial reporting and reconciliation.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

createdByApplication

string

false

none

Identifier of the application that initiated the ledger transaction, providing accountability and traceability within financial records.

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

Type of the payment

applicationReferenceId

string

false

none

Unique identifier for the application reference

documentComments

string

false

none

Comments related to the ledger transaction, providing additional context or notes for internal review and audit purposes.

documentDate

string(date)

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

fiscalYear

integer(int32)

false

none

Represents the fiscal year associated with the ledger transaction, facilitating accurate financial reporting and analysis.

fiscalPeriod

integer(int32)

false

none

Represents the fiscal period associated with the ledger transaction, facilitating accurate financial reporting and analysis.

currencyDetail

CurrencyDetail

false

none

Details the currency information associated with the ledger transaction, facilitating accurate financial reporting and analysis.

company

BaseId

false

none

Represents the company associated with the ledger transaction, providing essential context for financial reporting and analysis.

vendorId

integer(int64)

false

none

Unique identifier for the vendor

vendorDisplayId

string

false

none

Unique identifier for the vendor display

vendorName

string

false

none

Name of the vendor

invoiceId

integer(int64)

false

none

Unique identifier for the invoice

invoicePaymentId

integer(int64)

false

none

Unique identifier for the invoice payment

workspaceId

integer(int64)

false

none

Unique identifier for the workspace

clearingLedgerTransactionId

integer(int64)

false

none

Unique identifier for the clearing ledger transaction

currency

CurrencyLite

false

none

Specifies the currency in which the ledger transaction is recorded, ensuring accurate financial reporting and compliance.

accountingStandard

BaseId

false

none

Indicates the accounting standard applied to the ledger transaction, ensuring compliance with relevant financial reporting requirements.

leaseClassificationType

string

false

none

Type of the lease classification

generateVendorInvoice

boolean

false

none

Indicates whether to generate a vendor invoice as part of the ledger transaction processing.

splitLeasePayment

boolean

false

none

Indicates whether the lease payment should be divided into multiple transactions within the ledger.

parallelCurrencyEnabled

boolean

false

none

Indicates whether transactions can be processed in multiple currencies simultaneously within the ledger.

calculateTax

boolean

false

none

Indicates whether tax calculation should be applied to the ledger transaction.

taxCalculationType

string

false

none

Type of the tax calculation

principalPositionType

string

false

none

Type of the principal position

nlaReferences

LedgerTransactionReferencesNlaDto

false

none

Collection of references associated with the ledger transaction, providing context for financial entries and facilitating audit trails.

nreReferences

LedgerTransactionReferencesNreDto

false

none

List of non-recurring expense references associated with the ledger transaction, providing essential context for financial reporting and analysis.

fosReferences

LedgerTransactionReferencesFosDto

false

none

Collection of references related to the ledger transaction, providing essential context for financial reporting and auditing purposes.

apReferences

LedgerTransactionReferencesApDto

false

none

Collection of associated reference identifiers for ledger transactions, facilitating tracking and reconciliation within financial records.

assetRegisterReferences

LedgerTransactionReferencesAssetRegisterDto

false

none

References to the asset register associated with the ledger transaction, facilitating accurate tracking and management of financial assets.

ledgerTransactionGroupId

integer(int64)

false

none

Unique identifier for the ledger transaction group

accountingDocumentId

integer(int64)

false

none

Unique identifier for the accounting document

entries

[LedgerEntryDto]

false

none

An array of ledger transaction entries that captures detailed financial activities for accurate accounting and reporting.

notes

[LedgerTransactionNoteDto]

false

none

An array of notes associated with the ledger transaction, providing additional context and details for financial record-keeping.

reasonCode

ReasonCodeDto

false

none

Code for the reason

internalPostingStatus

InternalPostingStatus

false

none

Status of the internal posting

externalPostingStatus

ExternalPostingStatus

false

none

Status of the external posting

nlaEnrichmentState

ApplicationEnrichmentStateDto

false

none

Indicates the current status of enrichment processing for the ledger transaction, providing insight into its processing stage within the financial workflow.

nreEnrichmentState

ApplicationEnrichmentStateDto

false

none

Indicates the current state of enrichment for the non-revenue expense within the ledger transaction.

apEnrichmentState

ApplicationEnrichmentStateDto

false

none

Indicates the current state of enrichment processing for the ledger transaction, providing insights into its status within the financial workflow.

allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

numberRangeIdentifierValue

string

false

none

Represents a unique string value that identifies a specific range of numbers associated with a ledger transaction.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeType

INumberRangeType

false

none

Type of the number range

Enumerated Values

Attribute

Value

createdByApplication

ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE

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

postingTransactionType

POST, REVERSE

postingType

ACCRUAL, CHARGE, DEPRECIATION, FX_REMEASUREMENT, INVOICE_POSTING, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER

principalPositionType

LESSEE, LESSOR

taxCalculationType

NET