@robosystems/client 2.23.0 → 2.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import type { AcceptSuggestionsRequest, AcceptSuggestionsResponse, AllocationOverrideResponse, AssociationResponse, AutoMapElementsOperation, BindTextBlockRequest, BindTextBlockResponse, BlockedSourceGraphResponse, BlockSourceGraphResult, ComputeMetricsRequest, ComputeMetricsResponse, ConsolidationProposal, ConsolidationWorksheetRequest, ConsolidationWorksheetResponse, CreateAgentRequest, CreateDimensionRequest, CreateEntityRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateInformationBlockRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, DimensionResponse, EntityTaxonomyResponse, EvaluateRulesRequest, EvaluateRulesResponse, EventBlockEnvelope, EventHandlerResponse, FinancialStatementAnalysisRequest, FinancialStatementAnalysisResponse, InformationBlockEnvelope, InitializeChartOfAccountsRequest, JournalEntryResponse, LearnClassificationDefaultsResponse, LedgerAgentResponse, LinkBankAccountRequest, LinkBankAccountResponse, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, LiveFinancialStatementResponse, OperationEnvelope, PreviewConsolidationEntriesResponse, PreviewEventBlockResponse, PreviewReconciliationsRequest, PromoteObligationsRequest, PromoteObligationsResponse, ProposeConsolidationEntriesResponse, PublishListMemberResponse, PublishListResponse, ReconcilingItemPlan, RecordOpeningBalanceRequest, ReportResponse, ResolveReconcilingItemRequest, ResolveReconcilingItemResponse, RevokeReportShareResponse, SetAllocationOverrideRequest, ShareReportResponse, TaxonomyBlockEnvelope, UpdateAgentRequest, UpdateDimensionRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateInformationBlockRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest, ViewResponse } from '../types.gen';
2
2
  import type { TokenProvider } from './graphql/client';
3
- import { ListLedgerBankAccountsQuery, type AgedReceivablesQuery, type ClassificationStatsQuery, type DischargeCandidatesQuery, type FlowCandidatesQuery, type GetInformationBlockQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerAgentQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerEventBlockQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportPackageQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListChartTemplatesQuery, type ListInformationBlocksQuery, type ListInformationBlockSummariesQuery, type ListLedgerAccountsQuery, type ListLedgerAgentsQuery, type ListLedgerBlockedSourceGraphsQuery, type ListLedgerDimensionsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerJournalEntriesQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReconciliationsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery, type MappingCandidatesQuery, type OpenItemsForAgentQuery, type ReportDownloadFormat, type ReportLifecycle } from './graphql/generated/graphql';
3
+ import { ListLedgerBankAccountsQuery, type AgedReceivablesQuery, type ClassificationStatsQuery, type DischargeCandidatesQuery, type FlowCandidatesQuery, type GetInformationBlockQuery, type GetLedgerAccountRegisterQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerAgentQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerEventBlockQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportPackageQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListChartTemplatesQuery, type ListInformationBlocksQuery, type ListInformationBlockSummariesQuery, type ListLedgerAccountsQuery, type ListLedgerAgentsQuery, type ListLedgerBlockedSourceGraphsQuery, type ListLedgerDimensionsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerJournalEntriesQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReconciliationsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery, type MappingCandidatesQuery, type OpenItemsForAgentQuery, type ReportDownloadFormat, type ReportLifecycle } from './graphql/generated/graphql';
4
4
  export { GraphQLError } from './graphql/client';
5
5
  export type { ReportLifecycle };
6
6
  export type LedgerEntity = NonNullable<GetLedgerEntityQuery['entity']>;
