@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/types.gen.d.ts CHANGED
@@ -1151,12 +1151,6 @@ export type BackupDownloadUrlResponse = {
1151
1151
  * Backup operation limits.
1152
1152
  */
1153
1153
  export type BackupLimits = {
1154
- /**
1155
- * Max Backup Size Gb
1156
- *
1157
- * Maximum backup size in GB
1158
- */
1159
- max_backup_size_gb: number;
1160
1154
  /**
1161
1155
  * Backup Retention Days
1162
1156
  *
@@ -1166,9 +1160,15 @@ export type BackupLimits = {
1166
1160
  /**
1167
1161
  * Max Backups Per Day
1168
1162
  *
1169
- * Maximum backups per day
1163
+ * Maximum user-initiated backups per day (-1 for unlimited)
1170
1164
  */
1171
1165
  max_backups_per_day: number;
1166
+ /**
1167
+ * Max Downloads Per Month
1168
+ *
1169
+ * Backup downloads allowed per user per calendar month (UTC)
1170
+ */
1171
+ max_downloads_per_month?: number | null;
1172
1172
  };
1173
1173
  /**
1174
1174
  * BackupListResponse
@@ -2628,7 +2628,7 @@ export type ConsolidationProposal = {
2628
2628
  /**
2629
2629
  * Posting Date
2630
2630
  *
2631
- * The month's last day.
2631
+ * The month's last day; for an opening, the eve of the consolidation entity's first month.
2632
2632
  */
2633
2633
  posting_date: string;
2634
2634
  /**
@@ -2649,6 +2649,12 @@ export type ConsolidationProposal = {
2649
2649
  * The entry's lines; they balance.
2650
2650
  */
2651
2651
  lines: Array<ConsolidationProposalLine>;
2652
+ /**
2653
+ * Opening
2654
+ *
2655
+ * 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.
2656
+ */
2657
+ opening?: boolean;
2652
2658
  };
2653
2659
  /**
2654
2660
  * ConsolidationProposalLine
@@ -2838,6 +2844,12 @@ export type ConsolidationWorksheetResponse = {
2838
2844
  * The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
2839
2845
  */
2840
2846
  period: PeriodSpec;
2847
+ /**
2848
+ * Omitted Periods
2849
+ *
2850
+ * 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.
2851
+ */
2852
+ omitted_periods?: Array<PeriodSpec>;
2841
2853
  /**
2842
2854
  * Columns
2843
2855
  *
@@ -2901,39 +2913,15 @@ export type ContentLimits = {
2901
2913
  /**
2902
2914
  * CopyOperationLimits
2903
2915
  *
2904
- * Copy/ingestion operation limits.
2916
+ * File upload limits.
2905
2917
  */
