Month End Balances

Month End Balances - Search Ledger Transactions

HTTP Request

POST /api/v1/general-ledger/period-end-closure/search-ledger-transactions

📋 Description: Submits a request to search for ledger transactions within the general ledger, enabling users to filter and retrieve specific financial records related to ledger entries and accounts at period-end closure.

Parameters

Name

In

Type

Required

Description

body

body

object

true

Request body containing the parameters for searching ledger transactions, including account identifiers and date ranges, essential for accurate financial record management.

» searchRequest

body

PeriodEndClosureLedgerTransactionSearchRequest

false

Data transfer object representing a request to search for ledger transactions related to period-end closures, facilitating the retrieval of financial records associated with specific accounts and transactions in the General Ledger.

»» idIn

body

[integer]

false

Filter by multiple values of id

»» idLike

body

string

false

Filter by partial match of id

»» accountingDocumentIdIn

body

[integer]

false

Filter by multiple values of accounting document id

»» accountingDocumentIdLike

body

string

false

Filter by partial match of accounting document id

»» ledgerTypeIn

body

[string]

false

Filter by multiple values of ledger type

»» ledgerTypeEqual

body

string

false

Filter by exact match of ledger type

»» documentDateEqual

body

string(date)

false

Filter by exact match of document date

»» postingDateEqual

body

string(date)

false

Filter by exact match of posting date

»» companyIdIn

body

[integer]

false

Filter by multiple values of company id

»» companySearchTerm

body

string

false

Search term used to filter ledger entries and transactions based on the associated company name within financial records.

»» accountingStandardIdEqual

body

integer(int64)

false

Filter by exact match of accounting standard id

»» from

body

PeriodEndClosureFiscalYearPeriod

false

Data structure representing the closure of fiscal year periods within the General Ledger, encapsulating essential details for ledger entries, transactions, and financial records to ensure accurate financial reporting and compliance.

»»» fiscalYear

body

integer(int32)

false

Numeric value representing fiscalYear

»»» fiscalPeriod

body

integer(int32)

false

Numeric value representing fiscalPeriod

»» to

body

PeriodEndClosureFiscalYearPeriod

false

Data structure representing the closure of fiscal year periods within the General Ledger, encapsulating essential details for ledger entries, transactions, and financial records to ensure accurate financial reporting and compliance.

»» enrichmentStatusIn

body

[string]

false

Filter by multiple values of enrichment status

»» postingTransactionTypeEqual

body

string

false

Filter by exact match of posting transaction type

»» internalPostingStatusIn

body

[string]

false

Filter by multiple values of internal posting status

»» internalPostingStatusEqual

body

string

false

Filter by exact match of internal posting status

»» externalPostingStatusIn

body

[string]

false

Filter by multiple values of external posting status

»» externalPostingStatusEqual

body

string

false

Filter by exact match of external posting status

»» internalDocumentNumberLike

body

string

false

Filter by partial match of internal document number

»» externalDocumentNumberLike

body

string

false

Filter by partial match of external document number

»» generalLedgerAccountIdIn

body

[integer]

false

Filter by multiple values of general ledger account id

»» generalLedgerAccountSearchTerm

body

string

false

Search term used to identify specific general ledger accounts within ledger entries and financial records.

» pageable

body

Pageable

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

»» enrichmentStatusIn

ENRICHED, ENRICHING, FAILED, PENDING, SKIPPED

»» externalPostingStatusEqual

, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED

»» externalPostingStatusIn

, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED

»» internalPostingStatusEqual

, ARCHIVED, DONE, FAILED, OPEN, PROCESSING, SCHEDULED

»» internalPostingStatusIn

, 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

»» ledgerTypeIn

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

»» postingTransactionTypeEqual

POST, REVERSE

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "idIn": [
 4      0
 5    ],
 6    "idLike": "string",
 7    "accountingDocumentIdIn": [
 8      0
 9    ],
10    "accountingDocumentIdLike": "string",
11    "ledgerTypeIn": [
12      "LIABILITY"
13    ],
14    "ledgerTypeEqual": "LIABILITY",
15    "documentDateEqual": "2019-08-24",
16    "postingDateEqual": "2019-08-24",
17    "companyIdIn": [
18      0
19    ],
20    "companySearchTerm": "string",
21    "accountingStandardIdEqual": 0,
22    "from": {
23      "fiscalYear": 0,
24      "fiscalPeriod": 0
25    },
26    "to": {
27      "fiscalYear": 0,
28      "fiscalPeriod": 0
29    },
30    "enrichmentStatusIn": [
31      "PENDING"
32    ],
33    "postingTransactionTypeEqual": "POST",
34    "internalPostingStatusIn": [
35      "NA"
36    ],
37    "internalPostingStatusEqual": "NA",
38    "externalPostingStatusIn": [
39      "NA"
40    ],
41    "externalPostingStatusEqual": "NA",
42    "internalDocumentNumberLike": "string",
43    "externalDocumentNumberLike": "string",
44    "generalLedgerAccountIdIn": [
45      0
46    ],
47    "generalLedgerAccountSearchTerm": "string"
48  },
49  "pageable": {
50    "page": 0,
51    "size": 1,
52    "sort": [
53      "string"
54    ]
55  }
56}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLedgerTransactionInfo

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}

Month End Balances - Search Period Balances Contract Currency

HTTP Request

POST /api/v1/general-ledger/period-end-closure/search-balances-contract-currency

📋 Description: Submits a request to search for balances in the general ledger by contract currency, facilitating the review of financial records and ledger entries associated with specific transactions and accounts during the period-end closure process.

Parameters

Name

In

Type

Required

Description

body

body

object

true

Request body containing the financial record parameters necessary for searching balances by contract currency within the general ledger, including relevant account and transaction details.

» searchRequest

body

PeriodBalancesContractCurrencySearchRequest

false

Data transfer object representing a request to search for period balances in a specific contract currency within the General Ledger, facilitating the retrieval of ledger entries, transactions, and financial records associated with accounts.

»» companyIdIn

body

[integer]

false

Filter by multiple values of company id

»» companySearchTerm

body

string

false

Search term used to filter and identify specific company-related ledger entries, transactions, or financial records within the General Ledger.

»» fiscalVariantIdIn

body

[integer]

false

Filter by multiple values of fiscal variant id

»» companyCurrencyIdIn

body

[integer]

false

Filter by multiple values of company currency id

»» from

body

PeriodEndClosureFiscalYearPeriod

false

Data structure representing the closure of fiscal year periods within the General Ledger, encapsulating essential details for ledger entries, transactions, and financial records to ensure accurate financial reporting and compliance.

»»» fiscalYear

body

integer(int32)

false

Numeric value representing fiscalYear

»»» fiscalPeriod

body

integer(int32)

false

Numeric value representing fiscalPeriod

»» to

body

PeriodEndClosureFiscalYearPeriod

false

Data structure representing the closure of fiscal year periods within the General Ledger, encapsulating essential details for ledger entries, transactions, and financial records to ensure accurate financial reporting and compliance.

»» generalLedgerAccountIdIn

body

[integer]

false

Filter by multiple values of general ledger account id

»» generalLedgerAccountSearchTerm

body

string

false

Search term used to identify specific general ledger accounts within ledger entries, transactions, or financial records.

»» generalLedgerAccountCategoryEqual

body

string

false

Filter by exact match of general ledger account category

»» contractCurrencyIdIn

body

[integer]

false

Filter by multiple values of contract currency id

»» contractCurrencySearchTerm

body

string

false

Search term for identifying contract currencies within ledger entries, transactions, accounts, and financial records.

» pageable

body

Pageable

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

»» generalLedgerAccountCategoryEqual

BALANCESHEET, PROFITANDLOSS

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "companyIdIn": [
 4      0
 5    ],
 6    "companySearchTerm": "string",
 7    "fiscalVariantIdIn": [
 8      0
 9    ],
10    "companyCurrencyIdIn": [
11      0
12    ],
13    "from": {
14      "fiscalYear": 0,
15      "fiscalPeriod": 0
16    },
17    "to": {
18      "fiscalYear": 0,
19      "fiscalPeriod": 0
20    },
21    "generalLedgerAccountIdIn": [
22      0
23    ],
24    "generalLedgerAccountSearchTerm": "string",
25    "generalLedgerAccountCategoryEqual": "BALANCESHEET",
26    "contractCurrencyIdIn": [
27      0
28    ],
29    "contractCurrencySearchTerm": "string"
30  },
31  "pageable": {
32    "page": 0,
33    "size": 1,
34    "sort": [
35      "string"
36    ]
37  }
38}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePeriodBalancesContractCurrencyDto

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      "contractCurrency": {
22        "id": 0,
23        "displayId": "string",
24        "status": "CREATED",
25        "name": "string",
26        "decimalPoints": 0
27      },
28      "amounts": {
29        "openingBalance": 0,
30        "debitedAmounts": 0,
31        "creditedAmounts": 0,
32        "closingBalance": 0
33      },
34      "periodBalancesCompanyCurrency": {
35        "id": 0,
36        "company": {
37          "id": 0,
38          "displayId": "string",
39          "status": "CREATED",
40          "erpSystemId": 0,
41          "erpSystemDisplayId": "string",
42          "countryId": 0,
43          "countryDisplayId": "string",
44          "name": "string",
45          "postingPeriodVariantId": 0,
46          "fiscalVariantId": 0
47        },
48        "generalLedgerAccount": {
49          "id": 0,
50          "displayId": "string",
51          "status": "CREATED",
52          "erpSystemId": 0,
53          "erpSystemDisplayId": "string",
54          "shortName": "string",
55          "longName": "string",
56          "accountCategory": "BALANCESHEET",
57          "accountTarget": "ALL"
58        },
59        "fiscalYear": 0,
60        "fiscalPeriod": 0,
61        "amounts": {
62          "openingBalance": 0,
63          "debitedAmounts": 0,
64          "creditedAmounts": 0,
65          "closingBalance": 0
66        },
67        "companyCurrency": {
68          "id": 0,
69          "displayId": "string",
70          "status": "CREATED",
71          "name": "string",
72          "decimalPoints": 0
73        },
74        "fiscalVariant": {
75          "id": 0,
76          "displayId": "string",
77          "status": "CREATED",
78          "isCalendarYear": true,
79          "yearDependent": true,
80          "erpSystemDisplayId": "string",
81          "isErpSystemDefault": true
82        },
83        "openForPosting": true
84      }
85    }
86  ],
87  "number": 0,
88  "sort": {
89    "unsorted": true,
90    "sorted": true,
91    "empty": true
92  },
93  "first": true,
94  "last": true,
95  "empty": true
96}

Month End Balances - Search Period Balances Company Currency

HTTP Request

POST /api/v1/general-ledger/period-end-closure/search-balances-company-currency

📋 Description: Submits a request to search for balances in the general ledger by company and currency, facilitating the review of ledger entries and financial records during the period-end closure process.

Parameters

Name

In

Type

Required

Description

body

body

object

true

Request body containing the criteria for searching balances by company and currency within the general ledger, including relevant ledger entries and financial records.

» searchRequest

body

PeriodBalancesCompanyCurrencySearchRequest

false

Data transfer object representing a request to retrieve period balances in the company’s currency, facilitating the analysis of ledger entries, transactions, and financial records within the General Ledger.

»» companyIdIn

body

[integer]

false

Filter by multiple values of company id

»» companySearchTerm

body

string

false

Search term used to identify specific companies within ledger entries, transactions, or financial records in the General Ledger.

»» fiscalVariantIdIn

body

[integer]

