Ledger Transaction¶
Search¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
none |
» pageable |
body |
false |
none |
|
»» page |
body |
integer(int32) |
false |
none |
»» size |
body |
integer(int32) |
false |
none |
»» sort |
body |
[string] |
false |
none |
» filter |
body |
false |
none |
|
»» idIn |
body |
[integer] |
false |
none |
»» idEqual |
body |
integer(int64) |
false |
none |
»» idLike |
body |
string |
false |
none |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
none |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
none |
»» createdByLike |
body |
string |
false |
none |
»» createdByEqual |
body |
string |
false |
none |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
none |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
none |
»» modifiedByLike |
body |
string |
false |
none |
»» modifiedByEqual |
body |
string |
false |
none |
»» createdByApplicationIn |
body |
[string] |
false |
none |
»» applicationReferenceIdEqual |
body |
string |
false |
none |
»» documentCommentsLike |
body |
string |
false |
none |
»» nameLike |
body |
string |
false |
none |
»» principalPositionTypeEqual |
body |
string |
false |
none |
»» postingTransactionTypeEqual |
body |
string |
false |
none |
»» postingTypeEqual |
body |
string |
false |
none |
»» ledgerTypeEqual |
body |
string |
false |
none |
»» currencyIdEqual |
body |
integer(int64) |
false |
none |
»» currencyDisplayIdLike |
body |
string |
false |
none |
»» accountingStandardIdEqual |
body |
integer(int64) |
false |
none |
»» accountingStandardDisplayIdLike |
body |
string |
false |
none |
»» dateDocumentDateGreaterThanOrEqual |
body |
string(date-time) |
false |
none |
»» dateUserDocumentDateGreaterThanOrEqual |
body |
string(date) |
false |
none |
»» datePostingDateGreaterThanOrEqual |
body |
string(date) |
false |
none |
»» dateDocumentDateLessThanOrEqual |
body |
string(date-time) |
false |
none |
»» dateUserDocumentDateLessThanOrEqual |
body |
string(date) |
false |
none |
»» datePostingDateLessThanOrEqual |
body |
string(date) |
false |
none |
»» systemIdEqual |
body |
integer(int64) |
false |
none |
»» companyIdEqual |
body |
integer(int64) |
false |
none |
»» systemDisplayIdLike |
body |
string |
false |
none |
»» companyDisplayIdLike |
body |
string |
false |
none |
»» activationGroupIdEqual |
body |
integer(int64) |
false |
none |
»» activationGroupDisplayIdLike |
body |
string |
false |
none |
»» nlaCustomReferencesKeyEqual |
body |
string |
false |
none |
»» nlaCustomReferencesValueLike |
body |
string |
false |
none |
»» nlaCustomReferencesDataTypeLike |
body |
string |
false |
none |
»» nreCustomReferencesKeyEqual |
body |
string |
false |
none |
»» nreCustomReferencesValueLike |
body |
string |
false |
none |
»» nreCustomReferencesDataTypeLike |
body |
string |
false |
none |
»» apCustomReferencesKeyEqual |
body |
string |
false |
none |
»» apCustomReferencesValueLike |
body |
string |
false |
none |
»» apCustomReferencesDataTypeLike |
body |
string |
false |
none |
»» ledgerTransactionGroupIdLike |
body |
string |
false |
none |
»» accountingDocumentIdLike |
body |
string |
false |
none |
»» internalPostingStatusEqual |
body |
string |
false |
none |
»» internalPostingDocumentNumberLike |
body |
string |
false |
none |
»» nlaEnrichmentStatusEqual |
body |
string |
false |
none |
»» nreEnrichmentStatusEqual |
body |
string |
false |
none |
»» apEnrichmentStatusEqual |
body |
string |
false |
none |
»» externalPostingStatusEqual |
body |
string |
false |
none |
»» externalPostingDocumentNumberLike |
body |
string |
false |
none |
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, nan |
»» internalPostingStatusEqual |
ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED, nan |
»» ledgerTypeEqual |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER |
»» nlaEnrichmentStatusEqual |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
»» nreEnrichmentStatusEqual |
ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED |
»» postingTransactionTypeEqual |
POST, REVERSE |
»» postingTypeEqual |
ACCRUAL, CHARGE, DEPRECIATION, MODIFICATION_RECOGNITION, PAYMENT, PROVISIONING, RECOGNITION, TERMINATION, VOUCHER |
»» principalPositionTypeEqual |
LESSEE, LESSOR |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "pageable": {
3 "page": 0,
4 "size": 1,
5 "sort": [
6 "string"
7 ]
8 },
9 "filter": {
10 "idIn": [
11 0
12 ],
13 "idEqual": 0,
14 "idLike": "string",
15 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
16 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
17 "createdByLike": "string",
18 "createdByEqual": "string",
19 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
20 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
21 "modifiedByLike": "string",
22 "modifiedByEqual": "string",
23 "createdByApplicationIn": [
24 "NLA"
25 ],
26 "applicationReferenceIdEqual": "string",
27 "documentCommentsLike": "string",
28 "nameLike": "string",
29 "principalPositionTypeEqual": "LESSEE",
30 "postingTransactionTypeEqual": "POST",
31 "postingTypeEqual": "PAYMENT",
32 "ledgerTypeEqual": "LIABILITY",
33 "currencyIdEqual": 0,
34 "currencyDisplayIdLike": "string",
35 "accountingStandardIdEqual": 0,
36 "accountingStandardDisplayIdLike": "string",
37 "dateDocumentDateGreaterThanOrEqual": "2019-08-24T14:15:22Z",
38 "dateUserDocumentDateGreaterThanOrEqual": "2019-08-24",
39 "datePostingDateGreaterThanOrEqual": "2019-08-24",
40 "dateDocumentDateLessThanOrEqual": "2019-08-24T14:15:22Z",
41 "dateUserDocumentDateLessThanOrEqual": "2019-08-24",
42 "datePostingDateLessThanOrEqual": "2019-08-24",
43 "systemIdEqual": 0,
44 "companyIdEqual": 0,
45 "systemDisplayIdLike": "string",
46 "companyDisplayIdLike": "string",
47 "activationGroupIdEqual": 0,
48 "activationGroupDisplayIdLike": "string",
49 "nlaCustomReferencesKeyEqual": "string",
50 "nlaCustomReferencesValueLike": "string",
51 "nlaCustomReferencesDataTypeLike": "string",
52 "nreCustomReferencesKeyEqual": "string",
53 "nreCustomReferencesValueLike": "string",
54 "nreCustomReferencesDataTypeLike": "string",
55 "apCustomReferencesKeyEqual": "string",
56 "apCustomReferencesValueLike": "string",
57 "apCustomReferencesDataTypeLike": "string",
58 "ledgerTransactionGroupIdLike": "string",
59 "accountingDocumentIdLike": "string",
60 "internalPostingStatusEqual": "NA",
61 "internalPostingDocumentNumberLike": "string",
62 "nlaEnrichmentStatusEqual": "PENDING",
63 "nreEnrichmentStatusEqual": "PENDING",
64 "apEnrichmentStatusEqual": "PENDING",
65 "externalPostingStatusEqual": "NA",
66 "externalPostingDocumentNumberLike": "string"
67 }
68}
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 "parallelCurrencyEnabled": true,
31 "generateInvoiceInAp": true,
32 "generateVendorInvoice": true,
33 "calculateTax": true,
34 "taxCalculationType": "NET",
35 "currencyDetail": {
36 "currencyId": 0,
37 "currencyDisplayId": "string",
38 "currencyDefinitionType": "CONTRACT_CURRENCY",
39 "currencyType": "string"
40 },
41 "classificationInfo": {
42 "accountingStandard": {
43 "id": 0,
44 "displayId": "string"
45 },
46 "leaseClassificationType": "NON_LEASE"
47 },
48 "date": {
49 "documentDate": "2019-08-24T14:15:22Z",
50 "userDocumentDate": "2019-08-24",
51 "postingDate": "2019-08-24",
52 "transactionDate": "2019-08-24",
53 "translationDate": "2019-08-24",
54 "fiscalVariantId": 0,
55 "fiscalVariantDisplayId": "string",
56 "calendarType": "REGULAR_CALENDAR",
57 "fiscalYear": 0,
58 "fiscalPeriod": 0
59 },
60 "automaticReversal": {
61 "id": 0,
62 "postingDate": "2019-08-24",
63 "documentDate": "2019-08-24",
64 "reversalReason": {
65 "id": 0,
66 "displayId": "string"
67 }
68 },
69 "trace": {
70 "previousLedgerTransactionId": 0,
71 "nextLedgerTransactionId": 0,
72 "postExternalType": "SKIP"
73 },
74 "fosReferences": {
75 "id": 0,
76 "system": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "company": {
81 "id": 0,
82 "displayId": "string"
83 },
84 "leaseArea": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "leaseGroup": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "leaseDepartment": {
93 "id": 0,
94 "displayId": "string"
95 },
96 "businessUnit": {
97 "id": 0,
98 "displayId": "string"
99 },
100 "mainCostCenter": {
101 "id": 0,
102 "displayId": "string"
103 },
104 "internalAssetClass": {
105 "id": 0,
106 "displayId": "string"
107 },
108 "documentType": {
109 "id": 0,
110 "displayId": "string"
111 },
112 "depreciationArea": {
113 "id": 0,
114 "displayId": "string"
115 },
116 "reversalReason": {
117 "id": 0,
118 "displayId": "string"
119 },
120 "tradingPartner": {
121 "id": 0,
122 "displayId": "string"
123 },
124 "allocationNumber": {
125 "id": 0,
126 "displayId": "string"
127 },
128 "responsibleCostCenter": {
129 "id": 0,
130 "displayId": "string"
131 },
132 "workBreakdownStructure": {
133 "id": 0,
134 "displayId": "string"
135 },
136 "businessArea": {
137 "id": 0,
138 "displayId": "string"
139 },
140 "functionalArea": {
141 "id": 0,
142 "displayId": "string"
143 },
144 "plant": {
145 "id": 0,
146 "displayId": "string"
147 },
148 "internalOrder": {
149 "id": 0,
150 "displayId": "string"
151 },
152 "network": {
153 "id": 0,
154 "displayId": "string"
155 },
156 "paymentTerm": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "paymentBlock": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "paymentMethod": {
165 "id": 0,
166 "displayId": "string",
167 "type": "string"
168 },
169 "segment": {
170 "id": 0,
171 "displayId": "string"
172 },
173 "purchasingOrganization": {
174 "id": 0,
175 "displayId": "string"
176 },
177 "purchasingOrder": {
178 "id": 0,
179 "displayId": "string"
180 },
181 "ledgerTransactionId": 0
182 },
183 "assetRegisterReferences": {
184 "id": 0,
185 "asset": {
186 "assetId": 0,
187 "assetDisplayId": "string",
188 "assetNumber": "string",
189 "subAssetNumber": "string"
190 },
191 "ledgerTransactionId": 0
192 },
193 "nlaReferences": {
194 "id": 0,
195 "contract": {
196 "id": 0,
197 "displayId": "string"
198 },
199 "leaseComponent": {
200 "id": 0,
201 "displayId": "string"
202 },
203 "activationGroup": {
204 "id": 0,
205 "displayId": "string"
206 },
207 "unit": {
208 "id": 0,
209 "displayId": "string"
210 },
211 "contractExternalId": "string",
212 "journalId": 0,
213 "activationGroupRevisionId": 0,
214 "ledgerTransactionId": 0
215 },
216 "nlaCustomReferences": [
217 {
218 "key": "string",
219 "dataType": "STRING",
220 "value": 0
221 }
222 ],
223 "nreReferences": {
224 "id": 0,
225 "premise": {
226 "id": 0,
227 "displayId": "string"
228 },
229 "location": {
230 "id": 0,
231 "displayId": "string"
232 },
233 "lease": {
234 "id": 0,
235 "displayId": "string"
236 },
237 "ledgerTransactionId": 0
238 },
239 "nreCustomReferences": [
240 {
241 "key": "string",
242 "dataType": "STRING",
243 "value": 0
244 }
245 ],
246 "apReferences": {
247 "id": 0,
248 "invoice": {
249 "id": 0,
250 "displayId": "string"
251 },
252 "ledgerTransactionId": 0
253 },
254 "apCustomReferences": [
255 {
256 "key": "string",
257 "dataType": "STRING",
258 "value": 0
259 }
260 ],
261 "entries": [
262 {
263 "id": 0,
264 "entryType": "D",
265 "amount": 0,
266 "unroundedAmount": 0,
267 "deltaAdjustment": 0,
268 "itemText": "string",
269 "itemNoAcc": 0,
270 "generalLedger": {
271 "id": 0,
272 "displayId": "string",
273 "generalLedgerAccountName": "string",
274 "generalLedgerAccountCode": "string",
275 "openItemManagement": true,
276 "accountCategory": "BALANCESHEET",
277 "shortName": "string",
278 "longName": "string"
279 },
280 "additionalCurrencyEntries": [
281 {
282 "id": 0,
283 "amount": 0,
284 "unroundedAmount": 0,
285 "deltaAdjustment": 0,
286 "itemNoAcc": 0,
287 "currencyDetail": {
288 "currencyId": 0,
289 "currencyDisplayId": "string",
290 "currencyDefinitionType": "CONTRACT_CURRENCY",
291 "currencyType": "string"
292 },
293 "currencyConversionDetail": {
294 "rate": 0,
295 "conversionDate": "2019-08-24",
296 "translationDateType": "DOCUMENT_DATE",
297 "sourceCurrencyType": "CONTRACT_CURRENCY",
298 "sourceCurrency": {
299 "id": 0,
300 "displayId": "string"
301 },
302 "depreciationArea": {
303 "id": 0,
304 "displayId": "string"
305 }
306 },
307 "ledgerEntryId": 0,
308 "ledgerEntryTaxId": 0
309 }
310 ],
311 "tag": "string",
312 "costCenter": {
313 "id": 0,
314 "displayId": "string",
315 "mainCostCenter": true,
316 "allocationPercentage": 0.1
317 },
318 "profitCenter": {
319 "id": 0,
320 "displayId": "string"
321 },
322 "vendor": {
323 "id": 0,
324 "displayId": "string"
325 },
326 "transactionType": "string",
327 "nlaCustomReferences": [
328 {
329 "key": "string",
330 "dataType": "STRING",
331 "value": 0
332 }
333 ],
334 "nreCustomReferences": [
335 {
336 "key": "string",
337 "dataType": "STRING",
338 "value": 0
339 }
340 ],
341 "apCustomReferences": [
342 {
343 "key": "string",
344 "dataType": "STRING",
345 "value": 0
346 }
347 ],
348 "taxEntries": [
349 {
350 "id": 0,
351 "entryType": "D",
352 "amount": 0,
353 "unroundedAmount": 0,
354 "deltaAdjustment": 0,
355 "itemText": "string",
356 "itemNoAcc": 0,
357 "generalLedger": {
358 "id": 0,
359 "displayId": "string",
360 "generalLedgerAccountName": "string",
361 "generalLedgerAccountCode": "string",
362 "openItemManagement": true,
363 "accountCategory": "BALANCESHEET",
364 "shortName": "string",
365 "longName": "string"
366 },
367 "additionalCurrencyEntries": [
368 {
369 "id": 0,
370 "amount": 0,
371 "unroundedAmount": 0,
372 "deltaAdjustment": 0,
373 "itemNoAcc": 0,
374 "currencyDetail": {
375 "currencyId": 0,
376 "currencyDisplayId": "string",
377 "currencyDefinitionType": "CONTRACT_CURRENCY",
378 "currencyType": "string"
379 },
380 "currencyConversionDetail": {
381 "rate": 0,
382 "conversionDate": "2019-08-24",
383 "translationDateType": "DOCUMENT_DATE",
384 "sourceCurrencyType": "CONTRACT_CURRENCY",
385 "sourceCurrency": {},
386 "depreciationArea": {}
387 },
388 "ledgerEntryId": 0,
389 "ledgerEntryTaxId": 0
390 }
391 ],
392 "taxRate": 0,
393 "taxBaseAmount": 0,
394 "totalTaxDocumentAmount": 0,
395 "taxExempt": 0,
396 "taxExemptionPercentage": 0,
397 "taxAffected": 0,
398 "taxAccount": "string",
399 "accountingKey": "string",
400 "conditionKey": "string",
401 "taxCode": {
402 "id": 0,
403 "displayId": "string"
404 },
405 "taxJurisdiction": {
406 "id": 0,
407 "displayId": "string"
408 },
409 "taxDetermination": {
410 "id": 0,
411 "displayId": "string"
412 },
413 "financialTermId": 0,
414 "ledgerEntryId": 0
415 }
416 ],
417 "ledgerTransactionId": 0
418 }
419 ],
420 "notes": [
421 {
422 "id": 0,
423 "note": "string"
424 }
425 ],
426 "attachments": [
427 {
428 "id": 0,
429 "fileName": "string",
430 "fileStorageId": "string",
431 "docStoreId": 0
432 }
433 ],
434 "journalVoucherWorkflowHistory": [
435 {
436 "id": 0,
437 "eventType": "SEND_TO_APPROVAL",
438 "eventDate": "2019-08-24T14:15:22Z",
439 "user": "string"
440 }
441 ],
442 "ledgerTransactionGroupId": 0,
443 "accountingDocumentId": 0,
444 "internalPostingStatus": {
445 "documentNumber": "string",
446 "status": "NA",
447 "postingMessage": "string"
448 },
449 "nlaEnrichmentState": {
450 "id": 0,
451 "status": "PENDING",
452 "message": "string",
453 "history": [
454 {
455 "requestingUser": "string",
456 "enrichmentRequestId": 0,
457 "requestedAt": "2019-08-24T14:15:22Z",
458 "enrichedAt": "2019-08-24T14:15:22Z",
459 "requestStatus": "SENT",
460 "applicationStatus": "PENDING",
461 "message": "string"
462 }
463 ]
464 },
465 "nreEnrichmentState": {
466 "id": 0,
467 "status": "PENDING",
468 "message": "string",
469 "history": [
470 {
471 "requestingUser": "string",
472 "enrichmentRequestId": 0,
473 "requestedAt": "2019-08-24T14:15:22Z",
474 "enrichedAt": "2019-08-24T14:15:22Z",
475 "requestStatus": "SENT",
476 "applicationStatus": "PENDING",
477 "message": "string"
478 }
479 ]
480 },
481 "apEnrichmentState": {
482 "id": 0,
483 "status": "PENDING",
484 "message": "string",
485 "history": [
486 {
487 "requestingUser": "string",
488 "enrichmentRequestId": 0,
489 "requestedAt": "2019-08-24T14:15:22Z",
490 "enrichedAt": "2019-08-24T14:15:22Z",
491 "requestStatus": "SENT",
492 "applicationStatus": "PENDING",
493 "message": "string"
494 }
495 ]
496 },
497 "externalPostingStatus": {
498 "documentNumber": "string",
499 "objType": "string",
500 "objKey": "string",
501 "objSys": "string",
502 "username": "string",
503 "status": "NA",
504 "postingMessage": "string",
505 "taskId": 0
506 }
507 }
508 ],
509 "number": 0,
510 "sort": {
511 "unsorted": true,
512 "sorted": true,
513 "empty": true
514 },
515 "first": true,
516 "last": true,
517 "empty": true
518}
Get Latest Ledger Transaction By Application Reference Ids¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/application-references
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[string] |
true |
none |
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 "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 },
235 "ledgerTransactionId": 0
236 },
237 "apCustomReferences": [
238 {
239 "key": "string",
240 "dataType": "STRING",
241 "value": 0
242 }
243 ],
244 "entries": [
245 {
246 "id": 0,
247 "entryType": "D",
248 "amount": 0,
249 "unroundedAmount": 0,
250 "deltaAdjustment": 0,
251 "itemText": "string",
252 "itemNoAcc": 0,
253 "generalLedger": {
254 "id": 0,
255 "displayId": "string",
256 "generalLedgerAccountName": "string",
257 "generalLedgerAccountCode": "string",
258 "openItemManagement": true,
259 "accountCategory": "BALANCESHEET",
260 "shortName": "string",
261 "longName": "string"
262 },
263 "additionalCurrencyEntries": [
264 {
265 "id": 0,
266 "amount": 0,
267 "unroundedAmount": 0,
268 "deltaAdjustment": 0,
269 "itemNoAcc": 0,
270 "currencyDetail": {
271 "currencyId": 0,
272 "currencyDisplayId": "string",
273 "currencyDefinitionType": "CONTRACT_CURRENCY",
274 "currencyType": "string"
275 },
276 "currencyConversionDetail": {
277 "rate": 0,
278 "conversionDate": "2019-08-24",
279 "translationDateType": "DOCUMENT_DATE",
280 "sourceCurrencyType": "CONTRACT_CURRENCY",
281 "sourceCurrency": {
282 "id": 0,
283 "displayId": "string"
284 },
285 "depreciationArea": {
286 "id": 0,
287 "displayId": "string"
288 }
289 },
290 "ledgerEntryId": 0,
291 "ledgerEntryTaxId": 0
292 }
293 ],
294 "tag": "string",
295 "costCenter": {
296 "id": 0,
297 "displayId": "string",
298 "mainCostCenter": true,
299 "allocationPercentage": 0.1
300 },
301 "profitCenter": {
302 "id": 0,
303 "displayId": "string"
304 },
305 "vendor": {
306 "id": 0,
307 "displayId": "string"
308 },
309 "transactionType": "string",
310 "nlaCustomReferences": [
311 {
312 "key": "string",
313 "dataType": "STRING",
314 "value": 0
315 }
316 ],
317 "nreCustomReferences": [
318 {
319 "key": "string",
320 "dataType": "STRING",
321 "value": 0
322 }
323 ],
324 "apCustomReferences": [
325 {
326 "key": "string",
327 "dataType": "STRING",
328 "value": 0
329 }
330 ],
331 "taxEntries": [
332 {
333 "id": 0,
334 "entryType": "D",
335 "amount": 0,
336 "unroundedAmount": 0,
337 "deltaAdjustment": 0,
338 "itemText": "string",
339 "itemNoAcc": 0,
340 "generalLedger": {
341 "id": 0,
342 "displayId": "string",
343 "generalLedgerAccountName": "string",
344 "generalLedgerAccountCode": "string",
345 "openItemManagement": true,
346 "accountCategory": "BALANCESHEET",
347 "shortName": "string",
348 "longName": "string"
349 },
350 "additionalCurrencyEntries": [
351 {
352 "id": 0,
353 "amount": 0,
354 "unroundedAmount": 0,
355 "deltaAdjustment": 0,
356 "itemNoAcc": 0,
357 "currencyDetail": {
358 "currencyId": 0,
359 "currencyDisplayId": "string",
360 "currencyDefinitionType": "CONTRACT_CURRENCY",
361 "currencyType": "string"
362 },
363 "currencyConversionDetail": {
364 "rate": 0,
365 "conversionDate": "2019-08-24",
366 "translationDateType": "DOCUMENT_DATE",
367 "sourceCurrencyType": "CONTRACT_CURRENCY",
368 "sourceCurrency": {
369 "id": 0,
370 "displayId": "string"
371 },
372 "depreciationArea": {
373 "id": 0,
374 "displayId": "string"
375 }
376 },
377 "ledgerEntryId": 0,
378 "ledgerEntryTaxId": 0
379 }
380 ],
381 "taxRate": 0,
382 "taxBaseAmount": 0,
383 "totalTaxDocumentAmount": 0,
384 "taxExempt": 0,
385 "taxExemptionPercentage": 0,
386 "taxAffected": 0,
387 "taxAccount": "string",
388 "accountingKey": "string",
389 "conditionKey": "string",
390 "taxCode": {
391 "id": 0,
392 "displayId": "string"
393 },
394 "taxJurisdiction": {
395 "id": 0,
396 "displayId": "string"
397 },
398 "taxDetermination": {
399 "id": 0,
400 "displayId": "string"
401 },
402 "financialTermId": 0,
403 "ledgerEntryId": 0
404 }
405 ],
406 "ledgerTransactionId": 0
407 }
408 ],
409 "notes": [
410 {
411 "id": 0,
412 "note": "string"
413 }
414 ],
415 "attachments": [
416 {
417 "id": 0,
418 "fileName": "string",
419 "fileStorageId": "string",
420 "docStoreId": 0
421 }
422 ],
423 "journalVoucherWorkflowHistory": [
424 {
425 "id": 0,
426 "eventType": "SEND_TO_APPROVAL",
427 "eventDate": "2019-08-24T14:15:22Z",
428 "user": "string"
429 }
430 ],
431 "ledgerTransactionGroupId": 0,
432 "accountingDocumentId": 0,
433 "internalPostingStatus": {
434 "documentNumber": "string",
435 "status": "NA",
436 "postingMessage": "string"
437 },
438 "nlaEnrichmentState": {
439 "id": 0,
440 "status": "PENDING",
441 "message": "string",
442 "history": [
443 {
444 "requestingUser": "string",
445 "enrichmentRequestId": 0,
446 "requestedAt": "2019-08-24T14:15:22Z",
447 "enrichedAt": "2019-08-24T14:15:22Z",
448 "requestStatus": "SENT",
449 "applicationStatus": "PENDING",
450 "message": "string"
451 }
452 ]
453 },
454 "nreEnrichmentState": {
455 "id": 0,
456 "status": "PENDING",
457 "message": "string",
458 "history": [
459 {
460 "requestingUser": "string",
461 "enrichmentRequestId": 0,
462 "requestedAt": "2019-08-24T14:15:22Z",
463 "enrichedAt": "2019-08-24T14:15:22Z",
464 "requestStatus": "SENT",
465 "applicationStatus": "PENDING",
466 "message": "string"
467 }
468 ]
469 },
470 "apEnrichmentState": {
471 "id": 0,
472 "status": "PENDING",
473 "message": "string",
474 "history": [
475 {
476 "requestingUser": "string",
477 "enrichmentRequestId": 0,
478 "requestedAt": "2019-08-24T14:15:22Z",
479 "enrichedAt": "2019-08-24T14:15:22Z",
480 "requestStatus": "SENT",
481 "applicationStatus": "PENDING",
482 "message": "string"
483 }
484 ]
485 },
486 "externalPostingStatus": {
487 "documentNumber": "string",
488 "objType": "string",
489 "objKey": "string",
490 "objSys": "string",
491 "username": "string",
492 "status": "NA",
493 "postingMessage": "string",
494 "taskId": 0
495 }
496 }
497]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
none |
|
» id |
integer(int64) |
false |
none |
none |
» requestUniqueId |
string |
true |
none |
none |
» createdByApplication |
string |
true |
none |
none |
» applicationReferenceId |
string |
true |
none |
Any application MUST send a unique reference in order to ignore duplicate postings. |
» documentComments |
string |
false |
none |
none |
» name |
string |
false |
none |
none |
» principalPositionType |
string |
false |
none |
none |
» postingTransactionType |
string |
false |
none |
none |
» postingType |
string |
true |
none |
none |
» ledgerType |
string |
true |
none |
none |
» parallelCurrencyEnabled |
boolean |
false |
none |
none |
» generateInvoiceInAp |
boolean |
false |
none |
none |
» generateVendorInvoice |
boolean |
false |
none |
none |
» calculateTax |
boolean |
false |
none |
none |
» taxCalculationType |
string |
false |
none |
none |
» currencyDetail |
false |
none |
none |
|
»» currencyId |
integer(int64) |
false |
none |
none |
»» currencyDisplayId |
string |
false |
none |
none |
»» currencyDefinitionType |
string |
false |
none |
none |
»» currencyType |
string |
false |
none |
none |
» classificationInfo |
false |
none |
none |
|
»» accountingStandard |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»» leaseClassificationType |
string |
false |
none |
none |
» date |
false |
none |
none |
|
»» documentDate |
string(date-time) |
false |
none |
none |
»» userDocumentDate |
string(date) |
false |
none |
none |
»» postingDate |
string(date) |
false |
none |
none |
»» transactionDate |
string(date) |
false |
none |
none |
»» translationDate |
string(date) |
false |
none |
none |
»» fiscalVariantId |
integer(int64) |
false |
none |
none |
»» fiscalVariantDisplayId |
string |
false |
none |
none |
»» calendarType |
string |
false |
none |
none |
»» fiscalYear |
integer(int32) |
false |
none |
none |
»» fiscalPeriod |
integer(int32) |
false |
none |
none |
» automaticReversal |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» postingDate |
string(date) |
false |
none |
none |
»» documentDate |
string(date) |
false |
none |
none |
»» reversalReason |
false |
none |
none |
|
» trace |
false |
none |
none |
|
»» previousLedgerTransactionId |
integer(int64) |
false |
none |
none |
»» nextLedgerTransactionId |
integer(int64) |
false |
none |
none |
»» postExternalType |
string |
false |
none |
none |
» fosReferences |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» system |
false |
none |
none |
|
»» company |
false |
none |
none |
|
»» leaseArea |
false |
none |
none |
|
»» leaseGroup |
false |
none |
none |
|
»» leaseDepartment |
false |
none |
none |
|
»» businessUnit |
false |
none |
none |
|
»» mainCostCenter |
false |
none |
none |
|
»» internalAssetClass |
false |
none |
none |
|
»» documentType |
false |
none |
none |
|
»» depreciationArea |
false |
none |
none |
|
»» reversalReason |
false |
none |
none |
|
»» tradingPartner |
false |
none |
none |
|
»» allocationNumber |
false |
none |
none |
|
»» responsibleCostCenter |
false |
none |
none |
|
»» workBreakdownStructure |
false |
none |
none |
|
»» businessArea |
false |
none |
none |
|
»» functionalArea |
false |
none |
none |
|
»» plant |
false |
none |
none |
|
»» internalOrder |
false |
none |
none |
|
»» network |
false |
none |
none |
|
»» paymentTerm |
false |
none |
none |
|
»» paymentBlock |
false |
none |
none |
|
»» paymentMethod |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»»» type |
string |
true |
none |
none |
»» segment |
false |
none |
none |
|
»» purchasingOrganization |
false |
none |
none |
|
»» purchasingOrder |
false |
none |
none |
|
»» ledgerTransactionId |
integer(int64) |
false |
none |
none |
» assetRegisterReferences |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» asset |
false |
none |
none |
|
»»» assetId |
integer(int64) |
false |
none |
none |
»»» assetDisplayId |
string |
false |
none |
none |
»»» assetNumber |
string |
false |
none |
none |
»»» subAssetNumber |
string |
false |
none |
none |
»» ledgerTransactionId |
integer(int64) |
false |
none |
none |
» nlaReferences |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» contract |
false |
none |
none |
|
»» leaseComponent |
false |
none |
none |
|
»» activationGroup |
false |
none |
none |
|
»» unit |
false |
none |
none |
|
»» contractExternalId |
string |
false |
none |
none |
»» journalId |
integer(int64) |
false |
none |
none |
»» activationGroupRevisionId |
integer(int64) |
false |
none |
none |
»» ledgerTransactionId |
integer(int64) |
false |
none |
none |
» nlaCustomReferences |
[oneOf] |
false |
none |
none |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
|
»»»» key |
string |
false |
none |
none |
»»»» dataType |
string |
false |
none |
none |
»»»» value |
object |
false |
none |
none |
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 |
none |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
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 |
none |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
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 |
none |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
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 |
none |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
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 |
none |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
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 |
none |
allOf - discriminator: dataType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
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 |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» premise |
false |
none |
none |
|
»» location |
false |
none |
none |
|
»» lease |
false |
none |
none |
|
»» ledgerTransactionId |
integer(int64) |
false |
none |
none |
» nreCustomReferences |
[oneOf] |
false |
none |
none |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» apReferences |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» invoice |
false |
none |
none |
|
»» ledgerTransactionId |
integer(int64) |
false |
none |
none |
» apCustomReferences |
[oneOf] |
false |
none |
none |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» entries |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» entryType |
string |
true |
none |
none |
»» amount |
number |
true |
none |
none |
»» unroundedAmount |
number |
false |
none |
none |
»» deltaAdjustment |
number |
false |
none |
none |
»» itemText |
string |
false |
none |
none |
»» itemNoAcc |
integer(int32) |
false |
none |
none |
»» generalLedger |
true |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»»» generalLedgerAccountName |
string |
true |
none |
none |
»»» generalLedgerAccountCode |
string |
true |
none |
none |
»»» openItemManagement |
boolean |
true |
none |
none |
»»» accountCategory |
string |
true |
none |
none |
»»» shortName |
string |
false |
none |
none |
»»» longName |
string |
false |
none |
none |
»» additionalCurrencyEntries |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» amount |
number |
false |
none |
none |
»»» unroundedAmount |
number |
false |
none |
none |
»»» deltaAdjustment |
number |
false |
none |
none |
»»» itemNoAcc |
integer(int32) |
false |
none |
none |
»»» currencyDetail |
false |
none |
none |
|
»»» currencyConversionDetail |
false |
none |
none |
|
»»»» rate |
number |
false |
none |
none |
»»»» conversionDate |
string(date) |
false |
none |
none |
»»»» translationDateType |
string |
false |
none |
none |
»»»» sourceCurrencyType |
string |
false |
none |
none |
»»»» sourceCurrency |
false |
none |
none |
|
»»»» depreciationArea |
false |
none |
none |
|
»»» ledgerEntryId |
integer(int64) |
false |
none |
none |
»»» ledgerEntryTaxId |
integer(int64) |
false |
none |
none |
»» tag |
string |
false |
none |
none |
»» costCenter |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» displayId |
string |
false |
none |
none |
»»» mainCostCenter |
boolean |
false |
none |
none |
»»» allocationPercentage |
number(double) |
false |
none |
none |
»» profitCenter |
false |
none |
none |
|
»» vendor |
false |
none |
none |
|
»» transactionType |
string |
false |
none |
none |
»» nlaCustomReferences |
[oneOf] |
false |
none |
none |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» nreCustomReferences |
[oneOf] |
false |
none |
none |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» apCustomReferences |
[oneOf] |
false |
none |
none |
oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» taxEntries |
false |
none |
none |
|
»»» id |
integer(int64) |
false |
none |
none |
»»» entryType |
string |
true |
none |
none |
»»» amount |
number |
true |
none |
none |
»»» unroundedAmount |
number |
false |
none |
none |
»»» deltaAdjustment |
number |
false |
none |
none |
»»» itemText |
string |
false |
none |
none |
»»» itemNoAcc |
integer(int32) |
false |
none |
none |
»»» generalLedger |
true |
none |
none |
|
»»» additionalCurrencyEntries |
false |
none |
none |
|
»»» taxRate |
number |
false |
none |
none |
»»» taxBaseAmount |
number |
false |
none |
none |
»»» totalTaxDocumentAmount |
number |
false |
none |
none |
»»» taxExempt |
number |
false |
none |
none |
»»» taxExemptionPercentage |
number |
false |
none |
none |
»»» taxAffected |
number |
false |
none |
none |
»»» taxAccount |
string |
false |
none |
none |
»»» accountingKey |
string |
false |
none |
none |
»»» conditionKey |
string |
false |
none |
none |
»»» taxCode |
false |
none |
none |
|
»»» taxJurisdiction |
false |
none |
none |
|
»»» taxDetermination |
false |
none |
none |
|
»»» financialTermId |
integer(int64) |
false |
none |
none |
»»» ledgerEntryId |
integer(int64) |
false |
none |
none |
»» ledgerTransactionId |
integer(int64) |
false |
none |
none |
» notes |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» note |
string |
false |
none |
none |
» attachments |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» fileName |
string |
false |
none |
none |
»» fileStorageId |
string |
false |
none |
none |
»» docStoreId |
integer(int64) |
false |
none |
none |
» journalVoucherWorkflowHistory |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» eventType |
string |
false |
none |
none |
»» eventDate |
string(date-time) |
false |
none |
none |
»» user |
string |
false |
none |
none |
» ledgerTransactionGroupId |
integer(int64) |
false |
none |
none |
» accountingDocumentId |
integer(int64) |
false |
none |
none |
» internalPostingStatus |
false |
none |
none |
|
»» documentNumber |
string |
false |
none |
none |
»» status |
string |
false |
none |
none |
»» postingMessage |
string |
false |
none |
none |
» nlaEnrichmentState |
false |
none |
none |
|
»» id |
integer(int64) |
false |
none |
none |
»» status |
string |
false |
none |
none |
»» message |
string |
false |
none |
none |
»» history |
false |
none |
none |
|
»»» requestingUser |
string |
false |
none |
none |
»»» enrichmentRequestId |
integer(int64) |
false |
none |
none |
»»» requestedAt |
string(date-time) |
false |
none |
none |
»»» enrichedAt |
string(date-time) |
false |
none |
none |
»»» requestStatus |
string |
false |
none |
none |
»»» applicationStatus |
string |
false |
none |
none |
»»» message |
string |
false |
none |
none |
» nreEnrichmentState |
false |
none |
none |
|
» apEnrichmentState |
false |
none |
none |
|
» externalPostingStatus |
false |
none |
none |
|
»» documentNumber |
string |
false |
none |
none |
»» objType |
string |
false |
none |
none |
»» objKey |
string |
false |
none |
none |
»» objSys |
string |
false |
none |
none |
»» username |
string |
false |
none |
none |
»» status |
string |
false |
none |
none |
»» postingMessage |
string |
false |
none |
none |
»» taskId |
integer(int64) |
false |
none |
none |
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, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM |
ledgerType |
ACCRUAL, ASSET_CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, GRV, IDC, IMPAIRMENT, INCENTIVE, LIABILITY, LIABILITY_ADJUSTMENT, LIABILITY_ADJUSTMENT_DECREASE, LIABILITY_ADJUSTMENT_INCREASE, LIABILITY_ADJUSTMENT_INDEXATION_DECREASE, LIABILITY_ADJUSTMENT_INDEXATION_INCREASE, MODIFICATION_CAPITALIZATION, MODIFICATION_CAPITALIZATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_ASSET_INCREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_DECREASE, MODIFICATION_CAPITALIZATION_INDEXATION_ASSET_INCREASE, PAYMENT, PREPAID, PROVISIONING, RECLASSIFICATION_ASSET_TRANSFER, RECLASSIFICATION_NON_ASSET_TRANSFER, TERMINATION_ASSET, TERMINATION_CLOSED_LEDGER, TERMINATION_LIABILITY, TERMINATION_ROUNDING, URV, VOUCHER |
postExternalType |
POST, SKIP |
postingTransactionType |
POST, REVERSE |
postingType |
ACCRUAL, CHARGE, DEPRECIATION, 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, nan |
taxCalculationType |
NET |
translationDateType |
DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE, nan |
Delete Ledger Transactions By Application Reference Ids¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/application-references/{transactionType}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transactionType |
path |
string |
true |
none |
body |
body |
array[string] |
true |
none |
Body Parameters
1[
2 "string"
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Ledger Transactions By Application Reference Id¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/application-reference/{transactionType}/{applicationReferenceId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transactionType |
path |
string |
true |
none |
applicationReferenceId |
path |
string |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Ledger Transactions By Activation Group¶
HTTP Request
POST /api/v1/general-ledger/ledger-transactions/activation-group/{transactionType}/{revisionId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
transactionType |
path |
string |
true |
none |
revisionId |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string"
4}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get By Id¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
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 "parallelCurrencyEnabled": true,
13 "generateInvoiceInAp": true,
14 "generateVendorInvoice": true,
15 "calculateTax": true,
16 "taxCalculationType": "NET",
17 "currencyDetail": {
18 "currencyId": 0,
19 "currencyDisplayId": "string",
20 "currencyDefinitionType": "CONTRACT_CURRENCY",
21 "currencyType": "string"
22 },
23 "classificationInfo": {
24 "accountingStandard": {
25 "id": 0,
26 "displayId": "string"
27 },
28 "leaseClassificationType": "NON_LEASE"
29 },
30 "date": {
31 "documentDate": "2019-08-24T14:15:22Z",
32 "userDocumentDate": "2019-08-24",
33 "postingDate": "2019-08-24",
34 "transactionDate": "2019-08-24",
35 "translationDate": "2019-08-24",
36 "fiscalVariantId": 0,
37 "fiscalVariantDisplayId": "string",
38 "calendarType": "REGULAR_CALENDAR",
39 "fiscalYear": 0,
40 "fiscalPeriod": 0
41 },
42 "automaticReversal": {
43 "id": 0,
44 "postingDate": "2019-08-24",
45 "documentDate": "2019-08-24",
46 "reversalReason": {
47 "id": 0,
48 "displayId": "string"
49 }
50 },
51 "trace": {
52 "previousLedgerTransactionId": 0,
53 "nextLedgerTransactionId": 0,
54 "postExternalType": "SKIP"
55 },
56 "fosReferences": {
57 "id": 0,
58 "system": {
59 "id": 0,
60 "displayId": "string"
61 },
62 "company": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "leaseArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "leaseGroup": {
71 "id": 0,
72 "displayId": "string"
73 },
74 "leaseDepartment": {
75 "id": 0,
76 "displayId": "string"
77 },
78 "businessUnit": {
79 "id": 0,
80 "displayId": "string"
81 },
82 "mainCostCenter": {
83 "id": 0,
84 "displayId": "string"
85 },
86 "internalAssetClass": {
87 "id": 0,
88 "displayId": "string"
89 },
90 "documentType": {
91 "id": 0,
92 "displayId": "string"
93 },
94 "depreciationArea": {
95 "id": 0,
96 "displayId": "string"
97 },
98 "reversalReason": {
99 "id": 0,
100 "displayId": "string"
101 },
102 "tradingPartner": {
103 "id": 0,
104 "displayId": "string"
105 },
106 "allocationNumber": {
107 "id": 0,
108 "displayId": "string"
109 },
110 "responsibleCostCenter": {
111 "id": 0,
112 "displayId": "string"
113 },
114 "workBreakdownStructure": {
115 "id": 0,
116 "displayId": "string"
117 },
118 "businessArea": {
119 "id": 0,
120 "displayId": "string"
121 },
122 "functionalArea": {
123 "id": 0,
124 "displayId": "string"
125 },
126 "plant": {
127 "id": 0,
128 "displayId": "string"
129 },
130 "internalOrder": {
131 "id": 0,
132 "displayId": "string"
133 },
134 "network": {
135 "id": 0,
136 "displayId": "string"
137 },
138 "paymentTerm": {
139 "id": 0,
140 "displayId": "string"
141 },
142 "paymentBlock": {
143 "id": 0,
144 "displayId": "string"
145 },
146 "paymentMethod": {
147 "id": 0,
148 "displayId": "string",
149 "type": "string"
150 },
151 "segment": {
152 "id": 0,
153 "displayId": "string"
154 },
155 "purchasingOrganization": {
156 "id": 0,
157 "displayId": "string"
158 },
159 "purchasingOrder": {
160 "id": 0,
161 "displayId": "string"
162 },
163 "ledgerTransactionId": 0
164 },
165 "assetRegisterReferences": {
166 "id": 0,
167 "asset": {
168 "assetId": 0,
169 "assetDisplayId": "string",
170 "assetNumber": "string",
171 "subAssetNumber": "string"
172 },
173 "ledgerTransactionId": 0
174 },
175 "nlaReferences": {
176 "id": 0,
177 "contract": {
178 "id": 0,
179 "displayId": "string"
180 },
181 "leaseComponent": {
182 "id": 0,
183 "displayId": "string"
184 },
185 "activationGroup": {
186 "id": 0,
187 "displayId": "string"
188 },
189 "unit": {
190 "id": 0,
191 "displayId": "string"
192 },
193 "contractExternalId": "string",
194 "journalId": 0,
195 "activationGroupRevisionId": 0,
196 "ledgerTransactionId": 0
197 },
198 "nlaCustomReferences": [
199 {
200 "key": "string",
201 "dataType": "STRING",
202 "value": 0
203 }
204 ],
205 "nreReferences": {
206 "id": 0,
207 "premise": {
208 "id": 0,
209 "displayId": "string"
210 },
211 "location": {
212 "id": 0,
213 "displayId": "string"
214 },
215 "lease": {
216 "id": 0,
217 "displayId": "string"
218 },
219 "ledgerTransactionId": 0
220 },
221 "nreCustomReferences": [
222 {
223 "key": "string",
224 "dataType": "STRING",
225 "value": 0
226 }
227 ],
228 "apReferences": {
229 "id": 0,
230 "invoice": {
231 "id": 0,
232 "displayId": "string"
233 },
234 "ledgerTransactionId": 0
235 },
236 "apCustomReferences": [
237 {
238 "key": "string",
239 "dataType": "STRING",
240 "value": 0
241 }
242 ],
243 "entries": [
244 {
245 "id": 0,
246 "entryType": "D",
247 "amount": 0,
248 "unroundedAmount": 0,
249 "deltaAdjustment": 0,
250 "itemText": "string",
251 "itemNoAcc": 0,
252 "generalLedger": {
253 "id": 0,
254 "displayId": "string",
255 "generalLedgerAccountName": "string",
256 "generalLedgerAccountCode": "string",
257 "openItemManagement": true,
258 "accountCategory": "BALANCESHEET",
259 "shortName": "string",
260 "longName": "string"
261 },
262 "additionalCurrencyEntries": [
263 {
264 "id": 0,
265 "amount": 0,
266 "unroundedAmount": 0,
267 "deltaAdjustment": 0,
268 "itemNoAcc": 0,
269 "currencyDetail": {
270 "currencyId": 0,
271 "currencyDisplayId": "string",
272 "currencyDefinitionType": "CONTRACT_CURRENCY",
273 "currencyType": "string"
274 },
275 "currencyConversionDetail": {
276 "rate": 0,
277 "conversionDate": "2019-08-24",
278 "translationDateType": "DOCUMENT_DATE",
279 "sourceCurrencyType": "CONTRACT_CURRENCY",
280 "sourceCurrency": {
281 "id": 0,
282 "displayId": "string"
283 },
284 "depreciationArea": {
285 "id": 0,
286 "displayId": "string"
287 }
288 },
289 "ledgerEntryId": 0,
290 "ledgerEntryTaxId": 0
291 }
292 ],
293 "tag": "string",
294 "costCenter": {
295 "id": 0,
296 "displayId": "string",
297 "mainCostCenter": true,
298 "allocationPercentage": 0.1
299 },
300 "profitCenter": {
301 "id": 0,
302 "displayId": "string"
303 },
304 "vendor": {
305 "id": 0,
306 "displayId": "string"
307 },
308 "transactionType": "string",
309 "nlaCustomReferences": [
310 {
311 "key": "string",
312 "dataType": "STRING",
313 "value": 0
314 }
315 ],
316 "nreCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "apCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "taxEntries": [
331 {
332 "id": 0,
333 "entryType": "D",
334 "amount": 0,
335 "unroundedAmount": 0,
336 "deltaAdjustment": 0,
337 "itemText": "string",
338 "itemNoAcc": 0,
339 "generalLedger": {
340 "id": 0,
341 "displayId": "string",
342 "generalLedgerAccountName": "string",
343 "generalLedgerAccountCode": "string",
344 "openItemManagement": true,
345 "accountCategory": "BALANCESHEET",
346 "shortName": "string",
347 "longName": "string"
348 },
349 "additionalCurrencyEntries": [
350 {
351 "id": 0,
352 "amount": 0,
353 "unroundedAmount": 0,
354 "deltaAdjustment": 0,
355 "itemNoAcc": 0,
356 "currencyDetail": {
357 "currencyId": 0,
358 "currencyDisplayId": "string",
359 "currencyDefinitionType": "CONTRACT_CURRENCY",
360 "currencyType": "string"
361 },
362 "currencyConversionDetail": {
363 "rate": 0,
364 "conversionDate": "2019-08-24",
365 "translationDateType": "DOCUMENT_DATE",
366 "sourceCurrencyType": "CONTRACT_CURRENCY",
367 "sourceCurrency": {
368 "id": 0,
369 "displayId": "string"
370 },
371 "depreciationArea": {
372 "id": 0,
373 "displayId": "string"
374 }
375 },
376 "ledgerEntryId": 0,
377 "ledgerEntryTaxId": 0
378 }
379 ],
380 "taxRate": 0,
381 "taxBaseAmount": 0,
382 "totalTaxDocumentAmount": 0,
383 "taxExempt": 0,
384 "taxExemptionPercentage": 0,
385 "taxAffected": 0,
386 "taxAccount": "string",
387 "accountingKey": "string",
388 "conditionKey": "string",
389 "taxCode": {
390 "id": 0,
391 "displayId": "string"
392 },
393 "taxJurisdiction": {
394 "id": 0,
395 "displayId": "string"
396 },
397 "taxDetermination": {
398 "id": 0,
399 "displayId": "string"
400 },
401 "financialTermId": 0,
402 "ledgerEntryId": 0
403 }
404 ],
405 "ledgerTransactionId": 0
406 }
407 ],
408 "notes": [
409 {
410 "id": 0,
411 "note": "string"
412 }
413 ],
414 "attachments": [
415 {
416 "id": 0,
417 "fileName": "string",
418 "fileStorageId": "string",
419 "docStoreId": 0
420 }
421 ],
422 "journalVoucherWorkflowHistory": [
423 {
424 "id": 0,
425 "eventType": "SEND_TO_APPROVAL",
426 "eventDate": "2019-08-24T14:15:22Z",
427 "user": "string"
428 }
429 ],
430 "ledgerTransactionGroupId": 0,
431 "accountingDocumentId": 0,
432 "internalPostingStatus": {
433 "documentNumber": "string",
434 "status": "NA",
435 "postingMessage": "string"
436 },
437 "nlaEnrichmentState": {
438 "id": 0,
439 "status": "PENDING",
440 "message": "string",
441 "history": [
442 {
443 "requestingUser": "string",
444 "enrichmentRequestId": 0,
445 "requestedAt": "2019-08-24T14:15:22Z",
446 "enrichedAt": "2019-08-24T14:15:22Z",
447 "requestStatus": "SENT",
448 "applicationStatus": "PENDING",
449 "message": "string"
450 }
451 ]
452 },
453 "nreEnrichmentState": {
454 "id": 0,
455 "status": "PENDING",
456 "message": "string",
457 "history": [
458 {
459 "requestingUser": "string",
460 "enrichmentRequestId": 0,
461 "requestedAt": "2019-08-24T14:15:22Z",
462 "enrichedAt": "2019-08-24T14:15:22Z",
463 "requestStatus": "SENT",
464 "applicationStatus": "PENDING",
465 "message": "string"
466 }
467 ]
468 },
469 "apEnrichmentState": {
470 "id": 0,
471 "status": "PENDING",
472 "message": "string",
473 "history": [
474 {
475 "requestingUser": "string",
476 "enrichmentRequestId": 0,
477 "requestedAt": "2019-08-24T14:15:22Z",
478 "enrichedAt": "2019-08-24T14:15:22Z",
479 "requestStatus": "SENT",
480 "applicationStatus": "PENDING",
481 "message": "string"
482 }
483 ]
484 },
485 "externalPostingStatus": {
486 "documentNumber": "string",
487 "objType": "string",
488 "objKey": "string",
489 "objSys": "string",
490 "username": "string",
491 "status": "NA",
492 "postingMessage": "string",
493 "taskId": 0
494 }
495}
Get Group By Id¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/group/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
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 "parallelCurrencyEnabled": true,
18 "generateInvoiceInAp": true,
19 "generateVendorInvoice": true,
20 "calculateTax": true,
21 "taxCalculationType": "NET",
22 "currencyDetail": {
23 "currencyId": 0,
24 "currencyDisplayId": "string",
25 "currencyDefinitionType": "CONTRACT_CURRENCY",
26 "currencyType": "string"
27 },
28 "classificationInfo": {
29 "accountingStandard": {
30 "id": 0,
31 "displayId": "string"
32 },
33 "leaseClassificationType": "NON_LEASE"
34 },
35 "date": {
36 "documentDate": "2019-08-24T14:15:22Z",
37 "userDocumentDate": "2019-08-24",
38 "postingDate": "2019-08-24",
39 "transactionDate": "2019-08-24",
40 "translationDate": "2019-08-24",
41 "fiscalVariantId": 0,
42 "fiscalVariantDisplayId": "string",
43 "calendarType": "REGULAR_CALENDAR",
44 "fiscalYear": 0,
45 "fiscalPeriod": 0
46 },
47 "automaticReversal": {
48 "id": 0,
49 "postingDate": "2019-08-24",
50 "documentDate": "2019-08-24",
51 "reversalReason": {
52 "id": 0,
53 "displayId": "string"
54 }
55 },
56 "trace": {
57 "previousLedgerTransactionId": 0,
58 "nextLedgerTransactionId": 0,
59 "postExternalType": "SKIP"
60 },
61 "fosReferences": {
62 "id": 0,
63 "system": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "company": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "leaseArea": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "leaseGroup": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "leaseDepartment": {
80 "id": 0,
81 "displayId": "string"
82 },
83 "businessUnit": {
84 "id": 0,
85 "displayId": "string"
86 },
87 "mainCostCenter": {
88 "id": 0,
89 "displayId": "string"
90 },
91 "internalAssetClass": {
92 "id": 0,
93 "displayId": "string"
94 },
95 "documentType": {
96 "id": 0,
97 "displayId": "string"
98 },
99 "depreciationArea": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "reversalReason": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "tradingPartner": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "allocationNumber": {
112 "id": 0,
113 "displayId": "string"
114 },
115 "responsibleCostCenter": {
116 "id": 0,
117 "displayId": "string"
118 },
119 "workBreakdownStructure": {
120 "id": 0,
121 "displayId": "string"
122 },
123 "businessArea": {
124 "id": 0,
125 "displayId": "string"
126 },
127 "functionalArea": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "plant": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "internalOrder": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "network": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "paymentTerm": {
144 "id": 0,
145 "displayId": "string"
146 },
147 "paymentBlock": {
148 "id": 0,
149 "displayId": "string"
150 },
151 "paymentMethod": {
152 "id": 0,
153 "displayId": "string",
154 "type": "string"
155 },
156 "segment": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "purchasingOrganization": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "purchasingOrder": {
165 "id": 0,
166 "displayId": "string"
167 },
168 "ledgerTransactionId": 0
169 },
170 "assetRegisterReferences": {
171 "id": 0,
172 "asset": {
173 "assetId": 0,
174 "assetDisplayId": "string",
175 "assetNumber": "string",
176 "subAssetNumber": "string"
177 },
178 "ledgerTransactionId": 0
179 },
180 "nlaReferences": {
181 "id": 0,
182 "contract": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "leaseComponent": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "activationGroup": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "unit": {
195 "id": 0,
196 "displayId": "string"
197 },
198 "contractExternalId": "string",
199 "journalId": 0,
200 "activationGroupRevisionId": 0,
201 "ledgerTransactionId": 0
202 },
203 "nlaCustomReferences": [
204 {
205 "key": "string",
206 "dataType": "STRING",
207 "value": 0
208 }
209 ],
210 "nreReferences": {
211 "id": 0,
212 "premise": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "location": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "lease": {
221 "id": 0,
222 "displayId": "string"
223 },
224 "ledgerTransactionId": 0
225 },
226 "nreCustomReferences": [
227 {
228 "key": "string",
229 "dataType": "STRING",
230 "value": 0
231 }
232 ],
233 "apReferences": {
234 "id": 0,
235 "invoice": {
236 "id": 0,
237 "displayId": "string"
238 },
239 "ledgerTransactionId": 0
240 },
241 "apCustomReferences": [
242 {
243 "key": "string",
244 "dataType": "STRING",
245 "value": 0
246 }
247 ],
248 "entries": [
249 {
250 "id": 0,
251 "entryType": "D",
252 "amount": 0,
253 "unroundedAmount": 0,
254 "deltaAdjustment": 0,
255 "itemText": "string",
256 "itemNoAcc": 0,
257 "generalLedger": {
258 "id": 0,
259 "displayId": "string",
260 "generalLedgerAccountName": "string",
261 "generalLedgerAccountCode": "string",
262 "openItemManagement": true,
263 "accountCategory": "BALANCESHEET",
264 "shortName": "string",
265 "longName": "string"
266 },
267 "additionalCurrencyEntries": [
268 {
269 "id": 0,
270 "amount": 0,
271 "unroundedAmount": 0,
272 "deltaAdjustment": 0,
273 "itemNoAcc": 0,
274 "currencyDetail": {
275 "currencyId": 0,
276 "currencyDisplayId": "string",
277 "currencyDefinitionType": "CONTRACT_CURRENCY",
278 "currencyType": "string"
279 },
280 "currencyConversionDetail": {
281 "rate": 0,
282 "conversionDate": "2019-08-24",
283 "translationDateType": "DOCUMENT_DATE",
284 "sourceCurrencyType": "CONTRACT_CURRENCY",
285 "sourceCurrency": {
286 "id": 0,
287 "displayId": "string"
288 },
289 "depreciationArea": {
290 "id": 0,
291 "displayId": "string"
292 }
293 },
294 "ledgerEntryId": 0,
295 "ledgerEntryTaxId": 0
296 }
297 ],
298 "tag": "string",
299 "costCenter": {
300 "id": 0,
301 "displayId": "string",
302 "mainCostCenter": true,
303 "allocationPercentage": 0.1
304 },
305 "profitCenter": {
306 "id": 0,
307 "displayId": "string"
308 },
309 "vendor": {
310 "id": 0,
311 "displayId": "string"
312 },
313 "transactionType": "string",
314 "nlaCustomReferences": [
315 {
316 "key": "string",
317 "dataType": "STRING",
318 "value": 0
319 }
320 ],
321 "nreCustomReferences": [
322 {
323 "key": "string",
324 "dataType": "STRING",
325 "value": 0
326 }
327 ],
328 "apCustomReferences": [
329 {
330 "key": "string",
331 "dataType": "STRING",
332 "value": 0
333 }
334 ],
335 "taxEntries": [
336 {
337 "id": 0,
338 "entryType": "D",
339 "amount": 0,
340 "unroundedAmount": 0,
341 "deltaAdjustment": 0,
342 "itemText": "string",
343 "itemNoAcc": 0,
344 "generalLedger": {
345 "id": 0,
346 "displayId": "string",
347 "generalLedgerAccountName": "string",
348 "generalLedgerAccountCode": "string",
349 "openItemManagement": true,
350 "accountCategory": "BALANCESHEET",
351 "shortName": "string",
352 "longName": "string"
353 },
354 "additionalCurrencyEntries": [
355 {
356 "id": 0,
357 "amount": 0,
358 "unroundedAmount": 0,
359 "deltaAdjustment": 0,
360 "itemNoAcc": 0,
361 "currencyDetail": {
362 "currencyId": 0,
363 "currencyDisplayId": "string",
364 "currencyDefinitionType": "CONTRACT_CURRENCY",
365 "currencyType": "string"
366 },
367 "currencyConversionDetail": {
368 "rate": 0,
369 "conversionDate": "2019-08-24",
370 "translationDateType": "DOCUMENT_DATE",
371 "sourceCurrencyType": "CONTRACT_CURRENCY",
372 "sourceCurrency": {},
373 "depreciationArea": {}
374 },
375 "ledgerEntryId": 0,
376 "ledgerEntryTaxId": 0
377 }
378 ],
379 "taxRate": 0,
380 "taxBaseAmount": 0,
381 "totalTaxDocumentAmount": 0,
382 "taxExempt": 0,
383 "taxExemptionPercentage": 0,
384 "taxAffected": 0,
385 "taxAccount": "string",
386 "accountingKey": "string",
387 "conditionKey": "string",
388 "taxCode": {
389 "id": 0,
390 "displayId": "string"
391 },
392 "taxJurisdiction": {
393 "id": 0,
394 "displayId": "string"
395 },
396 "taxDetermination": {
397 "id": 0,
398 "displayId": "string"
399 },
400 "financialTermId": 0,
401 "ledgerEntryId": 0
402 }
403 ],
404 "ledgerTransactionId": 0
405 }
406 ],
407 "notes": [
408 {
409 "id": 0,
410 "note": "string"
411 }
412 ],
413 "attachments": [
414 {
415 "id": 0,
416 "fileName": "string",
417 "fileStorageId": "string",
418 "docStoreId": 0
419 }
420 ],
421 "journalVoucherWorkflowHistory": [
422 {
423 "id": 0,
424 "eventType": "SEND_TO_APPROVAL",
425 "eventDate": "2019-08-24T14:15:22Z",
426 "user": "string"
427 }
428 ],
429 "ledgerTransactionGroupId": 0,
430 "accountingDocumentId": 0,
431 "internalPostingStatus": {
432 "documentNumber": "string",
433 "status": "NA",
434 "postingMessage": "string"
435 },
436 "nlaEnrichmentState": {
437 "id": 0,
438 "status": "PENDING",
439 "message": "string",
440 "history": [
441 {
442 "requestingUser": "string",
443 "enrichmentRequestId": 0,
444 "requestedAt": "2019-08-24T14:15:22Z",
445 "enrichedAt": "2019-08-24T14:15:22Z",
446 "requestStatus": "SENT",
447 "applicationStatus": "PENDING",
448 "message": "string"
449 }
450 ]
451 },
452 "nreEnrichmentState": {
453 "id": 0,
454 "status": "PENDING",
455 "message": "string",
456 "history": [
457 {
458 "requestingUser": "string",
459 "enrichmentRequestId": 0,
460 "requestedAt": "2019-08-24T14:15:22Z",
461 "enrichedAt": "2019-08-24T14:15:22Z",
462 "requestStatus": "SENT",
463 "applicationStatus": "PENDING",
464 "message": "string"
465 }
466 ]
467 },
468 "apEnrichmentState": {
469 "id": 0,
470 "status": "PENDING",
471 "message": "string",
472 "history": [
473 {
474 "requestingUser": "string",
475 "enrichmentRequestId": 0,
476 "requestedAt": "2019-08-24T14:15:22Z",
477 "enrichedAt": "2019-08-24T14:15:22Z",
478 "requestStatus": "SENT",
479 "applicationStatus": "PENDING",
480 "message": "string"
481 }
482 ]
483 },
484 "externalPostingStatus": {
485 "documentNumber": "string",
486 "objType": "string",
487 "objKey": "string",
488 "objSys": "string",
489 "username": "string",
490 "status": "NA",
491 "postingMessage": "string",
492 "taskId": 0
493 }
494 }
495 ]
496}
Get Latest Ledger Transaction By Application Reference Id¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/application-reference/{applicationReferenceId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
applicationReferenceId |
path |
string |
true |
none |
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 "parallelCurrencyEnabled": true,
13 "generateInvoiceInAp": true,
14 "generateVendorInvoice": true,
15 "calculateTax": true,
16 "taxCalculationType": "NET",
17 "currencyDetail": {
18 "currencyId": 0,
19 "currencyDisplayId": "string",
20 "currencyDefinitionType": "CONTRACT_CURRENCY",
21 "currencyType": "string"
22 },
23 "classificationInfo": {
24 "accountingStandard": {
25 "id": 0,
26 "displayId": "string"
27 },
28 "leaseClassificationType": "NON_LEASE"
29 },
30 "date": {
31 "documentDate": "2019-08-24T14:15:22Z",
32 "userDocumentDate": "2019-08-24",
33 "postingDate": "2019-08-24",
34 "transactionDate": "2019-08-24",
35 "translationDate": "2019-08-24",
36 "fiscalVariantId": 0,
37 "fiscalVariantDisplayId": "string",
38 "calendarType": "REGULAR_CALENDAR",
39 "fiscalYear": 0,
40 "fiscalPeriod": 0
41 },
42 "automaticReversal": {
43 "id": 0,
44 "postingDate": "2019-08-24",
45 "documentDate": "2019-08-24",
46 "reversalReason": {
47 "id": 0,
48 "displayId": "string"
49 }
50 },
51 "trace": {
52 "previousLedgerTransactionId": 0,
53 "nextLedgerTransactionId": 0,
54 "postExternalType": "SKIP"
55 },
56 "fosReferences": {
57 "id": 0,
58 "system": {
59 "id": 0,
60 "displayId": "string"
61 },
62 "company": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "leaseArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "leaseGroup": {
71 "id": 0,
72 "displayId": "string"
73 },
74 "leaseDepartment": {
75 "id": 0,
76 "displayId": "string"
77 },
78 "businessUnit": {
79 "id": 0,
80 "displayId": "string"
81 },
82 "mainCostCenter": {
83 "id": 0,
84 "displayId": "string"
85 },
86 "internalAssetClass": {
87 "id": 0,
88 "displayId": "string"
89 },
90 "documentType": {
91 "id": 0,
92 "displayId": "string"
93 },
94 "depreciationArea": {
95 "id": 0,
96 "displayId": "string"
97 },
98 "reversalReason": {
99 "id": 0,
100 "displayId": "string"
101 },
102 "tradingPartner": {
103 "id": 0,
104 "displayId": "string"
105 },
106 "allocationNumber": {
107 "id": 0,
108 "displayId": "string"
109 },
110 "responsibleCostCenter": {
111 "id": 0,
112 "displayId": "string"
113 },
114 "workBreakdownStructure": {
115 "id": 0,
116 "displayId": "string"
117 },
118 "businessArea": {
119 "id": 0,
120 "displayId": "string"
121 },
122 "functionalArea": {
123 "id": 0,
124 "displayId": "string"
125 },
126 "plant": {
127 "id": 0,
128 "displayId": "string"
129 },
130 "internalOrder": {
131 "id": 0,
132 "displayId": "string"
133 },
134 "network": {
135 "id": 0,
136 "displayId": "string"
137 },
138 "paymentTerm": {
139 "id": 0,
140 "displayId": "string"
141 },
142 "paymentBlock": {
143 "id": 0,
144 "displayId": "string"
145 },
146 "paymentMethod": {
147 "id": 0,
148 "displayId": "string",
149 "type": "string"
150 },
151 "segment": {
152 "id": 0,
153 "displayId": "string"
154 },
155 "purchasingOrganization": {
156 "id": 0,
157 "displayId": "string"
158 },
159 "purchasingOrder": {
160 "id": 0,
161 "displayId": "string"
162 },
163 "ledgerTransactionId": 0
164 },
165 "assetRegisterReferences": {
166 "id": 0,
167 "asset": {
168 "assetId": 0,
169 "assetDisplayId": "string",
170 "assetNumber": "string",
171 "subAssetNumber": "string"
172 },
173 "ledgerTransactionId": 0
174 },
175 "nlaReferences": {
176 "id": 0,
177 "contract": {
178 "id": 0,
179 "displayId": "string"
180 },
181 "leaseComponent": {
182 "id": 0,
183 "displayId": "string"
184 },
185 "activationGroup": {
186 "id": 0,
187 "displayId": "string"
188 },
189 "unit": {
190 "id": 0,
191 "displayId": "string"
192 },
193 "contractExternalId": "string",
194 "journalId": 0,
195 "activationGroupRevisionId": 0,
196 "ledgerTransactionId": 0
197 },
198 "nlaCustomReferences": [
199 {
200 "key": "string",
201 "dataType": "STRING",
202 "value": 0
203 }
204 ],
205 "nreReferences": {
206 "id": 0,
207 "premise": {
208 "id": 0,
209 "displayId": "string"
210 },
211 "location": {
212 "id": 0,
213 "displayId": "string"
214 },
215 "lease": {
216 "id": 0,
217 "displayId": "string"
218 },
219 "ledgerTransactionId": 0
220 },
221 "nreCustomReferences": [
222 {
223 "key": "string",
224 "dataType": "STRING",
225 "value": 0
226 }
227 ],
228 "apReferences": {
229 "id": 0,
230 "invoice": {
231 "id": 0,
232 "displayId": "string"
233 },
234 "ledgerTransactionId": 0
235 },
236 "apCustomReferences": [
237 {
238 "key": "string",
239 "dataType": "STRING",
240 "value": 0
241 }
242 ],
243 "entries": [
244 {
245 "id": 0,
246 "entryType": "D",
247 "amount": 0,
248 "unroundedAmount": 0,
249 "deltaAdjustment": 0,
250 "itemText": "string",
251 "itemNoAcc": 0,
252 "generalLedger": {
253 "id": 0,
254 "displayId": "string",
255 "generalLedgerAccountName": "string",
256 "generalLedgerAccountCode": "string",
257 "openItemManagement": true,
258 "accountCategory": "BALANCESHEET",
259 "shortName": "string",
260 "longName": "string"
261 },
262 "additionalCurrencyEntries": [
263 {
264 "id": 0,
265 "amount": 0,
266 "unroundedAmount": 0,
267 "deltaAdjustment": 0,
268 "itemNoAcc": 0,
269 "currencyDetail": {
270 "currencyId": 0,
271 "currencyDisplayId": "string",
272 "currencyDefinitionType": "CONTRACT_CURRENCY",
273 "currencyType": "string"
274 },
275 "currencyConversionDetail": {
276 "rate": 0,
277 "conversionDate": "2019-08-24",
278 "translationDateType": "DOCUMENT_DATE",
279 "sourceCurrencyType": "CONTRACT_CURRENCY",
280 "sourceCurrency": {
281 "id": 0,
282 "displayId": "string"
283 },
284 "depreciationArea": {
285 "id": 0,
286 "displayId": "string"
287 }
288 },
289 "ledgerEntryId": 0,
290 "ledgerEntryTaxId": 0
291 }
292 ],
293 "tag": "string",
294 "costCenter": {
295 "id": 0,
296 "displayId": "string",
297 "mainCostCenter": true,
298 "allocationPercentage": 0.1
299 },
300 "profitCenter": {
301 "id": 0,
302 "displayId": "string"
303 },
304 "vendor": {
305 "id": 0,
306 "displayId": "string"
307 },
308 "transactionType": "string",
309 "nlaCustomReferences": [
310 {
311 "key": "string",
312 "dataType": "STRING",
313 "value": 0
314 }
315 ],
316 "nreCustomReferences": [
317 {
318 "key": "string",
319 "dataType": "STRING",
320 "value": 0
321 }
322 ],
323 "apCustomReferences": [
324 {
325 "key": "string",
326 "dataType": "STRING",
327 "value": 0
328 }
329 ],
330 "taxEntries": [
331 {
332 "id": 0,
333 "entryType": "D",
334 "amount": 0,
335 "unroundedAmount": 0,
336 "deltaAdjustment": 0,
337 "itemText": "string",
338 "itemNoAcc": 0,
339 "generalLedger": {
340 "id": 0,
341 "displayId": "string",
342 "generalLedgerAccountName": "string",
343 "generalLedgerAccountCode": "string",
344 "openItemManagement": true,
345 "accountCategory": "BALANCESHEET",
346 "shortName": "string",
347 "longName": "string"
348 },
349 "additionalCurrencyEntries": [
350 {
351 "id": 0,
352 "amount": 0,
353 "unroundedAmount": 0,
354 "deltaAdjustment": 0,
355 "itemNoAcc": 0,
356 "currencyDetail": {
357 "currencyId": 0,
358 "currencyDisplayId": "string",
359 "currencyDefinitionType": "CONTRACT_CURRENCY",
360 "currencyType": "string"
361 },
362 "currencyConversionDetail": {
363 "rate": 0,
364 "conversionDate": "2019-08-24",
365 "translationDateType": "DOCUMENT_DATE",
366 "sourceCurrencyType": "CONTRACT_CURRENCY",
367 "sourceCurrency": {
368 "id": 0,
369 "displayId": "string"
370 },
371 "depreciationArea": {
372 "id": 0,
373 "displayId": "string"
374 }
375 },
376 "ledgerEntryId": 0,
377 "ledgerEntryTaxId": 0
378 }
379 ],
380 "taxRate": 0,
381 "taxBaseAmount": 0,
382 "totalTaxDocumentAmount": 0,
383 "taxExempt": 0,
384 "taxExemptionPercentage": 0,
385 "taxAffected": 0,
386 "taxAccount": "string",
387 "accountingKey": "string",
388 "conditionKey": "string",
389 "taxCode": {
390 "id": 0,
391 "displayId": "string"
392 },
393 "taxJurisdiction": {
394 "id": 0,
395 "displayId": "string"
396 },
397 "taxDetermination": {
398 "id": 0,
399 "displayId": "string"
400 },
401 "financialTermId": 0,
402 "ledgerEntryId": 0
403 }
404 ],
405 "ledgerTransactionId": 0
406 }
407 ],
408 "notes": [
409 {
410 "id": 0,
411 "note": "string"
412 }
413 ],
414 "attachments": [
415 {
416 "id": 0,
417 "fileName": "string",
418 "fileStorageId": "string",
419 "docStoreId": 0
420 }
421 ],
422 "journalVoucherWorkflowHistory": [
423 {
424 "id": 0,
425 "eventType": "SEND_TO_APPROVAL",
426 "eventDate": "2019-08-24T14:15:22Z",
427 "user": "string"
428 }
429 ],
430 "ledgerTransactionGroupId": 0,
431 "accountingDocumentId": 0,
432 "internalPostingStatus": {
433 "documentNumber": "string",
434 "status": "NA",
435 "postingMessage": "string"
436 },
437 "nlaEnrichmentState": {
438 "id": 0,
439 "status": "PENDING",
440 "message": "string",
441 "history": [
442 {
443 "requestingUser": "string",
444 "enrichmentRequestId": 0,
445 "requestedAt": "2019-08-24T14:15:22Z",
446 "enrichedAt": "2019-08-24T14:15:22Z",
447 "requestStatus": "SENT",
448 "applicationStatus": "PENDING",
449 "message": "string"
450 }
451 ]
452 },
453 "nreEnrichmentState": {
454 "id": 0,
455 "status": "PENDING",
456 "message": "string",
457 "history": [
458 {
459 "requestingUser": "string",
460 "enrichmentRequestId": 0,
461 "requestedAt": "2019-08-24T14:15:22Z",
462 "enrichedAt": "2019-08-24T14:15:22Z",
463 "requestStatus": "SENT",
464 "applicationStatus": "PENDING",
465 "message": "string"
466 }
467 ]
468 },
469 "apEnrichmentState": {
470 "id": 0,
471 "status": "PENDING",
472 "message": "string",
473 "history": [
474 {
475 "requestingUser": "string",
476 "enrichmentRequestId": 0,
477 "requestedAt": "2019-08-24T14:15:22Z",
478 "enrichedAt": "2019-08-24T14:15:22Z",
479 "requestStatus": "SENT",
480 "applicationStatus": "PENDING",
481 "message": "string"
482 }
483 ]
484 },
485 "externalPostingStatus": {
486 "documentNumber": "string",
487 "objType": "string",
488 "objKey": "string",
489 "objSys": "string",
490 "username": "string",
491 "status": "NA",
492 "postingMessage": "string",
493 "taskId": 0
494 }
495}
Account Balance Report¶
HTTP Request
GET /api/v1/general-ledger/ledger-transactions/account-balance
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 |
none |
|
» accountId |
integer(int64) |
false |
none |
none |
» accountDisplayId |
string |
false |
none |
none |
» accountCode |
string |
false |
none |
none |
» debitBalance |
number |
false |
none |
none |
» creditBalance |
number |
false |
none |
none |
» accountCategory |
string |
false |
none |
none |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |