Skip to main content

generalLedgerBalancesForwardByGroup

DEPRECATED

Superseded by generalLedgerBalancesForwardByGroupV2. This version applies its cursor after grouping, so every page re-groups the whole remainder of the company and a full crawl costs O(n^2) in dataset size. When switching: the lastGroupKey format differs, so restart the crawl from the first page; and pageSize defaults to 1000 on V2 rather than 100, so send an explicit pageSize if you rely on the default.

EXPERIMENTAL – DO NOT USE IN PRODUCTION. Subject to breaking changes or removal. Forward-period expansion paginated by group. pageSize = max groups. 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.

generalLedgerBalancesForwardByGroup(
  lastGroupKey: String
  updatedInDataMart: DateTime
  pageSize: Int! = 100
  periodsUpTo: String
  toggleBalanceSign: Boolean! = false
  includeDeleted: Boolean! = false
): GeneralLedgerBalanceForwardPage! @deprecated

Arguments​

generalLedgerBalancesForwardByGroup.lastGroupKey ● String scalar​

Pagination cursor for group-based queries. Format: 'branchId_accountId_subaccountId_ledgerId'. Pass the lastGroupKey from the previous page to get the next page.

generalLedgerBalancesForwardByGroup.updatedInDataMart ● DateTime scalar​

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

generalLedgerBalancesForwardByGroup.pageSize ● Int! non-null scalar​

Maximum number of groups to return

generalLedgerBalancesForwardByGroup.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.

generalLedgerBalancesForwardByGroup.toggleBalanceSign ● Boolean! non-null scalar​

If set to true, the balance sign will be toggled

generalLedgerBalancesForwardByGroup.includeDeleted ● Boolean! non-null scalar​

IF set to true then returns also the deleted items

Type​

GeneralLedgerBalanceForwardPage object​

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