false

Filter by multiple values of fiscal variant id

»» companyCurrencyIdIn

body

[integer]

false

Filter by multiple values of company currency id

»» from

body

PeriodEndClosureFiscalYearPeriod

false

Data structure representing the closure of fiscal year periods within the General Ledger, encapsulating essential details for ledger entries, transactions, and financial records to ensure accurate financial reporting and compliance.

»»» fiscalYear

body

integer(int32)

false

Numeric value representing fiscalYear

»»» fiscalPeriod

body

integer(int32)

false

Numeric value representing fiscalPeriod

»» to

body

PeriodEndClosureFiscalYearPeriod

false

Data structure representing the closure of fiscal year periods within the General Ledger, encapsulating essential details for ledger entries, transactions, and financial records to ensure accurate financial reporting and compliance.

»» generalLedgerAccountIdIn

body

[integer]

false

Filter by multiple values of general ledger account id

»» generalLedgerAccountSearchTerm

body

string

false

Search term used to identify specific general ledger accounts within ledger entries, transactions, and financial records.

»» generalLedgerAccountCategoryEqual

body

string

false

Filter by exact match of general ledger account category

» pageable

body

Pageable

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

»» generalLedgerAccountCategoryEqual

BALANCESHEET, PROFITANDLOSS

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "companyIdIn": [
 4      0
 5    ],
 6    "companySearchTerm": "string",
 7    "fiscalVariantIdIn": [
 8      0
 9    ],
10    "companyCurrencyIdIn": [
11      0
12    ],
13    "from": {
14      "fiscalYear": 0,
15      "fiscalPeriod": 0
16    },
17    "to": {
18      "fiscalYear": 0,
19      "fiscalPeriod": 0
20    },
21    "generalLedgerAccountIdIn": [
22      0
23    ],
24    "generalLedgerAccountSearchTerm": "string",
25    "generalLedgerAccountCategoryEqual": "BALANCESHEET"
26  },
27  "pageable": {
28    "page": 0,
29    "size": 1,
30    "sort": [
31      "string"
32    ]
33  }
34}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePeriodBalancesCompanyCurrencyDto

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      "company": {
22        "id": 0,
23        "displayId": "string",
24        "status": "CREATED",
25        "erpSystemId": 0,
26        "erpSystemDisplayId": "string",
27        "countryId": 0,
28        "countryDisplayId": "string",
29        "name": "string",
30        "postingPeriodVariantId": 0,
31        "fiscalVariantId": 0
32      },
33      "generalLedgerAccount": {
34        "id": 0,
35        "displayId": "string",
36        "status": "CREATED",
37        "erpSystemId": 0,
38        "erpSystemDisplayId": "string",
39        "shortName": "string",
40        "longName": "string",
41        "accountCategory": "BALANCESHEET",
42        "accountTarget": "ALL"
43      },
44      "fiscalYear": 0,
45      "fiscalPeriod": 0,
46      "amounts": {
47        "openingBalance": 0,
48        "debitedAmounts": 0,
49        "creditedAmounts": 0,
50        "closingBalance": 0
51      },
52      "companyCurrency": {
53        "id": 0,
54        "displayId": "string",
55        "status": "CREATED",
56        "name": "string",
57        "decimalPoints": 0
58      },
59      "fiscalVariant": {
60        "id": 0,
61        "displayId": "string",
62        "status": "CREATED",
63        "isCalendarYear": true,
64        "yearDependent": true,
65        "erpSystemDisplayId": "string",
66        "isErpSystemDefault": true
67      },
68      "openForPosting": true
69    }
70  ],
71  "number": 0,
72  "sort": {
73    "unsorted": true,
74    "sorted": true,
75    "empty": true
76  },
77  "first": true,
78  "last": true,
79  "empty": true
80}

Month End Balances - Clean Daily And Period End Balances

HTTP Request

POST /api/v1/general-ledger/period-end-closure/clean-daily-and-period-end-balances

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Month End Balances - Calculate Period Balances

