@robosystems/client 2.20.2 → 2.22.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 +60 -2
- package/artifacts/LedgerClient.js +50 -0
- package/artifacts/LedgerClient.ts +127 -0
- package/artifacts/graphql/generated/graphql.d.ts +295 -0
- package/artifacts/graphql/generated/graphql.js +788 -2
- package/artifacts/graphql/generated/graphql.ts +1073 -0
- package/artifacts/graphql/queries/ledger/agedBalances.d.ts +27 -0
- package/artifacts/graphql/queries/ledger/agedBalances.js +136 -0
- package/artifacts/graphql/queries/ledger/agedBalances.ts +139 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/sdk/index.d.ts +1 -1
- package/sdk/index.ts +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 +92 -91
- package/sdk/types.gen.ts +93 -91
- package/sdk.gen.d.ts +3 -3
- package/sdk.gen.js +3 -3
- package/sdk.gen.ts +3 -3
- package/types.gen.d.ts +92 -91
- package/types.gen.ts +93 -91
package/types.gen.ts
CHANGED
|
@@ -1182,12 +1182,6 @@ export type BackupDownloadUrlResponse = {
|
|
|
1182
1182
|
* Backup operation limits.
|
|
1183
1183
|
*/
|
|
1184
1184
|
export type BackupLimits = {
|
|
1185
|
-
/**
|
|
1186
|
-
* Max Backup Size Gb
|
|
1187
|
-
*
|
|
1188
|
-
* Maximum backup size in GB
|
|
1189
|
-
*/
|
|
1190
|
-
max_backup_size_gb: number;
|
|
1191
1185
|
/**
|
|
1192
1186
|
* Backup Retention Days
|
|
1193
1187
|
*
|
|
@@ -1197,9 +1191,15 @@ export type BackupLimits = {
|
|
|
1197
1191
|
/**
|
|
1198
1192
|
* Max Backups Per Day
|
|
1199
1193
|
*
|
|
1200
|
-
* Maximum backups per day
|
|
1194
|
+
* Maximum user-initiated backups per day (-1 for unlimited)
|
|
1201
1195
|
*/
|
|
1202
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;
|
|
1203
1203
|
};
|
|
1204
1204
|
|
|
1205
1205
|
/**
|
|
@@ -2694,7 +2694,7 @@ export type ConsolidationProposal = {
|
|
|
2694
2694
|
/**
|
|
2695
2695
|
* Posting Date
|
|
2696
2696
|
*
|
|
2697
|
-
* The month's last day.
|
|
2697
|
+
* The month's last day; for an opening, the eve of the consolidation entity's first month.
|
|
2698
2698
|
*/
|
|
2699
2699
|
posting_date: string;
|
|
2700
2700
|
/**
|
|
@@ -2715,6 +2715,12 @@ export type ConsolidationProposal = {
|
|
|
2715
2715
|
* The entry's lines; they balance.
|
|
2716
2716
|
*/
|
|
2717
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;
|
|
2718
2724
|
};
|
|
2719
2725
|
|
|
2720
2726
|
/**
|
|
@@ -2909,6 +2915,12 @@ export type ConsolidationWorksheetResponse = {
|
|
|
2909
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.
|
|
2910
2916
|
*/
|
|
2911
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>;
|
|
2912
2924
|
/**
|
|
2913
2925
|
* Columns
|
|
2914
2926
|
*
|
|
@@ -2974,39 +2986,15 @@ export type ContentLimits = {
|
|
|
2974
2986
|
/**
|
|
2975
2987
|
* CopyOperationLimits
|
|
2976
2988
|
*
|
|
2977
|
-
*
|
|
2989
|
+
* File upload limits.
|
|
2978
2990
|
*/
|
|
2979
2991
|
export type CopyOperationLimits = {
|
|
2980
2992
|
/**
|
|
2981
2993
|
* Max File Size Gb
|
|
2982
2994
|
*
|
|
2983
|
-
* Maximum file size in GB
|
|
2995
|
+
* Maximum upload file size in GB
|
|
2984
2996
|
*/
|
|
2985
2997
|
max_file_size_gb: number;
|
|
2986
|
-
/**
|
|
2987
|
-
* Timeout Seconds
|
|
2988
|
-
*
|
|
2989
|
-
* Operation timeout in seconds
|
|
2990
|
-
*/
|
|
2991
|
-
timeout_seconds: number;
|
|
2992
|
-
/**
|
|
2993
|
-
* Concurrent Operations
|
|
2994
|
-
*
|
|
2995
|
-
* Maximum concurrent operations
|
|
2996
|
-
*/
|
|
2997
|
-
concurrent_operations: number;
|
|
2998
|
-
/**
|
|
2999
|
-
* Max Files Per Operation
|
|
3000
|
-
*
|
|
3001
|
-
* Maximum files per operation
|
|
3002
|
-
*/
|
|
3003
|
-
max_files_per_operation: number;
|
|
3004
|
-
/**
|
|
3005
|
-
* Daily Copy Operations
|
|
3006
|
-
*
|
|
3007
|
-
* Daily operation limit
|
|
3008
|
-
*/
|
|
3009
|
-
daily_copy_operations: number;
|
|
3010
2998
|
/**
|
|
3011
2999
|
* Supported Formats
|
|
3012
3000
|
*
|
|
@@ -3310,7 +3298,7 @@ export type CreateEntityRequest = {
|
|
|
3310
3298
|
/**
|
|
3311
3299
|
* Joined On
|
|
3312
3300
|
*
|
|
3313
|
-
* 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.
|
|
3314
3302
|
*/
|
|
3315
3303
|
joined_on?: string | null;
|
|
3316
3304
|
/**
|
|
@@ -3459,6 +3447,18 @@ export type CreateEventBlockRequest = {
|
|
|
3459
3447
|
* Accounting recognition date, if different from occurred_at
|
|
3460
3448
|
*/
|
|
3461
3449
|
effective_at?: string | null;
|
|
3450
|
+
/**
|
|
3451
|
+
* Due Date
|
|
3452
|
+
*
|
|
3453
|
+
* When an obligation falls due: an `invoice_issued` or a `bill_received`. Give it, or `terms_days`; with neither, the obligation is due on receipt. Refused on any other event type.
|
|
3454
|
+
*/
|
|
3455
|
+
due_date?: string | null;
|
|
3456
|
+
/**
|
|
3457
|
+
* Terms Days
|
|
3458
|
+
*
|
|
3459
|
+
* Net terms in days from `occurred_at` (30 for net 30), in place of `due_date`. Only on an `invoice_issued` or a `bill_received`.
|
|
3460
|
+
*/
|
|
3461
|
+
terms_days?: number | null;
|
|
3462
3462
|
/**
|
|
3463
3463
|
* Source
|
|
3464
3464
|
*
|
|
@@ -3915,7 +3915,7 @@ export type CreateReportRequest = {
|
|
|
3915
3915
|
/**
|
|
3916
3916
|
* Entity Id
|
|
3917
3917
|
*
|
|
3918
|
-
* 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.
|
|
3918
|
+
* 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.
|
|
3919
3919
|
*/
|
|
3920
3920
|
entity_id?: string | null;
|
|
3921
3921
|
/**
|
|
@@ -5366,6 +5366,26 @@ export type Dimension = {
|
|
|
5366
5366
|
*/
|
|
5367
5367
|
export type DimensionType = 'element' | 'period' | 'entity';
|
|
5368
5368
|
|
|
5369
|
+
/**
|
|
5370
|
+
* DischargeAllocation
|
|
5371
|
+
*
|
|
5372
|
+
* How much of a payment went to one invoice or bill.
|
|
5373
|
+
*/
|
|
5374
|
+
export type DischargeAllocation = {
|
|
5375
|
+
/**
|
|
5376
|
+
* Obligation Event Id
|
|
5377
|
+
*
|
|
5378
|
+
* The `invoice_issued` or `bill_received` event it settles.
|
|
5379
|
+
*/
|
|
5380
|
+
obligation_event_id: string;
|
|
5381
|
+
/**
|
|
5382
|
+
* Amount
|
|
5383
|
+
*
|
|
5384
|
+
* Positive cents of the payment applied to it.
|
|
5385
|
+
*/
|
|
5386
|
+
amount: number;
|
|
5387
|
+
};
|
|
5388
|
+
|
|
5369
5389
|
/**
|
|
5370
5390
|
* DisclosuresRequest
|
|
5371
5391
|
*
|
|
@@ -6329,6 +6349,12 @@ export type EventBlockEnvelope = {
|
|
|
6329
6349
|
* Accounting recognition date, when different from `occurred_at`.
|
|
6330
6350
|
*/
|
|
6331
6351
|
effective_at?: string | null;
|
|
6352
|
+
/**
|
|
6353
|
+
* Due Date
|
|
6354
|
+
*
|
|
6355
|
+
* When the obligation falls due (an `invoice_issued` or a `bill_received`); null when none was stated, which reads as due on receipt, and on every other event type.
|
|
6356
|
+
*/
|
|
6357
|
+
due_date?: string | null;
|
|
6332
6358
|
/**
|
|
6333
6359
|
* Source
|
|
6334
6360
|
*
|
|
@@ -7713,21 +7739,21 @@ export type GraphLimitsResponse = {
|
|
|
7713
7739
|
*/
|
|
7714
7740
|
is_shared_repository: boolean;
|
|
7715
7741
|
/**
|
|
7716
|
-
* Storage limits and usage
|
|
7742
|
+
* Storage limits and usage (user graphs only)
|
|
7717
7743
|
*/
|
|
7718
|
-
storage
|
|
7744
|
+
storage?: StorageLimits | null;
|
|
7719
7745
|
/**
|
|
7720
7746
|
* Query operation limits
|
|
7721
7747
|
*/
|
|
7722
7748
|
queries: QueryLimits;
|
|
7723
7749
|
/**
|
|
7724
|
-
*
|
|
7750
|
+
* File upload limits (user graphs only)
|
|
7725
7751
|
*/
|
|
7726
|
-
copy_operations
|
|
7752
|
+
copy_operations?: CopyOperationLimits | null;
|
|
7727
7753
|
/**
|
|
7728
|
-
* Backup operation limits
|
|
7754
|
+
* Backup operation limits (user graphs only)
|
|
7729
7755
|
*/
|
|
7730
|
-
backups
|
|
7756
|
+
backups?: BackupLimits | null;
|
|
7731
7757
|
/**
|
|
7732
7758
|
* API rate limits
|
|
7733
7759
|
*/
|
|
@@ -8154,7 +8180,7 @@ export type GraphSubscriptionTier = {
|
|
|
8154
8180
|
/**
|
|
8155
8181
|
* Instance Storage Limit Gb
|
|
8156
8182
|
*
|
|
8157
|
-
*
|
|
8183
|
+
* Instance storage cap in GB; ingest and materialize are refused above it
|
|
8158
8184
|
*/
|
|
8159
8185
|
instance_storage_limit_gb?: number;
|
|
8160
8186
|
};
|
|
@@ -8201,12 +8227,6 @@ export type GraphSubscriptions = {
|
|
|
8201
8227
|
* Backup configuration for a tier.
|
|
8202
8228
|
*/
|
|
8203
8229
|
export type GraphTierBackup = {
|
|
8204
|
-
/**
|
|
8205
|
-
* Max Backup Size Gb
|
|
8206
|
-
*
|
|
8207
|
-
* Maximum backup size in GB
|
|
8208
|
-
*/
|
|
8209
|
-
max_backup_size_gb: number;
|
|
8210
8230
|
/**
|
|
8211
8231
|
* Backup Retention Days
|
|
8212
8232
|
*
|
|
@@ -8224,39 +8244,15 @@ export type GraphTierBackup = {
|
|
|
8224
8244
|
/**
|
|
8225
8245
|
* GraphTierCopyOperations
|
|
8226
8246
|
*
|
|
8227
|
-
*
|
|
8247
|
+
* File upload limits for a tier.
|
|
8228
8248
|
*/
|
|
8229
8249
|
export type GraphTierCopyOperations = {
|
|
8230
8250
|
/**
|
|
8231
8251
|
* Max File Size Gb
|
|
8232
8252
|
*
|
|
8233
|
-
* Maximum file size in GB
|
|
8253
|
+
* Maximum upload file size in GB
|
|
8234
8254
|
*/
|
|
8235
8255
|
max_file_size_gb: number;
|
|
8236
|
-
/**
|
|
8237
|
-
* Timeout Seconds
|
|
8238
|
-
*
|
|
8239
|
-
* Operation timeout in seconds
|
|
8240
|
-
*/
|
|
8241
|
-
timeout_seconds: number;
|
|
8242
|
-
/**
|
|
8243
|
-
* Concurrent Operations
|
|
8244
|
-
*
|
|
8245
|
-
* Maximum concurrent operations
|
|
8246
|
-
*/
|
|
8247
|
-
concurrent_operations: number;
|
|
8248
|
-
/**
|
|
8249
|
-
* Max Files Per Operation
|
|
8250
|
-
*
|
|
8251
|
-
* Maximum files per operation
|
|
8252
|
-
*/
|
|
8253
|
-
max_files_per_operation: number;
|
|
8254
|
-
/**
|
|
8255
|
-
* Daily Copy Operations
|
|
8256
|
-
*
|
|
8257
|
-
* Daily operation limit
|
|
8258
|
-
*/
|
|
8259
|
-
daily_copy_operations: number;
|
|
8260
8256
|
};
|
|
8261
8257
|
|
|
8262
8258
|
/**
|
|
@@ -8386,7 +8382,7 @@ export type GraphTierLimits = {
|
|
|
8386
8382
|
*/
|
|
8387
8383
|
max_subgraphs: number | null;
|
|
8388
8384
|
/**
|
|
8389
|
-
*
|
|
8385
|
+
* File upload limits
|
|
8390
8386
|
*/
|
|
8391
8387
|
copy_operations: GraphTierCopyOperations;
|
|
8392
8388
|
/**
|
|
@@ -9089,7 +9085,7 @@ export type InstanceUsage = {
|
|
|
9089
9085
|
/**
|
|
9090
9086
|
* Limit Gb
|
|
9091
9087
|
*
|
|
9092
|
-
*
|
|
9088
|
+
* Instance storage cap in GB; ingest and materialize are refused above it
|
|
9093
9089
|
*/
|
|
9094
9090
|
limit_gb: number;
|
|
9095
9091
|
/**
|
|
@@ -10501,7 +10497,7 @@ export type LiveFinancialStatementResponse = {
|
|
|
10501
10497
|
/**
|
|
10502
10498
|
* Omitted Periods
|
|
10503
10499
|
*
|
|
10504
|
-
* 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.
|
|
10500
|
+
* 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.
|
|
10505
10501
|
*/
|
|
10506
10502
|
omitted_periods?: Array<PeriodSpec>;
|
|
10507
10503
|
/**
|
|
@@ -16170,27 +16166,21 @@ export type QueryLimits = {
|
|
|
16170
16166
|
/**
|
|
16171
16167
|
* Max Timeout Seconds
|
|
16172
16168
|
*
|
|
16173
|
-
*
|
|
16169
|
+
* Per-query time ceiling the graph engine enforces, in seconds
|
|
16174
16170
|
*/
|
|
16175
16171
|
max_timeout_seconds: number;
|
|
16176
16172
|
/**
|
|
16177
16173
|
* Chunk Size
|
|
16178
16174
|
*
|
|
16179
|
-
*
|
|
16175
|
+
* Default rows per streamed chunk (a request may set chunk_size, 10-10,000)
|
|
16180
16176
|
*/
|
|
16181
16177
|
chunk_size: number;
|
|
16182
16178
|
/**
|
|
16183
16179
|
* Max Rows Per Query
|
|
16184
16180
|
*
|
|
16185
|
-
*
|
|
16181
|
+
* Rows a non-streaming Cypher query returns before it stops (the response sets `truncated`); a streamed query returns up to 1,000,000
|
|
16186
16182
|
*/
|
|
16187
16183
|
max_rows_per_query: number;
|
|
16188
|
-
/**
|
|
16189
|
-
* Concurrent Queries
|
|
16190
|
-
*
|
|
16191
|
-
* Maximum concurrent queries allowed
|
|
16192
|
-
*/
|
|
16193
|
-
concurrent_queries: number;
|
|
16194
16184
|
};
|
|
16195
16185
|
|
|
16196
16186
|
/**
|
|
@@ -19651,7 +19641,7 @@ export type StorageLimits = {
|
|
|
19651
19641
|
/**
|
|
19652
19642
|
* Max Storage Gb
|
|
19653
19643
|
*
|
|
19654
|
-
*
|
|
19644
|
+
* Instance storage cap in GB; ingest and materialize are refused above it
|
|
19655
19645
|
*/
|
|
19656
19646
|
max_storage_gb: number;
|
|
19657
19647
|
/**
|
|
@@ -21219,13 +21209,13 @@ export type UpdateEntityRequest = {
|
|
|
21219
21209
|
/**
|
|
21220
21210
|
* Joined On
|
|
21221
21211
|
*
|
|
21222
|
-
* 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.
|
|
21212
|
+
* 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.
|
|
21223
21213
|
*/
|
|
21224
21214
|
joined_on?: string | null;
|
|
21225
21215
|
/**
|
|
21226
21216
|
* Left On
|
|
21227
21217
|
*
|
|
21228
|
-
* 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.
|
|
21218
|
+
* 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.
|
|
21229
21219
|
*/
|
|
21230
21220
|
left_on?: string | null;
|
|
21231
21221
|
};
|
|
@@ -21268,6 +21258,12 @@ export type UpdateEventBlockRequest = {
|
|
|
21268
21258
|
* New accounting recognition date. Unset = unchanged. Useful when an event was captured against the wrong period.
|
|
21269
21259
|
*/
|
|
21270
21260
|
effective_at?: string | null;
|
|
21261
|
+
/**
|
|
21262
|
+
* Due Date
|
|
21263
|
+
*
|
|
21264
|
+
* New due date of an obligation (an `invoice_issued` or a `bill_received`), such as an extension granted. Unset = unchanged. It moves no ledger row, so it is accepted in a closed period.
|
|
21265
|
+
*/
|
|
21266
|
+
due_date?: string | null;
|
|
21271
21267
|
/**
|
|
21272
21268
|
* Metadata Patch
|
|
21273
21269
|
*
|
|
@@ -21291,9 +21287,15 @@ export type UpdateEventBlockRequest = {
|
|
|
21291
21287
|
/**
|
|
21292
21288
|
* Discharges Event Id
|
|
21293
21289
|
*
|
|
21294
|
-
* Set
|
|
21290
|
+
* Set the settlement link: the one invoice or bill this payment settles, at its full amount; an empty string clears it. Replaces any `discharge_allocations`. Checked as they are.
|
|
21295
21291
|
*/
|
|
21296
21292
|
discharges_event_id?: string | null;
|
|
21293
|
+
/**
|
|
21294
|
+
* Discharge Allocations
|
|
21295
|
+
*
|
|
21296
|
+
* What this payment settles, document by document: one row per invoice or bill with the positive cents applied to it, together at most the payment's amount (the rest is unapplied). Replaces any held; an empty list clears them, and the settlement link becomes the first row's. Each must be an obligation of this event's entity, not voided: an invoice for money in, a bill for money out. A person chooses them; the open items a bank line may settle are `dischargeCandidates` over GraphQL.
|
|
21297
|
+
*/
|
|
21298
|
+
discharge_allocations?: Array<DischargeAllocation> | null;
|
|
21297
21299
|
/**
|
|
21298
21300
|
* Document Id
|
|
21299
21301
|
*
|