Ledger Transaction¶
Ledger Transaction - Search¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/search
📋 Description: Submits a request to search for ledger transactions within the general ledger, allowing users to filter results based on specific criteria related to ledger entries, accounts, and financial records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
Request body containing search criteria for ledger transactions, including parameters such as account identifiers and transaction details to facilitate precise financial record retrieval. |
» filter |
body |
false |
Data transfer object representing a filter for retrieving specific ledger transaction entries, enabling users to refine searches based on account details and financial records within the General Ledger. |
|
»» idIn |
body |
[integer] |
false |
Filter by multiple values of id |
»» idEqual |
body |
integer(int64) |
false |
Filter by exact match of id |
»» idLike |
body |
string |
false |
Filter by partial match of id |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is greater than or equal to specified value |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is less than or equal to specified value |
»» createdByLike |
body |
string |
false |
Filter by partial match of created by |
»» createdByEqual |
body |
string |
false |
Filter by exact match of created by |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is greater than or equal to specified value |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is less than or equal to specified value |
»» modifiedByLike |
body |
string |
false |
Filter by partial match of modified by |
»» modifiedByEqual |
body |
string |
false |
Filter by exact match of modified by |
»» createdByApplicationIn |
body |
[string] |
false |
Filter by multiple values of created by application |
»» applicationReferenceIdEqual |
body |
string |
false |
Filter by exact match of application reference id |
»» documentCommentsLike |
body |
string |
false |
Filter by partial match of document comments |
»» nameLike |
body |
string |
false |
Filter by partial match of name |
»» principalPositionTypeEqual |
body |
string |
false |
Filter by exact match of principal position type |
»» postingTransactionTypeEqual |
body |
string |
false |
Filter by exact match of posting transaction type |
»» postingTypeEqual |
body |
string |
false |
Filter by exact match of posting type |
»» ledgerTypeEqual |
body |
string |
false |
Filter by exact match of ledger type |
»» paymentTypeEqual |
body |
string |
false |
none |
»» currencyIdEqual |
body |
integer(int64) |
false |
Filter by exact match of currency id |
»» currencyDisplayIdLike |
body |
string |
false |
Filter by partial match of currency display id |
»» accountingStandardIdEqual |
body |
integer(int64) |
false |
Filter by exact match of accounting standard id |
»» accountingStandardDisplayIdLike |
body |
string |
false |
Filter by partial match of accounting standard display id |
»» dateDocumentDateGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where date document date is greater than or equal to specified value |
»» dateUserDocumentDateGreaterThanOrEqual |
body |
string(date) |
false |
Filter where date user document date is greater than or equal to specified value |
»» datePostingDateGreaterThanOrEqual |
body |
string(date) |
false |
Filter where date posting date is greater than or equal to specified value |
»» dateDocumentDateLessThanOrEqual |
body |
string(date-time) |
false |
Filter where date document date is less than or equal to specified value |
»» dateUserDocumentDateLessThanOrEqual |
body |
string(date) |
false |
Filter where date user document date is less than or equal to specified value |
»» datePostingDateLessThanOrEqual |
body |
string(date) |
false |
Filter where date posting date is less than or equal to specified value |
»» systemIdEqual |
body |
integer(int64) |
false |
Filter by exact match of system id |
»» companyIdEqual |
body |
integer(int64) |
false |
Filter by exact match of company id |
»» systemDisplayIdLike |
body |
string |
false |
Filter by partial match of system display id |
»» companyDisplayIdLike |
body |
string |
false |
Filter by partial match of company display id |
»» activationGroupIdEqual |
body |
integer(int64) |
false |
Filter by exact match of activation group id |
»» activationGroupDisplayIdLike |
body |
string |
false |
Filter by partial match of activation group display id |
»» nlaCustomReferencesKeyEqual |
body |
string |
false |
Filter by exact match of nla custom references key |
»» nlaCustomReferencesValueLike |
body |
string |
false |
Filter by partial match of nla custom references value |
»» nlaCustomReferencesDataTypeLike |
body |
string |
false |
Filter by partial match of nla custom references data type |
»» nreCustomReferencesKeyEqual |
body |
string |
false |
Filter by exact match of nre custom references key |
»» nreCustomReferencesValueLike |
body |
string |
false |
Filter by partial match of nre custom references value |
»» nreCustomReferencesDataTypeLike |
body |
string |
false |
Filter by partial match of nre custom references data type |
»» apCustomReferencesKeyEqual |
body |
string |
false |
Filter by exact match of ap custom references key |
»» apCustomReferencesValueLike |
body |
string |
false |
Filter by partial match of ap custom references value |
»» apCustomReferencesDataTypeLike |
body |
string |
false |
Filter by partial match of ap custom references data type |
»» ledgerTransactionGroupIdLike |
body |
string |
false |
Filter by partial match of ledger transaction group id |
»» accountingDocumentIdLike |
body |
string |
false |
Filter by partial match of accounting document id |
»» internalPostingStatusEqual |
body |
string |
false |
Filter by exact match of internal posting status |
»» internalPostingDocumentNumberLike |
body |
string |
false |
Filter by partial match of internal posting document number |
»» nlaEnrichmentStatusEqual |
body |
string |
false |
Filter by exact match of nla enrichment status |
»» nreEnrichmentStatusEqual |
body |
string |
false |
Filter by exact match of nre enrichment status |
»» apEnrichmentStatusEqual |
body |
string |
false |
Filter by exact match of ap enrichment status |
»» externalPostingStatusEqual |
body |
string |
false |
Filter by exact match of external posting status |
»» externalPostingDocumentNumberLike |
body |
string |
false |
Filter by partial match of external posting document number |
» pageable |
body |
false |
Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» apEnrichmentStatusEqual |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
»» createdByApplicationIn |
ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE |
»» externalPostingStatusEqual |
, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED |
»» internalPostingStatusEqual |
, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED |
»» ledgerTypeEqual |
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 |
»» nlaEnrichmentStatusEqual |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
»» nreEnrichmentStatusEqual |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
»» paymentTypeEqual |
CLEARING, N_A, PAYMENT |
»» postingTransactionTypeEqual |
POST, REVERSE |
»» postingTypeEqual |
ACCRUAL, CHARGE, DEPRECIATION, FX_REMEASUREMENT, INVOICE_POSTING, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
»» principalPositionTypeEqual |
LESSEE, LESSOR |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "createdByApplicationIn": [
17 "NLA"
18 ],
19 "applicationReferenceIdEqual": "string",
20 "documentCommentsLike": "string",
21 "nameLike": "string",
22 "principalPositionTypeEqual": "LESSEE",
23 "postingTransactionTypeEqual": "POST",
24 "postingTypeEqual": "PAYMENT",
25 "ledgerTypeEqual": "LIABILITY",
26 "paymentTypeEqual": "N_A",
27 "currencyIdEqual": 0,
28 "currencyDisplayIdLike": "string",
29 "accountingStandardIdEqual": 0,
30 "accountingStandardDisplayIdLike": "string",
31 "dateDocumentDateGreaterThanOrEqual": "2019-08-24T14:15:22Z",
32 "dateUserDocumentDateGreaterThanOrEqual": "2019-08-24",
33 "datePostingDateGreaterThanOrEqual": "2019-08-24",
34 "dateDocumentDateLessThanOrEqual": "2019-08-24T14:15:22Z",
35 "dateUserDocumentDateLessThanOrEqual": "2019-08-24",
36 "datePostingDateLessThanOrEqual": "2019-08-24",
37 "systemIdEqual": 0,
38 "companyIdEqual": 0,
39 "systemDisplayIdLike": "string",
40 "companyDisplayIdLike": "string",
41 "activationGroupIdEqual": 0,
42 "activationGroupDisplayIdLike": "string",
43 "nlaCustomReferencesKeyEqual": "string",
44 "nlaCustomReferencesValueLike": "string",
45 "nlaCustomReferencesDataTypeLike": "string",
46 "nreCustomReferencesKeyEqual": "string",
47 "nreCustomReferencesValueLike": "string",
48 "nreCustomReferencesDataTypeLike": "string",
49 "apCustomReferencesKeyEqual": "string",
50 "apCustomReferencesValueLike": "string",
51 "apCustomReferencesDataTypeLike": "string",
52 "ledgerTransactionGroupIdLike": "string",
53 "accountingDocumentIdLike": "string",
54 "internalPostingStatusEqual": "NA",
55 "internalPostingDocumentNumberLike": "string",
56 "nlaEnrichmentStatusEqual": "PENDING",
57 "nreEnrichmentStatusEqual": "PENDING",
58 "apEnrichmentStatusEqual": "PENDING",
59 "externalPostingStatusEqual": "NA",
60 "externalPostingDocumentNumberLike": "string"
61 },
62 "pageable": {
63 "page": 0,
64 "size": 1,
65 "sort": [
66 "string"
67 ]
68 }
69}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "requestUniqueId": "string",
22 "createdByApplication": "NLA",
23 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
24 "documentComments": "string",
25 "name": "string",
26 "principalPositionType": "LESSEE",
27 "postingTransactionType": "POST",
28 "postingType": "PAYMENT",
29 "ledgerType": "LIABILITY",
30 "paymentType": "N_A",
31 "parallelCurrencyEnabled": true,
32 "generateInvoiceInAp": true,
33 "generateVendorInvoice": true,
34 "calculateTax": true,
35 "taxCalculationType": "NET",
36 "currencyDetail": {
37 "currencyId": 0,
38 "currencyDisplayId": "string",
39 "currencyDefinitionType": "CONTRACT_CURRENCY",
40 "currencyType": "string"
41 },
42 "classificationInfo": {
43 "accountingStandard": {
44 "id": 0,
45 "displayId": "string"
46 },
47 "leaseClassificationType": "NON_LEASE"
48 },
49 "date": {
50 "documentDate": "2019-08-24T14:15:22Z",
51 "userDocumentDate": "2019-08-24",
52 "postingDate": "2019-08-24",
53 "transactionDate": "2019-08-24",
54 "translationDate": "2019-08-24",
55 "fiscalVariantId": 0,
56 "fiscalVariantDisplayId": "string",
57 "calendarType": "REGULAR_CALENDAR",
58 "fiscalYear": 0,
59 "fiscalPeriod": 0
60 },
61 "automaticReversal": {
62 "id": 0,
63 "postingDate": "2019-08-24",
64 "documentDate": "2019-08-24",
65 "reversalReason": {
66 "id": 0,
67 "displayId": "string"
68 }
69 },
70 "trace": {
71 "previousLedgerTransactionId": 0,
72 "nextLedgerTransactionId": 0,
73 "postExternalType": "SKIP"
74 },
75 "fosReferences": {
76 "id": 0,
77 "system": {
78 "id": 0,
79 "displayId": "string"
80 },
81 "company": {
82 "id": 0,
83 "displayId": "string"
84 },
85 "leaseArea": {
86 "id": 0,
87 "displayId": "string"
88 },
89 "leaseGroup": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "leaseDepartment": {
94 "id": 0,
95 "displayId": "string"
96 },
97 "businessUnit": {
98 "id": 0,
99 "displayId": "string"
100 },
101 "mainCostCenter": {
102 "id": 0,
103 "displayId": "string"
104 },
105 "internalAssetClass": {
106 "id": 0,
107 "displayId": "string"
108 },
109 "documentType": {
110 "id": 0,
111 "displayId": "string"
112 },
113 "depreciationArea": {
114 "id": 0,
115 "displayId": "string"
116 },
117 "reversalReason": {
118 "id": 0,
119 "displayId": "string"
120 },
121 "tradingPartner": {
122 "id": 0,
123 "displayId": "string"
124 },
125 "allocationNumber": {
126 "id": 0,
127 "displayId": "string"
128 },
129 "responsibleCostCenter": {
130 "id": 0,
131 "displayId": "string"
132 },
133 "workBreakdownStructure": {
134 "id": 0,
135 "displayId": "string"
136 },
137 "businessArea": {
138 "id": 0,
139 "displayId": "string"
140 },
141 "functionalArea": {
142 "id": 0,
143 "displayId": "string"
144 },
145 "plant": {
146 "id": 0,
147 "displayId": "string"
148 },
149 "internalOrder": {
150 "id": 0,
151 "displayId": "string"
152 },
153 "network": {
154 "id": 0,
155 "displayId": "string"
156 },
157 "paymentTerm": {
158 "id": 0,
159 "displayId": "string"
160 },
161 "paymentBlock": {
162 "id": 0,
163 "displayId": "string"
164 },
165 "paymentMethod": {
166 "id": 0,
167 "displayId": "string",
168 "type": "string"
169 },
170 "segment": {
171 "id": 0,
172 "displayId": "string"
173 },
174 "purchasingOrganization": {
175 "id": 0,
176 "displayId": "string"
177 },
178 "purchasingOrder": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "ledgerTransactionId": 0
183 },
184 "assetRegisterReferences": {
185 "id": 0,
186 "asset": {
187 "assetId": 0,
188 "assetDisplayId": "string",
189 "assetNumber": "string",
190 "subAssetNumber": "string"
191 },
192 "ledgerTransactionId": 0
193 },
194 "nlaReferences": {
195 "id": 0,
196 "contract": {
197 "id": 0,
198 "displayId": "string"
199 },
200 "leaseComponent": {
201 "id": 0,
202 "displayId": "string"
203 },
204 "activationGroup": {
205 "id": 0,
206 "displayId": "string"
207 },
208 "unit": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "contractExternalId": "string",
213 "journalId": 0,
214 "activationGroupRevisionId": 0,
215 "ledgerTransactionId": 0
216 },
217 "nlaCustomReferences": [
218 {
219 "key": "string",
220 "dataType": "STRING",
221 "value": 0
222 }
223 ],
224 "nreReferences": {
225 "id": 0,
226 "premise": {
227 "id": 0,
228 "displayId": "string"
229 },
230 "location": {
231 "id": 0,
232 "displayId": "string"
233 },
234 "lease": {
235 "id": 0,
236 "displayId": "string"
237 },
238 "ledgerTransactionId": 0
239 },
240 "nreCustomReferences": [
241 {
242 "key": "string",
243 "dataType": "STRING",
244 "value": 0
245 }
246 ],
247 "apReferences": {
248 "id": 0,
249 "invoice": {
250 "id": 0,
251 "displayId": "string",
252 "name": "string"
253 },
254 "vendor": {
255 "id": 0,
256 "displayId": "string",
257 "name": "string"
258 },
259 "ledgerTransactionId": 0
260 },
261 "apCustomReferences": [
262 {
263 "key": "string",
264 "dataType": "STRING",
265 "value": 0
266 }
267 ],
268 "entries": [
269 {
270 "id": 0,
271 "entryType": "D",
272 "amount": 0,
273 "unroundedAmount": 0,
274 "deltaAdjustment": 0,
275 "itemText": "string",
276 "itemNoAcc": 0,
277 "generalLedger": {
278 "id": 0,
279 "displayId": "string",
280 "generalLedgerAccountName": "string",
281 "generalLedgerAccountCode": "string",
282 "openItemManagement": true,
283 "accountCategory": "BALANCESHEET",
284 "shortName": "string",
285 "longName": "string"
286 },
287 "additionalCurrencyEntries": [
288 {
289 "id": 0,
290 "amount": 0,
291 "unroundedAmount": 0,
292 "deltaAdjustment": 0,
293 "itemNoAcc": 0,
294 "currencyDetail": {
295 "currencyId": 0,
296 "currencyDisplayId": "string",
297 "currencyDefinitionType": "CONTRACT_CURRENCY",
298 "currencyType": "string"
299 },
300 "currencyConversionDetail": {
301 "rate": 0,
302 "conversionDate": "2019-08-24",
303 "translationDateType": "DOCUMENT_DATE",
304 "sourceCurrencyType": "CONTRACT_CURRENCY",
305 "sourceCurrency": {
306 "id": 0,
307 "displayId": "string"
308 },
309 "depreciationArea": {
310 "id": 0,
311 "displayId": "string"
312 }
313 },
314 "ledgerEntryId": 0,
315 "ledgerEntryTaxId": 0
316 }
317 ],
318 "tag": "string",
319 "costCenter": {
320 "id": 0,
321 "displayId": "string",
322 "mainCostCenter": true,
323 "allocationPercentage": 0.1
324 },
325 "profitCenter": {
326 "id": 0,
327 "displayId": "string"
328 },
329 "partner": {
330 "id": 0,
331 "displayId": "string"
332 },
333 "transactionType": "string",
334 "nlaCustomReferences": [
335 {
336 "key": "string",
337 "dataType": "STRING",
338 "value": 0
339 }
340 ],
341 "nreCustomReferences": [
342 {
343 "key": "string",
344 "dataType": "STRING",
345 "value": 0
346 }
347 ],
348 "apCustomReferences": [
349 {
350 "key": "string",
351 "dataType": "STRING",
352 "value": 0
353 }
354 ],
355 "taxEntries": [
356 {
357 "id": 0,
358 "entryType": "D",
359 "amount": 0,
360 "unroundedAmount": 0,
361 "deltaAdjustment": 0,
362 "itemText": "string",
363 "itemNoAcc": 0,
364 "generalLedger": {
365 "id": 0,
366 "displayId": "string",
367 "generalLedgerAccountName": "string",
368 "generalLedgerAccountCode": "string",
369 "openItemManagement": true,
370 "accountCategory": "BALANCESHEET",
371 "shortName": "string",
372 "longName": "string"
373 },
374 "additionalCurrencyEntries": [
375 {
376 "id": 0,
377 "amount": 0,
378 "unroundedAmount": 0,
379 "deltaAdjustment": 0,
380 "itemNoAcc": 0,
381 "currencyDetail": {
382 "currencyId": 0,
383 "currencyDisplayId": "string",
384 "currencyDefinitionType": "CONTRACT_CURRENCY",
385 "currencyType": "string"
386 },
387 "currencyConversionDetail": {
388 "rate": 0,
389 "conversionDate": "2019-08-24",
390 "translationDateType": "DOCUMENT_DATE",
391 "sourceCurrencyType": "CONTRACT_CURRENCY",
392 "sourceCurrency": {},
393 "depreciationArea": {}
394 },
395 "ledgerEntryId": 0,
396 "ledgerEntryTaxId": 0
397 }
398 ],
399 "taxRate": 0,
400 "taxBaseAmount": 0,
401 "totalTaxDocumentAmount": 0,
402 "taxExempt": 0,
403 "taxExemptionPercentage": 0,
404 "taxAffected": 0,
405 "taxAccount": "string",
406 "accountingKey": "string",
407 "conditionKey": "string",
408 "taxCode": {
409 "id": 0,
410 "displayId": "string"
411 },
412 "taxJurisdiction": {
413 "id": 0,
414 "displayId": "string"
415 },
416 "taxDetermination": {
417 "id": 0,
418 "displayId": "string"
419 },
420 "financialTermId": 0,
421 "ledgerEntryId": 0
422 }
423 ],
424 "ledgerTransactionId": 0
425 }
426 ],
427 "notes": [
428 {
429 "id": 0,
430 "note": "string"
431 }
432 ],
433 "attachments": [
434 {
435 "id": 0,
436 "fileName": "string",
437 "fileStorageId": "string",
438 "docStoreId": 0
439 }
440 ],
441 "journalVoucherWorkflowHistory": [
442 {
443 "id": 0,
444 "eventType": "SEND_TO_APPROVAL",
445 "eventDate": "2019-08-24T14:15:22Z",
446 "user": "string"
447 }
448 ],
449 "ledgerTransactionGroupId": 0,
450 "accountingDocumentId": 0,
451 "internalPostingStatus": {
452 "documentNumber": "string",
453 "status": "NA",
454 "postingMessage": "string"
455 },
456 "nlaEnrichmentState": {
457 "id": 0,
458 "status": "PENDING",
459 "message": "string",
460 "history": [
461 {
462 "requestingUser": "string",
463 "enrichmentRequestId": 0,
464 "requestedAt": "2019-08-24T14:15:22Z",
465 "enrichedAt": "2019-08-24T14:15:22Z",
466 "requestStatus": "SENT",
467 "applicationStatus": "PENDING",
468 "message": "string"
469 }
470 ]
471 },
472 "nreEnrichmentState": {
473 "id": 0,
474 "status": "PENDING",
475 "message": "string",
476 "history": [
477 {
478 "requestingUser": "string",
479 "enrichmentRequestId": 0,
480 "requestedAt": "2019-08-24T14:15:22Z",
481 "enrichedAt": "2019-08-24T14:15:22Z",
482 "requestStatus": "SENT",
483 "applicationStatus": "PENDING",
484 "message": "string"
485 }
486 ]
487 },
488 "apEnrichmentState": {
489 "id": 0,
490 "status": "PENDING",
491 "message": "string",
492 "history": [
493 {
494 "requestingUser": "string",
495 "enrichmentRequestId": 0,
496 "requestedAt": "2019-08-24T14:15:22Z",
497 "enrichedAt": "2019-08-24T14:15:22Z",
498 "requestStatus": "SENT",
499 "applicationStatus": "PENDING",
500 "message": "string"
501 }
502 ]
503 },
504 "externalPostingStatus": {
505 "documentNumber": "string",
506 "objType": "string",
507 "objKey": "string",
508 "objSys": "string",
509 "username": "string",
510 "status": "NA",
511 "postingMessage": "string",
512 "taskId": 0
513 }
514 }
515 ],
516 "number": 0,
517 "sort": {
518 "unsorted": true,
519 "sorted": true,
520 "empty": true
521 },
522 "first": true,
523 "last": true,
524 "empty": true
525}
Ledger Transaction - Fetch Custom References¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/custom-references
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "erpSystem": {
3 "id": 0,
4 "displayId": "string"
5 },
6 "principalPositionType": "LESSEE"
7}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "table": "LEDGER_TRANSACTION",
4 "fields": [
5 {
6 "field": "string",
7 "captionKey": "string",
8 "caption": "string",
9 "customReference": true
10 }
11 ]
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data structure representing the mapping of general ledger tables and fields, facilitating the alignment of ledger entries, transactions, accounts, and financial records for accurate reporting and analysis.] |
|
» table |
string |
false |
none |
Specifies the name of the general ledger table associated with the ledger entry, transaction, account, or financial record. |
» fields |
false |
none |
List of fields items |
|
»» field |
string |
false |
none |
Represents a specific attribute related to ledger entries, transactions, accounts, or financial records within the General Ledger API. |
»» captionKey |
string |
false |
none |
The captionKey is a unique string identifier used to reference specific captions associated with ledger entries, transactions, accounts, and financial records within the General Ledger API. |
»» caption |
string |
false |
none |
Descriptive text associated with a ledger entry, providing context for transactions within financial records and accounts. |
»» customReference |
boolean |
false |
none |
Boolean flag indicating customReference status |
Enumerated Values
Attribute |
Value |
|---|---|
table |
EMPTY_FIELD, LEDGER_ENTRY, LEDGER_ENTRY_ADDITIONAL_CURRENCIES, LEDGER_ENTRY_APPLICATION_REFERENCE_AP, LEDGER_ENTRY_APPLICATION_REFERENCE_NLA, LEDGER_ENTRY_APPLICATION_REFERENCE_NRE, LEDGER_ENTRY_TAX, LEDGER_TRANSACTION, LEDGER_TRANSACTION_APPLICATION_REFERENCE_AP, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NLA, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NRE, USER_INPUT |
Ledger Transaction - Fetch Latest Ledger Transaction By Application Reference IDs¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/application-references
📋 Description: Creates application references for ledger transactions within the General Ledger, enabling the association of specific transactions with relevant financial records and accounts.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[string] |
true |
Request body containing the application reference data for ledger transactions, including relevant identifiers and metadata to ensure accurate financial recordkeeping. |
Body Parameters
1[
2 "string"
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "requestUniqueId": "string",
5 "createdByApplication": "NLA",
6 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
7 "documentComments": "string",
8 "name": "string",
9 "principalPositionType": "LESSEE",
10 "postingTransactionType": "POST",
11 "postingType": "PAYMENT",
12 "ledgerType": "LIABILITY",
13 "paymentType": "N_A",
14 "parallelCurrencyEnabled": true,
15 "generateInvoiceInAp": true,
16 "generateVendorInvoice": true,
17 "calculateTax": true,
18 "taxCalculationType": "NET",
19 "currencyDetail": {
20 "currencyId": 0,
21 "currencyDisplayId": "string",
22 "currencyDefinitionType": "CONTRACT_CURRENCY",
23 "currencyType": "string"
24 },
25 "classificationInfo": {
26 "accountingStandard": {
27 "id": 0,
28 "displayId": "string"
29 },
30 "leaseClassificationType": "NON_LEASE"
31 },
32 "date": {
33 "documentDate": "2019-08-24T14:15:22Z",
34 "userDocumentDate": "2019-08-24",
35 "postingDate": "2019-08-24",
36 "transactionDate": "2019-08-24",
37 "translationDate": "2019-08-24",
38 "fiscalVariantId": 0,
39 "fiscalVariantDisplayId": "string",
40 "calendarType": "REGULAR_CALENDAR",
41 "fiscalYear": 0,
42 "fiscalPeriod": 0
43 },
44 "automaticReversal": {
45 "id": 0,
46 "postingDate": "2019-08-24",
47 "documentDate": "2019-08-24",
48 "reversalReason": {
49 "id": 0,
50 "displayId": "string"
51 }
52 },
53 "trace": {
54 "previousLedgerTransactionId": 0,
55 "nextLedgerTransactionId": 0,
56 "postExternalType": "SKIP"
57 },
58 "fosReferences": {
59 "id": 0,
60 "system": {
61 "id": 0,
62 "displayId": "string"
63 },
64 "company": {
65 "id": 0,
66 "displayId": "string"
67 },
68 "leaseArea": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "leaseGroup": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "leaseDepartment": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "businessUnit": {
81 "id": 0,
82 "displayId": "string"
83 },
84 "mainCostCenter": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "internalAssetClass": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "documentType": {
93 "id": 0,
94 "displayId": "string"
95 },
96 "depreciationArea": {
97 "id": 0,
98 "displayId": "string"
99 },
100 "reversalReason": {
101 "id": 0,
102 "displayId": "string"
103 },
104 "tradingPartner": {
105 "id": 0,
106 "displayId": "string"
107 },
108 "allocationNumber": {
109 "id": 0,
110 "displayId": "string"
111 },
112 "responsibleCostCenter": {
113 "id": 0,
114 "displayId": "string"
115 },
116 "workBreakdownStructure": {
117 "id": 0,
118 "displayId": "string"
119 },
120 "businessArea": {
121 "id": 0,
122 "displayId": "string"
123 },
124 "functionalArea": {
125 "id": 0,
126 "displayId": "string"
127 },
128 "plant": {
129 "id": 0,
130 "displayId": "string"
131 },
132 "internalOrder": {
133 "id": 0,
134 "displayId": "string"
135 },
136 "network": {
137 "id": 0,
138 "displayId": "string"
139 },
140 "paymentTerm": {
141 "id": 0,
142 "displayId": "string"
143 },
144 "paymentBlock": {
145 "id": 0,
146 "displayId": "string"
147 },
148 "paymentMethod": {
149 "id": 0,
150 "displayId": "string",
151 "type": "string"
152 },
153 "segment": {
154 "id": 0,
155 "displayId": "string"
156 },
157 "purchasingOrganization": {
158 "id": 0,
159 "displayId": "string"
160 },
161 "purchasingOrder": {
162 "id": 0,
163 "displayId": "string"
164 },
165 "ledgerTransactionId": 0
166 },
167 "assetRegisterReferences": {
168 "id": 0,
169 "asset": {
170 "assetId": 0,
171 "assetDisplayId": "string",
172 "assetNumber": "string",
173 "subAssetNumber": "string"
174 },
175 "ledgerTransactionId": 0
176 },
177 "nlaReferences": {
178 "id": 0,
179 "contract": {
180 "id": 0,
181 "displayId": "string"
182 },
183 "leaseComponent": {
184 "id": 0,
185 "displayId": "string"
186 },
187 "activationGroup": {
188 "id": 0,
189 "displayId": "string"
190 },
191 "unit": {
192 "id": 0,
193 "displayId": "string"
194 },
195 "contractExternalId": "string",
196 "journalId": 0,
197 "activationGroupRevisionId": 0,
198 "ledgerTransactionId": 0
199 },
200 "nlaCustomReferences": [
201 {
202 "key": "string",
203 "dataType": "STRING",
204 "value": 0
205 }
206 ],
207 "nreReferences": {
208 "id": 0,
209 "premise": {
210 "id": 0,
211 "displayId": "string"
212 },
213 "location": {
214 "id": 0,
215 "displayId": "string"
216 },
217 "lease": {
218 "id": 0,
219 "displayId": "string"
220 },
221 "ledgerTransactionId": 0
222 },
223 "nreCustomReferences": [
224 {
225 "key": "string",
226 "dataType": "STRING",
227 "value": 0
228 }
229 ],
230 "apReferences": {
231 "id": 0,
232 "invoice": {
233 "id": 0,
234 "displayId": "string",
235 "name": "string"
236 },
237 "vendor": {
238 "id": 0,
239 "displayId": "string",
240 "name": "string"
241 },
242 "ledgerTransactionId": 0
243 },
244 "apCustomReferences": [
245 {
246 "key": "string",
247 "dataType": "STRING",
248 "value": 0
249 }
250 ],
251 "entries": [
252 {
253 "id": 0,
254 "entryType": "D",
255 "amount": 0,
256 "unroundedAmount": 0,
257 "deltaAdjustment": 0,
258 "itemText": "string",
259 "itemNoAcc": 0,
260 "generalLedger": {
261 "id": 0,
262 "displayId": "string",
263 "generalLedgerAccountName": "string",
264 "generalLedgerAccountCode": "string",
265 "openItemManagement": true,
266 "accountCategory": "BALANCESHEET",
267 "shortName": "string",
268 "longName": "string"
269 },
270 "additionalCurrencyEntries": [
271 {
272 "id": 0,
273 "amount": 0,
274 "unroundedAmount": 0,
275 "deltaAdjustment": 0,
276 "itemNoAcc": 0,
277 "currencyDetail": {
278 "currencyId": 0,
279 "currencyDisplayId": "string",
280 "currencyDefinitionType": "CONTRACT_CURRENCY",
281 "currencyType": "string"
282 },
283 "currencyConversionDetail": {
284 "rate": 0,
285 "conversionDate": "2019-08-24",
286 "translationDateType": "DOCUMENT_DATE",
287 "sourceCurrencyType": "CONTRACT_CURRENCY",
288 "sourceCurrency": {
289 "id": 0,
290 "displayId": "string"
291 },
292 "depreciationArea": {
293 "id": 0,
294 "displayId": "string"
295 }
296 },
297 "ledgerEntryId": 0,
298 "ledgerEntryTaxId": 0
299 }
300 ],
301 "tag": "string",
302 "costCenter": {
303 "id": 0,
304 "displayId": "string",
305 "mainCostCenter": true,
306 "allocationPercentage": 0.1
307 },
308 "profitCenter": {
309 "id": 0,
310 "displayId": "string"
311 },
312 "partner": {
313 "id": 0,
314 "displayId": "string"
315 },
316 "transactionType": "string",
317 "nlaCustomReferences": [
318 {
319 "key": "string",
320 "dataType": "STRING",
321 "value": 0
322 }
323 ],
324 "nreCustomReferences": [
325 {
326 "key": "string",
327 "dataType": "STRING",
328 "value": 0
329 }
330 ],
331 "apCustomReferences": [
332 {
333 "key": "string",
334 "dataType": "STRING",
335 "value": 0
336 }
337 ],
338 "taxEntries": [
339 {
340 "id": 0,
341 "entryType": "D",
342 "amount": 0,
343 "unroundedAmount": 0,
344 "deltaAdjustment": 0,
345 "itemText": "string",
346 "itemNoAcc": 0,
347 "generalLedger": {
348 "id": 0,
349 "displayId": "string",
350 "generalLedgerAccountName": "string",
351 "generalLedgerAccountCode": "string",
352 "openItemManagement": true,
353 "accountCategory": "BALANCESHEET",
354 "shortName": "string",
355 "longName": "string"
356 },
357 "additionalCurrencyEntries": [
358 {
359 "id": 0,
360 "amount": 0,
361 "unroundedAmount": 0,
362 "deltaAdjustment": 0,
363 "itemNoAcc": 0,
364 "currencyDetail": {
365 "currencyId": 0,
366 "currencyDisplayId": "string",
367 "currencyDefinitionType": "CONTRACT_CURRENCY",
368 "currencyType": "string"
369 },
370 "currencyConversionDetail": {
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 },
384 "ledgerEntryId": 0,
385 "ledgerEntryTaxId": 0
386 }
387 ],
388 "taxRate": 0,
389 "taxBaseAmount": 0,
390 "totalTaxDocumentAmount": 0,
391 "taxExempt": 0,
392 "taxExemptionPercentage": 0,
393 "taxAffected": 0,
394 "taxAccount": "string",
395 "accountingKey": "string",
396 "conditionKey": "string",
397 "taxCode": {
398 "id": 0,
399 "displayId": "string"
400 },
401 "taxJurisdiction": {
402 "id": 0,
403 "displayId": "string"
404 },
405 "taxDetermination": {
406 "id": 0,
407 "displayId": "string"
408 },
409 "financialTermId": 0,
410 "ledgerEntryId": 0
411 }
412 ],
413 "ledgerTransactionId": 0
414 }
415 ],
416 "notes": [
417 {
418 "id": 0,
419 "note": "string"
420 }
421 ],
422 "attachments": [
423 {
424 "id": 0,
425 "fileName": "string",
426 "fileStorageId": "string",
427 "docStoreId": 0
428 }
429 ],
430 "journalVoucherWorkflowHistory": [
431 {
432 "id": 0,
433 "eventType": "SEND_TO_APPROVAL",
434 "eventDate": "2019-08-24T14:15:22Z",
435 "user": "string"
436 }
437 ],
438 "ledgerTransactionGroupId": 0,
439 "accountingDocumentId": 0,
440 "internalPostingStatus": {
441 "documentNumber": "string",
442 "status": "NA",
443 "postingMessage": "string"
444 },
445 "nlaEnrichmentState": {
446 "id": 0,
447 "status": "PENDING",
448 "message": "string",
449 "history": [
450 {
451 "requestingUser": "string",
452 "enrichmentRequestId": 0,
453 "requestedAt": "2019-08-24T14:15:22Z",
454 "enrichedAt": "2019-08-24T14:15:22Z",
455 "requestStatus": "SENT",
456 "applicationStatus": "PENDING",
457 "message": "string"
458 }
459 ]
460 },
461 "nreEnrichmentState": {
462 "id": 0,
463 "status": "PENDING",
464 "message": "string",
465 "history": [
466 {
467 "requestingUser": "string",
468 "enrichmentRequestId": 0,
469 "requestedAt": "2019-08-24T14:15:22Z",
470 "enrichedAt": "2019-08-24T14:15:22Z",
471 "requestStatus": "SENT",
472 "applicationStatus": "PENDING",
473 "message": "string"
474 }
475 ]
476 },
477 "apEnrichmentState": {
478 "id": 0,
479 "status": "PENDING",
480 "message": "string",
481 "history": [
482 {
483 "requestingUser": "string",
484 "enrichmentRequestId": 0,
485 "requestedAt": "2019-08-24T14:15:22Z",
486 "enrichedAt": "2019-08-24T14:15:22Z",
487 "requestStatus": "SENT",
488 "applicationStatus": "PENDING",
489 "message": "string"
490 }
491 ]
492 },
493 "externalPostingStatus": {
494 "documentNumber": "string",
495 "objType": "string",
496 "objKey": "string",
497 "objSys": "string",
498 "username": "string",
499 "status": "NA",
500 "postingMessage": "string",
501 "taskId": 0
502 }
503 }
504]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data structure representing detailed information about a ledger transaction, including associated accounts and financial records, essential for accurate ledger entry management and reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» requestUniqueId |
string |
false |
none |
Unique identifier for the request unique |
» createdByApplication |
string |
false |
none |
Identifies the application that initiated the ledger entry, ensuring traceability of financial records and transactions within the General Ledger. |
» applicationReferenceId |
string |
true |
none |
Any application MUST send a unique reference in order to ignore duplicate postings. |
» documentComments |
string |
false |
none |
Comments associated with the ledger entry, providing additional context or notes related to the transaction within the financial record. |
» 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 |
false |
none |
Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management. |
|
»» currencyId |
integer(int64) |
false |
none |
Unique identifier for the currency |
»» currencyDisplayId |
string |
false |
none |
Unique identifier for the currency display |
»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»» currencyType |
string |
false |
none |
Type of the currency |
» classificationInfo |
false |
none |
Data structure representing classification details for ledger entries, encompassing transaction types, associated accounts, and relevant financial records to facilitate accurate financial reporting and analysis. |
|
»» accountingStandard |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»» leaseClassificationType |
string |
false |
none |
Type of the lease classification |
» date |
false |
none |
Data structure representing the date associated with a ledger transaction, crucial for maintaining accurate financial records and facilitating effective account management within the General Ledger. |
|
»» documentDate |
string(date-time) |
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 |
»» translationDate |
string(date) |
false |
none |
Date of the translation |
»» fiscalVariantId |
integer(int64) |
false |
none |
Unique identifier for the fiscal variant |
»» fiscalVariantDisplayId |
string |
false |
none |
Unique identifier for the fiscal variant display |
»» calendarType |
string |
false |
none |
Type of the calendar |
»» fiscalYear |
integer(int32) |
false |
none |
Numeric value representing fiscalYear |
»» fiscalPeriod |
integer(int32) |
false |
none |
Numeric value representing fiscalPeriod |
» automaticReversal |
false |
none |
Data transfer object representing an automatic reversal of journal vouchers within the General Ledger, facilitating accurate financial record management and ensuring the integrity of ledger entries and transactions. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» postingDate |
string(date) |
false |
none |
Date of the posting |
»» documentDate |
string(date) |
false |
none |
Date of the document |
»» reversalReason |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
» trace |
false |
none |
Data transfer object representing a detailed trace of ledger transactions, capturing essential information related to each financial record, including associated accounts and ledger entries. |
|
»» previousLedgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the previous ledger transaction |
»» nextLedgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the next ledger transaction |
»» postExternalType |
string |
false |
none |
Type of the post external |
» fosReferences |
false |
none |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» system |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» company |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» leaseArea |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» leaseGroup |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» leaseDepartment |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» businessUnit |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» mainCostCenter |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» internalAssetClass |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» documentType |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» depreciationArea |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» reversalReason |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» tradingPartner |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» allocationNumber |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» responsibleCostCenter |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» workBreakdownStructure |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» businessArea |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» functionalArea |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» plant |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» internalOrder |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» network |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» paymentTerm |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» paymentBlock |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» paymentMethod |
false |
none |
Data transfer object representing the unique identifier for a payment method used in ledger entries and financial transactions, facilitating accurate tracking and management of accounts and financial records. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» type |
string |
true |
none |
Type of the resource |
»» segment |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» purchasingOrganization |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» purchasingOrder |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» assetRegisterReferences |
false |
none |
Data transfer object representing the references associated with ledger transactions in the asset register, facilitating accurate tracking and management of financial records within the general ledger. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» asset |
false |
none |
Data structure representing detailed information about an asset within the General Ledger, including its associated ledger entries, transactions, and account details, essential for accurate financial record management. |
|
»»» assetId |
integer(int64) |
false |
none |
Unique identifier for the asset |
»»» assetDisplayId |
string |
false |
none |
Unique identifier for the asset display |
»»» assetNumber |
string |
false |
none |
Unique identifier for the asset associated with ledger entries, transactions, and financial records within the General Ledger. |
»»» subAssetNumber |
string |
false |
none |
Unique identifier for a sub-asset within the General Ledger, used to track and manage financial records related to ledger entries and transactions. |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» nlaReferences |
false |
none |
Data transfer object representing references associated with ledger transactions, facilitating the management of financial records and ensuring accurate accounting entries within the General Ledger. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» contract |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» leaseComponent |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» activationGroup |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» unit |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» contractExternalId |
string |
false |
none |
Unique identifier for the contract external |
»» journalId |
integer(int64) |
false |
none |
Unique identifier for the journal |
»» activationGroupRevisionId |
integer(int64) |
false |
none |
Unique identifier for the activation group revision |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» nlaCustomReferences |
[oneOf] |
false |
none |
List of nlaCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
|
»»»» key |
string |
false |
none |
Unique identifier for the ledger entry, facilitating accurate tracking and management of financial records within the General Ledger. |
»»»» dataType |
string |
false |
none |
Type of the data |
»»»» value |
object |
false |
none |
Object containing value details |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
string(date) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
number(double) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
integer(int32) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
integer(int64) |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a custom application reference within the General Ledger domain, encapsulating essential details related to ledger entries, transactions, accounts, and financial records. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» value |
string |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» nreReferences |
false |
none |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records within the General Ledger domain. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» premise |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» location |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» lease |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» nreCustomReferences |
[oneOf] |
false |
none |
List of nreCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» apReferences |
false |
none |
Data transfer object representing references for ledger transactions, encapsulating essential details related to ledger entries, accounts, and financial records for accurate transaction tracking and reporting within the General Ledger domain. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» invoice |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»»» name |
string |
false |
none |
none |
»» vendor |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»»» name |
string |
false |
none |
none |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» apCustomReferences |
[oneOf] |
false |
none |
List of apCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» entries |
false |
none |
List of entries items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» entryType |
string |
true |
none |
Type of the entry |
»» amount |
number |
true |
none |
Amount value |
»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»» itemText |
string |
false |
none |
Descriptive text associated with a ledger entry, providing context for the transaction within the financial record. |
»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»» generalLedger |
true |
none |
Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»»» openItemManagement |
boolean |
true |
none |
Boolean flag indicating openItemManagement status |
»»» accountCategory |
string |
true |
none |
Category of the account |
»»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»»» longName |
string |
false |
none |
Name of the long |
»» additionalCurrencyEntries |
false |
none |
List of additionalCurrencyEntries items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» amount |
number |
false |
none |
Amount value |
»»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»»» currencyDetail |
false |
none |
Data transfer object representing detailed information about currency used in ledger entries, transactions, and accounts within the General Ledger, facilitating accurate financial record management. |
|
»»» currencyConversionDetail |
false |
none |
Data transfer object representing the details of currency conversion for ledger entries, facilitating accurate transaction recording and financial reporting within accounts. |
|
»»»» rate |
number |
false |
none |
Rate value |
»»»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»»»» translationDateType |
string |
false |
none |
Type of the translation date |
»»»» sourceCurrencyType |
string |
false |
none |
Type of the source currency |
»»»» sourceCurrency |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»»» depreciationArea |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» ledgerEntryId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry |
»»» ledgerEntryTaxId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry tax |
»» tag |
string |
false |
none |
Tag is a string field used to categorize and identify ledger entries within financial records, facilitating efficient transaction tracking and account management. |
»» costCenter |
false |
none |
Data structure representing the allocation of costs to specific cost centers within the General Ledger, facilitating accurate tracking and reporting of financial transactions and ledger entries. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» mainCostCenter |
boolean |
false |
none |
Boolean flag indicating mainCostCenter status |
»»» allocationPercentage |
number(double) |
false |
none |
Percentage of allocation |
»» profitCenter |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» partner |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»» transactionType |
string |
false |
none |
Type of the transaction |
»» nlaCustomReferences |
[oneOf] |
false |
none |
List of nlaCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» nreCustomReferences |
[oneOf] |
false |
none |
List of nreCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» apCustomReferences |
[oneOf] |
false |
none |
List of apCustomReferences items |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
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. |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» taxEntries |
false |
none |
List of taxEntries items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» entryType |
string |
true |
none |
Type of the entry |
»»» amount |
number |
true |
none |
Amount value |
»»» unroundedAmount |
number |
false |
none |
Amount of unrounded |
»»» deltaAdjustment |
number |
false |
none |
Value for deltaAdjustment field |
»»» itemText |
string |
false |
none |
Descriptive text associated with a ledger entry, providing context for the transaction within the financial record. |
»»» itemNoAcc |
integer(int32) |
false |
none |
Numeric value representing itemNoAcc |
»»» generalLedger |
true |
none |
Data transfer object representing detailed information about ledger entries, including associated transactions and accounts, to facilitate accurate financial record management within the General Ledger domain. |
|
»»» additionalCurrencyEntries |
false |
none |
List of additionalCurrencyEntries items |
|
»»» taxRate |
number |
false |
none |
Rate of tax |
»»» taxBaseAmount |
number |
false |
none |
Amount of tax base |
»»» totalTaxDocumentAmount |
number |
false |
none |
Amount of total tax document |
»»» taxExempt |
number |
false |
none |
Value for taxExempt field |
»»» taxExemptionPercentage |
number |
false |
none |
Percentage of tax exemption |
»»» taxAffected |
number |
false |
none |
Value for taxAffected field |
»»» taxAccount |
string |
false |
none |
Number of ledger entry items |
»»» accountingKey |
string |
false |
none |
Unique identifier for the accounting entry associated with a ledger transaction, facilitating accurate financial record management. |
»»» conditionKey |
string |
false |
none |
Represents the specific condition associated with a ledger entry, facilitating accurate tracking and categorization of financial transactions within the general ledger. |
»»» taxCode |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» taxJurisdiction |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» taxDetermination |
false |
none |
Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records. |
|
»»» financialTermId |
integer(int64) |
false |
none |
Unique identifier for the financial term |
»»» ledgerEntryId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry |
»» ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
» notes |
false |
none |
List of notes items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» note |
string |
false |
none |
Textual annotation associated with a ledger entry, providing additional context for the transaction within the financial record. |
» attachments |
false |
none |
List of attachments items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fileName |
string |
false |
none |
Name of the file |
»» fileStorageId |
string |
false |
none |
Unique identifier for the file storage |
»» docStoreId |
integer(int64) |
false |
none |
Unique identifier for the doc store |
» journalVoucherWorkflowHistory |
false |
none |
List of journalVoucherWorkflowHistory items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» eventType |
string |
false |
none |
Type of the event |
»» eventDate |
string(date-time) |
false |
none |
Date of the event |
»» user |
string |
false |
none |
User information related to accounting |
» ledgerTransactionGroupId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction group |
» accountingDocumentId |
integer(int64) |
false |
none |
Unique identifier for the accounting document |
» internalPostingStatus |
false |
none |
Data transfer object representing the status of internal postings within the General Ledger, encompassing ledger entries, transactions, and associated financial records to ensure accurate account management. |
|
»» documentNumber |
string |
false |
none |
Unique identifier for the financial record associated with a ledger entry or transaction within the General Ledger. |
»» status |
string |
false |
none |
Status of the resource |
»» postingMessage |
string |
false |
none |
Descriptive message associated with the posting status of a ledger entry, providing context for the transaction within the financial record. |
» nlaEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» status |
string |
false |
none |
Status of the resource |
»» message |
string |
false |
none |
Textual representation of the message associated with a ledger entry, providing context for the transaction or financial record. |
»» history |
false |
none |
List of history items |
|
»»» requestingUser |
string |
false |
none |
User information related to accounting |
»»» enrichmentRequestId |
integer(int64) |
false |
none |
Unique identifier for the enrichment request |
»»» requestedAt |
string(date-time) |
false |
none |
Timestamp indicating when the enrichment request was initiated, relevant for tracking ledger entries and financial transactions. |
»»» enrichedAt |
string(date-time) |
false |
none |
Timestamp indicating when the ledger entry was enriched, providing a record of the transaction’s enhancement within the financial context. |
»»» requestStatus |
string |
false |
none |
Status of the request |
»»» applicationStatus |
string |
false |
none |
Status of the application |
»»» message |
string |
false |
none |
Textual representation of the message associated with a ledger entry, providing context for the transaction within the financial record. |
» nreEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
» apEnrichmentState |
false |
none |
Data transfer object representing the state of application enrichment for ledger entries, transactions, and accounts, facilitating the management and tracking of financial records within the General Ledger domain. |
|
» externalPostingStatus |
false |
none |
Data structure representing the status of external postings within the General Ledger, encompassing ledger entries, transactions, accounts, and financial records to ensure accurate tracking and reporting of financial activities. |
|
»» documentNumber |
string |
false |
none |
Unique identifier for the financial document associated with a ledger entry, facilitating accurate tracking of transactions and account records. |
»» objType |
string |
false |
none |
Type of the obj |
»» objKey |
string |
false |
none |
Unique identifier for the external posting status associated with ledger entries and financial records within the General Ledger. |
»» objSys |
string |
false |
none |
Represents the system-generated status of an external posting related to ledger entries, transactions, accounts, and financial records. |
»» username |
string |
false |
none |
Human-readable name of the ledger entry |
»» status |
string |
false |
none |
Status of the resource |
»» postingMessage |
string |
false |
none |
Textual representation of the posting message associated with a ledger entry, providing context for the transaction within financial records. |
»» taskId |
integer(int64) |
false |
none |
Unique identifier for the task |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
applicationStatus |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
createdByApplication |
ACCOUNT_PAYABLE, ACCOUNT_RECEIVABLE, GENERAL_LEDGER, NLA, NRE, REPAIR_MAINTENANCE |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
dataType |
BIG_DECIMAL, BOOLEAN, DATE, DATETIME, DOUBLE, INTEGER, LONG, STRING |
entryType |
C, D |
eventType |
APPROVED, ARCHIVED, REWORK, SEND_TO_APPROVAL |
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 |
postExternalType |
POST, SKIP |
postingTransactionType |
POST, REVERSE |
postingType |
ACCRUAL, CHARGE, DEPRECIATION, FX_REMEASUREMENT, INVOICE_POSTING, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
principalPositionType |
LESSEE, LESSOR |
requestStatus |
FAILED, SENT |
sourceCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A |
status |
, ARCHIVED, DONE, ENRICHED, ENRICHING, FAILED, OPEN, PENDING, PROCESSING, SCHEDULED, SKIPPED |
taxCalculationType |
NET |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Ledger Transaction - Delete Ledger Transactions By Application Reference IDs¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/application-references/{transactionType}
📋 Description: Creates new application references for ledger transactions of a specified type, facilitating accurate financial record management within the general ledger.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transactionType |
path |
string |
true |
Type of the transaction |
body |
body |
array[string] |
true |
Request body containing the financial record details for ledger transactions, including necessary application references and associated account information based on the specified transaction type. |
Body Parameters
1[
2 "string"
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Ledger Transaction - Delete Ledger Transactions By Application Reference ID¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/application-reference/{transactionType}/{applicationReferenceId}
📋 Description: Creates a new ledger transaction entry in the General Ledger by associating it with a specified transaction type and application reference ID, ensuring accurate financial record management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transactionType |
path |
string |
true |
Type of the transaction |
applicationReferenceId |
path |
string |
true |
Unique identifier for the application reference |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Ledger Transaction - Delete Ledger Transactions By Activation Group¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/activation-group/{transactionType}/{revisionId}
📋 Description: Activates a group of ledger transactions based on the specified transaction type and revision ID, facilitating the management of financial records within the general ledger. This operation ensures accurate ledger entries and supports effective transaction processing.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transactionType |
path |
string |
true |
Type of the transaction |
revisionId |
path |
integer(int64) |
true |
Unique identifier for the revision |
body |
body |
true |
Request body containing the activation group data for ledger transactions, including details on transaction type and associated financial records for the specified revision. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string"
4}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Ledger Transaction - Fetch By ID¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/{id}
📋 Description: Retrieves detailed information about a specific ledger transaction identified by the provided ID, facilitating access to critical financial records within the general ledger. This operation supports effective account management and transaction analysis.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
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 "internalPostingStatus": {
440 "documentNumber": "string",
441 "status": "NA",
442 "postingMessage": "string"
443 },
444 "nlaEnrichmentState": {
445 "id": 0,
446 "status": "PENDING",
447 "message": "string",
448 "history": [
449 {
450 "requestingUser": "string",
451 "enrichmentRequestId": 0,
452 "requestedAt": "2019-08-24T14:15:22Z",
453 "enrichedAt": "2019-08-24T14:15:22Z",
454 "requestStatus": "SENT",
455 "applicationStatus": "PENDING",
456 "message": "string"
457 }
458 ]
459 },
460 "nreEnrichmentState": {
461 "id": 0,
462 "status": "PENDING",
463 "message": "string",
464 "history": [
465 {
466 "requestingUser": "string",
467 "enrichmentRequestId": 0,
468 "requestedAt": "2019-08-24T14:15:22Z",
469 "enrichedAt": "2019-08-24T14:15:22Z",
470 "requestStatus": "SENT",
471 "applicationStatus": "PENDING",
472 "message": "string"
473 }
474 ]
475 },
476 "apEnrichmentState": {
477 "id": 0,
478 "status": "PENDING",
479 "message": "string",
480 "history": [
481 {
482 "requestingUser": "string",
483 "enrichmentRequestId": 0,
484 "requestedAt": "2019-08-24T14:15:22Z",
485 "enrichedAt": "2019-08-24T14:15:22Z",
486 "requestStatus": "SENT",
487 "applicationStatus": "PENDING",
488 "message": "string"
489 }
490 ]
491 },
492 "externalPostingStatus": {
493 "documentNumber": "string",
494 "objType": "string",
495 "objKey": "string",
496 "objSys": "string",
497 "username": "string",
498 "status": "NA",
499 "postingMessage": "string",
500 "taskId": 0
501 }
502}
Ledger Transaction - Fetch Group By ID¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/group/{id}
📋 Description: Retrieves detailed ledger transactions grouped by the specified identifier, providing insights into financial records associated with ledger entries and accounts. This operation supports effective tracking and analysis of financial activities within the General Ledger domain.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "latestDocument": true,
4 "accountingDocumentId": 0,
5 "ledgerTransactions": [
6 {
7 "id": 0,
8 "requestUniqueId": "string",
9 "createdByApplication": "NLA",
10 "applicationReferenceId": "JOURNAL_ENTRY_ID--UNIT_ID",
11 "documentComments": "string",
12 "name": "string",
13 "principalPositionType": "LESSEE",
14 "postingTransactionType": "POST",
15 "postingType": "PAYMENT",
16 "ledgerType": "LIABILITY",
17 "paymentType": "N_A",
18 "parallelCurrencyEnabled": true,
19 "generateInvoiceInAp": true,
20 "generateVendorInvoice": true,
21 "calculateTax": true,
22 "taxCalculationType": "NET",
23 "currencyDetail": {
24 "currencyId": 0,
25 "currencyDisplayId": "string",
26 "currencyDefinitionType": "CONTRACT_CURRENCY",
27 "currencyType": "string"
28 },
29 "classificationInfo": {
30 "accountingStandard": {
31 "id": 0,
32 "displayId": "string"
33 },
34 "leaseClassificationType": "NON_LEASE"
35 },
36 "date": {
37 "documentDate": "2019-08-24T14:15:22Z",
38 "userDocumentDate": "2019-08-24",
39 "postingDate": "2019-08-24",
40 "transactionDate": "2019-08-24",
41 "translationDate": "2019-08-24",
42 "fiscalVariantId": 0,
43 "fiscalVariantDisplayId": "string",
44 "calendarType": "REGULAR_CALENDAR",
45 "fiscalYear": 0,
46 "fiscalPeriod": 0
47 },
48 "automaticReversal": {
49 "id": 0,
50 "postingDate": "2019-08-24",
51 "documentDate": "2019-08-24",
52 "reversalReason": {
53 "id": 0,
54 "displayId": "string"
55 }
56 },
57 "trace": {
58 "previousLedgerTransactionId": 0,
59 "nextLedgerTransactionId": 0,
60 "postExternalType": "SKIP"
61 },
62 "fosReferences": {
63 "id": 0,
64 "system": {
65 "id": 0,
66 "displayId": "string"
67 },
68 "company": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "leaseArea": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "leaseGroup": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "leaseDepartment": {
81 "id": 0,
82 "displayId": "string"
83 },
84 "businessUnit": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "mainCostCenter": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "internalAssetClass": {
93 "id": 0,
94 "displayId": "string"
95 },
96 "documentType": {
97 "id": 0,
98 "displayId": "string"
99 },
100 "depreciationArea": {
101 "id": 0,
102 "displayId": "string"
103 },
104 "reversalReason": {
105 "id": 0,
106 "displayId": "string"
107 },
108 "tradingPartner": {
109 "id": 0,
110 "displayId": "string"
111 },
112 "allocationNumber": {
113 "id": 0,
114 "displayId": "string"
115 },
116 "responsibleCostCenter": {
117 "id": 0,
118 "displayId": "string"
119 },
120 "workBreakdownStructure": {
121 "id": 0,
122 "displayId": "string"
123 },
124 "businessArea": {
125 "id": 0,
126 "displayId": "string"
127 },
128 "functionalArea": {
129 "id": 0,
130 "displayId": "string"
131 },
132 "plant": {
133 "id": 0,
134 "displayId": "string"
135 },
136 "internalOrder": {
137 "id": 0,
138 "displayId": "string"
139 },
140 "network": {
141 "id": 0,
142 "displayId": "string"
143 },
144 "paymentTerm": {
145 "id": 0,
146 "displayId": "string"
147 },
148 "paymentBlock": {
149 "id": 0,
150 "displayId": "string"
151 },
152 "paymentMethod": {
153 "id": 0,
154 "displayId": "string",
155 "type": "string"
156 },
157 "segment": {
158 "id": 0,
159 "displayId": "string"
160 },
161 "purchasingOrganization": {
162 "id": 0,
163 "displayId": "string"
164 },
165 "purchasingOrder": {
166 "id": 0,
167 "displayId": "string"
168 },
169 "ledgerTransactionId": 0
170 },
171 "assetRegisterReferences": {
172 "id": 0,
173 "asset": {
174 "assetId": 0,
175 "assetDisplayId": "string",
176 "assetNumber": "string",
177 "subAssetNumber": "string"
178 },
179 "ledgerTransactionId": 0
180 },
181 "nlaReferences": {
182 "id": 0,
183 "contract": {
184 "id": 0,
185 "displayId": "string"
186 },
187 "leaseComponent": {
188 "id": 0,
189 "displayId": "string"
190 },
191 "activationGroup": {
192 "id": 0,
193 "displayId": "string"
194 },
195 "unit": {
196 "id": 0,
197 "displayId": "string"
198 },
199 "contractExternalId": "string",
200 "journalId": 0,
201 "activationGroupRevisionId": 0,
202 "ledgerTransactionId": 0
203 },
204 "nlaCustomReferences": [
205 {
206 "key": "string",
207 "dataType": "STRING",
208 "value": 0
209 }
210 ],
211 "nreReferences": {
212 "id": 0,
213 "premise": {
214 "id": 0,
215 "displayId": "string"
216 },
217 "location": {
218 "id": 0,
219 "displayId": "string"
220 },
221 "lease": {
222 "id": 0,
223 "displayId": "string"
224 },
225 "ledgerTransactionId": 0
226 },
227 "nreCustomReferences": [
228 {
229 "key": "string",
230 "dataType": "STRING",
231 "value": 0
232 }
233 ],
234 "apReferences": {
235 "id": 0,
236 "invoice": {
237 "id": 0,
238 "displayId": "string",
239 "name": "string"
240 },
241 "vendor": {
242 "id": 0,
243 "displayId": "string",
244 "name": "string"
245 },
246 "ledgerTransactionId": 0
247 },
248 "apCustomReferences": [
249 {
250 "key": "string",
251 "dataType": "STRING",
252 "value": 0
253 }
254 ],
255 "entries": [
256 {
257 "id": 0,
258 "entryType": "D",
259 "amount": 0,
260 "unroundedAmount": 0,
261 "deltaAdjustment": 0,
262 "itemText": "string",
263 "itemNoAcc": 0,
264 "generalLedger": {
265 "id": 0,
266 "displayId": "string",
267 "generalLedgerAccountName": "string",
268 "generalLedgerAccountCode": "string",
269 "openItemManagement": true,
270 "accountCategory": "BALANCESHEET",
271 "shortName": "string",
272 "longName": "string"
273 },
274 "additionalCurrencyEntries": [
275 {
276 "id": 0,
277 "amount": 0,
278 "unroundedAmount": 0,
279 "deltaAdjustment": 0,
280 "itemNoAcc": 0,
281 "currencyDetail": {
282 "currencyId": 0,
283 "currencyDisplayId": "string",
284 "currencyDefinitionType": "CONTRACT_CURRENCY",
285 "currencyType": "string"
286 },
287 "currencyConversionDetail": {
288 "rate": 0,
289 "conversionDate": "2019-08-24",
290 "translationDateType": "DOCUMENT_DATE",
291 "sourceCurrencyType": "CONTRACT_CURRENCY",
292 "sourceCurrency": {
293 "id": 0,
294 "displayId": "string"
295 },
296 "depreciationArea": {
297 "id": 0,
298 "displayId": "string"
299 }
300 },
301 "ledgerEntryId": 0,
302 "ledgerEntryTaxId": 0
303 }
304 ],
305 "tag": "string",
306 "costCenter": {
307 "id": 0,
308 "displayId": "string",
309 "mainCostCenter": true,
310 "allocationPercentage": 0.1
311 },
312 "profitCenter": {
313 "id": 0,
314 "displayId": "string"
315 },
316 "partner": {
317 "id": 0,
318 "displayId": "string"
319 },
320 "transactionType": "string",
321 "nlaCustomReferences": [
322 {
323 "key": "string",
324 "dataType": "STRING",
325 "value": 0
326 }
327 ],
328 "nreCustomReferences": [
329 {
330 "key": "string",
331 "dataType": "STRING",
332 "value": 0
333 }
334 ],
335 "apCustomReferences": [
336 {
337 "key": "string",
338 "dataType": "STRING",
339 "value": 0
340 }
341 ],
342 "taxEntries": [
343 {
344 "id": 0,
345 "entryType": "D",
346 "amount": 0,
347 "unroundedAmount": 0,
348 "deltaAdjustment": 0,
349 "itemText": "string",
350 "itemNoAcc": 0,
351 "generalLedger": {
352 "id": 0,
353 "displayId": "string",
354 "generalLedgerAccountName": "string",
355 "generalLedgerAccountCode": "string",
356 "openItemManagement": true,
357 "accountCategory": "BALANCESHEET",
358 "shortName": "string",
359 "longName": "string"
360 },
361 "additionalCurrencyEntries": [
362 {
363 "id": 0,
364 "amount": 0,
365 "unroundedAmount": 0,
366 "deltaAdjustment": 0,
367 "itemNoAcc": 0,
368 "currencyDetail": {
369 "currencyId": 0,
370 "currencyDisplayId": "string",
371 "currencyDefinitionType": "CONTRACT_CURRENCY",
372 "currencyType": "string"
373 },
374 "currencyConversionDetail": {
375 "rate": 0,
376 "conversionDate": "2019-08-24",
377 "translationDateType": "DOCUMENT_DATE",
378 "sourceCurrencyType": "CONTRACT_CURRENCY",
379 "sourceCurrency": {},
380 "depreciationArea": {}
381 },
382 "ledgerEntryId": 0,
383 "ledgerEntryTaxId": 0
384 }
385 ],
386 "taxRate": 0,
387 "taxBaseAmount": 0,
388 "totalTaxDocumentAmount": 0,
389 "taxExempt": 0,
390 "taxExemptionPercentage": 0,
391 "taxAffected": 0,
392 "taxAccount": "string",
393 "accountingKey": "string",
394 "conditionKey": "string",
395 "taxCode": {
396 "id": 0,
397 "displayId": "string"
398 },
399 "taxJurisdiction": {
400 "id": 0,
401 "displayId": "string"
402 },
403 "taxDetermination": {
404 "id": 0,
405 "displayId": "string"
406 },
407 "financialTermId": 0,
408 "ledgerEntryId": 0
409 }
410 ],
411 "ledgerTransactionId": 0
412 }
413 ],
414 "notes": [
415 {
416 "id": 0,
417 "note": "string"
418 }
419 ],
420 "attachments": [
421 {
422 "id": 0,
423 "fileName": "string",
424 "fileStorageId": "string",
425 "docStoreId": 0
426 }
427 ],
428 "journalVoucherWorkflowHistory": [
429 {
430 "id": 0,
431 "eventType": "SEND_TO_APPROVAL",
432 "eventDate": "2019-08-24T14:15:22Z",
433 "user": "string"
434 }
435 ],
436 "ledgerTransactionGroupId": 0,
437 "accountingDocumentId": 0,
438 "internalPostingStatus": {
439 "documentNumber": "string",
440 "status": "NA",
441 "postingMessage": "string"
442 },
443 "nlaEnrichmentState": {
444 "id": 0,
445 "status": "PENDING",
446 "message": "string",
447 "history": [
448 {
449 "requestingUser": "string",
450 "enrichmentRequestId": 0,
451 "requestedAt": "2019-08-24T14:15:22Z",
452 "enrichedAt": "2019-08-24T14:15:22Z",
453 "requestStatus": "SENT",
454 "applicationStatus": "PENDING",
455 "message": "string"
456 }
457 ]
458 },
459 "nreEnrichmentState": {
460 "id": 0,
461 "status": "PENDING",
462 "message": "string",
463 "history": [
464 {
465 "requestingUser": "string",
466 "enrichmentRequestId": 0,
467 "requestedAt": "2019-08-24T14:15:22Z",
468 "enrichedAt": "2019-08-24T14:15:22Z",
469 "requestStatus": "SENT",
470 "applicationStatus": "PENDING",
471 "message": "string"
472 }
473 ]
474 },
475 "apEnrichmentState": {
476 "id": 0,
477 "status": "PENDING",
478 "message": "string",
479 "history": [
480 {
481 "requestingUser": "string",
482 "enrichmentRequestId": 0,
483 "requestedAt": "2019-08-24T14:15:22Z",
484 "enrichedAt": "2019-08-24T14:15:22Z",
485 "requestStatus": "SENT",
486 "applicationStatus": "PENDING",
487 "message": "string"
488 }
489 ]
490 },
491 "externalPostingStatus": {
492 "documentNumber": "string",
493 "objType": "string",
494 "objKey": "string",
495 "objSys": "string",
496 "username": "string",
497 "status": "NA",
498 "postingMessage": "string",
499 "taskId": 0
500 }
501 }
502 ]
503}
Ledger Transaction - Fetch Operational Exchange Rate Types For Company¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/companies/{companyId}/operational-exchange-rate-types
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
companyId |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "exchangeRateTypes": [
3 {
4 "id": 0,
5 "status": "CREATED",
6 "displayId": "string",
7 "erpSystemId": 0,
8 "erpSystemDisplayId": "string",
9 "exchangeRateType": "string",
10 "currencyType": "string",
11 "sourceCurrencyType": "CONTRACT_CURRENCY",
12 "translationDateType": "DOCUMENT_DATE",
13 "currencyDefinitionType": "CONTRACT_CURRENCY",
14 "companyId": 0,
15 "companyDisplayId": "string",
16 "targetCurrencyId": 0,
17 "targetCurrencyDisplayId": "string",
18 "targetCurrencyDecimalPoints": 0,
19 "targetCurrencyName": "string",
20 "referenceCurrencyId": 0,
21 "referenceCurrencyDisplayId": "string"
22 }
23 ],
24 "warnings": [
25 "string"
26 ]
27}
Ledger Transaction - Fetch Latest Ledger Transaction By Application Reference ID¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/application-reference/{applicationReferenceId}
📋 Description: Retrieves ledger transactions associated with a specific application reference ID, providing essential financial records for accurate account management and reporting within the General Ledger domain.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
applicationReferenceId |
path |
string |
true |
Unique identifier for the application reference |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
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 "internalPostingStatus": {
440 "documentNumber": "string",
441 "status": "NA",
442 "postingMessage": "string"
443 },
444 "nlaEnrichmentState": {
445 "id": 0,
446 "status": "PENDING",
447 "message": "string",
448 "history": [
449 {
450 "requestingUser": "string",
451 "enrichmentRequestId": 0,
452 "requestedAt": "2019-08-24T14:15:22Z",
453 "enrichedAt": "2019-08-24T14:15:22Z",
454 "requestStatus": "SENT",
455 "applicationStatus": "PENDING",
456 "message": "string"
457 }
458 ]
459 },
460 "nreEnrichmentState": {
461 "id": 0,
462 "status": "PENDING",
463 "message": "string",
464 "history": [
465 {
466 "requestingUser": "string",
467 "enrichmentRequestId": 0,
468 "requestedAt": "2019-08-24T14:15:22Z",
469 "enrichedAt": "2019-08-24T14:15:22Z",
470 "requestStatus": "SENT",
471 "applicationStatus": "PENDING",
472 "message": "string"
473 }
474 ]
475 },
476 "apEnrichmentState": {
477 "id": 0,
478 "status": "PENDING",
479 "message": "string",
480 "history": [
481 {
482 "requestingUser": "string",
483 "enrichmentRequestId": 0,
484 "requestedAt": "2019-08-24T14:15:22Z",
485 "enrichedAt": "2019-08-24T14:15:22Z",
486 "requestStatus": "SENT",
487 "applicationStatus": "PENDING",
488 "message": "string"
489 }
490 ]
491 },
492 "externalPostingStatus": {
493 "documentNumber": "string",
494 "objType": "string",
495 "objKey": "string",
496 "objSys": "string",
497 "username": "string",
498 "status": "NA",
499 "postingMessage": "string",
500 "taskId": 0
501 }
502}
Ledger Transaction - Account Balance Reports¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/account-balance
📋 Description: Retrieves the current account balance for specified ledger transactions within the General Ledger, providing essential financial records for effective account management.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "accountId": 0,
4 "accountDisplayId": "string",
5 "accountCode": "string",
6 "debitBalance": 0,
7 "creditBalance": 0,
8 "accountCategory": "BALANCESHEET"
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the financial status of an account, detailing ledger entries and transactions to provide a comprehensive overview of account balances within the General Ledger.] |
|
» accountId |
integer(int64) |
false |
none |
Unique identifier for the account |
» accountDisplayId |
string |
false |
none |
Unique identifier for the account display |
» accountCode |
string |
false |
none |
Code for the account |
» debitBalance |
number |
false |
none |
Value for debitBalance field |
» creditBalance |
number |
false |
none |
Value for creditBalance field |
» accountCategory |
string |
false |
none |
Category of the account |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
Ledger Transaction - Delete¶
HTTP Request
DELETE /api/v1/general-ledger/ledger-transactions
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |