Clarify the purpose and side effects of the Period Summary Process endpoints

I recently implemented against the Financial Edge NXT General Ledger Period Summary endpoints:

  • POST /generalledger/v1/periodsummary/summarize

  • GET /generalledger/v1/periodsummary/processinginfo

  • GET /generalledger/v1/periodsummary/summaries

The documentation currently says the summarize endpoint “must be called first” and that it summarizes a selected fiscal period, but it is not clear what “summarize” means in relation to Financial Edge’s existing General Ledger fiscal year status of “Detail available” vs. “Summarized.”

As an accounting/finance user and developer, this distinction is very important. The endpoint requires fnxt.w, and the word “summarize” suggested that the endpoint might compact or optimize GL detail in the same way the Financial Edge UI describes summarized fiscal years. That made the endpoint feel risky to use, especially for current or detail-available periods.

After testing, it appears that StartPeriodSummaryProcess generates or refreshes API ledger summary rows without changing the fiscal year’s “Detail available” status and without removing transaction detail from either the FE NXT web query UI or the SKY Query API. If that is the intended behavior, it would be extremely helpful for the documentation to say so explicitly.

Suggested documentation improvements:

  1. Explain whether POST /periodsummary/summarize changes Financial Edge transaction detail availability.

  2. Clarify whether it is related to, or separate from, the General Ledger fiscal year status shown in the FE NXT UI.

  3. Explain why the endpoint requires fnxt.w.

  4. State that GET /periodsummary/summaries returns LedgerSummary rows produced by the summary process, not necessarily historical summaries already visible in the FE NXT UI.

  5. Explain that returned LedgerSummary rows may be split by dimensions such as project and transaction codes, so account-level balances must be calculated by aggregating all returned rows for the account/period.

  6. Provide an example workflow for getting an account beginning balance:

    • start the summary process for a specific fiscal period

    • poll processing info until complete

    • list period summaries filtered by account number and fiscal period ID

    • aggregate returned rows to derive the account-level beginning balance, debits, and credits

This would help developers avoid accidentally misusing a write-scoped endpoint, and would make it much clearer that these endpoints are the intended path for retrieving period-level account balances from the API.

  • Guest
  • Jul 7 2026
  • Attach files