Skip to main content

apHistoricalDataForwardByGroup

Forward-period expansion paginated by group. pageSize = max groups (branch, account, subaccount, currency, supplier). Each group is expanded from its first period with activity up to periodsUpTo (or, when omitted, the current open financial period, or the latest defined period when the calendar does not cover the current date), following the company's financial calendar. hasActivity marks the periods that have an ERP history row; a carried period repeats the last ending balances with revaluedGainLoss 0 and shares the id of the row it is carried from. With updatedInDataMart, only groups that have a row updated after that date are returned, each expanded from its earliest changed period. Read lastGroupKey and hasMore from the response; pass lastGroupKey back for the next page.

apHistoricalDataForwardByGroup(
lastGroupKey: String
updatedInDataMart: DateTime
pageSize: Int! = 1000
periodsUpTo: String
): APHistoricalDataForwardPage!

Arguments​

apHistoricalDataForwardByGroup.lastGroupKey ● String scalar​

Pagination cursor for the AP history forward query. Format: 'ap1:branchId_accountId_subaccountId_currencyId_supplierId'. Pass the lastGroupKey from the previous page to get the next page. Cursors from other queries use a different group key and are rejected.

apHistoricalDataForwardByGroup.updatedInDataMart ● DateTime scalar​

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

apHistoricalDataForwardByGroup.pageSize ● Int! non-null scalar​

Maximum number of groups to return

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

Type​

APHistoricalDataForwardPage object​

A page of expanded AP history periods with a group-based pagination cursor.