2906
2918
  export type CopyOperationLimits = {
2907
2919
  /**
2908
2920
  * Max File Size Gb
2909
2921
  *
2910
- * Maximum file size in GB
2922
+ * Maximum upload file size in GB
2911
2923
  */
2912
2924
  max_file_size_gb: number;
2913
- /**
2914
- * Timeout Seconds
2915
- *
2916
- * Operation timeout in seconds
2917
- */
2918
- timeout_seconds: number;
2919
- /**
2920
- * Concurrent Operations
2921
- *
2922
- * Maximum concurrent operations
2923
- */
2924
- concurrent_operations: number;
2925
- /**
2926
- * Max Files Per Operation
2927
- *
2928
- * Maximum files per operation
2929
- */
2930
- max_files_per_operation: number;
2931
- /**
2932
- * Daily Copy Operations
2933
- *
2934
- * Daily operation limit
2935
- */
2936
- daily_copy_operations: number;
2937
2925
  /**
2938
2926
  * Supported Formats
2939
2927
  *
@@ -3230,7 +3218,7 @@ export type CreateEntityRequest = {
3230
3218
  /**
3231
3219
  * Joined On
3232
3220
  *
3233
- * 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.
3221
+ * 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.
3234
3222
  */
3235
3223
  joined_on?: string | null;
3236
3224
  /**
@@ -3378,6 +3366,18 @@ export type CreateEventBlockRequest = {
3378
3366
  * Accounting recognition date, if different from occurred_at
3379
3367
  */
3380
3368
  effective_at?: string | null;
3369
+ /**
3370
+ * Due Date
3371
+ *
3372
+ * 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.
3373
+ */
3374
+ due_date?: string | null;
3375
+ /**
3376
+ * Terms Days
3377
+ *
3378
+ * 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`.
3379
+ */
3380
+ terms_days?: number | null;
3381
3381
  /**
3382
3382
  * Source
3383
3383
  *
@@ -3825,7 +3825,7 @@ export type CreateReportRequest = {
3825
3825
  /**
3826
3826
  * Entity Id
3827
3827
  *
3828
- * 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.
3828
+ * 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.
3829
3829
  */
3830
3830
  entity_id?: string | null;
3831
3831
  /**
@@ -5236,6 +5236,25 @@ export type Dimension = {
5236
5236
  * DimensionType
5237
5237
  */
5238
5238
  export type DimensionType = 'element' | 'period' | 'entity';
5239
+ /**
5240
+ * DischargeAllocation
5241
+ *
5242
+ * How much of a payment went to one invoice or bill.
5243
+ */
5244
+ export type DischargeAllocation = {
5245
+ /**
5246
+ * Obligation Event Id
5247
+ *
5248
+ * The `invoice_issued` or `bill_received` event it settles.
5249
+ */
5250
+ obligation_event_id: string;
5251
+ /**
5252
+ * Amount
5253
+ *
5254
+ * Positive cents of the payment applied to it.
5255
+ */
5256
+ amount: number;
5257
+ };
5239
5258
  /**
5240
5259
  * DisclosuresRequest
5241
5260
  *
@@ -6176,6 +6195,12 @@ export type EventBlockEnvelope = {
6176
6195
  * Accounting recognition date, when different from `occurred_at`.
6177
6196
  */
6178
6197
  effective_at?: string | null;
6198
+ /**
6199
+ * Due Date
6200
+ *
6201
+ * 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.
6202
+ */
6203
+ due_date?: string | null;
6179
6204
  /**
6180
6205
  * Source
6181
6206
  *
@@ -7536,21 +7561,21 @@ export type GraphLimitsResponse = {
7536
7561
  */
7537
7562
  is_shared_repository: boolean;
7538
7563
  /**
7539
- * Storage limits and usage
7564
+ * Storage limits and usage (user graphs only)
7540
7565
  */
7541
- storage: StorageLimits;
7566
+ storage?: StorageLimits | null;
7542
7567
  /**
7543
7568
  * Query operation limits
7544
7569
  */
7545
7570
  queries: QueryLimits;
7546
7571
  /**
7547
- * Copy/ingestion operation limits
7572
+ * File upload limits (user graphs only)
7548
7573
  */
7549
- copy_operations: CopyOperationLimits;
7574
+ copy_operations?: CopyOperationLimits | null;
7550
7575
  /**
7551
- * Backup operation limits
7576
+ * Backup operation limits (user graphs only)
7552
7577
  */
7553
- backups: BackupLimits;
7578
+ backups?: BackupLimits | null;
7554
7579
  /**
7555
7580
  * API rate limits
7556
7581
  */
@@ -7969,7 +7994,7 @@ export type GraphSubscriptionTier = {
7969
7994
  /**
7970
7995
  * Instance Storage Limit Gb
7971
7996
  *
7972
- * Soft storage cap for the instance in GB
7997
+ * Instance storage cap in GB; ingest and materialize are refused above it
7973
7998
  */
7974
7999
  instance_storage_limit_gb?: number;
7975
8000
  };
@@ -8014,12 +8039,6 @@ export type GraphSubscriptions = {
8014
8039
  * Backup configuration for a tier.
8015
8040
  */
8016
8041
  export type GraphTierBackup = {
8017
- /**
8018
- * Max Backup Size Gb
8019
- *
8020
- * Maximum backup size in GB
8021
- */
8022
- max_backup_size_gb: number;
8023
8042
  /**
8024
8043
  * Backup Retention Days
8025
8044
  *
@@ -8036,39 +8055,15 @@ export type GraphTierBackup = {
8036
8055
  /**
8037
8056
  * GraphTierCopyOperations
8038
8057
  *
8039
- * Copy operation limits for a tier.
8058
+ * File upload limits for a tier.
8040
8059
  */
8041
8060
  export type GraphTierCopyOperations = {
8042
8061
  /**
8043
8062
  * Max File Size Gb
8044
8063
  *
8045
- * Maximum file size in GB
8064
+ * Maximum upload file size in GB
8046
8065
  */
8047
8066
  max_file_size_gb: number;
8048
- /**
8049
- * Timeout Seconds
8050
- *
8051
- * Operation timeout in seconds
8052
- */
8053
- timeout_seconds: number;
8054
- /**
8055
- * Concurrent Operations
8056
- *
8057
- * Maximum concurrent operations
8058
- */
8059
- concurrent_operations: number;
8060
- /**
8061
- * Max Files Per Operation
8062
- *
8063
- * Maximum files per operation
8064
- */
8065
- max_files_per_operation: number;
8066
- /**
8067
- * Daily Copy Operations
8068
- *
8069
- * Daily operation limit
8070
- */
8071
- daily_copy_operations: number;
8072
8067
  };
8073
8068
  /**
8074
8069
  * GraphTierInfo
@@ -8195,7 +8190,7 @@ export type GraphTierLimits = {
8195
8190
  */
8196
8191
  max_subgraphs: number | null;
8197
8192
  /**
8198
- * Copy operation limits
8193
+ * File upload limits
8199
8194
  */
8200
8195
  copy_operations: GraphTierCopyOperations;
8201
8196
  /**
@@ -8883,7 +8878,7 @@ export type InstanceUsage = {
8883
8878
  /**
8884
8879
  * Limit Gb
8885
8880
  *
8886
- * Soft storage limit for this tier in GB
8881
+ * Instance storage cap in GB; ingest and materialize are refused above it
8887
8882
  */
8888
8883
  limit_gb: number;
8889
8884
  /**
@@ -10269,7 +10264,7 @@ export type LiveFinancialStatementResponse = {
10269
10264
  /**
10270
10265
  * Omitted Periods
10271
10266
  *
10272
- * 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.
10267
+ * 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.
10273
10268
  */
10274
10269
  omitted_periods?: Array<PeriodSpec>;
10275
10270
  /**
@@ -15797,27 +15792,21 @@ export type QueryLimits = {
15797
15792
  /**
15798
15793
  * Max Timeout Seconds
15799
15794
  *
15800
- * Maximum query timeout in seconds
15795
+ * Per-query time ceiling the graph engine enforces, in seconds
15801
15796
  */
15802
15797
  max_timeout_seconds: number;
15803
15798
  /**
15804
15799
  * Chunk Size
15805
15800
  *
15806
- * Maximum chunk size for result streaming
15801
+ * Default rows per streamed chunk (a request may set chunk_size, 10-10,000)
15807
15802
  */
15808
15803
  chunk_size: number;
15809
15804
  /**
15810
15805
  * Max Rows Per Query
15811
15806
  *
15812
- * Maximum rows returned per query
15807
+ * Rows a non-streaming Cypher query returns before it stops (the response sets `truncated`); a streamed query returns up to 1,000,000
15813
15808
  */
15814
15809
  max_rows_per_query: number;
15815
- /**
15816
- * Concurrent Queries
15817
- *
15818
- * Maximum concurrent queries allowed
15819
- */
15820
- concurrent_queries: number;
15821
15810
  };
15822
15811
  /**
15823
15812
  * QuickBooksConnectionConfig
@@ -19195,7 +19184,7 @@ export type StorageLimits = {
19195
19184
  /**
19196
19185
  * Max Storage Gb
19197
19186
  *
19198
- * Maximum storage limit in GB
19187
+ * Instance storage cap in GB; ingest and materialize are refused above it
19199
19188
  */
19200
19189
  max_storage_gb: number;
19201
19190
  /**
@@ -20727,13 +20716,13 @@ export type UpdateEntityRequest = {
20727
20716
  /**
20728
20717
  * Joined On
20729
20718
  *
20730
- * 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.
20719
+ * 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.
20731
20720
  */
20732
20721
  joined_on?: string | null;
20733
20722
  /**
20734
20723
  * Left On
20735
20724
  *
20736
- * 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.
20725
+ * 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.
20737
20726
  */
20738
20727
  left_on?: string | null;
20739
20728
  };
@@ -20775,6 +20764,12 @@ export type UpdateEventBlockRequest = {
20775
20764
  * New accounting recognition date. Unset = unchanged. Useful when an event was captured against the wrong period.
20776
20765
  */
20777
20766
  effective_at?: string | null;
20767
+ /**
20768
+ * Due Date
20769
+ *
20770
+ * 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.
20771
+ */
20772
+ due_date?: string | null;
20778
20773
  /**
20779
20774
  * Metadata Patch
20780
20775
  *
@@ -20798,9 +20793,15 @@ export type UpdateEventBlockRequest = {
20798
20793
  /**
20799
20794
  * Discharges Event Id
20800
20795
  *
20801
- * Set/update the settlement link.
20796
+ * 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.
20802
20797
  */
20803
20798
  discharges_event_id?: string | null;
20799
+ /**
20800
+ * Discharge Allocations
20801
+ *
20802
+ * 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.
20803
+ */
20804
+ discharge_allocations?: Array<DischargeAllocation> | null;
20804
20805
  /**
20805
20806
  * Document Id
20806
20807
  *