Skip to main content

generalLedgerBalancesByPeriodV2

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. Gets the latest GeneralLedgerBalance at or before a given finPeriodId, one row per (ledgerId, branchId, accountId, subaccountId) group. Replaces generalLedgerBalancesByPeriod: paginates on the group key rather than the document id, so page cost no longer scales with the company's total dataset, and parallel ledgers are reported separately instead of being collapsed into a single row. Read lastGroupKey and hasMore from the response; pass lastGroupKey back for the next page.

generalLedgerBalancesByPeriodV2(
  finPeriodId: String!
  accountId: Int
  subaccountId: Int
  lastGroupKey: String
  updatedInDataMart: DateTime
  updatedInDataMartTo: DateTime
  pageSize: Int! = 1000
  toggleBalanceSign: Boolean! = false
  includeDeleted: Boolean! = false
): GeneralLedgerBalanceGroupPage! @deprecated

Arguments​

generalLedgerBalancesByPeriodV2.finPeriodId ● String! non-null scalar​

Financial period identifier (inclusive upper bound)

generalLedgerBalancesByPeriodV2.accountId ● Int scalar​

Account identifier

generalLedgerBalancesByPeriodV2.subaccountId ● Int scalar​

Subaccount identifier

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

generalLedgerBalancesByPeriodV2.updatedInDataMart ● DateTime scalar​

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

generalLedgerBalancesByPeriodV2.updatedInDataMartTo ● DateTime scalar​

DateTime upper bound for when the document was updated in DataMart (logic used: less than); pairs with updatedInDataMart (greater than)

generalLedgerBalancesByPeriodV2.pageSize ● Int! non-null scalar​

Maximum number of groups to return

generalLedgerBalancesByPeriodV2.toggleBalanceSign ● Boolean! non-null scalar​

If set to true, the balance sign will be toggled

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