@@ -13,6 +13,7 @@ export type LedgerAccountRollups = NonNullable<GetLedgerAccountRollupsQuery['acc
13
13
  export type LedgerBankAccountList = NonNullable<ListLedgerBankAccountsQuery['bankAccounts']>;
14
14
  export type LedgerBankAccount = LedgerBankAccountList['accounts'][number];
15
15
  export type LedgerTrialBalance = NonNullable<GetLedgerTrialBalanceQuery['trialBalance']>;
16
+ export type LedgerAccountRegister = NonNullable<GetLedgerAccountRegisterQuery['accountRegister']>;
16
17
  export type LedgerMappedTrialBalance = NonNullable<GetLedgerMappedTrialBalanceQuery['mappedTrialBalance']>;
17
18
  export type LedgerTransactionList = NonNullable<ListLedgerTransactionsQuery['transactions']>;
18
19
  export type LedgerTransactionListItem = LedgerTransactionList['transactions'][number];
@@ -656,6 +657,26 @@ export declare class LedgerClient {
656
657
  memberId: string;
657
658
  } | null;
658
659
  }): Promise<LedgerTrialBalance | null>;
660
+ /**
661
+ * One entity's posted lines on one account, oldest first, each with the
662
+ * balance it leaves, between an opening and a closing balance that agree
663
+ * with the trial balance. An income or expense account opens at the fiscal
664
+ * year's start. `options.after` takes the last page's `nextCursor`;
665
+ * `options.dimension` or `options.flowElementId` reads one slice.
666
+ */
667
+ getAccountRegister(graphId: string, accountId: string, options?: {
668
+ startDate?: string;
669
+ endDate?: string;
670
+ entityId?: string | null;
671
+ dimension?: {
672
+ type: string;
673
+ memberId: string;
674
+ } | null;
675
+ flowElementId?: string | null;
676
+ includeDrafts?: boolean;
677
+ after?: string | null;
678
+ limit?: number | null;
679
+ }): Promise<LedgerAccountRegister | null>;
659
680
  /** Trial balance rolled up to GAAP reporting concepts via a mapping. */
660
681
  getMappedTrialBalance(graphId: string, mappingId: string, options?: {
661
682
  startDate?: string;
@@ -301,6 +301,27 @@ class LedgerClient {
301
301
  dimensionMemberId: options?.dimension?.memberId ?? null,
302
302
  }, 'Get trial balance', (data) => data.trialBalance);
303
303
  }
304
+ /**
305
+ * One entity's posted lines on one account, oldest first, each with the
306
+ * balance it leaves, between an opening and a closing balance that agree
307
+ * with the trial balance. An income or expense account opens at the fiscal
308
+ * year's start. `options.after` takes the last page's `nextCursor`;
309
+ * `options.dimension` or `options.flowElementId` reads one slice.
310
+ */
311
+ async getAccountRegister(graphId, accountId, options) {
312
+ return this.gqlQuery(graphId, graphql_1.GetLedgerAccountRegisterDocument, {
313
+ accountId,
314
+ startDate: options?.startDate ?? null,
315
+ endDate: options?.endDate ?? null,
316
+ entityId: options?.entityId ?? null,
317
+ dimensionType: options?.dimension?.type ?? null,
318
+ dimensionMemberId: options?.dimension?.memberId ?? null,
319
+ flowElementId: options?.flowElementId ?? null,
320
+ includeDrafts: options?.includeDrafts ?? false,
321
+ after: options?.after ?? null,
322
+ limit: options?.limit ?? null,
323
+ }, 'Get account register', (data) => data.accountRegister);
324
+ }
304
325
  /** Trial balance rolled up to GAAP reporting concepts via a mapping. */
