@robosystems/client 2.20.1 → 2.21.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,4 +1,4 @@
1
- import type { AcceptSuggestionsRequest, AcceptSuggestionsResponse, AllocationOverrideResponse, AssociationResponse, AutoMapElementsOperation, BindTextBlockRequest, BindTextBlockResponse, BlockedSourceGraphResponse, BlockSourceGraphResult, ComputeMetricsRequest, ComputeMetricsResponse, 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, 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';
2
2
  import type { TokenProvider } from './graphql/client';
3
3
  import { ListLedgerBankAccountsQuery, type ClassificationStatsQuery, 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 ReportDownloadFormat, type ReportLifecycle } from './graphql/generated/graphql';
4
4
  export { GraphQLError } from './graphql/client';
@@ -393,7 +393,21 @@ export interface CreateJournalEntryOptions {
393
393
  idempotencyKey?: string | null;
394
394
  /** The entity whose books the entry goes into. Omitted: the group parent. */
395
395
  entityId?: string | null;
396
+ /**
397
+ * A consolidating entry in the group's consolidation entity: what it
398
+ * adjusts. Only that entity's books take one; the consolidation engine
399
+ * counts a tagged entry toward what it already holds, so an elimination
400
+ * posted by hand is not proposed again.
401
+ */
402
+ adjustmentKind?: AdjustmentKind | null;
403
+ /**
404
+ * The entity whose figures a consolidating entry adjusts. Required with
405
+ * every `adjustmentKind` but `manual`.
406
+ */
407
+ adjustsEntityId?: string | null;
396
408
  }
409
+ /** What a consolidating entry adjusts. */
410
+ export type AdjustmentKind = ConsolidationProposal['adjustment_kind'];
397
411
  interface LedgerClientConfig {
398
412
  baseUrl: string;
399
413
  credentials?: 'include' | 'same-origin' | 'omit';
@@ -1020,7 +1034,9 @@ export declare class LedgerClient {
1020
1034
  * metadata object; all other fields replace. `classification_element_id`
1021
1035
  * sets the account its bank lines are suggested (an empty string clears
1022
1036
  * it) and `classification_mode: 'always_ask'` stops suggesting one; its
1023
- * open lines are re-suggested at once.
1037
+ * open lines are re-suggested at once. Each entity keeps its own default:
1038
+ * `classification_entity_id` names the one these are for, omitted the group
1039
+ * parent.
1024
1040
  */
1025
1041
  updateAgent(graphId: string, body: UpdateAgentRequest): Promise<LedgerAgentResponse>;
1026
1042
  /**
@@ -942,6 +942,8 @@ class LedgerClient {
942
942
  type: options.type ?? 'standard',
943
943
  status: options.status ?? 'draft',
944
944
  transaction_id: options.transactionId ?? null,
945
+ ...(options.adjustmentKind ? { adjustment_kind: options.adjustmentKind } : {}),
946
+ ...(options.adjustsEntityId ? { adjusts_entity_id: options.adjustsEntityId } : {}),
945
947
  },
946
948
  };
947
949
  const envelope = await this.callOperation('Create journal entry', (o) => (0, sdk_gen_1.createEventBlock)({
@@ -1088,7 +1090,9 @@ class LedgerClient {
1088
1090
  * metadata object; all other fields replace. `classification_element_id`
1089
1091
  * sets the account its bank lines are suggested (an empty string clears
1090
1092
  * it) and `classification_mode: 'always_ask'` stops suggesting one; its
1091
- * open lines are re-suggested at once.
1093
+ * open lines are re-suggested at once. Each entity keeps its own default:
1094
+ * `classification_entity_id` names the one these are for, omitted the group
1095
+ * parent.
1092
1096
  */
1093
1097
  async updateAgent(graphId, body) {
1094
1098
  const envelope = await this.callOperation('Update agent', (o) => (0, sdk_gen_1.updateAgent)({ ...o, path: { graph_id: graphId }, body }));
@@ -108,6 +108,7 @@ import type {
108
108
  ClosePeriodOperation,
109
109
  ComputeMetricsRequest,
110
110
  ComputeMetricsResponse,
111
+ ConsolidationProposal,
111
112
  ConsolidationWorksheetRequest,
112
113
  ConsolidationWorksheetResponse,
113
114
  CreateAgentRequest,
@@ -847,8 +848,23 @@ export interface CreateJournalEntryOptions {
847
848
  idempotencyKey?: string | null
848
849
  /** The entity whose books the entry goes into. Omitted: the group parent. */
849
850
  entityId?: string | null
851
+ /**
852
+ * A consolidating entry in the group's consolidation entity: what it
853
+ * adjusts. Only that entity's books take one; the consolidation engine
854
+ * counts a tagged entry toward what it already holds, so an elimination
855
+ * posted by hand is not proposed again.
856
+ */
857
+ adjustmentKind?: AdjustmentKind | null
858
+ /**
859
+ * The entity whose figures a consolidating entry adjusts. Required with
860
+ * every `adjustmentKind` but `manual`.
861
+ */
862
+ adjustsEntityId?: string | null
850
863
  }
851
864
 
865
+ /** What a consolidating entry adjusts. */
866
+ export type AdjustmentKind = ConsolidationProposal['adjustment_kind']
867
+
852
868
  // ── Client ──────────────────────────────────────────────────────────────
853
869
 
854
870
  interface LedgerClientConfig {
@@ -2483,6 +2499,8 @@ export class LedgerClient {
2483
2499
  type: options.type ?? 'standard',
2484
2500
  status: options.status ?? 'draft',
2485
2501
  transaction_id: options.transactionId ?? null,
2502
+ ...(options.adjustmentKind ? { adjustment_kind: options.adjustmentKind } : {}),
2503
+ ...(options.adjustsEntityId ? { adjusts_entity_id: options.adjustsEntityId } : {}),
2486
2504
  },
2487
2505
  }
2488
2506
  const envelope = await this.callOperation('Create journal entry', (o) =>
@@ -2699,7 +2717,9 @@ export class LedgerClient {
2699
2717
  * metadata object; all other fields replace. `classification_element_id`
2700
2718
  * sets the account its bank lines are suggested (an empty string clears
2701
2719
  * it) and `classification_mode: 'always_ask'` stops suggesting one; its
2702
- * open lines are re-suggested at once.
2720
+ * open lines are re-suggested at once. Each entity keeps its own default:
2721
+ * `classification_entity_id` names the one these are for, omitted the group
2722
+ * parent.
2703
2723
  */
2704
2724
  async updateAgent(graphId: string, body: UpdateAgentRequest): Promise<LedgerAgentResponse> {
2705
2725
  const envelope = await this.callOperation('Update agent', (o) =>
@@ -362,6 +362,7 @@ export type GetLedgerAgentQuery = {
362
362
  updatedAt: string | null;
363
363
  createdBy: string | null;
364
364
  classification: {
365
+ entityId: string;
365
366
  elementId: string;
366
367
  accountName: string | null;
367
368
  mode: string;
@@ -371,6 +372,17 @@ export type GetLedgerAgentQuery = {
371
372
  setAt: string | null;
372
373
  learnedFrom: string | null;
373
374
  } | null;
375
+ classifications: Array<{
376
+ entityId: string;
377
+ elementId: string;
378
+ accountName: string | null;
379
+ mode: string;
380
+ confirmations: number;
381
+ overrides: number;
382
+ setBy: string | null;
383
+ setAt: string | null;
384
+ learnedFrom: string | null;
385
+ }>;
374
386
  } | null;
375
387
  };
376
388
  export type ListLedgerAgentsQueryVariables = Exact<{
@@ -401,6 +413,7 @@ export type ListLedgerAgentsQuery = {
401
413
  updatedAt: string | null;
402
414
  createdBy: string | null;
403
415
  classification: {
416
+ entityId: string;
404
417
  elementId: string;
405
418
  accountName: string | null;
406
419
  mode: string;
@@ -410,6 +423,17 @@ export type ListLedgerAgentsQuery = {
410
423
  setAt: string | null;
411
424
  learnedFrom: string | null;
412
425
  } | null;
426
+ classifications: Array<{
427
+ entityId: string;
428
+ elementId: string;
429
+ accountName: string | null;
430
+ mode: string;
431
+ confirmations: number;
432
+ overrides: number;
433
+ setBy: string | null;
434
+ setAt: string | null;
435
+ learnedFrom: string | null;
436
+ }>;
413
437
  }>;
414
438
  };
415
439
  export type ListLedgerBankAccountsQueryVariables = Exact<{
@@ -1030,6 +1030,25 @@ exports.GetLedgerAgentDocument = {
1030
1030
  selectionSet: {
1031
1031
  kind: 'SelectionSet',
1032
1032
  selections: [
1033
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
1034
+ { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
1035
+ { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
1036
+ { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
1037
+ { kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
1038
+ { kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
1039
+ { kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
1040
+ { kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
1041
+ { kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
1042
+ ],
1043
+ },
1044
+ },
1045
+ {
1046
+ kind: 'Field',
1047
+ name: { kind: 'Name', value: 'classifications' },
1048
+ selectionSet: {
1049
+ kind: 'SelectionSet',
1050
+ selections: [
1051
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
1033
1052
  { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
1034
1053
  { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
1035
1054
  { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
@@ -1152,6 +1171,25 @@ exports.ListLedgerAgentsDocument = {
1152
1171
  selectionSet: {
1153
1172
  kind: 'SelectionSet',
1154
1173
  selections: [
1174
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
1175
+ { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
1176
+ { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
1177
+ { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
1178
+ { kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
1179
+ { kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
1180
+ { kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
1181
+ { kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
1182
+ { kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
1183
+ ],
1184
+ },
1185
+ },
1186
+ {
1187
+ kind: 'Field',
1188
+ name: { kind: 'Name', value: 'classifications' },
1189
+ selectionSet: {
1190
+ kind: 'SelectionSet',
1191
+ selections: [
1192
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
1155
1193
  { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
1156
1194
  { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
1157
1195
  { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
@@ -352,6 +352,7 @@ export type GetLedgerAgentQuery = {
352
352
  updatedAt: string | null
353
353
  createdBy: string | null
354
354
  classification: {
355
+ entityId: string
355
356
  elementId: string
356
357
  accountName: string | null
357
358
  mode: string
@@ -361,6 +362,17 @@ export type GetLedgerAgentQuery = {
361
362
  setAt: string | null
362
363
  learnedFrom: string | null
363
364
  } | null
365
+ classifications: Array<{
366
+ entityId: string
367
+ elementId: string
368
+ accountName: string | null
369
+ mode: string
370
+ confirmations: number
371
+ overrides: number
372
+ setBy: string | null
373
+ setAt: string | null
374
+ learnedFrom: string | null
375
+ }>
364
376
  } | null
365
377
  }
366
378
 
@@ -393,6 +405,7 @@ export type ListLedgerAgentsQuery = {
393
405
  updatedAt: string | null
394
406
  createdBy: string | null
395
407
  classification: {
408
+ entityId: string
396
409
  elementId: string
397
410
  accountName: string | null
398
411
  mode: string
@@ -402,6 +415,17 @@ export type ListLedgerAgentsQuery = {
402
415
  setAt: string | null
403
416
  learnedFrom: string | null
404
417
  } | null
418
+ classifications: Array<{
419
+ entityId: string
420
+ elementId: string
421
+ accountName: string | null
422
+ mode: string
423
+ confirmations: number
424
+ overrides: number
425
+ setBy: string | null
426
+ setAt: string | null
427
+ learnedFrom: string | null
428
+ }>
405
429
  }>
406
430
  }
407
431
 
@@ -3332,6 +3356,25 @@ export const GetLedgerAgentDocument = {
3332
3356
  selectionSet: {
3333
3357
  kind: 'SelectionSet',
3334
3358
  selections: [
3359
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
3360
+ { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
3361
+ { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
3362
+ { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
3363
+ { kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
3364
+ { kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
3365
+ { kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
3366
+ { kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
3367
+ { kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
3368
+ ],
3369
+ },
3370
+ },
3371
+ {
3372
+ kind: 'Field',
3373
+ name: { kind: 'Name', value: 'classifications' },
3374
+ selectionSet: {
3375
+ kind: 'SelectionSet',
3376
+ selections: [
3377
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
3335
3378
  { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
3336
3379
  { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
3337
3380
  { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
@@ -3454,6 +3497,25 @@ export const ListLedgerAgentsDocument = {
3454
3497
  selectionSet: {
3455
3498
  kind: 'SelectionSet',
3456
3499
  selections: [
3500
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
3501
+ { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
3502
+ { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
3503
+ { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
3504
+ { kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
3505
+ { kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
3506
+ { kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
3507
+ { kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
3508
+ { kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
3509
+ ],
3510
+ },
3511
+ },
3512
+ {
3513
+ kind: 'Field',
3514
+ name: { kind: 'Name', value: 'classifications' },
3515
+ selectionSet: {
3516
+ kind: 'SelectionSet',
3517
+ selections: [
3518
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
3457
3519
  { kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
3458
3520
  { kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
3459
3521
  { kind: 'Field', name: { kind: 'Name', value: 'mode' } },
@@ -2,8 +2,9 @@
2
2
  * Get a single agent by id (the agents detail view).
3
3
  *
4
4
  * `address` is a JSON dict — typically QB-shaped with `Line1`/`City`/
5
- * `CountrySubDivisionCode`/`PostalCode` keys. `classification` is the
6
- * account its bank lines are suggested, learned from committed lines or set
7
- * with `updateAgent`; null until it has one.
5
+ * `CountrySubDivisionCode`/`PostalCode` keys. `classifications` holds the
6
+ * account each entity's bank lines are suggested, learned from committed lines
7
+ * or set with `updateAgent`; `classification` is the group parent's, null
8
+ * until it has one.
8
9
  */
9
10
  export declare const GET_AGENT: string;
@@ -6,9 +6,10 @@ const graphql_request_1 = require("graphql-request");
6
6
  * Get a single agent by id (the agents detail view).
7
7
  *
8
8
  * `address` is a JSON dict — typically QB-shaped with `Line1`/`City`/
9
- * `CountrySubDivisionCode`/`PostalCode` keys. `classification` is the
10
- * account its bank lines are suggested, learned from committed lines or set
11
- * with `updateAgent`; null until it has one.
9
+ * `CountrySubDivisionCode`/`PostalCode` keys. `classifications` holds the
10
+ * account each entity's bank lines are suggested, learned from committed lines
11
+ * or set with `updateAgent`; `classification` is the group parent's, null
12
+ * until it has one.
12
13
  */
13
14
  exports.GET_AGENT = (0, graphql_request_1.gql) `
14
15
  query GetLedgerAgent($id: String!) {
@@ -29,6 +30,18 @@ exports.GET_AGENT = (0, graphql_request_1.gql) `
29
30
  isActive
30
31
  is1099Recipient
31
32
  classification {
33
+ entityId
34
+ elementId
35
+ accountName
36
+ mode
37
+ confirmations
38
+ overrides
39
+ setBy
40
+ setAt
41
+ learnedFrom
42
+ }
43
+ classifications {
44
+ entityId
32
45
  elementId
33
46
  accountName
34
47
  mode
@@ -4,9 +4,10 @@ import { gql } from 'graphql-request'
4
4
  * Get a single agent by id (the agents detail view).
5
5
  *
6
6
  * `address` is a JSON dict — typically QB-shaped with `Line1`/`City`/
7
- * `CountrySubDivisionCode`/`PostalCode` keys. `classification` is the
8
- * account its bank lines are suggested, learned from committed lines or set
9
- * with `updateAgent`; null until it has one.
7
+ * `CountrySubDivisionCode`/`PostalCode` keys. `classifications` holds the
8
+ * account each entity's bank lines are suggested, learned from committed lines
9
+ * or set with `updateAgent`; `classification` is the group parent's, null
10
+ * until it has one.
10
11
  */
11
12
  export const GET_AGENT = gql`
12
13
  query GetLedgerAgent($id: String!) {
@@ -27,6 +28,18 @@ export const GET_AGENT = gql`
27
28
  isActive
28
29
  is1099Recipient
29
30
  classification {
31
+ entityId
32
+ elementId
33
+ accountName
34
+ mode
35
+ confirmations
36
+ overrides
37
+ setBy
38
+ setAt
39
+ learnedFrom
40
+ }
41
+ classifications {
42
+ entityId
30
43
  elementId
31
44
  accountName
32
45
  mode
@@ -41,6 +41,18 @@ exports.LIST_AGENTS = (0, graphql_request_1.gql) `
41
41
  isActive
42
42
  is1099Recipient
43
43
  classification {
44
+ entityId
45
+ elementId
46
+ accountName
47
+ mode
48
+ confirmations
49
+ overrides
50
+ setBy
51
+ setAt
52
+ learnedFrom
53
+ }
54
+ classifications {
55
+ entityId
44
56
  elementId
45
57
  accountName
46
58
  mode
@@ -39,6 +39,18 @@ export const LIST_AGENTS = gql`
39
39
  isActive
40
40
  is1099Recipient
41
41
  classification {
42
+ entityId
43
+ elementId
44
+ accountName
45
+ mode
46
+ confirmations
47
+ overrides
48
+ setBy
49
+ setAt
50
+ learnedFrom
51
+ }
52
+ classifications {
53
+ entityId
42
54
  elementId
43
55
  accountName
44
56
  mode
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "2.20.1",
3
+ "version": "2.21.0",
4
4
  "description": "TypeScript client library for the RoboSystems financial intelligence platform",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
package/sdk/sdk.gen.d.ts CHANGED
@@ -1030,7 +1030,7 @@ export declare const createAgent: <ThrowOnError extends boolean = false>(options
1030
1030
  /**
1031
1031
  * Update Agent
1032
1032
  *
1033
- * Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
1033
+ * Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
1034
1034
  *
1035
1035
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1036
1036
  */
@@ -1038,7 +1038,7 @@ export declare const updateAgent: <ThrowOnError extends boolean = false>(options
1038
1038
  /**
1039
1039
  * Learn Classification Defaults
1040
1040
  *
1041
- * Seed each counterparty's default account from the bank lines already committed to the books: the account most of its lines went to becomes its default, with the lines that agreed counted as confirmations. A counterparty that already has a default keeps it. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
1041
+ * Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
1042
1042
  *
1043
1043
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1044
1044
  */
@@ -1254,7 +1254,7 @@ export declare const terminateSchedule: <ThrowOnError extends boolean = false>(o
1254
1254
  /**
1255
1255
  * Create Report
1256
1256
  *
1257
- * Generates report facts from the ledger and marks the report as published.
1257
+ * Generates report facts from the ledger and marks the report as published. The report is the entity's whose chart `mapping_id` maps from; made from the consolidation entity's mapping it is the group's consolidated statements: every member summed in full with the consolidating entries, under the group parent's Reporting Style. A consolidated column cannot span a member joining or leaving the group.
1258
1258
  *
1259
1259
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1260
1260
  */
package/sdk/sdk.gen.js CHANGED
@@ -2113,7 +2113,7 @@ exports.createAgent = createAgent;
2113
2113
  /**
2114
2114
  * Update Agent
2115
2115
  *
2116
- * Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
2116
+ * Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
2117
2117
  *
2118
2118
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2119
2119
  */
@@ -2130,7 +2130,7 @@ exports.updateAgent = updateAgent;
2130
2130
  /**
2131
2131
  * Learn Classification Defaults
2132
2132
  *
2133
- * Seed each counterparty's default account from the bank lines already committed to the books: the account most of its lines went to becomes its default, with the lines that agreed counted as confirmations. A counterparty that already has a default keeps it. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
2133
+ * Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
2134
2134
  *
2135
2135
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2136
2136
  */
@@ -2589,7 +2589,7 @@ exports.terminateSchedule = terminateSchedule;
2589
2589
  /**
2590
2590
  * Create Report
2591
2591
  *
2592
- * Generates report facts from the ledger and marks the report as published.
2592
+ * Generates report facts from the ledger and marks the report as published. The report is the entity's whose chart `mapping_id` maps from; made from the consolidation entity's mapping it is the group's consolidated statements: every member summed in full with the consolidating entries, under the group parent's Reporting Style. A consolidated column cannot span a member joining or leaving the group.
2593
2593
  *
2594
2594
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2595
2595
  */
package/sdk/sdk.gen.ts CHANGED
@@ -2124,7 +2124,7 @@ export const createAgent = <ThrowOnError extends boolean = false>(options: Optio
2124
2124
  /**
2125
2125
  * Update Agent
2126
2126
  *
2127
- * Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
2127
+ * Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
2128
2128
  *
2129
2129
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2130
2130
  */
@@ -2141,7 +2141,7 @@ export const updateAgent = <ThrowOnError extends boolean = false>(options: Optio
2141
2141
  /**
2142
2142
  * Learn Classification Defaults
2143
2143
  *
2144
- * Seed each counterparty's default account from the bank lines already committed to the books: the account most of its lines went to becomes its default, with the lines that agreed counted as confirmations. A counterparty that already has a default keeps it. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
2144
+ * Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
2145
2145
  *
2146
2146
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2147
2147
  */
@@ -2600,7 +2600,7 @@ export const terminateSchedule = <ThrowOnError extends boolean = false>(options:
2600
2600
  /**
2601
2601
  * Create Report
2602
2602
  *
2603
- * Generates report facts from the ledger and marks the report as published.
2603
+ * Generates report facts from the ledger and marks the report as published. The report is the entity's whose chart `mapping_id` maps from; made from the consolidation entity's mapping it is the group's consolidated statements: every member summed in full with the consolidating entries, under the group parent's Reporting Style. A consolidated column cannot span a member joining or leaving the group.
2604
2604
  *
2605
2605
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2606
2606
  */