@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.
- package/artifacts/LedgerClient.d.ts +18 -2
- package/artifacts/LedgerClient.js +5 -1
- package/artifacts/LedgerClient.ts +21 -1
- package/artifacts/graphql/generated/graphql.d.ts +24 -0
- package/artifacts/graphql/generated/graphql.js +38 -0
- package/artifacts/graphql/generated/graphql.ts +62 -0
- package/artifacts/graphql/queries/ledger/agent.d.ts +4 -3
- package/artifacts/graphql/queries/ledger/agent.js +16 -3
- package/artifacts/graphql/queries/ledger/agent.ts +16 -3
- package/artifacts/graphql/queries/ledger/agents.js +12 -0
- package/artifacts/graphql/queries/ledger/agents.ts +12 -0
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +3 -3
- package/sdk/sdk.gen.js +3 -3
- package/sdk/sdk.gen.ts +3 -3
- package/sdk/types.gen.d.ts +66 -96
- package/sdk/types.gen.ts +66 -96
- package/sdk.gen.d.ts +3 -3
- package/sdk.gen.js +3 -3
- package/sdk.gen.ts +3 -3
- package/types.gen.d.ts +66 -96
- package/types.gen.ts +66 -96
package/sdk/types.gen.ts
CHANGED
|
@@ -101,7 +101,7 @@ export type AcceptSuggestionLine = {
|
|
|
101
101
|
/**
|
|
102
102
|
* Reason
|
|
103
103
|
*
|
|
104
|
-
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
104
|
+
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
105
105
|
*/
|
|
106
106
|
reason?: string | null;
|
|
107
107
|
/**
|
|
@@ -309,10 +309,16 @@ export type AddPublishListMembersOperation = {
|
|
|
309
309
|
/**
|
|
310
310
|
* AgentClassification
|
|
311
311
|
*
|
|
312
|
-
* A counterparty's default account
|
|
313
|
-
* hand.
|
|
312
|
+
* A counterparty's default account for one entity's lines, learned from
|
|
313
|
+
* committed lines or set by hand.
|
|
314
314
|
*/
|
|
315
315
|
export type AgentClassification = {
|
|
316
|
+
/**
|
|
317
|
+
* Entity Id
|
|
318
|
+
*
|
|
319
|
+
* The entity whose lines it is for.
|
|
320
|
+
*/
|
|
321
|
+
entity_id: string;
|
|
316
322
|
/**
|
|
317
323
|
* Element Id
|
|
318
324
|
*
|
|
@@ -1176,12 +1182,6 @@ export type BackupDownloadUrlResponse = {
|
|
|
1176
1182
|
* Backup operation limits.
|
|
1177
1183
|
*/
|
|
1178
1184
|
export type BackupLimits = {
|
|
1179
|
-
/**
|
|
1180
|
-
* Max Backup Size Gb
|
|
1181
|
-
*
|
|
1182
|
-
* Maximum backup size in GB
|
|
1183
|
-
*/
|
|
1184
|
-
max_backup_size_gb: number;
|
|
1185
1185
|
/**
|
|
1186
1186
|
* Backup Retention Days
|
|
1187
1187
|
*
|
|
@@ -1191,9 +1191,15 @@ export type BackupLimits = {
|
|
|
1191
1191
|
/**
|
|
1192
1192
|
* Max Backups Per Day
|
|
1193
1193
|
*
|
|
1194
|
-
* Maximum backups per day
|
|
1194
|
+
* Maximum user-initiated backups per day (-1 for unlimited)
|
|
1195
1195
|
*/
|
|
1196
1196
|
max_backups_per_day: number;
|
|
1197
|
+
/**
|
|
1198
|
+
* Max Downloads Per Month
|
|
1199
|
+
*
|
|
1200
|
+
* Backup downloads allowed per user per calendar month (UTC)
|
|
1201
|
+
*/
|
|
1202
|
+
max_downloads_per_month?: number | null;
|
|
1197
1203
|
};
|
|
1198
1204
|
|
|
1199
1205
|
/**
|
|
@@ -2688,7 +2694,7 @@ export type ConsolidationProposal = {
|
|
|
2688
2694
|
/**
|
|
2689
2695
|
* Posting Date
|
|
2690
2696
|
*
|
|
2691
|
-
* The month's last day.
|
|
2697
|
+
* The month's last day; for an opening, the eve of the consolidation entity's first month.
|
|
2692
2698
|
*/
|
|
2693
2699
|
posting_date: string;
|
|
2694
2700
|
/**
|
|
@@ -2709,6 +2715,12 @@ export type ConsolidationProposal = {
|
|
|
2709
2715
|
* The entry's lines; they balance.
|
|
2710
2716
|
*/
|
|
2711
2717
|
lines: Array<ConsolidationProposalLine>;
|
|
2718
|
+
/**
|
|
2719
|
+
* Opening
|
|
2720
|
+
*
|
|
2721
|
+
* Part of the consolidation entity's opening balance: what the members' history before the group's first month already needed eliminated, so the consolidated statements open on it rather than move by it. Proposing records it, posted, replacing the earlier one until the first close.
|
|
2722
|
+
*/
|
|
2723
|
+
opening?: boolean;
|
|
2712
2724
|
};
|
|
2713
2725
|
|
|
2714
2726
|
/**
|
|
@@ -2903,6 +2915,12 @@ export type ConsolidationWorksheetResponse = {
|
|
|
2903
2915
|
* The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
|
|
2904
2916
|
*/
|
|
2905
2917
|
period: PeriodSpec;
|
|
2918
|
+
/**
|
|
2919
|
+
* Omitted Periods
|
|
2920
|
+
*
|
|
2921
|
+
* Windows the worksheet does not total, as live-financial-statement leaves them out: before a summed entity's books begin, or, on a cash flow or equity statement, one a member joined or left the group within. When it names `period`, `rows` is empty.
|
|
2922
|
+
*/
|
|
2923
|
+
omitted_periods?: Array<PeriodSpec>;
|
|
2906
2924
|
/**
|
|
2907
2925
|
* Columns
|
|
2908
2926
|
*
|
|
@@ -2968,39 +2986,15 @@ export type ContentLimits = {
|
|
|
2968
2986
|
/**
|
|
2969
2987
|
* CopyOperationLimits
|
|
2970
2988
|
*
|
|
2971
|
-
*
|
|
2989
|
+
* File upload limits.
|
|
2972
2990
|
*/
|
|
2973
2991
|
export type CopyOperationLimits = {
|
|
2974
2992
|
/**
|
|
2975
2993
|
* Max File Size Gb
|
|
2976
2994
|
*
|
|
2977
|
-
* Maximum file size in GB
|
|
2995
|
+
* Maximum upload file size in GB
|
|
2978
2996
|
*/
|
|
2979
2997
|
max_file_size_gb: number;
|
|
2980
|
-
/**
|
|
2981
|
-
* Timeout Seconds
|
|
2982
|
-
*
|
|
2983
|
-
* Operation timeout in seconds
|
|
2984
|
-
*/
|
|
2985
|
-
timeout_seconds: number;
|
|
2986
|
-
/**
|
|
2987
|
-
* Concurrent Operations
|
|
2988
|
-
*
|
|
2989
|
-
* Maximum concurrent operations
|
|
2990
|
-
*/
|
|
2991
|
-
concurrent_operations: number;
|
|
2992
|
-
/**
|
|
2993
|
-
* Max Files Per Operation
|
|
2994
|
-
*
|
|
2995
|
-
* Maximum files per operation
|
|
2996
|
-
*/
|
|
2997
|
-
max_files_per_operation: number;
|
|
2998
|
-
/**
|
|
2999
|
-
* Daily Copy Operations
|
|
3000
|
-
*
|
|
3001
|
-
* Daily operation limit
|
|
3002
|
-
*/
|
|
3003
|
-
daily_copy_operations: number;
|
|
3004
2998
|
/**
|
|
3005
2999
|
* Supported Formats
|
|
3006
3000
|
*
|
|
@@ -3304,7 +3298,7 @@ export type CreateEntityRequest = {
|
|
|
3304
3298
|
/**
|
|
3305
3299
|
* Joined On
|
|
3306
3300
|
*
|
|
3307
|
-
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Omit for a subsidiary formed by the parent; give the acquisition month for one acquired, whose books in this graph then hold only what follows it.
|
|
3301
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Omit for a subsidiary formed by the parent; give the acquisition month for one acquired, whose books in this graph then hold only what follows it. Refused on the consolidation entity.
|
|
3308
3302
|
*/
|
|
3309
3303
|
joined_on?: string | null;
|
|
3310
3304
|
/**
|
|
@@ -3909,7 +3903,7 @@ export type CreateReportRequest = {
|
|
|
3909
3903
|
/**
|
|
3910
3904
|
* Entity Id
|
|
3911
3905
|
*
|
|
3912
|
-
* The entity the report is for, by id. Omit for the entity whose chart `mapping_id` maps from (the group parent on a one-entity graph). Named alongside a mapping of another entity's chart, it is refused.
|
|
3906
|
+
* The entity the report is for, by id. Omit for the entity whose chart `mapping_id` maps from (the group parent on a one-entity graph). Named alongside a mapping of another entity's chart, it is refused. The consolidation entity's report is the group's consolidated statements.
|
|
3913
3907
|
*/
|
|
3914
3908
|
entity_id?: string | null;
|
|
3915
3909
|
/**
|
|
@@ -7707,21 +7701,21 @@ export type GraphLimitsResponse = {
|
|
|
7707
7701
|
*/
|
|
7708
7702
|
is_shared_repository: boolean;
|
|
7709
7703
|
/**
|
|
7710
|
-
* Storage limits and usage
|
|
7704
|
+
* Storage limits and usage (user graphs only)
|
|
7711
7705
|
*/
|
|
7712
|
-
storage
|
|
7706
|
+
storage?: StorageLimits | null;
|
|
7713
7707
|
/**
|
|
7714
7708
|
* Query operation limits
|
|
7715
7709
|
*/
|
|
7716
7710
|
queries: QueryLimits;
|
|
7717
7711
|
/**
|
|
7718
|
-
*
|
|
7712
|
+
* File upload limits (user graphs only)
|
|
7719
7713
|
*/
|
|
7720
|
-
copy_operations
|
|
7714
|
+
copy_operations?: CopyOperationLimits | null;
|
|
7721
7715
|
/**
|
|
7722
|
-
* Backup operation limits
|
|
7716
|
+
* Backup operation limits (user graphs only)
|
|
7723
7717
|
*/
|
|
7724
|
-
backups
|
|
7718
|
+
backups?: BackupLimits | null;
|
|
7725
7719
|
/**
|
|
7726
7720
|
* API rate limits
|
|
7727
7721
|
*/
|
|
@@ -8148,7 +8142,7 @@ export type GraphSubscriptionTier = {
|
|
|
8148
8142
|
/**
|
|
8149
8143
|
* Instance Storage Limit Gb
|
|
8150
8144
|
*
|
|
8151
|
-
*
|
|
8145
|
+
* Instance storage cap in GB; ingest and materialize are refused above it
|
|
8152
8146
|
*/
|
|
8153
8147
|
instance_storage_limit_gb?: number;
|
|
8154
8148
|
};
|
|
@@ -8195,12 +8189,6 @@ export type GraphSubscriptions = {
|
|
|
8195
8189
|
* Backup configuration for a tier.
|
|
8196
8190
|
*/
|
|
8197
8191
|
export type GraphTierBackup = {
|
|
8198
|
-
/**
|
|
8199
|
-
* Max Backup Size Gb
|
|
8200
|
-
*
|
|
8201
|
-
* Maximum backup size in GB
|
|
8202
|
-
*/
|
|
8203
|
-
max_backup_size_gb: number;
|
|
8204
8192
|
/**
|
|
8205
8193
|
* Backup Retention Days
|
|
8206
8194
|
*
|
|
@@ -8218,39 +8206,15 @@ export type GraphTierBackup = {
|
|
|
8218
8206
|
/**
|
|
8219
8207
|
* GraphTierCopyOperations
|
|
8220
8208
|
*
|
|
8221
|
-
*
|
|
8209
|
+
* File upload limits for a tier.
|
|
8222
8210
|
*/
|
|
8223
8211
|
export type GraphTierCopyOperations = {
|
|
8224
8212
|
/**
|
|
8225
8213
|
* Max File Size Gb
|
|
8226
8214
|
*
|
|
8227
|
-
* Maximum file size in GB
|
|
8215
|
+
* Maximum upload file size in GB
|
|
8228
8216
|
*/
|
|
8229
8217
|
max_file_size_gb: number;
|
|
8230
|
-
/**
|
|
8231
|
-
* Timeout Seconds
|
|
8232
|
-
*
|
|
8233
|
-
* Operation timeout in seconds
|
|
8234
|
-
*/
|
|
8235
|
-
timeout_seconds: number;
|
|
8236
|
-
/**
|
|
8237
|
-
* Concurrent Operations
|
|
8238
|
-
*
|
|
8239
|
-
* Maximum concurrent operations
|
|
8240
|
-
*/
|
|
8241
|
-
concurrent_operations: number;
|
|
8242
|
-
/**
|
|
8243
|
-
* Max Files Per Operation
|
|
8244
|
-
*
|
|
8245
|
-
* Maximum files per operation
|
|
8246
|
-
*/
|
|
8247
|
-
max_files_per_operation: number;
|
|
8248
|
-
/**
|
|
8249
|
-
* Daily Copy Operations
|
|
8250
|
-
*
|
|
8251
|
-
* Daily operation limit
|
|
8252
|
-
*/
|
|
8253
|
-
daily_copy_operations: number;
|
|
8254
8218
|
};
|
|
8255
8219
|
|
|
8256
8220
|
/**
|
|
@@ -8380,7 +8344,7 @@ export type GraphTierLimits = {
|
|
|
8380
8344
|
*/
|
|
8381
8345
|
max_subgraphs: number | null;
|
|
8382
8346
|
/**
|
|
8383
|
-
*
|
|
8347
|
+
* File upload limits
|
|
8384
8348
|
*/
|
|
8385
8349
|
copy_operations: GraphTierCopyOperations;
|
|
8386
8350
|
/**
|
|
@@ -9083,7 +9047,7 @@ export type InstanceUsage = {
|
|
|
9083
9047
|
/**
|
|
9084
9048
|
* Limit Gb
|
|
9085
9049
|
*
|
|
9086
|
-
*
|
|
9050
|
+
* Instance storage cap in GB; ingest and materialize are refused above it
|
|
9087
9051
|
*/
|
|
9088
9052
|
limit_gb: number;
|
|
9089
9053
|
/**
|
|
@@ -9477,13 +9441,13 @@ export type LearnClassificationDefaultsResponse = {
|
|
|
9477
9441
|
/**
|
|
9478
9442
|
* Agents Learned
|
|
9479
9443
|
*
|
|
9480
|
-
*
|
|
9444
|
+
* Defaults learned from committed lines, one per counterparty and entity.
|
|
9481
9445
|
*/
|
|
9482
9446
|
agents_learned: number;
|
|
9483
9447
|
/**
|
|
9484
9448
|
* Agents Kept
|
|
9485
9449
|
*
|
|
9486
|
-
*
|
|
9450
|
+
* Counterparty and entity pairs that already had a default, left as they were.
|
|
9487
9451
|
*/
|
|
9488
9452
|
agents_kept: number;
|
|
9489
9453
|
/**
|
|
@@ -9571,9 +9535,15 @@ export type LedgerAgentResponse = {
|
|
|
9571
9535
|
*/
|
|
9572
9536
|
is_1099_recipient: boolean;
|
|
9573
9537
|
/**
|
|
9574
|
-
* The default account
|
|
9538
|
+
* The default account the group parent's bank lines are suggested.
|
|
9575
9539
|
*/
|
|
9576
9540
|
classification?: AgentClassification | null;
|
|
9541
|
+
/**
|
|
9542
|
+
* Classifications
|
|
9543
|
+
*
|
|
9544
|
+
* The default account for each entity's bank lines, one per entity.
|
|
9545
|
+
*/
|
|
9546
|
+
classifications?: Array<AgentClassification>;
|
|
9577
9547
|
/**
|
|
9578
9548
|
* Created At
|
|
9579
9549
|
*/
|
|
@@ -10489,7 +10459,7 @@ export type LiveFinancialStatementResponse = {
|
|
|
10489
10459
|
/**
|
|
10490
10460
|
* Omitted Periods
|
|
10491
10461
|
*
|
|
10492
|
-
* Columns left out because they reach back before the books begin: on books that start from an opening balance, a flow statement column that starts before the first day it covers, or a balance sheet dated before it. They would show a partial figure, not the months before the books.
|
|
10462
|
+
* Columns left out because they reach back before the books begin: on books that start from an opening balance, a flow statement column that starts before the first day it covers, or a balance sheet dated before it. They would show a partial figure, not the months before the books. On a group read, also a cash flow or equity statement column a member joined or left the group within.
|
|
10493
10463
|
*/
|
|
10494
10464
|
omitted_periods?: Array<PeriodSpec>;
|
|
10495
10465
|
/**
|
|
@@ -16158,27 +16128,21 @@ export type QueryLimits = {
|
|
|
16158
16128
|
/**
|
|
16159
16129
|
* Max Timeout Seconds
|
|
16160
16130
|
*
|
|
16161
|
-
*
|
|
16131
|
+
* Per-query time ceiling the graph engine enforces, in seconds
|
|
16162
16132
|
*/
|
|
16163
16133
|
max_timeout_seconds: number;
|
|
16164
16134
|
/**
|
|
16165
16135
|
* Chunk Size
|
|
16166
16136
|
*
|
|
16167
|
-
*
|
|
16137
|
+
* Default rows per streamed chunk (a request may set chunk_size, 10-10,000)
|
|
16168
16138
|
*/
|
|
16169
16139
|
chunk_size: number;
|
|
16170
16140
|
/**
|
|
16171
16141
|
* Max Rows Per Query
|
|
16172
16142
|
*
|
|
16173
|
-
*
|
|
16143
|
+
* Rows a non-streaming Cypher query returns before it stops (the response sets `truncated`); a streamed query returns up to 1,000,000
|
|
16174
16144
|
*/
|
|
16175
16145
|
max_rows_per_query: number;
|
|
16176
|
-
/**
|
|
16177
|
-
* Concurrent Queries
|
|
16178
|
-
*
|
|
16179
|
-
* Maximum concurrent queries allowed
|
|
16180
|
-
*/
|
|
16181
|
-
concurrent_queries: number;
|
|
16182
16146
|
};
|
|
16183
16147
|
|
|
16184
16148
|
/**
|
|
@@ -19639,7 +19603,7 @@ export type StorageLimits = {
|
|
|
19639
19603
|
/**
|
|
19640
19604
|
* Max Storage Gb
|
|
19641
19605
|
*
|
|
19642
|
-
*
|
|
19606
|
+
* Instance storage cap in GB; ingest and materialize are refused above it
|
|
19643
19607
|
*/
|
|
19644
19608
|
max_storage_gb: number;
|
|
19645
19609
|
/**
|
|
@@ -21063,6 +21027,12 @@ export type UpdateAgentRequest = {
|
|
|
21063
21027
|
* `suggest` offers the default on each line; `always_ask` offers none, for a counterparty whose lines go to different accounts. Omit to keep.
|
|
21064
21028
|
*/
|
|
21065
21029
|
classification_mode?: 'suggest' | 'always_ask' | null;
|
|
21030
|
+
/**
|
|
21031
|
+
* Classification Entity Id
|
|
21032
|
+
*
|
|
21033
|
+
* The entity whose bank lines the default above is for. Each entity keeps its own default, on its own chart. Omit for the group parent.
|
|
21034
|
+
*/
|
|
21035
|
+
classification_entity_id?: string | null;
|
|
21066
21036
|
/**
|
|
21067
21037
|
* Metadata Patch
|
|
21068
21038
|
*
|
|
@@ -21201,13 +21171,13 @@ export type UpdateEntityRequest = {
|
|
|
21201
21171
|
/**
|
|
21202
21172
|
* Joined On
|
|
21203
21173
|
*
|
|
21204
|
-
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Pass null to clear it.
|
|
21174
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Pass null to clear it. Refused on the consolidation entity.
|
|
21205
21175
|
*/
|
|
21206
21176
|
joined_on?: string | null;
|
|
21207
21177
|
/**
|
|
21208
21178
|
* Left On
|
|
21209
21179
|
*
|
|
21210
|
-
* The month this entity left the group, as any date in it; null is a member still. The consolidated statements include it through that month and leave it out after. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Must not precede `joined_on`. Set it when a subsidiary is sold, dissolved or deconsolidated; its closed months and stamped statements stay readable under the group. Pass null to reopen membership.
|
|
21180
|
+
* The month this entity left the group, as any date in it; null is a member still. The consolidated statements include it through that month and leave it out after. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Must not precede `joined_on`. Set it when a subsidiary is sold, dissolved or deconsolidated; its closed months and stamped statements stay readable under the group. Pass null to reopen membership. Refused on the consolidation entity.
|
|
21211
21181
|
*/
|
|
21212
21182
|
left_on?: string | null;
|
|
21213
21183
|
};
|
package/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
|
|
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.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
|
|
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.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
|
|
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
|
*/
|