HTTP Request

POST /api/v1/general-ledger/period-end-closure/calculate-period-balances

📋 Description: Calculates the period-end balances for ledger entries by aggregating transactions and updating financial records for the specified accounting period in the General Ledger. This operation ensures accurate financial reporting and compliance with accounting standards.

Parameters

Name

In

Type

Required

Description

body

body

PeriodBalancesCalculationRequest

true

Request body containing the financial records, including ledger entries and transaction details, necessary for calculating period balances in the general ledger.

Body Parameters

1{
2  "companyIds": [
3    0
4  ],
5  "targetFiscalYear": 0,
6  "targetFiscalPeriod": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PeriodBalancesCalculationJobDto

Example Responses

 1{
 2  "id": 0,
 3  "taskCount": 0,
 4  "failedTaskCount": 0,
 5  "doneTaskCount": 0,
 6  "inProgressTaskCount": 0,
 7  "cancelledTaskCount": 0,
 8  "errorMessage": "string",
 9  "status": "CREATED",
10  "companies": [
11    {
12      "id": 0,
13      "displayId": "string",
14      "status": "CREATED",
15      "erpSystemId": 0,
16      "erpSystemDisplayId": "string",
17      "countryId": 0,
18      "countryDisplayId": "string",
19      "name": "string",
20      "postingPeriodVariantId": 0,
21      "fiscalVariantId": 0
22    }
23  ],
24  "targetFiscalYear": 0,
25  "targetFiscalPeriod": 0
26}

Month End Balances - Calculate Daily Balances

HTTP Request

POST /api/v1/general-ledger/period-end-closure/calculate-daily-balances

📋 Description: Calculates daily balances for ledger entries by processing transactions within the specified accounting period, ensuring accurate financial records for the General Ledger.

Parameters

Name

In

Type

Required

Description

body

body

DailyBalancesCalculationRequest

true

Request body containing the ledger entry data required to calculate daily balances for transactions and accounts within the financial record.

Body Parameters

1{
2  "companyIds": [
3    0
4  ],
5  "targetFiscalYear": 0,
6  "targetFiscalPeriod": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

NonCalculatedDailyBalancesActionableTask

Example Responses

1{
2  "totalNumberOfLedgerTransactions": 0,
3  "nonCalculatedLedgerTransactions": 0,
4  "dailyBalancesCalculationStatus": "CREATED",
5  "triggerredBy": "string",
6  "triggerredAt": "2019-08-24T14:15:22Z"
7}

Month End Balances - Fetch Period End Closure Navigation Data

HTTP Request

GET /api/v1/general-ledger/period-end-closure/fetch-navigation-data

📋 Description: Fetches navigation data for period-end closure in the General Ledger, providing essential information related to ledger entries, transactions, accounts, and financial records to facilitate efficient financial reporting.

Parameters

Name

In

Type

Required

Description

companyId

query

integer(int64)

true

Unique identifier for the company

fiscalYear

query

integer(int32)

true

Specifies the fiscal year for which navigation data related to ledger entries, transactions, and financial records is being requested.

fiscalPeriod

query

integer(int32)

true

Specifies the fiscal period for which navigation data related to ledger entries, transactions, accounts, and financial records is being retrieved.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PeriodEndClosureNavigationData

Example Responses

 1{
 2  "previousPeriod": {
 3    "id": 0,
 4    "displayId": "string",
 5    "status": "CREATED",
 6    "day": 0,
 7    "year": 0,
 8    "month": 0,
 9    "postingPeriod": 0,
10    "yearShift": 0,
11    "periodStartDate": "2019-08-24",
12    "periodEndDate": "2019-08-24"
13  },
14  "nextPeriod": {
15    "id": 0,
16    "displayId": "string",
17    "status": "CREATED",
18    "day": 0,
19    "year": 0,
20    "month": 0,
21    "postingPeriod": 0,
22    "yearShift": 0,
23    "periodStartDate": "2019-08-24",
24    "periodEndDate": "2019-08-24"
25  }
26}

Month End Balances - Fetch Available Fiscal Years And Periods

HTTP Request

GET /api/v1/general-ledger/period-end-closure/fetch-available-fiscal-years-periods

📋 Description: Fetches a list of available fiscal years and their corresponding periods for period-end closure in the General Ledger, enabling users to manage ledger entries and financial records effectively.

Parameters

Name

In

Type

Required

Description

companyId

query

integer(int64)

true

Unique identifier for the company

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  {
3    "fiscalYear": 0,
4    "firstFiscalPeriod": 0,
5    "lastFiscalPeriod": 0
6  }
7]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[PeriodEndClosureAvailableFiscalYearAndPeriod]

false

none

[Data transfer object representing the available fiscal year and period for period-end closure in the General Ledger, facilitating accurate ledger entry and transaction management within financial records.]

» fiscalYear

integer(int32)

false

none

Numeric value representing fiscalYear

» firstFiscalPeriod

integer(int32)

false

none

Numeric value representing firstFiscalPeriod

» lastFiscalPeriod

integer(int32)

false

none

Numeric value representing lastFiscalPeriod

Month End Balances - Download Report To Excel

HTTP Request

GET /api/v1/general-ledger/period-end-closure/download-trial-balances-report

📋 Description: Downloads the trial balances report for period-end closure in the General Ledger, providing a comprehensive overview of ledger entries, transactions, and account balances essential for financial record assessment.

Parameters

Name

In

Type

Required

Description

companyId

query

integer(int64)

false

Unique identifier for the company

fiscalYear

query

integer(int32)

false

Specifies the fiscal year for which the trial balances report is generated, ensuring accurate financial record representation in the general ledger.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Month End Balances - Fetch Non Posted Externally Ledger Transactions Actionable Task

HTTP Request

GET /api/v1/general-ledger/period-end-closure/actionable-tasks/non-posted-externally-ledger-transactions

📋 Description: Retrieves actionable tasks related to non-posted externally ledger transactions within the General Ledger, enabling users to efficiently manage and review outstanding ledger entries and financial records.

Parameters

Name

In

Type

Required

Description

companyId

query

integer(int64)

true

Unique identifier for the company

fiscalYear

query

integer(int32)

true

Specifies the fiscal year for which non-posted externally ledger transactions are retrieved, ensuring accurate alignment with financial records and ledger entries.

fiscalPeriod

query

integer(int32)

true

Specifies the fiscal period for retrieving actionable tasks related to non-posted externally ledger transactions within the general ledger.

Responses

Status

Meaning

Description

Schema

200

OK

OK

NonPostedExternallyLedgerTransactionsActionableTask

Example Responses

1{
2  "numberOfNonPostedExternallyLedgerTransactions": 0
3}

Month End Balances - Fetch Non Enriched Ledger Transactions Actionable Task

HTTP Request

GET /api/v1/general-ledger/period-end-closure/actionable-tasks/non-enriched-ledger-transactions

📋 Description: Retrieves actionable tasks related to non-enriched ledger transactions within the General Ledger, enabling users to identify and address outstanding ledger entries and financial records efficiently.

Parameters

Name

In

Type

Required

Description

companyId

query

integer(int64)

true

Unique identifier for the company

fiscalYear

query

integer(int32)

true

Specifies the fiscal year for which non-enriched ledger transactions are retrieved, facilitating accurate financial record management and analysis within the general ledger.

fiscalPeriod

query

integer(int32)

true

Specifies the fiscal period for which actionable tasks related to non-enriched ledger transactions are retrieved from the general ledger.

Responses

Status

Meaning

Description

Schema

200

OK

OK

NonEnrichedLedgerTransactionsActionableTask

Example Responses

1{
2  "numberOfNonEnrichedLedgerTransactions": 0
3}

Month End Balances - Fetch Non Calculated Daily Balances Actionable Task

HTTP Request

GET /api/v1/general-ledger/period-end-closure/actionable-tasks/non-calculated-daily-balances

📋 Description: Retrieves actionable tasks related to non-calculated daily balances within the general ledger, facilitating the management of ledger entries and ensuring accurate financial record maintenance. This operation supports users in identifying necessary transactions for period-end closure activities.

Parameters

Name

In

Type

Required

Description

companyId

query

integer(int64)

false

Unique identifier for the company

fiscalYear

query

integer(int32)

false

Specifies the fiscal year for which non-calculated daily balances are retrieved from the general ledger, facilitating accurate financial record analysis and transaction management.

fiscalPeriod

query

integer(int32)

false

Specifies the fiscal period for which non-calculated daily balances are retrieved, facilitating accurate ledger entries and financial record management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

NonCalculatedDailyBalancesActionableTask

Example Responses

1{
2  "totalNumberOfLedgerTransactions": 0,
3  "nonCalculatedLedgerTransactions": 0,
4  "dailyBalancesCalculationStatus": "CREATED",
5  "triggerredBy": "string",
6  "triggerredAt": "2019-08-24T14:15:22Z"
7}

Month End Balances - Fetch Dirty Period Balances Actionable Task

HTTP Request

GET /api/v1/general-ledger/period-end-closure/actionable-tasks/dirty-period-balances

📋 Description: Retrieves actionable tasks related to dirty period balances in the general ledger, enabling users to identify and address discrepancies in ledger entries and financial records for accurate transaction management.

Parameters

Name

In

Type

Required

Description

companyId

query

integer(int64)

true

Unique identifier for the company

fiscalYear

query

integer(int32)

false

Specifies the fiscal year for which the dirty period balances are retrieved, ensuring accurate alignment with ledger entries and financial records.

fiscalPeriod

query

integer(int32)

false

Specifies the fiscal period for which dirty period balances are retrieved in the general ledger, facilitating accurate ledger entry and financial record management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

DirtyPeriodBalancesActionableTask

Example Responses

 1{
 2  "earliest": {
 3    "fiscalYear": 0,
 4    "fiscalPeriod": 0
 5  },
 6  "latest": {
 7    "fiscalYear": 0,
 8    "fiscalPeriod": 0
 9  },
10  "runningOrLastSuccessfulJob": {
11    "id": 0,
12    "taskCount": 0,
13    "failedTaskCount": 0,
14    "doneTaskCount": 0,
15    "inProgressTaskCount": 0,
16    "cancelledTaskCount": 0,
17    "errorMessage": "string",
18    "status": "CREATED",
19    "companies": [
20      {
21        "id": 0,
22        "displayId": "string",
23        "status": "CREATED",
24        "erpSystemId": 0,
25        "erpSystemDisplayId": "string",
26        "countryId": 0,
27        "countryDisplayId": "string",
28        "name": "string",
29        "postingPeriodVariantId": 0,
30        "fiscalVariantId": 0
31      }
32    ],
33    "targetFiscalYear": 0,
34    "targetFiscalPeriod": 0
35  },
36  "fiscalPeriodLastSuccessfulJob": {
37    "id": 0,
38    "taskCount": 0,
39    "failedTaskCount": 0,
40    "doneTaskCount": 0,
41    "inProgressTaskCount": 0,
42    "cancelledTaskCount": 0,
43    "errorMessage": "string",
44    "status": "CREATED",
45    "companies": [
46      {
47        "id": 0,
48        "displayId": "string",
49        "status": "CREATED",
50        "erpSystemId": 0,
51        "erpSystemDisplayId": "string",
52        "countryId": 0,
53        "countryDisplayId": "string",
54        "name": "string",
55        "postingPeriodVariantId": 0,
56        "fiscalVariantId": 0
57      }
58    ],
59    "targetFiscalYear": 0,
60    "targetFiscalPeriod": 0
61  }
62}