@robosystems/client 2.22.0 → 2.23.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.
- package/artifacts/LedgerClient.d.ts +37 -3
- package/artifacts/LedgerClient.js +44 -1
- package/artifacts/LedgerClient.ts +81 -2
- package/artifacts/graphql/generated/graphql.d.ts +34 -0
- package/artifacts/graphql/generated/graphql.js +118 -2
- package/artifacts/graphql/generated/graphql.ts +143 -0
- package/artifacts/graphql/queries/ledger/dimensions.d.ts +7 -0
- package/artifacts/graphql/queries/ledger/dimensions.js +27 -0
- package/artifacts/graphql/queries/ledger/dimensions.ts +25 -0
- package/artifacts/graphql/queries/ledger/journalEntries.js +5 -0
- package/artifacts/graphql/queries/ledger/journalEntries.ts +5 -0
- package/artifacts/graphql/queries/ledger/transaction.js +6 -0
- package/artifacts/graphql/queries/ledger/transaction.ts +6 -0
- package/artifacts/graphql/queries/ledger/trialBalance.d.ts +4 -1
- package/artifacts/graphql/queries/ledger/trialBalance.js +19 -3
- package/artifacts/graphql/queries/ledger/trialBalance.ts +19 -3
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +7 -5
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +19 -3
- package/sdk/sdk.gen.js +38 -4
- package/sdk/sdk.gen.ts +37 -3
- package/sdk/types.gen.d.ts +399 -4
- package/sdk/types.gen.ts +417 -4
- package/sdk.gen.d.ts +19 -3
- package/sdk.gen.js +38 -4
- package/sdk.gen.ts +37 -3
- package/types.gen.d.ts +399 -4
- package/types.gen.ts +417 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { AcceptSuggestionsRequest, AcceptSuggestionsResponse, AllocationOverrideResponse, AssociationResponse, AutoMapElementsOperation, BindTextBlockRequest, BindTextBlockResponse, BlockedSourceGraphResponse, BlockSourceGraphResult, ComputeMetricsRequest, ComputeMetricsResponse, ConsolidationProposal, ConsolidationWorksheetRequest, ConsolidationWorksheetResponse, CreateAgentRequest, CreateEntityRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateInformationBlockRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, 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, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateInformationBlockRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest, ViewResponse } from '../types.gen';
|
|
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 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 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']>;
|
|
@@ -40,6 +40,8 @@ export type LedgerControlTieOut = LedgerAgedBalances['tieOuts'][number];
|
|
|
40
40
|
export type LedgerIntercompanyPair = LedgerAgedBalances['pairs'][number];
|
|
41
41
|
export type LedgerOpenItem = OpenItemsForAgentQuery['openItemsForAgent'][number];
|
|
42
42
|
export type LedgerDischargeCandidates = NonNullable<DischargeCandidatesQuery['dischargeCandidates']>;
|
|
43
|
+
export type LedgerDimensionList = NonNullable<ListLedgerDimensionsQuery['dimensions']>;
|
|
44
|
+
export type LedgerDimension = LedgerDimensionList['dimensions'][number];
|
|
43
45
|
/** `receivables` (invoices) or `payables` (bills). */
|
|
44
46
|
export type LedgerOpenItemKind = 'receivables' | 'payables';
|
|
45
47
|
export type LedgerStructureList = NonNullable<ListLedgerStructuresQuery['structures']>;
|
|
@@ -616,11 +618,43 @@ export declare class LedgerClient {
|
|
|
616
618
|
* such event.
|
|
617
619
|
*/
|
|
618
620
|
getDischargeCandidates(graphId: string, eventId: string): Promise<LedgerDischargeCandidates | null>;
|
|
619
|
-
/**
|
|
621
|
+
/**
|
|
622
|
+
* The graph's management dimension members — departments, classes,
|
|
623
|
+
* locations, projects — by axis then name, each with how many lines carry
|
|
624
|
+
* it. `types` lists the axes the graph has members on. Retired members
|
|
625
|
+
* are left out unless `options.includeInactive`.
|
|
626
|
+
*/
|
|
627
|
+
getDimensions(graphId: string, options?: {
|
|
628
|
+
dimensionType?: string | null;
|
|
629
|
+
includeInactive?: boolean;
|
|
630
|
+
}): Promise<LedgerDimensionList | null>;
|
|
631
|
+
/**
|
|
632
|
+
* Add a member to a management dimension (`dimension_type`: department,
|
|
633
|
+
* class, location, project, or an axis of your own). `value`, the
|
|
634
|
+
* member's key within its axis, defaults to a slug of the name; a
|
|
635
|
+
* duplicate key is refused (409).
|
|
636
|
+
*/
|
|
637
|
+
createDimension(graphId: string, body: CreateDimensionRequest, idempotencyKey?: string): Promise<DimensionResponse>;
|
|
638
|
+
/**
|
|
639
|
+
* Rename a member, or retire it with `is_active: false`: it stays on the
|
|
640
|
+
* lines that carry it and goes on no new ones. A member synced from
|
|
641
|
+
* QuickBooks keeps QuickBooks's name.
|
|
642
|
+
*/
|
|
643
|
+
updateDimension(graphId: string, body: UpdateDimensionRequest): Promise<DimensionResponse>;
|
|
644
|
+
/**
|
|
645
|
+
* Trial balance by raw CoA account. `options.dimension` sums one
|
|
646
|
+
* management dimension member's lines (`memberId: 'unallocated'` for the
|
|
647
|
+
* lines no member of the axis tags); such a balance need not foot, and
|
|
648
|
+
* says so in `sliced`.
|
|
649
|
+
*/
|
|
620
650
|
getTrialBalance(graphId: string, options?: {
|
|
621
651
|
startDate?: string;
|
|
622
652
|
endDate?: string;
|
|
623
653
|
entityId?: string | null;
|
|
654
|
+
dimension?: {
|
|
655
|
+
type: string;
|
|
656
|
+
memberId: string;
|
|
657
|
+
} | null;
|
|
624
658
|
}): Promise<LedgerTrialBalance | null>;
|
|
625
659
|
/** Trial balance rolled up to GAAP reporting concepts via a mapping. */
|
|
626
660
|
getMappedTrialBalance(graphId: string, mappingId: string, options?: {
|
|
@@ -249,13 +249,56 @@ class LedgerClient {
|
|
|
249
249
|
async getDischargeCandidates(graphId, eventId) {
|
|
250
250
|
return this.gqlQuery(graphId, graphql_1.DischargeCandidatesDocument, { eventId }, 'Discharge candidates', (data) => data.dischargeCandidates);
|
|
251
251
|
}
|
|
252
|
+
// ── Management dimensions ─────────────────────────────────────────
|
|
253
|
+
/**
|
|
254
|
+
* The graph's management dimension members — departments, classes,
|
|
255
|
+
* locations, projects — by axis then name, each with how many lines carry
|
|
256
|
+
* it. `types` lists the axes the graph has members on. Retired members
|
|
257
|
+
* are left out unless `options.includeInactive`.
|
|
258
|
+
*/
|
|
259
|
+
async getDimensions(graphId, options) {
|
|
260
|
+
return this.gqlQuery(graphId, graphql_1.ListLedgerDimensionsDocument, {
|
|
261
|
+
dimensionType: options?.dimensionType ?? null,
|
|
262
|
+
includeInactive: options?.includeInactive ?? false,
|
|
263
|
+
}, 'List dimensions', (data) => data.dimensions);
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Add a member to a management dimension (`dimension_type`: department,
|
|
267
|
+
* class, location, project, or an axis of your own). `value`, the
|
|
268
|
+
* member's key within its axis, defaults to a slug of the name; a
|
|
269
|
+
* duplicate key is refused (409).
|
|
270
|
+
*/
|
|
271
|
+
async createDimension(graphId, body, idempotencyKey) {
|
|
272
|
+
const envelope = await this.callOperation('Create dimension', (o) => (0, sdk_gen_1.createDimension)({
|
|
273
|
+
...(0, rest_1.withIdempotencyKey)(o, idempotencyKey),
|
|
274
|
+
path: { graph_id: graphId },
|
|
275
|
+
body,
|
|
276
|
+
}));
|
|
277
|
+
return this.requireResult('Create dimension', envelope.result);
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Rename a member, or retire it with `is_active: false`: it stays on the
|
|
281
|
+
* lines that carry it and goes on no new ones. A member synced from
|
|
282
|
+
* QuickBooks keeps QuickBooks's name.
|
|
283
|
+
*/
|
|
284
|
+
async updateDimension(graphId, body) {
|
|
285
|
+
const envelope = await this.callOperation('Update dimension', (o) => (0, sdk_gen_1.updateDimension)({ ...o, path: { graph_id: graphId }, body }));
|
|
286
|
+
return this.requireResult('Update dimension', envelope.result);
|
|
287
|
+
}
|
|
252
288
|
// ── Trial Balance ──────────────────────────────────────────────────
|
|
253
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* Trial balance by raw CoA account. `options.dimension` sums one
|
|
291
|
+
* management dimension member's lines (`memberId: 'unallocated'` for the
|
|
292
|
+
* lines no member of the axis tags); such a balance need not foot, and
|
|
293
|
+
* says so in `sliced`.
|
|
294
|
+
*/
|
|
254
295
|
async getTrialBalance(graphId, options) {
|
|
255
296
|
return this.gqlQuery(graphId, graphql_1.GetLedgerTrialBalanceDocument, {
|
|
256
297
|
startDate: options?.startDate ?? null,
|
|
257
298
|
endDate: options?.endDate ?? null,
|
|
258
299
|
entityId: options?.entityId ?? null,
|
|
300
|
+
dimensionType: options?.dimension?.type ?? null,
|
|
301
|
+
dimensionMemberId: options?.dimension?.memberId ?? null,
|
|
259
302
|
}, 'Get trial balance', (data) => data.trialBalance);
|
|
260
303
|
}
|
|
261
304
|
/** Trial balance rolled up to GAAP reporting concepts via a mapping. */
|
|
@@ -39,6 +39,7 @@ import {
|
|
|
39
39
|
computeMetrics,
|
|
40
40
|
consolidationWorksheet,
|
|
41
41
|
createAgent,
|
|
42
|
+
createDimension,
|
|
42
43
|
createEntity,
|
|
43
44
|
createEventBlock,
|
|
44
45
|
createEventHandler,
|
|
@@ -85,6 +86,7 @@ import {
|
|
|
85
86
|
transitionFilingStatus,
|
|
86
87
|
unblockSourceGraph,
|
|
87
88
|
updateAgent,
|
|
89
|
+
updateDimension,
|
|
88
90
|
updateEntity,
|
|
89
91
|
updateEventBlock,
|
|
90
92
|
updateEventHandler,
|
|
@@ -112,6 +114,7 @@ import type {
|
|
|
112
114
|
ConsolidationWorksheetRequest,
|
|
113
115
|
ConsolidationWorksheetResponse,
|
|
114
116
|
CreateAgentRequest,
|
|
117
|
+
CreateDimensionRequest,
|
|
115
118
|
CreateEntityRequest,
|
|
116
119
|
CreateEventBlockRequest,
|
|
117
120
|
CreateEventHandlerRequest,
|
|
@@ -128,6 +131,7 @@ import type {
|
|
|
128
131
|
DeleteResult,
|
|
129
132
|
DeleteTaxonomyBlockRequest,
|
|
130
133
|
DeleteTaxonomyBlockResponse,
|
|
134
|
+
DimensionResponse,
|
|
131
135
|
EntityTaxonomyResponse,
|
|
132
136
|
EvaluateRulesRequest,
|
|
133
137
|
EvaluateRulesResponse,
|
|
@@ -183,6 +187,7 @@ import type {
|
|
|
183
187
|
TaxonomyBlockEnvelope,
|
|
184
188
|
TransitionFilingStatusRequest,
|
|
185
189
|
UpdateAgentRequest,
|
|
190
|
+
UpdateDimensionRequest,
|
|
186
191
|
UpdateEntityRequest,
|
|
187
192
|
UpdateEventBlockRequest,
|
|
188
193
|
UpdateEventHandlerRequest,
|
|
@@ -231,6 +236,7 @@ import {
|
|
|
231
236
|
ListLedgerBankAccountsDocument,
|
|
232
237
|
ListLedgerBankAccountsQuery,
|
|
233
238
|
ListLedgerBlockedSourceGraphsDocument,
|
|
239
|
+
ListLedgerDimensionsDocument,
|
|
234
240
|
ListLedgerElementsDocument,
|
|
235
241
|
ListLedgerEntitiesDocument,
|
|
236
242
|
ListLedgerEventBlocksDocument,
|
|
@@ -276,6 +282,7 @@ import {
|
|
|
276
282
|
type ListLedgerAccountsQuery,
|
|
277
283
|
type ListLedgerAgentsQuery,
|
|
278
284
|
type ListLedgerBlockedSourceGraphsQuery,
|
|
285
|
+
type ListLedgerDimensionsQuery,
|
|
279
286
|
type ListLedgerElementsQuery,
|
|
280
287
|
type ListLedgerEntitiesQuery,
|
|
281
288
|
type ListLedgerEventBlocksQuery,
|
|
@@ -358,6 +365,9 @@ export type LedgerControlTieOut = LedgerAgedBalances['tieOuts'][number]
|
|
|
358
365
|
export type LedgerIntercompanyPair = LedgerAgedBalances['pairs'][number]
|
|
359
366
|
export type LedgerOpenItem = OpenItemsForAgentQuery['openItemsForAgent'][number]
|
|
360
367
|
export type LedgerDischargeCandidates = NonNullable<DischargeCandidatesQuery['dischargeCandidates']>
|
|
368
|
+
|
|
369
|
+
export type LedgerDimensionList = NonNullable<ListLedgerDimensionsQuery['dimensions']>
|
|
370
|
+
export type LedgerDimension = LedgerDimensionList['dimensions'][number]
|
|
361
371
|
/** `receivables` (invoices) or `payables` (bills). */
|
|
362
372
|
export type LedgerOpenItemKind = 'receivables' | 'payables'
|
|
363
373
|
|
|
@@ -1383,12 +1393,79 @@ export class LedgerClient {
|
|
|
1383
1393
|
)
|
|
1384
1394
|
}
|
|
1385
1395
|
|
|
1396
|
+
// ── Management dimensions ─────────────────────────────────────────
|
|
1397
|
+
|
|
1398
|
+
/**
|
|
1399
|
+
* The graph's management dimension members — departments, classes,
|
|
1400
|
+
* locations, projects — by axis then name, each with how many lines carry
|
|
1401
|
+
* it. `types` lists the axes the graph has members on. Retired members
|
|
1402
|
+
* are left out unless `options.includeInactive`.
|
|
1403
|
+
*/
|
|
1404
|
+
async getDimensions(
|
|
1405
|
+
graphId: string,
|
|
1406
|
+
options?: { dimensionType?: string | null; includeInactive?: boolean }
|
|
1407
|
+
): Promise<LedgerDimensionList | null> {
|
|
1408
|
+
return this.gqlQuery(
|
|
1409
|
+
graphId,
|
|
1410
|
+
ListLedgerDimensionsDocument,
|
|
1411
|
+
{
|
|
1412
|
+
dimensionType: options?.dimensionType ?? null,
|
|
1413
|
+
includeInactive: options?.includeInactive ?? false,
|
|
1414
|
+
},
|
|
1415
|
+
'List dimensions',
|
|
1416
|
+
(data) => data.dimensions
|
|
1417
|
+
)
|
|
1418
|
+
}
|
|
1419
|
+
|
|
1420
|
+
/**
|
|
1421
|
+
* Add a member to a management dimension (`dimension_type`: department,
|
|
1422
|
+
* class, location, project, or an axis of your own). `value`, the
|
|
1423
|
+
* member's key within its axis, defaults to a slug of the name; a
|
|
1424
|
+
* duplicate key is refused (409).
|
|
1425
|
+
*/
|
|
1426
|
+
async createDimension(
|
|
1427
|
+
graphId: string,
|
|
1428
|
+
body: CreateDimensionRequest,
|
|
1429
|
+
idempotencyKey?: string
|
|
1430
|
+
): Promise<DimensionResponse> {
|
|
1431
|
+
const envelope = await this.callOperation('Create dimension', (o) =>
|
|
1432
|
+
createDimension({
|
|
1433
|
+
...withIdempotencyKey(o, idempotencyKey),
|
|
1434
|
+
path: { graph_id: graphId },
|
|
1435
|
+
body,
|
|
1436
|
+
})
|
|
1437
|
+
)
|
|
1438
|
+
return this.requireResult('Create dimension', envelope.result)
|
|
1439
|
+
}
|
|
1440
|
+
|
|
1441
|
+
/**
|
|
1442
|
+
* Rename a member, or retire it with `is_active: false`: it stays on the
|
|
1443
|
+
* lines that carry it and goes on no new ones. A member synced from
|
|
1444
|
+
* QuickBooks keeps QuickBooks's name.
|
|
1445
|
+
*/
|
|
1446
|
+
async updateDimension(graphId: string, body: UpdateDimensionRequest): Promise<DimensionResponse> {
|
|
1447
|
+
const envelope = await this.callOperation('Update dimension', (o) =>
|
|
1448
|
+
updateDimension({ ...o, path: { graph_id: graphId }, body })
|
|
1449
|
+
)
|
|
1450
|
+
return this.requireResult('Update dimension', envelope.result)
|
|
1451
|
+
}
|
|
1452
|
+
|
|
1386
1453
|
// ── Trial Balance ──────────────────────────────────────────────────
|
|
1387
1454
|
|
|
1388
|
-
/**
|
|
1455
|
+
/**
|
|
1456
|
+
* Trial balance by raw CoA account. `options.dimension` sums one
|
|
1457
|
+
* management dimension member's lines (`memberId: 'unallocated'` for the
|
|
1458
|
+
* lines no member of the axis tags); such a balance need not foot, and
|
|
1459
|
+
* says so in `sliced`.
|
|
1460
|
+
*/
|
|
1389
1461
|
async getTrialBalance(
|
|
1390
1462
|
graphId: string,
|
|
1391
|
-
options?: {
|
|
1463
|
+
options?: {
|
|
1464
|
+
startDate?: string
|
|
1465
|
+
endDate?: string
|
|
1466
|
+
entityId?: string | null
|
|
1467
|
+
dimension?: { type: string; memberId: string } | null
|
|
1468
|
+
}
|
|
1392
1469
|
): Promise<LedgerTrialBalance | null> {
|
|
1393
1470
|
return this.gqlQuery(
|
|
1394
1471
|
graphId,
|
|
@@ -1397,6 +1474,8 @@ export class LedgerClient {
|
|
|
1397
1474
|
startDate: options?.startDate ?? null,
|
|
1398
1475
|
endDate: options?.endDate ?? null,
|
|
1399
1476
|
entityId: options?.entityId ?? null,
|
|
1477
|
+
dimensionType: options?.dimension?.type ?? null,
|
|
1478
|
+
dimensionMemberId: options?.dimension?.memberId ?? null,
|
|
1400
1479
|
},
|
|
1401
1480
|
'Get trial balance',
|
|
1402
1481
|
(data) => data.trialBalance
|
|
@@ -829,6 +829,25 @@ export type GetLedgerClosingBookStructuresQuery = {
|
|
|
829
829
|
}>;
|
|
830
830
|
} | null;
|
|
831
831
|
};
|
|
832
|
+
export type ListLedgerDimensionsQueryVariables = Exact<{
|
|
833
|
+
dimensionType: string | null | undefined;
|
|
834
|
+
includeInactive?: boolean;
|
|
835
|
+
}>;
|
|
836
|
+
export type ListLedgerDimensionsQuery = {
|
|
837
|
+
dimensions: {
|
|
838
|
+
types: Array<string>;
|
|
839
|
+
dimensions: Array<{
|
|
840
|
+
id: string;
|
|
841
|
+
dimensionType: string;
|
|
842
|
+
name: string;
|
|
843
|
+
value: string;
|
|
844
|
+
source: string;
|
|
845
|
+
isActive: boolean;
|
|
846
|
+
lineCount: number;
|
|
847
|
+
createdAt: string | null;
|
|
848
|
+
}>;
|
|
849
|
+
} | null;
|
|
850
|
+
};
|
|
832
851
|
export type ListLedgerElementsQueryVariables = Exact<{
|
|
833
852
|
taxonomyId: string | null | undefined;
|
|
834
853
|
source: string | null | undefined;
|
|
@@ -1615,6 +1634,11 @@ export type ListLedgerJournalEntriesQuery = {
|
|
|
1615
1634
|
description: string | null;
|
|
1616
1635
|
lineOrder: number;
|
|
1617
1636
|
flowQname: string | null;
|
|
1637
|
+
dimensions: Array<{
|
|
1638
|
+
id: string;
|
|
1639
|
+
dimensionType: string;
|
|
1640
|
+
name: string;
|
|
1641
|
+
}>;
|
|
1618
1642
|
}>;
|
|
1619
1643
|
}>;
|
|
1620
1644
|
pagination: {
|
|
@@ -2335,6 +2359,12 @@ export type GetLedgerTransactionQuery = {
|
|
|
2335
2359
|
creditAmount: number;
|
|
2336
2360
|
description: string | null;
|
|
2337
2361
|
lineOrder: number;
|
|
2362
|
+
flowQname: string | null;
|
|
2363
|
+
dimensions: Array<{
|
|
2364
|
+
id: string;
|
|
2365
|
+
dimensionType: string;
|
|
2366
|
+
name: string;
|
|
2367
|
+
}>;
|
|
2338
2368
|
}>;
|
|
2339
2369
|
}>;
|
|
2340
2370
|
} | null;
|
|
@@ -2376,11 +2406,14 @@ export type GetLedgerTrialBalanceQueryVariables = Exact<{
|
|
|
2376
2406
|
startDate: string | null | undefined;
|
|
2377
2407
|
endDate: string | null | undefined;
|
|
2378
2408
|
entityId: string | null | undefined;
|
|
2409
|
+
dimensionType: string | null | undefined;
|
|
2410
|
+
dimensionMemberId: string | null | undefined;
|
|
2379
2411
|
}>;
|
|
2380
2412
|
export type GetLedgerTrialBalanceQuery = {
|
|
2381
2413
|
trialBalance: {
|
|
2382
2414
|
totalDebits: number;
|
|
2383
2415
|
totalCredits: number;
|
|
2416
|
+
sliced: boolean;
|
|
2384
2417
|
rows: Array<{
|
|
2385
2418
|
accountId: string;
|
|
2386
2419
|
accountCode: string;
|
|
@@ -2689,6 +2722,7 @@ export declare const ListLedgerBlockedSourceGraphsDocument: DocumentNode<ListLed
|
|
|
2689
2722
|
export declare const ListChartTemplatesDocument: DocumentNode<ListChartTemplatesQuery, ListChartTemplatesQueryVariables>;
|
|
2690
2723
|
export declare const ClassificationStatsDocument: DocumentNode<ClassificationStatsQuery, ClassificationStatsQueryVariables>;
|
|
2691
2724
|
export declare const GetLedgerClosingBookStructuresDocument: DocumentNode<GetLedgerClosingBookStructuresQuery, GetLedgerClosingBookStructuresQueryVariables>;
|
|
2725
|
+
export declare const ListLedgerDimensionsDocument: DocumentNode<ListLedgerDimensionsQuery, ListLedgerDimensionsQueryVariables>;
|
|
2692
2726
|
export declare const ListLedgerElementsDocument: DocumentNode<ListLedgerElementsQuery, ListLedgerElementsQueryVariables>;
|
|
2693
2727
|
export declare const ListLedgerEntitiesDocument: DocumentNode<ListLedgerEntitiesQuery, ListLedgerEntitiesQueryVariables>;
|
|
2694
2728
|
export declare const GetLedgerEntityDocument: DocumentNode<GetLedgerEntityQuery, GetLedgerEntityQueryVariables>;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.GetLibraryTaxonomyDocument = exports.ListLibraryTaxonomiesDocument = exports.GetLibraryStructureDocument = exports.ListLibraryStructuresDocument = exports.GetLibraryElementDocument = exports.SearchLibraryElementsDocument = exports.ListLibraryElementsDocument = exports.GetLibraryElementEquivalentsDocument = exports.GetLibraryElementClassificationsDocument = exports.GetLibraryElementArcsDocument = exports.ListLibraryTaxonomyArcsDocument = exports.ListLedgerUnmappedElementsDocument = exports.GetLedgerTrialBalanceDocument = exports.ListLedgerTransactionsDocument = exports.GetLedgerTransactionDocument = exports.ListLedgerTaxonomiesDocument = exports.GetLedgerSummaryDocument = exports.ListLedgerStructuresDocument = exports.GetLedgerStatementDocument = exports.ListLedgerReportsDocument = void 0;
|
|
3
|
+
exports.GetLedgerReportPackageDocument = exports.GetLedgerReportDownloadUrlDocument = exports.GetLedgerReportDocument = exports.ListLedgerReconciliationsDocument = exports.ListLedgerPublishListsDocument = exports.GetLedgerPublishListDocument = exports.GetLedgerPeriodDraftsDocument = exports.GetLedgerPeriodCloseStatusDocument = exports.ListLedgerMappingsDocument = exports.GetLedgerMappingCoverageDocument = exports.MappingCandidatesDocument = exports.GetLedgerMappingDocument = exports.GetLedgerMappedTrialBalanceDocument = exports.ListLedgerJournalEntriesDocument = exports.ListInformationBlockSummariesDocument = exports.ListInformationBlocksDocument = exports.GetInformationBlockWindowedDocument = exports.GetInformationBlockDocument = exports.FlowCandidatesDocument = exports.GetLedgerFiscalCalendarDocument = exports.ListLedgerEventBlocksDocument = exports.GetLedgerEventBlockDocument = exports.GetLedgerEntityDocument = exports.ListLedgerEntitiesDocument = exports.ListLedgerElementsDocument = exports.ListLedgerDimensionsDocument = exports.GetLedgerClosingBookStructuresDocument = exports.ClassificationStatsDocument = exports.ListChartTemplatesDocument = exports.ListLedgerBlockedSourceGraphsDocument = exports.ListLedgerBankAccountsDocument = exports.ListLedgerAgentsDocument = exports.GetLedgerAgentDocument = exports.DischargeCandidatesDocument = exports.OpenItemsForAgentDocument = exports.AgedPayablesDocument = exports.AgedReceivablesDocument = exports.ListLedgerAccountsDocument = exports.GetLedgerAccountTreeDocument = exports.GetLedgerAccountRollupsDocument = exports.GetInvestorSecurityDocument = exports.ListInvestorSecuritiesDocument = exports.ListInvestorPositionsDocument = exports.GetInvestorPositionDocument = exports.ListInvestorPortfoliosDocument = exports.GetInvestorPortfolioBlockDocument = exports.GetInvestorHoldingsDocument = exports.AgedBalancesFieldsFragmentDoc = exports.OpenItemFieldsFragmentDoc = exports.AgingBucketsFieldsFragmentDoc = void 0;
|
|
4
|
+
exports.GetLibraryTaxonomyDocument = exports.ListLibraryTaxonomiesDocument = exports.GetLibraryStructureDocument = exports.ListLibraryStructuresDocument = exports.GetLibraryElementDocument = exports.SearchLibraryElementsDocument = exports.ListLibraryElementsDocument = exports.GetLibraryElementEquivalentsDocument = exports.GetLibraryElementClassificationsDocument = exports.GetLibraryElementArcsDocument = exports.ListLibraryTaxonomyArcsDocument = exports.ListLedgerUnmappedElementsDocument = exports.GetLedgerTrialBalanceDocument = exports.ListLedgerTransactionsDocument = exports.GetLedgerTransactionDocument = exports.ListLedgerTaxonomiesDocument = exports.GetLedgerSummaryDocument = exports.ListLedgerStructuresDocument = exports.GetLedgerStatementDocument = exports.ListLedgerReportsDocument = exports.GetLedgerReportingTaxonomyDocument = void 0;
|
|
5
5
|
exports.AgingBucketsFieldsFragmentDoc = {
|
|
6
6
|
kind: 'Document',
|
|
7
7
|
definitions: [
|
|
@@ -2315,6 +2315,76 @@ exports.GetLedgerClosingBookStructuresDocument = {
|
|
|
2315
2315
|
},
|
|
2316
2316
|
],
|
|
2317
2317
|
};
|
|
2318
|
+
exports.ListLedgerDimensionsDocument = {
|
|
2319
|
+
kind: 'Document',
|
|
2320
|
+
definitions: [
|
|
2321
|
+
{
|
|
2322
|
+
kind: 'OperationDefinition',
|
|
2323
|
+
operation: 'query',
|
|
2324
|
+
name: { kind: 'Name', value: 'ListLedgerDimensions' },
|
|
2325
|
+
variableDefinitions: [
|
|
2326
|
+
{
|
|
2327
|
+
kind: 'VariableDefinition',
|
|
2328
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'dimensionType' } },
|
|
2329
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
2330
|
+
},
|
|
2331
|
+
{
|
|
2332
|
+
kind: 'VariableDefinition',
|
|
2333
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'includeInactive' } },
|
|
2334
|
+
type: {
|
|
2335
|
+
kind: 'NonNullType',
|
|
2336
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'Boolean' } },
|
|
2337
|
+
},
|
|
2338
|
+
defaultValue: { kind: 'BooleanValue', value: false },
|
|
2339
|
+
},
|
|
2340
|
+
],
|
|
2341
|
+
selectionSet: {
|
|
2342
|
+
kind: 'SelectionSet',
|
|
2343
|
+
selections: [
|
|
2344
|
+
{
|
|
2345
|
+
kind: 'Field',
|
|
2346
|
+
name: { kind: 'Name', value: 'dimensions' },
|
|
2347
|
+
arguments: [
|
|
2348
|
+
{
|
|
2349
|
+
kind: 'Argument',
|
|
2350
|
+
name: { kind: 'Name', value: 'dimensionType' },
|
|
2351
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'dimensionType' } },
|
|
2352
|
+
},
|
|
2353
|
+
{
|
|
2354
|
+
kind: 'Argument',
|
|
2355
|
+
name: { kind: 'Name', value: 'includeInactive' },
|
|
2356
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'includeInactive' } },
|
|
2357
|
+
},
|
|
2358
|
+
],
|
|
2359
|
+
selectionSet: {
|
|
2360
|
+
kind: 'SelectionSet',
|
|
2361
|
+
selections: [
|
|
2362
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'types' } },
|
|
2363
|
+
{
|
|
2364
|
+
kind: 'Field',
|
|
2365
|
+
name: { kind: 'Name', value: 'dimensions' },
|
|
2366
|
+
selectionSet: {
|
|
2367
|
+
kind: 'SelectionSet',
|
|
2368
|
+
selections: [
|
|
2369
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
|
|
2370
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'dimensionType' } },
|
|
2371
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'name' } },
|
|
2372
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'value' } },
|
|
2373
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'source' } },
|
|
2374
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'isActive' } },
|
|
2375
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'lineCount' } },
|
|
2376
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
|
|
2377
|
+
],
|
|
2378
|
+
},
|
|
2379
|
+
},
|
|
2380
|
+
],
|
|
2381
|
+
},
|
|
2382
|
+
},
|
|
2383
|
+
],
|
|
2384
|
+
},
|
|
2385
|
+
},
|
|
2386
|
+
],
|
|
2387
|
+
};
|
|
2318
2388
|
exports.ListLedgerElementsDocument = {
|
|
2319
2389
|
kind: 'Document',
|
|
2320
2390
|
definitions: [
|
|
@@ -4342,6 +4412,18 @@ exports.ListLedgerJournalEntriesDocument = {
|
|
|
4342
4412
|
{ kind: 'Field', name: { kind: 'Name', value: 'description' } },
|
|
4343
4413
|
{ kind: 'Field', name: { kind: 'Name', value: 'lineOrder' } },
|
|
4344
4414
|
{ kind: 'Field', name: { kind: 'Name', value: 'flowQname' } },
|
|
4415
|
+
{
|
|
4416
|
+
kind: 'Field',
|
|
4417
|
+
name: { kind: 'Name', value: 'dimensions' },
|
|
4418
|
+
selectionSet: {
|
|
4419
|
+
kind: 'SelectionSet',
|
|
4420
|
+
selections: [
|
|
4421
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
|
|
4422
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'dimensionType' } },
|
|
4423
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'name' } },
|
|
4424
|
+
],
|
|
4425
|
+
},
|
|
4426
|
+
},
|
|
4345
4427
|
],
|
|
4346
4428
|
},
|
|
4347
4429
|
},
|
|
@@ -6299,6 +6381,19 @@ exports.GetLedgerTransactionDocument = {
|
|
|
6299
6381
|
{ kind: 'Field', name: { kind: 'Name', value: 'creditAmount' } },
|
|
6300
6382
|
{ kind: 'Field', name: { kind: 'Name', value: 'description' } },
|
|
6301
6383
|
{ kind: 'Field', name: { kind: 'Name', value: 'lineOrder' } },
|
|
6384
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'flowQname' } },
|
|
6385
|
+
{
|
|
6386
|
+
kind: 'Field',
|
|
6387
|
+
name: { kind: 'Name', value: 'dimensions' },
|
|
6388
|
+
selectionSet: {
|
|
6389
|
+
kind: 'SelectionSet',
|
|
6390
|
+
selections: [
|
|
6391
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
|
|
6392
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'dimensionType' } },
|
|
6393
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'name' } },
|
|
6394
|
+
],
|
|
6395
|
+
},
|
|
6396
|
+
},
|
|
6302
6397
|
],
|
|
6303
6398
|
},
|
|
6304
6399
|
},
|
|
@@ -6467,6 +6562,16 @@ exports.GetLedgerTrialBalanceDocument = {
|
|
|
6467
6562
|
variable: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
|
|
6468
6563
|
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
6469
6564
|
},
|
|
6565
|
+
{
|
|
6566
|
+
kind: 'VariableDefinition',
|
|
6567
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'dimensionType' } },
|
|
6568
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
6569
|
+
},
|
|
6570
|
+
{
|
|
6571
|
+
kind: 'VariableDefinition',
|
|
6572
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'dimensionMemberId' } },
|
|
6573
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
|
|
6574
|
+
},
|
|
6470
6575
|
],
|
|
6471
6576
|
selectionSet: {
|
|
6472
6577
|
kind: 'SelectionSet',
|
|
@@ -6490,12 +6595,23 @@ exports.GetLedgerTrialBalanceDocument = {
|
|
|
6490
6595
|
name: { kind: 'Name', value: 'entityId' },
|
|
6491
6596
|
value: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
|
|
6492
6597
|
},
|
|
6598
|
+
{
|
|
6599
|
+
kind: 'Argument',
|
|
6600
|
+
name: { kind: 'Name', value: 'dimensionType' },
|
|
6601
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'dimensionType' } },
|
|
6602
|
+
},
|
|
6603
|
+
{
|
|
6604
|
+
kind: 'Argument',
|
|
6605
|
+
name: { kind: 'Name', value: 'dimensionMemberId' },
|
|
6606
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'dimensionMemberId' } },
|
|
6607
|
+
},
|
|
6493
6608
|
],
|
|
6494
6609
|
selectionSet: {
|
|
6495
6610
|
kind: 'SelectionSet',
|
|
6496
6611
|
selections: [
|
|
6497
6612
|
{ kind: 'Field', name: { kind: 'Name', value: 'totalDebits' } },
|
|
6498
6613
|
{ kind: 'Field', name: { kind: 'Name', value: 'totalCredits' } },
|
|
6614
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'sliced' } },
|
|
6499
6615
|
{
|
|
6500
6616
|
kind: 'Field',
|
|
6501
6617
|
name: { kind: 'Name', value: 'rows' },
|