305
326
  async getMappedTrialBalance(graphId, mappingId, options) {
306
327
  return this.gqlQuery(graphId, graphql_1.GetLedgerMappedTrialBalanceDocument, {
@@ -207,6 +207,7 @@ import {
207
207
  FlowCandidatesDocument,
208
208
  GetInformationBlockDocument,
209
209
  GetInformationBlockWindowedDocument,
210
+ GetLedgerAccountRegisterDocument,
210
211
  GetLedgerAccountRollupsDocument,
211
212
  GetLedgerAccountTreeDocument,
212
213
  GetLedgerAgentDocument,
@@ -256,6 +257,7 @@ import {
256
257
  type DischargeCandidatesQuery,
257
258
  type FlowCandidatesQuery,
258
259
  type GetInformationBlockQuery,
260
+ type GetLedgerAccountRegisterQuery,
259
261
  type GetLedgerAccountRollupsQuery,
260
262
  type GetLedgerAccountTreeQuery,
261
263
  type GetLedgerAgentQuery,
@@ -327,6 +329,7 @@ export type LedgerBankAccountList = NonNullable<ListLedgerBankAccountsQuery['ban
327
329
  export type LedgerBankAccount = LedgerBankAccountList['accounts'][number]
328
330
 
329
331
  export type LedgerTrialBalance = NonNullable<GetLedgerTrialBalanceQuery['trialBalance']>
332
+ export type LedgerAccountRegister = NonNullable<GetLedgerAccountRegisterQuery['accountRegister']>
330
333
  export type LedgerMappedTrialBalance = NonNullable<
331
334
  GetLedgerMappedTrialBalanceQuery['mappedTrialBalance']
332
335
  >
@@ -1482,6 +1485,47 @@ export class LedgerClient {
1482
1485
  )
1483
1486
  }
1484
1487
 
1488
+ /**
1489
+ * One entity's posted lines on one account, oldest first, each with the
1490
+ * balance it leaves, between an opening and a closing balance that agree
1491
+ * with the trial balance. An income or expense account opens at the fiscal
1492
+ * year's start. `options.after` takes the last page's `nextCursor`;
1493
+ * `options.dimension` or `options.flowElementId` reads one slice.
1494
+ */
1495
+ async getAccountRegister(
1496
+ graphId: string,
1497
+ accountId: string,
1498
+ options?: {
1499
+ startDate?: string
1500
+ endDate?: string
1501
+ entityId?: string | null
1502
+ dimension?: { type: string; memberId: string } | null
1503
+ flowElementId?: string | null
1504
+ includeDrafts?: boolean
1505
+ after?: string | null
1506
+ limit?: number | null
1507
+ }
1508
+ ): Promise<LedgerAccountRegister | null> {
1509
+ return this.gqlQuery(
1510
+ graphId,
1511
+ GetLedgerAccountRegisterDocument,
1512
+ {
1513
+ accountId,
1514
+ startDate: options?.startDate ?? null,
1515
+ endDate: options?.endDate ?? null,
1516
+ entityId: options?.entityId ?? null,
1517
+ dimensionType: options?.dimension?.type ?? null,
1518
+ dimensionMemberId: options?.dimension?.memberId ?? null,
1519
+ flowElementId: options?.flowElementId ?? null,
1520
+ includeDrafts: options?.includeDrafts ?? false,
1521
+ after: options?.after ?? null,
1522
+ limit: options?.limit ?? null,
1523
+ },
1524
+ 'Get account register',
1525
+ (data) => data.accountRegister
1526
+ )
1527
+ }
1528
+
1485
1529
  /** Trial balance rolled up to GAAP reporting concepts via a mapping. */
1486
1530
  async getMappedTrialBalance(
1487
1531
  graphId: string,
@@ -227,6 +227,121 @@ export type GetInvestorSecurityQuery = {
227
227
  updatedAt: string;
228
228
  } | null;
229
229
  };
230
+ export type GetLedgerAccountRegisterQueryVariables = Exact<{
231
+ accountId: string;
232
+ startDate: string | null | undefined;
233
+ endDate: string | null | undefined;
234
+ entityId: string | null | undefined;
235
+ dimensionType: string | null | undefined;
236
+ dimensionMemberId: string | null | undefined;
237
+ flowElementId: string | null | undefined;
238
+ includeDrafts?: boolean;
239
+ after: string | null | undefined;
240
+ limit: number | null | undefined;
241
+ }>;
242
+ export type GetLedgerAccountRegisterQuery = {
243
+ accountRegister: {
244
+ entityId: string | null;
245
+ startDate: string | null;
246
+ endDate: string | null;
247
+ openingFrom: string | null;
248
+ openingBalance: number;
249
+ totalDebits: number;
250
+ totalCredits: number;
251
+ closingBalance: number;
252
+ lineCount: number;
253
+ pageOpeningBalance: number;
254
+ nextCursor: string | null;
255
+ sliced: boolean;
256
+ draftsTruncated: boolean;
257
+ account: {
258
+ id: string;
259
+ code: string | null;
260
+ name: string;
261
+ balanceType: string;
262
+ trait: string | null;
263
+ temporary: boolean;
264
+ };
265
+ lines: Array<{
266
+ lineId: string;
267
+ entryId: string;
268
+ entryNumber: string | null;
269
+ postingDate: string;
270
+ entryType: string;
271
+ provenance: string | null;
272
+ status: string;
273
+ memo: string | null;
274
+ description: string | null;
275
+ debit: number;
276
+ credit: number;
277
+ balance: number | null;
278
+ triggeredByEventId: string | null;
279
+ triggeredByEventType: string | null;
280
+ reversalOf: string | null;
281
+ reversedBy: string | null;
282
+ agentId: string | null;
283
+ agentName: string | null;
284
+ flowElementId: string | null;
285
+ dimensions: Array<{
286
+ id: string;
287
+ dimensionType: string;
288
+ name: string;
289
+ }>;
290
+ }>;
291
+ drafts: Array<{
292
+ lineId: string;
293
+ entryId: string;
294
+ entryNumber: string | null;
295
+ postingDate: string;
296
+ entryType: string;
297
+ provenance: string | null;
298
+ status: string;
299
+ memo: string | null;
300
+ description: string | null;
301
+ debit: number;
302
+ credit: number;
303
+ balance: number | null;
304
+ triggeredByEventId: string | null;
305
+ triggeredByEventType: string | null;
306
+ reversalOf: string | null;
307
+ reversedBy: string | null;
308
+ agentId: string | null;
309
+ agentName: string | null;
310
+ flowElementId: string | null;
311
+ dimensions: Array<{
312
+ id: string;
313
+ dimensionType: string;
314
+ name: string;
315
+ }>;
316
+ }>;
317
+ } | null;
318
+ };
319
+ export type RegisterLineFieldsFragment = {
320
+ lineId: string;
321
+ entryId: string;
322
+ entryNumber: string | null;
323
+ postingDate: string;
324
+ entryType: string;
325
+ provenance: string | null;
326
+ status: string;
327
+ memo: string | null;
328
+ description: string | null;
329
+ debit: number;
330
+ credit: number;
331
+ balance: number | null;
332
+ triggeredByEventId: string | null;
333
+ triggeredByEventType: string | null;
334
+ reversalOf: string | null;
335
+ reversedBy: string | null;
336
+ agentId: string | null;
337
+ agentName: string | null;
338
+ flowElementId: string | null;
339
+ dimensions: Array<{
340
+ id: string;
341
+ dimensionType: string;
342
+ name: string;
343
+ }>;
344
+ };
230
345
  export type GetLedgerAccountRollupsQueryVariables = Exact<{
231
346
  mappingId: string | null | undefined;
232
347
  startDate: string | null | undefined;
@@ -989,6 +1104,27 @@ export type GetLedgerEventBlockQuery = {
989
1104
  documentId: string | null;
990
1105
  createdAt: string;
991
1106
  createdBy: string;
1107
+ triggeredEntries: Array<{
1108
+ id: string;
1109
+ number: string | null;
1110
+ type: string;
1111
+ status: string;
1112
+ postingDate: string;
1113
+ memo: string | null;
1114
+ provenance: string | null;
1115
+ totalDebit: number;
1116
+ totalCredit: number;
1117
+ lineItems: Array<{
1118
+ id: string;
1119
+ accountId: string;
1120
+ accountName: string | null;
1121
+ accountCode: string | null;
1122
+ debitAmount: number;
1123
+ creditAmount: number;
1124
+ description: string | null;
1125
+ lineOrder: number;
1126
+ }>;
1127
+ }>;
992
1128
  } | null;
993
1129
  };
994
1130
  export type ListLedgerEventBlocksQueryVariables = Exact<{
@@ -1153,6 +1289,8 @@ export type GetInformationBlockQuery = {
1153
1289
  unit: string;
1154
1290
  factScope: string;
1155
1291
  factSetId: string | null;
1292
+ provenance: unknown;
1293
+ frozenAt: string | null;
1156
1294
  }>;
1157
1295
  rules: Array<{
1158
1296
  id: string;
@@ -1313,6 +1451,8 @@ export type GetInformationBlockWindowedQuery = {
1313
1451
  unit: string;
1314
1452
  factScope: string;
1315
1453
  factSetId: string | null;
1454
+ provenance: unknown;
1455
+ frozenAt: string | null;
1316
1456
  }>;
1317
1457
  rules: Array<{
1318
1458
  id: string;
@@ -1473,6 +1613,8 @@ export type ListInformationBlocksQuery = {
1473
1613
  unit: string;
1474
1614
  factScope: string;
1475
1615
  factSetId: string | null;
1616
+ provenance: unknown;
1617
+ frozenAt: string | null;
1476
1618
  }>;
1477
1619
  rules: Array<{
1478
1620
  id: string;
@@ -1619,6 +1761,7 @@ export type ListLedgerJournalEntriesQuery = {
1619
1761
  sourceStructureId: string | null;
1620
1762
  sourceStructureName: string | null;
1621
1763
  triggeredByEventId: string | null;
1764
+ triggeredByEventType: string | null;
1622
1765
  reversalOf: string | null;
1623
1766
  postedAt: string | null;
1624
1767
  totalDebit: number;
@@ -2076,6 +2219,8 @@ export type GetLedgerReportPackageQuery = {
2076
2219
  unit: string;
2077
2220
  factScope: string;
2078
2221
  factSetId: string | null;
2222
+ provenance: unknown;
2223
+ frozenAt: string | null;
2079
2224
  }>;
2080
2225
  rules: Array<{
2081
2226
  id: string;
@@ -2698,6 +2843,7 @@ export type GetLibraryTaxonomyQuery = {
2698
2843
  elementCount: number | null;
2699
2844
  } | null;
2700
2845
  };
2846
+ export declare const RegisterLineFieldsFragmentDoc: DocumentNode<RegisterLineFieldsFragment, unknown>;
2701
2847
  export declare const AgingBucketsFieldsFragmentDoc: DocumentNode<AgingBucketsFieldsFragment, unknown>;
2702
2848
  export declare const OpenItemFieldsFragmentDoc: DocumentNode<OpenItemFieldsFragment, unknown>;
2703
2849
  export declare const AgedBalancesFieldsFragmentDoc: DocumentNode<AgedBalancesFieldsFragment, unknown>;
@@ -2708,6 +2854,7 @@ export declare const GetInvestorPositionDocument: DocumentNode<GetInvestorPositi
2708
2854
  export declare const ListInvestorPositionsDocument: DocumentNode<ListInvestorPositionsQuery, ListInvestorPositionsQueryVariables>;
2709
2855
  export declare const ListInvestorSecuritiesDocument: DocumentNode<ListInvestorSecuritiesQuery, ListInvestorSecuritiesQueryVariables>;
2710
2856
  export declare const GetInvestorSecurityDocument: DocumentNode<GetInvestorSecurityQuery, GetInvestorSecurityQueryVariables>;
2857
+ export declare const GetLedgerAccountRegisterDocument: DocumentNode<GetLedgerAccountRegisterQuery, GetLedgerAccountRegisterQueryVariables>;
2711
2858
  export declare const GetLedgerAccountRollupsDocument: DocumentNode<GetLedgerAccountRollupsQuery, GetLedgerAccountRollupsQueryVariables>;
2712
2859
  export declare const GetLedgerAccountTreeDocument: DocumentNode<GetLedgerAccountTreeQuery, GetLedgerAccountTreeQueryVariables>;
2713
2860
  export declare const ListLedgerAccountsDocument: DocumentNode<ListLedgerAccountsQuery, ListLedgerAccountsQueryVariables>;