@robosystems/client 2.22.0 → 2.24.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 +58 -3
- package/artifacts/LedgerClient.js +65 -1
- package/artifacts/LedgerClient.ts +125 -2
- package/artifacts/graphql/generated/graphql.d.ts +173 -0
- package/artifacts/graphql/generated/graphql.js +430 -2
- package/artifacts/graphql/generated/graphql.ts +583 -0
- package/artifacts/graphql/queries/ledger/accountRegister.d.ts +13 -0
- package/artifacts/graphql/queries/ledger/accountRegister.js +98 -0
- package/artifacts/graphql/queries/ledger/accountRegister.ts +96 -0
- package/artifacts/graphql/queries/ledger/dimensions.d.ts +7 -0
- package/artifacts/graphql/queries/ledger/dimensions.js +27 -0
- package/artifacts/graphql/queries/ledger/dimensions.ts +25 -0
- package/artifacts/graphql/queries/ledger/eventBlock.d.ts +3 -1
- package/artifacts/graphql/queries/ledger/eventBlock.js +24 -1
- package/artifacts/graphql/queries/ledger/eventBlock.ts +24 -1
- package/artifacts/graphql/queries/ledger/journalEntries.js +6 -0
- package/artifacts/graphql/queries/ledger/journalEntries.ts +6 -0
- package/artifacts/graphql/queries/ledger/transaction.js +6 -0
- package/artifacts/graphql/queries/ledger/transaction.ts +6 -0
- package/artifacts/graphql/queries/ledger/trialBalance.d.ts +4 -1
- package/artifacts/graphql/queries/ledger/trialBalance.js +19 -3
- package/artifacts/graphql/queries/ledger/trialBalance.ts +19 -3
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +7 -5
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +19 -3
- package/sdk/sdk.gen.js +38 -4
- package/sdk/sdk.gen.ts +37 -3
- package/sdk/types.gen.d.ts +455 -4
- package/sdk/types.gen.ts +474 -4
- package/sdk.gen.d.ts +19 -3
- package/sdk.gen.js +38 -4
- package/sdk.gen.ts +37 -3
- package/types.gen.d.ts +455 -4
- package/types.gen.ts +474 -4
package/sdk/types.gen.ts
CHANGED
|
@@ -3208,6 +3208,32 @@ export type CreateConnectionRequest = {
|
|
|
3208
3208
|
plaid_config?: PlaidConnectionConfig | null;
|
|
3209
3209
|
};
|
|
3210
3210
|
|
|
3211
|
+
/**
|
|
3212
|
+
* CreateDimensionRequest
|
|
3213
|
+
*
|
|
3214
|
+
* Add a member to a management dimension.
|
|
3215
|
+
*/
|
|
3216
|
+
export type CreateDimensionRequest = {
|
|
3217
|
+
/**
|
|
3218
|
+
* Dimension Type
|
|
3219
|
+
*
|
|
3220
|
+
* The axis: `department`, `class`, `location` or `project`, or any other lowercase name, which starts an axis of its own. `scenario` is reserved for forecasts.
|
|
3221
|
+
*/
|
|
3222
|
+
dimension_type: string;
|
|
3223
|
+
/**
|
|
3224
|
+
* Name
|
|
3225
|
+
*
|
|
3226
|
+
* The member's label.
|
|
3227
|
+
*/
|
|
3228
|
+
name: string;
|
|
3229
|
+
/**
|
|
3230
|
+
* Value
|
|
3231
|
+
*
|
|
3232
|
+
* The member's stable key within the axis; omitted, a slug of the name. Refused (409) when the axis already has it.
|
|
3233
|
+
*/
|
|
3234
|
+
value?: string | null;
|
|
3235
|
+
};
|
|
3236
|
+
|
|
3211
3237
|
/**
|
|
3212
3238
|
* CreateDocumentUploadOp
|
|
3213
3239
|
*
|
|
@@ -3506,7 +3532,7 @@ export type CreateEventBlockRequest = {
|
|
|
3506
3532
|
/**
|
|
3507
3533
|
* Dimension Ids
|
|
3508
3534
|
*
|
|
3509
|
-
*
|
|
3535
|
+
* Management dimension members tagging this event (department, class, location, project), one per axis. Every line its handler writes carries them on the axes the line does not tag itself.
|
|
3510
3536
|
*/
|
|
3511
3537
|
dimension_ids?: Array<string>;
|
|
3512
3538
|
/**
|
|
@@ -5361,6 +5387,62 @@ export type Dimension = {
|
|
|
5361
5387
|
members?: Array<string>;
|
|
5362
5388
|
};
|
|
5363
5389
|
|
|
5390
|
+
/**
|
|
5391
|
+
* DimensionResponse
|
|
5392
|
+
*
|
|
5393
|
+
* One member of a management dimension.
|
|
5394
|
+
*/
|
|
5395
|
+
export type DimensionResponse = {
|
|
5396
|
+
/**
|
|
5397
|
+
* Id
|
|
5398
|
+
*
|
|
5399
|
+
* The member's id, as lines carry it.
|
|
5400
|
+
*/
|
|
5401
|
+
id: string;
|
|
5402
|
+
/**
|
|
5403
|
+
* Dimension Type
|
|
5404
|
+
*
|
|
5405
|
+
* The axis: department, class, location, project, or another.
|
|
5406
|
+
*/
|
|
5407
|
+
dimension_type: string;
|
|
5408
|
+
/**
|
|
5409
|
+
* Name
|
|
5410
|
+
*
|
|
5411
|
+
* The member's label.
|
|
5412
|
+
*/
|
|
5413
|
+
name: string;
|
|
5414
|
+
/**
|
|
5415
|
+
* Value
|
|
5416
|
+
*
|
|
5417
|
+
* The member's stable key within its axis: the source's id for a synced member, a slug of the name for one created here.
|
|
5418
|
+
*/
|
|
5419
|
+
value: string;
|
|
5420
|
+
/**
|
|
5421
|
+
* Source
|
|
5422
|
+
*
|
|
5423
|
+
* Where the member came from: `native` or `quickbooks`.
|
|
5424
|
+
*/
|
|
5425
|
+
source?: string;
|
|
5426
|
+
/**
|
|
5427
|
+
* Is Active
|
|
5428
|
+
*
|
|
5429
|
+
* False once retired: the member stays on the lines that carry it and can no longer be put on new ones.
|
|
5430
|
+
*/
|
|
5431
|
+
is_active: boolean;
|
|
5432
|
+
/**
|
|
5433
|
+
* Line Count
|
|
5434
|
+
*
|
|
5435
|
+
* How many ledger lines carry the member.
|
|
5436
|
+
*/
|
|
5437
|
+
line_count?: number;
|
|
5438
|
+
/**
|
|
5439
|
+
* Created At
|
|
5440
|
+
*
|
|
5441
|
+
* When it was created.
|
|
5442
|
+
*/
|
|
5443
|
+
created_at?: string | null;
|
|
5444
|
+
};
|
|
5445
|
+
|
|
5364
5446
|
/**
|
|
5365
5447
|
* DimensionType
|
|
5366
5448
|
*/
|
|
@@ -6199,6 +6281,12 @@ export type EntryTemplateRequest = {
|
|
|
6199
6281
|
* Auto-generate a reversing entry on the first day of the next period
|
|
6200
6282
|
*/
|
|
6201
6283
|
auto_reverse?: boolean;
|
|
6284
|
+
/**
|
|
6285
|
+
* Dimension Ids
|
|
6286
|
+
*
|
|
6287
|
+
* The management dimension members (department, class, location, project) every entry the schedule drafts carries on both lines, one per axis: a department's depreciation lands in that department.
|
|
6288
|
+
*/
|
|
6289
|
+
dimension_ids?: Array<string>;
|
|
6202
6290
|
};
|
|
6203
6291
|
|
|
6204
6292
|
/**
|
|
@@ -9285,6 +9373,26 @@ export type InvoicesResponse = {
|
|
|
9285
9373
|
has_more: boolean;
|
|
9286
9374
|
};
|
|
9287
9375
|
|
|
9376
|
+
/**
|
|
9377
|
+
* JournalEntryLineDimensions
|
|
9378
|
+
*
|
|
9379
|
+
* A line's management dimension members, set in place.
|
|
9380
|
+
*/
|
|
9381
|
+
export type JournalEntryLineDimensions = {
|
|
9382
|
+
/**
|
|
9383
|
+
* Line Id
|
|
9384
|
+
*
|
|
9385
|
+
* The line to re-tag, by id.
|
|
9386
|
+
*/
|
|
9387
|
+
line_id: string;
|
|
9388
|
+
/**
|
|
9389
|
+
* Dimension Ids
|
|
9390
|
+
*
|
|
9391
|
+
* The members the line carries from now on, replacing what it carried; empty clears them. At most one per axis.
|
|
9392
|
+
*/
|
|
9393
|
+
dimension_ids: Array<string>;
|
|
9394
|
+
};
|
|
9395
|
+
|
|
9288
9396
|
/**
|
|
9289
9397
|
* JournalEntryLineFlow
|
|
9290
9398
|
*
|
|
@@ -9344,6 +9452,12 @@ export type JournalEntryLineItemInput = {
|
|
|
9344
9452
|
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. On the group's consolidation entity, which moves no cash, every tagged line counts on its own, cash-effect signed (a credit is an inflow), so an elimination offsets the flow a member's line produced, and a tag does not spread to the other side. Refused when it is not a row of the entity's cash flow statement.
|
|
9345
9453
|
*/
|
|
9346
9454
|
flow_qname?: string | null;
|
|
9455
|
+
/**
|
|
9456
|
+
* Dimension Ids
|
|
9457
|
+
*
|
|
9458
|
+
* The management dimension members this line carries (department, class, location, project), by id from `dimensions`; at most one per axis. An untagged line is read as the axis's Unallocated.
|
|
9459
|
+
*/
|
|
9460
|
+
dimension_ids?: Array<string> | null;
|
|
9347
9461
|
/**
|
|
9348
9462
|
* Metadata
|
|
9349
9463
|
*
|
|
@@ -9390,6 +9504,12 @@ export type JournalEntryLineItemResponse = {
|
|
|
9390
9504
|
* The cash flow row this line carries, when tagged; null means the account's default flow.
|
|
9391
9505
|
*/
|
|
9392
9506
|
flow_qname?: string | null;
|
|
9507
|
+
/**
|
|
9508
|
+
* Dimension Ids
|
|
9509
|
+
*
|
|
9510
|
+
* The management dimension members the line carries, by id.
|
|
9511
|
+
*/
|
|
9512
|
+
dimension_ids?: Array<string>;
|
|
9393
9513
|
};
|
|
9394
9514
|
|
|
9395
9515
|
/**
|
|
@@ -10448,6 +10568,16 @@ export type LiveFinancialStatementRequest = {
|
|
|
10448
10568
|
* Max fact rows returned. Defaults to the ceiling so a statement is never cut mid-section — visible rows would stop footing to visible subtotals. Lower it only for a preview.
|
|
10449
10569
|
*/
|
|
10450
10570
|
limit?: number;
|
|
10571
|
+
/**
|
|
10572
|
+
* Slice an income statement by a management dimension (department, class, location, project). `{type, member_id}` reads one member's lines, current and prior; `member_id: unallocated` reads the lines no member of the axis tags. `{type}` alone reads the current window with one column per member, then Unallocated, then Total, and says in `dimension.ties_out` whether every row's members plus Unallocated equal its Total. Composes with `scope` and `entity_id`; a consolidation entity's lines are untagged, so eliminations read as Unallocated. Refused (422) on any other statement.
|
|
10573
|
+
*/
|
|
10574
|
+
dimension?: StatementDimension | null;
|
|
10575
|
+
/**
|
|
10576
|
+
* Include Sources
|
|
10577
|
+
*
|
|
10578
|
+
* Add each row's `origin` and, per column, the accounts its figure was summed from (`sources`), each keyed by the entity whose books hold it, so a figure opens on the account registers behind it. Consolidated figures list each member's accounts and the consolidation entity's. Off by default: it multiplies the response. Refused (422) with a `dimension` read by column.
|
|
10579
|
+
*/
|
|
10580
|
+
include_sources?: boolean;
|
|
10451
10581
|
};
|
|
10452
10582
|
|
|
10453
10583
|
/**
|
|
@@ -10520,6 +10650,10 @@ export type LiveFinancialStatementResponse = {
|
|
|
10520
10650
|
* Truncated
|
|
10521
10651
|
*/
|
|
10522
10652
|
truncated?: boolean;
|
|
10653
|
+
/**
|
|
10654
|
+
* How the statement was sliced by a management dimension, when it was: the axis, the one member read, or the columns and whether they tie out to the Total.
|
|
10655
|
+
*/
|
|
10656
|
+
dimension?: StatementDimensionResponse | null;
|
|
10523
10657
|
};
|
|
10524
10658
|
|
|
10525
10659
|
/**
|
|
@@ -10558,6 +10692,18 @@ export type LiveStatementFactRow = {
|
|
|
10558
10692
|
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
10559
10693
|
*/
|
|
10560
10694
|
period_role?: string | null;
|
|
10695
|
+
/**
|
|
10696
|
+
* Origin
|
|
10697
|
+
*
|
|
10698
|
+
* With `include_sources`, how the figure was made: `accounts` (summed from accounts in at least one column; read each column's `sources`, which may be empty where they do not add up), `subtotal` (the rows beneath it), or `computed` (derived from other figures, or a flow, with no accounts of its own). Null without `include_sources`.
|
|
10699
|
+
*/
|
|
10700
|
+
origin?: 'accounts' | 'subtotal' | 'computed' | null;
|
|
10701
|
+
/**
|
|
10702
|
+
* Sources
|
|
10703
|
+
*
|
|
10704
|
+
* With `include_sources`, per column (aligned with `values`), the accounts the figure was summed from, largest first; their values add up to the figure. Empty for a column with nothing to show, and for a subtotal or computed row.
|
|
10705
|
+
*/
|
|
10706
|
+
sources?: Array<Array<StatementRowSource>> | null;
|
|
10561
10707
|
};
|
|
10562
10708
|
|
|
10563
10709
|
/**
|
|
@@ -12311,6 +12457,52 @@ export type OperationEnvelopeDescribeFilingResponse = {
|
|
|
12311
12457
|
idempotentReplay?: boolean;
|
|
12312
12458
|
};
|
|
12313
12459
|
|
|
12460
|
+
/**
|
|
12461
|
+
* OperationEnvelope[DimensionResponse]
|
|
12462
|
+
*/
|
|
12463
|
+
export type OperationEnvelopeDimensionResponse = {
|
|
12464
|
+
/**
|
|
12465
|
+
* Operation
|
|
12466
|
+
*
|
|
12467
|
+
* Kebab-case operation name
|
|
12468
|
+
*/
|
|
12469
|
+
operation: string;
|
|
12470
|
+
/**
|
|
12471
|
+
* Operationid
|
|
12472
|
+
*
|
|
12473
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
12474
|
+
*/
|
|
12475
|
+
operationId: string;
|
|
12476
|
+
/**
|
|
12477
|
+
* Status
|
|
12478
|
+
*
|
|
12479
|
+
* Operation lifecycle state
|
|
12480
|
+
*/
|
|
12481
|
+
status: 'completed' | 'pending' | 'failed';
|
|
12482
|
+
/**
|
|
12483
|
+
* Command-specific result payload
|
|
12484
|
+
*/
|
|
12485
|
+
result?: DimensionResponse | null;
|
|
12486
|
+
/**
|
|
12487
|
+
* At
|
|
12488
|
+
*
|
|
12489
|
+
* ISO-8601 UTC timestamp
|
|
12490
|
+
*/
|
|
12491
|
+
at: string;
|
|
12492
|
+
/**
|
|
12493
|
+
* Createdby
|
|
12494
|
+
*
|
|
12495
|
+
* User ID that initiated the operation
|
|
12496
|
+
*/
|
|
12497
|
+
createdBy?: string | null;
|
|
12498
|
+
/**
|
|
12499
|
+
* Idempotentreplay
|
|
12500
|
+
*
|
|
12501
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
12502
|
+
*/
|
|
12503
|
+
idempotentReplay?: boolean;
|
|
12504
|
+
};
|
|
12505
|
+
|
|
12314
12506
|
/**
|
|
12315
12507
|
* OperationEnvelope[DisclosuresResponse]
|
|
12316
12508
|
*/
|
|
@@ -19563,6 +19755,84 @@ export type SqlStatementResponse = {
|
|
|
19563
19755
|
execution_time_ms: number;
|
|
19564
19756
|
};
|
|
19565
19757
|
|
|
19758
|
+
/**
|
|
19759
|
+
* StatementDimension
|
|
19760
|
+
*
|
|
19761
|
+
* A management slice of a statement or trial balance.
|
|
19762
|
+
*/
|
|
19763
|
+
export type StatementDimension = {
|
|
19764
|
+
/**
|
|
19765
|
+
* Type
|
|
19766
|
+
*
|
|
19767
|
+
* The axis to slice by: `department`, `class`, and so on.
|
|
19768
|
+
*/
|
|
19769
|
+
type: string;
|
|
19770
|
+
/**
|
|
19771
|
+
* Member Id
|
|
19772
|
+
*
|
|
19773
|
+
* One member's lines only, by id, or `unallocated` for the lines no member of the axis tags. Omitted, a statement returns one column per member, then Unallocated, then Total, for the current window.
|
|
19774
|
+
*/
|
|
19775
|
+
member_id?: string | null;
|
|
19776
|
+
};
|
|
19777
|
+
|
|
19778
|
+
/**
|
|
19779
|
+
* StatementDimensionColumn
|
|
19780
|
+
*
|
|
19781
|
+
* One column of a statement read by dimension.
|
|
19782
|
+
*/
|
|
19783
|
+
export type StatementDimensionColumn = {
|
|
19784
|
+
/**
|
|
19785
|
+
* Member Id
|
|
19786
|
+
*
|
|
19787
|
+
* The member the column reads, `unallocated` for the untagged lines, null for the Total.
|
|
19788
|
+
*/
|
|
19789
|
+
member_id?: string | null;
|
|
19790
|
+
/**
|
|
19791
|
+
* Name
|
|
19792
|
+
*
|
|
19793
|
+
* The column's label.
|
|
19794
|
+
*/
|
|
19795
|
+
name: string;
|
|
19796
|
+
};
|
|
19797
|
+
|
|
19798
|
+
/**
|
|
19799
|
+
* StatementDimensionResponse
|
|
19800
|
+
*
|
|
19801
|
+
* How a statement was sliced, and whether the slice ties out.
|
|
19802
|
+
*/
|
|
19803
|
+
export type StatementDimensionResponse = {
|
|
19804
|
+
/**
|
|
19805
|
+
* Type
|
|
19806
|
+
*
|
|
19807
|
+
* The axis the statement was sliced by.
|
|
19808
|
+
*/
|
|
19809
|
+
type: string;
|
|
19810
|
+
/**
|
|
19811
|
+
* Member Id
|
|
19812
|
+
*
|
|
19813
|
+
* The one member read, when the statement was filtered to one; null when it was read by column.
|
|
19814
|
+
*/
|
|
19815
|
+
member_id?: string | null;
|
|
19816
|
+
/**
|
|
19817
|
+
* Columns
|
|
19818
|
+
*
|
|
19819
|
+
* Read by column: one per member, then Unallocated, then Total, aligned with each row's `values` and with `periods`. Empty when filtered to one member.
|
|
19820
|
+
*/
|
|
19821
|
+
columns?: Array<StatementDimensionColumn>;
|
|
19822
|
+
/**
|
|
19823
|
+
* Ties Out
|
|
19824
|
+
*
|
|
19825
|
+
* Read by column: whether every row's members plus Unallocated equal its Total. Null when filtered to one member.
|
|
19826
|
+
*/
|
|
19827
|
+
ties_out?: boolean | null;
|
|
19828
|
+
/**
|
|
19829
|
+
* Differences
|
|
19830
|
+
*
|
|
19831
|
+
* The rows whose members plus Unallocated miss the Total, by qname.
|
|
19832
|
+
*/
|
|
19833
|
+
differences?: Array<string>;
|
|
19834
|
+
};
|
|
19835
|
+
|
|
19566
19836
|
/**
|
|
19567
19837
|
* StatementMechanics
|
|
19568
19838
|
*
|
|
@@ -19600,6 +19870,45 @@ export type StatementMechanics = {
|
|
|
19600
19870
|
period_comparisons?: number;
|
|
19601
19871
|
};
|
|
19602
19872
|
|
|
19873
|
+
/**
|
|
19874
|
+
* StatementRowSource
|
|
19875
|
+
*
|
|
19876
|
+
* One account's part in a statement figure: what that account, in that
|
|
19877
|
+
* entity's books, contributed to the column.
|
|
19878
|
+
*/
|
|
19879
|
+
export type StatementRowSource = {
|
|
19880
|
+
/**
|
|
19881
|
+
* Entity Id
|
|
19882
|
+
*
|
|
19883
|
+
* The entity whose books hold the lines, the register to open.
|
|
19884
|
+
*/
|
|
19885
|
+
entity_id: string;
|
|
19886
|
+
/**
|
|
19887
|
+
* Account Id
|
|
19888
|
+
*
|
|
19889
|
+
* The account.
|
|
19890
|
+
*/
|
|
19891
|
+
account_id: string;
|
|
19892
|
+
/**
|
|
19893
|
+
* Code
|
|
19894
|
+
*
|
|
19895
|
+
* The account's code.
|
|
19896
|
+
*/
|
|
19897
|
+
code?: string | null;
|
|
19898
|
+
/**
|
|
19899
|
+
* Name
|
|
19900
|
+
*
|
|
19901
|
+
* The account's name.
|
|
19902
|
+
*/
|
|
19903
|
+
name: string;
|
|
19904
|
+
/**
|
|
19905
|
+
* Value
|
|
19906
|
+
*
|
|
19907
|
+
* What the account contributed, in the figure's sign.
|
|
19908
|
+
*/
|
|
19909
|
+
value: number;
|
|
19910
|
+
};
|
|
19911
|
+
|
|
19603
19912
|
/**
|
|
19604
19913
|
* StorageItem
|
|
19605
19914
|
*
|
|
@@ -21081,6 +21390,33 @@ export type UpdateAgentRequest = {
|
|
|
21081
21390
|
};
|
|
21082
21391
|
};
|
|
21083
21392
|
|
|
21393
|
+
/**
|
|
21394
|
+
* UpdateDimensionRequest
|
|
21395
|
+
*
|
|
21396
|
+
* Rename or retire a member. Members are never deleted: lines reference
|
|
21397
|
+
* them.
|
|
21398
|
+
*/
|
|
21399
|
+
export type UpdateDimensionRequest = {
|
|
21400
|
+
/**
|
|
21401
|
+
* Dimension Id
|
|
21402
|
+
*
|
|
21403
|
+
* The member to change.
|
|
21404
|
+
*/
|
|
21405
|
+
dimension_id: string;
|
|
21406
|
+
/**
|
|
21407
|
+
* Name
|
|
21408
|
+
*
|
|
21409
|
+
* The new label. Refused on a synced member, whose name follows its source.
|
|
21410
|
+
*/
|
|
21411
|
+
name?: string | null;
|
|
21412
|
+
/**
|
|
21413
|
+
* Is Active
|
|
21414
|
+
*
|
|
21415
|
+
* False retires the member: lines that carry it keep it, and it can no longer be put on new ones. True brings it back.
|
|
21416
|
+
*/
|
|
21417
|
+
is_active?: boolean | null;
|
|
21418
|
+
};
|
|
21419
|
+
|
|
21084
21420
|
/**
|
|
21085
21421
|
* UpdateEntityRequest
|
|
21086
21422
|
*
|
|
@@ -21518,9 +21854,9 @@ export type UpdateInformationBlockRequest = ({
|
|
|
21518
21854
|
*
|
|
21519
21855
|
* Update a draft journal entry, or re-tag any entry's flows.
|
|
21520
21856
|
*
|
|
21521
|
-
* Posted entries accept only `line_flows
|
|
21522
|
-
* changes in place, closed month or not. Anything
|
|
21523
|
-
* a reversal and a corrected entry.
|
|
21857
|
+
* Posted entries accept only `line_flows` and `line_dimensions`: neither
|
|
21858
|
+
* moves a balance, so each changes in place, closed month or not. Anything
|
|
21859
|
+
* else on a posted entry is a reversal and a corrected entry.
|
|
21524
21860
|
*
|
|
21525
21861
|
* Omitted fields are left unchanged. If `line_items` is provided, the
|
|
21526
21862
|
* existing line items are replaced entirely (atomic delete + insert)
|
|
@@ -21564,6 +21900,12 @@ export type UpdateJournalEntryRequest = {
|
|
|
21564
21900
|
* Re-tag lines in place: each named line takes its `flow_qname` (null clears it), and when every line on that side of the entry then carries one flow, the lines on the other side not named here follow when they were in step with it — untagged, or carrying the flow the named lines carried before — so the cash line and the account line agree; a line tagged differently on purpose keeps its tag. Allowed on a posted entry, closed month included, and the only change one accepts; recorded on the entry as `flow_retags`, with what each changed line carried before. Not combinable with `line_items`, which replaces the lines (set `flow_qname` on them).
|
|
21565
21901
|
*/
|
|
21566
21902
|
line_flows?: Array<JournalEntryLineFlow> | null;
|
|
21903
|
+
/**
|
|
21904
|
+
* Line Dimensions
|
|
21905
|
+
*
|
|
21906
|
+
* Re-tag lines' management dimensions in place: each named line carries exactly the members given (empty clears them). A dimension moves no balance, so this is allowed on a posted entry, closed month included; recorded on the entry as `dimension_retags`, with what each line carried before. Not combinable with `line_items` (set `dimension_ids` on the new lines).
|
|
21907
|
+
*/
|
|
21908
|
+
line_dimensions?: Array<JournalEntryLineDimensions> | null;
|
|
21567
21909
|
};
|
|
21568
21910
|
|
|
21569
21911
|
/**
|
|
@@ -32029,6 +32371,134 @@ export type UpdateAgentResponses = {
|
|
|
32029
32371
|
|
|
32030
32372
|
export type UpdateAgentResponse = UpdateAgentResponses[keyof UpdateAgentResponses];
|
|
32031
32373
|
|
|
32374
|
+
export type CreateDimensionData = {
|
|
32375
|
+
body: CreateDimensionRequest;
|
|
32376
|
+
headers?: {
|
|
32377
|
+
/**
|
|
32378
|
+
* Idempotency-Key
|
|
32379
|
+
*/
|
|
32380
|
+
'Idempotency-Key'?: string | null;
|
|
32381
|
+
};
|
|
32382
|
+
path: {
|
|
32383
|
+
/**
|
|
32384
|
+
* Graph Id
|
|
32385
|
+
*/
|
|
32386
|
+
graph_id: string;
|
|
32387
|
+
};
|
|
32388
|
+
query?: never;
|
|
32389
|
+
url: '/extensions/roboledger/{graph_id}/operations/create-dimension';
|
|
32390
|
+
};
|
|
32391
|
+
|
|
32392
|
+
export type CreateDimensionErrors = {
|
|
32393
|
+
/**
|
|
32394
|
+
* Invalid request
|
|
32395
|
+
*/
|
|
32396
|
+
400: ErrorResponse;
|
|
32397
|
+
/**
|
|
32398
|
+
* Authentication required
|
|
32399
|
+
*/
|
|
32400
|
+
401: ErrorResponse;
|
|
32401
|
+
/**
|
|
32402
|
+
* Access denied
|
|
32403
|
+
*/
|
|
32404
|
+
403: ErrorResponse;
|
|
32405
|
+
/**
|
|
32406
|
+
* Resource not found
|
|
32407
|
+
*/
|
|
32408
|
+
404: ErrorResponse;
|
|
32409
|
+
/**
|
|
32410
|
+
* Idempotency-Key conflict — key reused with different body
|
|
32411
|
+
*/
|
|
32412
|
+
409: ErrorResponse;
|
|
32413
|
+
/**
|
|
32414
|
+
* Validation error
|
|
32415
|
+
*/
|
|
32416
|
+
422: ErrorResponse;
|
|
32417
|
+
/**
|
|
32418
|
+
* Rate limit exceeded
|
|
32419
|
+
*/
|
|
32420
|
+
429: ErrorResponse;
|
|
32421
|
+
/**
|
|
32422
|
+
* Internal server error
|
|
32423
|
+
*/
|
|
32424
|
+
500: ErrorResponse;
|
|
32425
|
+
};
|
|
32426
|
+
|
|
32427
|
+
export type CreateDimensionError = CreateDimensionErrors[keyof CreateDimensionErrors];
|
|
32428
|
+
|
|
32429
|
+
export type CreateDimensionResponses = {
|
|
32430
|
+
/**
|
|
32431
|
+
* Successful Response
|
|
32432
|
+
*/
|
|
32433
|
+
200: OperationEnvelopeDimensionResponse;
|
|
32434
|
+
};
|
|
32435
|
+
|
|
32436
|
+
export type CreateDimensionResponse = CreateDimensionResponses[keyof CreateDimensionResponses];
|
|
32437
|
+
|
|
32438
|
+
export type UpdateDimensionData = {
|
|
32439
|
+
body: UpdateDimensionRequest;
|
|
32440
|
+
headers?: {
|
|
32441
|
+
/**
|
|
32442
|
+
* Idempotency-Key
|
|
32443
|
+
*/
|
|
32444
|
+
'Idempotency-Key'?: string | null;
|
|
32445
|
+
};
|
|
32446
|
+
path: {
|
|
32447
|
+
/**
|
|
32448
|
+
* Graph Id
|
|
32449
|
+
*/
|
|
32450
|
+
graph_id: string;
|
|
32451
|
+
};
|
|
32452
|
+
query?: never;
|
|
32453
|
+
url: '/extensions/roboledger/{graph_id}/operations/update-dimension';
|
|
32454
|
+
};
|
|
32455
|
+
|
|
32456
|
+
export type UpdateDimensionErrors = {
|
|
32457
|
+
/**
|
|
32458
|
+
* Invalid request
|
|
32459
|
+
*/
|
|
32460
|
+
400: ErrorResponse;
|
|
32461
|
+
/**
|
|
32462
|
+
* Authentication required
|
|
32463
|
+
*/
|
|
32464
|
+
401: ErrorResponse;
|
|
32465
|
+
/**
|
|
32466
|
+
* Access denied
|
|
32467
|
+
*/
|
|
32468
|
+
403: ErrorResponse;
|
|
32469
|
+
/**
|
|
32470
|
+
* Resource not found
|
|
32471
|
+
*/
|
|
32472
|
+
404: ErrorResponse;
|
|
32473
|
+
/**
|
|
32474
|
+
* Idempotency-Key conflict — key reused with different body
|
|
32475
|
+
*/
|
|
32476
|
+
409: ErrorResponse;
|
|
32477
|
+
/**
|
|
32478
|
+
* Validation error
|
|
32479
|
+
*/
|
|
32480
|
+
422: ErrorResponse;
|
|
32481
|
+
/**
|
|
32482
|
+
* Rate limit exceeded
|
|
32483
|
+
*/
|
|
32484
|
+
429: ErrorResponse;
|
|
32485
|
+
/**
|
|
32486
|
+
* Internal server error
|
|
32487
|
+
*/
|
|
32488
|
+
500: ErrorResponse;
|
|
32489
|
+
};
|
|
32490
|
+
|
|
32491
|
+
export type UpdateDimensionError = UpdateDimensionErrors[keyof UpdateDimensionErrors];
|
|
32492
|
+
|
|
32493
|
+
export type UpdateDimensionResponses = {
|
|
32494
|
+
/**
|
|
32495
|
+
* Successful Response
|
|
32496
|
+
*/
|
|
32497
|
+
200: OperationEnvelopeDimensionResponse;
|
|
32498
|
+
};
|
|
32499
|
+
|
|
32500
|
+
export type UpdateDimensionResponse = UpdateDimensionResponses[keyof UpdateDimensionResponses];
|
|
32501
|
+
|
|
32032
32502
|
export type LearnClassificationDefaultsData = {
|
|
32033
32503
|
body: LearnClassificationDefaultsRequest;
|
|
32034
32504
|
headers?: {
|