Skip to main content

generalLedgerBalancesByPeriod

DEPRECATED

Superseded by generalLedgerBalancesByPeriodV2. This version pages on the document id, which forces the backend to re-group the company's whole balance set on every page, and it omits ledgerId from the grouping, so parallel ledgers are silently collapsed into a single row with an arbitrary winner. When switching: V2 paginates on lastGroupKey and returns a page object rather than a list; it returns one row per (ledgerId, branchId, accountId, subaccountId) group, so expect more rows on a multi-ledger company and key rows on the whole group rather than on ledgerId alone; and pageSize counts groups rather than documents, defaulting to 1000 rather than 5000, so send an explicit pageSize if you rely on the default.

Gets the latest GeneralLedgerBalance before a given finPeriodId for the specified account and subaccount; if accountId/subaccountId are not provided, one per combination is returned

generalLedgerBalancesByPeriod(
  finPeriodId: String!
  accountId: Int
  subaccountId: Int
  lastId: String
  updatedInDataMart: DateTime
  updatedInDataMartTo: DateTime
  pageSize: Int! = 5000
  toggleBalanceSign: Boolean! = false
): [GeneralLedgerBalance!]! @deprecated

Arguments​

generalLedgerBalancesByPeriod.finPeriodId ● String! non-null scalar​

Financial period identifier (inclusive upper bound)

generalLedgerBalancesByPeriod.accountId ● Int scalar​

Account identifier

generalLedgerBalancesByPeriod.subaccountId ● Int scalar​

Subaccount identifier

generalLedgerBalancesByPeriod.lastId ● String scalar​

Id to be used to get the next page (logic used: greater than)

generalLedgerBalancesByPeriod.updatedInDataMart ● DateTime scalar​

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

generalLedgerBalancesByPeriod.updatedInDataMartTo ● DateTime scalar​

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

generalLedgerBalancesByPeriod.pageSize ● Int! non-null scalar​

Maximum page size is 5000

generalLedgerBalancesByPeriod.toggleBalanceSign ● Boolean! non-null scalar​

If set to true, the balance sign will be toggled

Type​

GeneralLedgerBalance object​

GeneralLedgerBalances. Represents the balance of a general ledger account for a specific period.