Skip to main content

generalLedgerBalancesForwardByGroupV2

DEPRECATED

EXPERIMENTAL – Work in progress. This query may change or be removed without notice. Do not use in production.

EXPERIMENTAL – DO NOT USE IN PRODUCTION. Subject to breaking changes or removal. Forward-period expansion paginated by group. pageSize = max groups. Replaces generalLedgerBalancesForwardByGroup: pages on a cursor the database can seek, so page cost no longer scales with the company's total dataset. Each group is fully expanded with virtual periods up to periodsUpTo (or, when omitted, the current open financial period, or to the latest defined period when the calendar does not cover the current date), following the company's financial calendar. Read lastGroupKey and hasMore from the response; pass lastGroupKey back for the next page. Cursors from the deprecated generalLedgerBalancesForwardByGroup are rejected - start the crawl from the first page.

generalLedgerBalancesForwardByGroupV2(
  lastGroupKey: String
  updatedInDataMart: DateTime
  pageSize: Int! = 1000
  periodsUpTo: String
  toggleBalanceSign: Boolean! = false
  includeDeleted: Boolean! = false
): GeneralLedgerBalanceGroupPage! @deprecated

Arguments​

generalLedgerBalancesForwardByGroupV2.lastGroupKey ● String scalar​

Pagination cursor for group-based queries. Format: 'v2:ledgerId_branchId_accountId_subaccountId'. Pass the lastGroupKey from the previous page to get the next page. Cursors from the non-V2 query use a different group order and are rejected.

generalLedgerBalancesForwardByGroupV2.updatedInDataMart ● DateTime scalar​

DateTime when the document was updated in DataMart (logic used: greater than)

generalLedgerBalancesForwardByGroupV2.pageSize ● Int! non-null scalar​

Maximum number of groups to return

generalLedgerBalancesForwardByGroupV2.periodsUpTo ● String scalar​

Upper-bound financial period (yyyyMM) for forward expansion; must exist in the company's financial calendar. When not provided, defaults to the current open financial period, or to the latest defined period when the calendar does not cover the current date.

generalLedgerBalancesForwardByGroupV2.toggleBalanceSign ● Boolean! non-null scalar​

If set to true, the balance sign will be toggled

generalLedgerBalancesForwardByGroupV2.includeDeleted ● Boolean! non-null scalar​

IF set to true then returns also the deleted items

Type​

GeneralLedgerBalanceGroupPage object​

A page of GeneralLedgerBalance documents with a group-based pagination cursor.