LedgerTransactionDto

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  "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}

📄 Description: Data transfer object representing a ledger transaction, encapsulating details of financial entries associated with accounts and their corresponding records within the general ledger.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

requestUniqueId

string

false

none

Unique identifier for the request unique

createdByApplication

string

false

none

Text value for createdByApplication in LedgerTransactionDto

applicationReferenceId

string

true

none

Any application MUST send a unique reference in order to ignore duplicate postings.

documentComments

string

false

none

Text value for documentComments in LedgerTransactionDto

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

CurrencyDetail

false

none

Value for currencyDetail field

classificationInfo

ClassificationInfo

false

none

Value for classificationInfo field

date

LedgerTransactionDate

false

none

Date of the resource

automaticReversal

JournalVoucherAutomaticReversalDto

false

none

Value for automaticReversal field

trace

LedgerTransactionTrace

false

none

Value for trace field

fosReferences

LedgerTransactionReferencesFosDto

false

none

Value for fosReferences field

assetRegisterReferences

LedgerTransactionReferencesAssetRegisterDto

false

none

Value for assetRegisterReferences field

nlaReferences

LedgerTransactionReferencesNlaDto

false

none

Value for nlaReferences field

nlaCustomReferences

[oneOf]

false

none

List of nlaCustomReferences items

📄 Description: oneOf

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceBigDecimalDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceBooleanDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceDateDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceDoubleDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceIntegerDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceLongDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceStringDto

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.

📄 Description: continued

Name

Type

Required

Restrictions

Description

nreReferences

LedgerTransactionReferencesNreDto

false

none

Value for nreReferences field

nreCustomReferences

[oneOf]

false

none

List of nreCustomReferences items

📄 Description: oneOf

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceBigDecimalDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceBooleanDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceDateDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceDoubleDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceIntegerDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceLongDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceStringDto

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.

📄 Description: continued

Name

Type

Required

Restrictions

Description

apReferences

LedgerTransactionReferencesApDto

false

none

Value for apReferences field

apCustomReferences

[oneOf]

false

none

List of apCustomReferences items

📄 Description: oneOf

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceBigDecimalDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceBooleanDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceDateDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceDoubleDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceIntegerDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceLongDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

CustomApplicationReferenceStringDto

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.

📄 Description: continued

Name

Type

Required

Restrictions

Description

entries

[LedgerEntryDto]

false

none

List of entries items

notes

[LedgerTransactionNoteDto]

false

none

List of notes items

attachments

[LedgerTransactionAttachmentDto]

false

none

List of attachments items

journalVoucherWorkflowHistory

[JournalVoucherWorkflowHistoryDto]

false

none

List of journalVoucherWorkflowHistory items

ledgerTransactionGroupId

integer(int64)

false

none

Unique identifier for the ledger transaction group

accountingDocumentId

integer(int64)

false

none

Unique identifier for the accounting document

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

paymentType

CLEARING, N_A, PAYMENT

postingTransactionType

POST, REVERSE

postingType

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

principalPositionType

LESSEE, LESSOR

taxCalculationType

NET