@robosystems/client 2.22.0 → 2.23.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
@@ -3129,6 +3129,31 @@ export type CreateConnectionRequest = {
3129
3129
  mercury_config?: MercuryConnectionConfig | null;
3130
3130
  plaid_config?: PlaidConnectionConfig | null;
3131
3131
  };
3132
+ /**
3133
+ * CreateDimensionRequest
3134
+ *
3135
+ * Add a member to a management dimension.
3136
+ */
3137
+ export type CreateDimensionRequest = {
3138
+ /**
3139
+ * Dimension Type
3140
+ *
3141
+ * The axis: `department`, `class`, `location` or `project`, or any other lowercase name, which starts an axis of its own. `scenario` is reserved for forecasts.
3142
+ */
3143
+ dimension_type: string;
3144
+ /**
3145
+ * Name
3146
+ *
3147
+ * The member's label.
3148
+ */
3149
+ name: string;
3150
+ /**
3151
+ * Value
3152
+ *
3153
+ * The member's stable key within the axis; omitted, a slug of the name. Refused (409) when the axis already has it.
3154
+ */
3155
+ value?: string | null;
3156
+ };
3132
3157
  /**
3133
3158
  * CreateDocumentUploadOp
3134
3159
  *
@@ -3425,7 +3450,7 @@ export type CreateEventBlockRequest = {
3425
3450
  /**
3426
3451
  * Dimension Ids
3427
3452
  *
3428
- * IDs of dimension members tagging this event (e.g. department, fund, project). Propagate to the GL entries produced by the handler.
3453
+ * 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.
3429
3454
  */
3430
3455
  dimension_ids?: Array<string>;
3431
3456
  /**
@@ -5232,6 +5257,61 @@ export type Dimension = {
5232
5257
  */
5233
5258
  members?: Array<string>;
5234
5259
  };
5260
+ /**
5261
+ * DimensionResponse
5262
+ *
5263
+ * One member of a management dimension.
5264
+ */
5265
+ export type DimensionResponse = {
5266
+ /**
5267
+ * Id
5268
+ *
5269
+ * The member's id, as lines carry it.
5270
+ */
5271
+ id: string;
5272
+ /**
5273
+ * Dimension Type
5274
+ *
5275
+ * The axis: department, class, location, project, or another.
5276
+ */
5277
+ dimension_type: string;
5278
+ /**
5279
+ * Name
5280
+ *
5281
+ * The member's label.
5282
+ */
5283
+ name: string;
5284
+ /**
5285
+ * Value
5286
+ *
5287
+ * 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.
5288
+ */
5289
+ value: string;
5290
+ /**
5291
+ * Source
5292
+ *
5293
+ * Where the member came from: `native` or `quickbooks`.
5294
+ */
5295
+ source?: string;
5296
+ /**
5297
+ * Is Active
5298
+ *
5299
+ * False once retired: the member stays on the lines that carry it and can no longer be put on new ones.
5300
+ */
5301
+ is_active: boolean;
5302
+ /**
5303
+ * Line Count
5304
+ *
5305
+ * How many ledger lines carry the member.
5306
+ */
5307
+ line_count?: number;
5308
+ /**
5309
+ * Created At
5310
+ *
5311
+ * When it was created.
5312
+ */
5313
+ created_at?: string | null;
5314
+ };
5235
5315
  /**
5236
5316
  * DimensionType
5237
5317
  */
@@ -6049,6 +6129,12 @@ export type EntryTemplateRequest = {
6049
6129
  * Auto-generate a reversing entry on the first day of the next period
6050
6130
  */
6051
6131
  auto_reverse?: boolean;
6132
+ /**
6133
+ * Dimension Ids
6134
+ *
6135
+ * 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.
6136
+ */
6137
+ dimension_ids?: Array<string>;
6052
6138
  };
6053
6139
  /**
6054
6140
  * ErrorResponse
@@ -9073,6 +9159,25 @@ export type InvoicesResponse = {
9073
9159
  */
9074
9160
  has_more: boolean;
9075
9161
  };
9162
+ /**
9163
+ * JournalEntryLineDimensions
9164
+ *
9165
+ * A line's management dimension members, set in place.
9166
+ */
9167
+ export type JournalEntryLineDimensions = {
9168
+ /**
9169
+ * Line Id
9170
+ *
9171
+ * The line to re-tag, by id.
9172
+ */
9173
+ line_id: string;
9174
+ /**
9175
+ * Dimension Ids
9176
+ *
9177
+ * The members the line carries from now on, replacing what it carried; empty clears them. At most one per axis.
9178
+ */
9179
+ dimension_ids: Array<string>;
9180
+ };
9076
9181
  /**
9077
9182
  * JournalEntryLineFlow
9078
9183
  *
@@ -9131,6 +9236,12 @@ export type JournalEntryLineItemInput = {
9131
9236
  * 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.
9132
9237
  */
9133
9238
  flow_qname?: string | null;
9239
+ /**
9240
+ * Dimension Ids
9241
+ *
9242
+ * 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.
9243
+ */
9244
+ dimension_ids?: Array<string> | null;
9134
9245
  /**
9135
9246
  * Metadata
9136
9247
  *
@@ -9176,6 +9287,12 @@ export type JournalEntryLineItemResponse = {
9176
9287
  * The cash flow row this line carries, when tagged; null means the account's default flow.
9177
9288
  */
9178
9289
  flow_qname?: string | null;
9290
+ /**
9291
+ * Dimension Ids
9292
+ *
9293
+ * The management dimension members the line carries, by id.
9294
+ */
9295
+ dimension_ids?: Array<string>;
9179
9296
  };
9180
9297
  /**
9181
9298
  * JournalEntryResponse
@@ -10216,6 +10333,10 @@ export type LiveFinancialStatementRequest = {
10216
10333
  * 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.
10217
10334
  */
10218
10335
  limit?: number;
10336
+ /**
10337
+ * 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.
10338
+ */
10339
+ dimension?: StatementDimension | null;
10219
10340
  };
10220
10341
  /**
10221
10342
  * LiveFinancialStatementResponse
@@ -10287,6 +10408,10 @@ export type LiveFinancialStatementResponse = {
10287
10408
  * Truncated
10288
10409
  */
10289
10410
  truncated?: boolean;
10411
+ /**
10412
+ * 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.
10413
+ */
10414
+ dimension?: StatementDimensionResponse | null;
10290
10415
  };
10291
10416
  /**
10292
10417
  * LiveStatementFactRow
@@ -12033,6 +12158,51 @@ export type OperationEnvelopeDescribeFilingResponse = {
12033
12158
  */
12034
12159
  idempotentReplay?: boolean;
12035
12160
  };
12161
+ /**
12162
+ * OperationEnvelope[DimensionResponse]
12163
+ */
12164
+ export type OperationEnvelopeDimensionResponse = {
12165
+ /**
12166
+ * Operation
12167
+ *
12168
+ * Kebab-case operation name
12169
+ */
12170
+ operation: string;
12171
+ /**
12172
+ * Operationid
12173
+ *
12174
+ * op_-prefixed ULID for audit and SSE correlation
12175
+ */
12176
+ operationId: string;
12177
+ /**
12178
+ * Status
12179
+ *
12180
+ * Operation lifecycle state
12181
+ */
12182
+ status: 'completed' | 'pending' | 'failed';
12183
+ /**
12184
+ * Command-specific result payload
12185
+ */
12186
+ result?: DimensionResponse | null;
12187
+ /**
12188
+ * At
12189
+ *
12190
+ * ISO-8601 UTC timestamp
12191
+ */
12192
+ at: string;
12193
+ /**
12194
+ * Createdby
12195
+ *
12196
+ * User ID that initiated the operation
12197
+ */
12198
+ createdBy?: string | null;
12199
+ /**
12200
+ * Idempotentreplay
12201
+ *
12202
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
12203
+ */
12204
+ idempotentReplay?: boolean;
12205
+ };
12036
12206
  /**
12037
12207
  * OperationEnvelope[DisclosuresResponse]
12038
12208
  */
@@ -19108,6 +19278,81 @@ export type SqlStatementResponse = {
19108
19278
  */
19109
19279
  execution_time_ms: number;
19110
19280
  };
19281
+ /**
19282
+ * StatementDimension
19283
+ *
19284
+ * A management slice of a statement or trial balance.
19285
+ */
19286
+ export type StatementDimension = {
19287
+ /**
19288
+ * Type
19289
+ *
19290
+ * The axis to slice by: `department`, `class`, and so on.
19291
+ */
19292
+ type: string;
19293
+ /**
19294
+ * Member Id
19295
+ *
19296
+ * 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.
19297
+ */
19298
+ member_id?: string | null;
19299
+ };
19300
+ /**
19301
+ * StatementDimensionColumn
19302
+ *
19303
+ * One column of a statement read by dimension.
19304
+ */
19305
+ export type StatementDimensionColumn = {
19306
+ /**
19307
+ * Member Id
19308
+ *
19309
+ * The member the column reads, `unallocated` for the untagged lines, null for the Total.
19310
+ */
19311
+ member_id?: string | null;
19312
+ /**
19313
+ * Name
19314
+ *
19315
+ * The column's label.
19316
+ */
19317
+ name: string;
19318
+ };
19319
+ /**
19320
+ * StatementDimensionResponse
19321
+ *
19322
+ * How a statement was sliced, and whether the slice ties out.
19323
+ */
19324
+ export type StatementDimensionResponse = {
19325
+ /**
19326
+ * Type
19327
+ *
19328
+ * The axis the statement was sliced by.
19329
+ */
19330
+ type: string;
19331
+ /**
19332
+ * Member Id
19333
+ *
19334
+ * The one member read, when the statement was filtered to one; null when it was read by column.
19335
+ */
19336
+ member_id?: string | null;
19337
+ /**
19338
+ * Columns
19339
+ *
19340
+ * 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.
19341
+ */
19342
+ columns?: Array<StatementDimensionColumn>;
19343
+ /**
19344
+ * Ties Out
19345
+ *
19346
+ * Read by column: whether every row's members plus Unallocated equal its Total. Null when filtered to one member.
19347
+ */
19348
+ ties_out?: boolean | null;
19349
+ /**
19350
+ * Differences
19351
+ *
19352
+ * The rows whose members plus Unallocated miss the Total, by qname.
19353
+ */
19354
+ differences?: Array<string>;
19355
+ };
19111
19356
  /**
19112
19357
  * StatementMechanics
19113
19358
  *
@@ -20588,6 +20833,32 @@ export type UpdateAgentRequest = {
20588
20833
  [key: string]: unknown;
20589
20834
  };
20590
20835
  };
20836
+ /**
20837
+ * UpdateDimensionRequest
20838
+ *
20839
+ * Rename or retire a member. Members are never deleted: lines reference
20840
+ * them.
20841
+ */
20842
+ export type UpdateDimensionRequest = {
20843
+ /**
20844
+ * Dimension Id
20845
+ *
20846
+ * The member to change.
20847
+ */
20848
+ dimension_id: string;
20849
+ /**
20850
+ * Name
20851
+ *
20852
+ * The new label. Refused on a synced member, whose name follows its source.
20853
+ */
20854
+ name?: string | null;
20855
+ /**
20856
+ * Is Active
20857
+ *
20858
+ * False retires the member: lines that carry it keep it, and it can no longer be put on new ones. True brings it back.
20859
+ */
20860
+ is_active?: boolean | null;
20861
+ };
20591
20862
  /**
20592
20863
  * UpdateEntityRequest
20593
20864
  *
@@ -21018,9 +21289,9 @@ export type UpdateInformationBlockRequest = ({
21018
21289
  *
21019
21290
  * Update a draft journal entry, or re-tag any entry's flows.
21020
21291
  *
21021
- * Posted entries accept only `line_flows`: a flow moves no balance, so it
21022
- * changes in place, closed month or not. Anything else on a posted entry is
21023
- * a reversal and a corrected entry.
21292
+ * Posted entries accept only `line_flows` and `line_dimensions`: neither
21293
+ * moves a balance, so each changes in place, closed month or not. Anything
21294
+ * else on a posted entry is a reversal and a corrected entry.
21024
21295
  *
21025
21296
  * Omitted fields are left unchanged. If `line_items` is provided, the
21026
21297
  * existing line items are replaced entirely (atomic delete + insert)
@@ -21064,6 +21335,12 @@ export type UpdateJournalEntryRequest = {
21064
21335
  * 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).
21065
21336
  */
21066
21337
  line_flows?: Array<JournalEntryLineFlow> | null;
21338
+ /**
21339
+ * Line Dimensions
21340
+ *
21341
+ * 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).
21342
+ */
21343
+ line_dimensions?: Array<JournalEntryLineDimensions> | null;
21067
21344
  };
21068
21345
  /**
21069
21346
  * UpdateMemberRoleRequest
@@ -30670,6 +30947,124 @@ export type UpdateAgentResponses = {
30670
30947
  200: OperationEnvelopeLedgerAgentResponse;
30671
30948
  };
30672
30949
  export type UpdateAgentResponse = UpdateAgentResponses[keyof UpdateAgentResponses];
30950
+ export type CreateDimensionData = {
30951
+ body: CreateDimensionRequest;
30952
+ headers?: {
30953
+ /**
30954
+ * Idempotency-Key
30955
+ */
30956
+ 'Idempotency-Key'?: string | null;
30957
+ };
30958
+ path: {
30959
+ /**
30960
+ * Graph Id
30961
+ */
30962
+ graph_id: string;
30963
+ };
30964
+ query?: never;
30965
+ url: '/extensions/roboledger/{graph_id}/operations/create-dimension';
30966
+ };
30967
+ export type CreateDimensionErrors = {
30968
+ /**
30969
+ * Invalid request
30970
+ */
30971
+ 400: ErrorResponse;
30972
+ /**
30973
+ * Authentication required
30974
+ */
30975
+ 401: ErrorResponse;
30976
+ /**
30977
+ * Access denied
30978
+ */
30979
+ 403: ErrorResponse;
30980
+ /**
30981
+ * Resource not found
30982
+ */
30983
+ 404: ErrorResponse;
30984
+ /**
30985
+ * Idempotency-Key conflict — key reused with different body
30986
+ */
30987
+ 409: ErrorResponse;
30988
+ /**
30989
+ * Validation error
30990
+ */
30991
+ 422: ErrorResponse;
30992
+ /**
30993
+ * Rate limit exceeded
30994
+ */
30995
+ 429: ErrorResponse;
30996
+ /**
30997
+ * Internal server error
30998
+ */
30999
+ 500: ErrorResponse;
31000
+ };
31001
+ export type CreateDimensionError = CreateDimensionErrors[keyof CreateDimensionErrors];
31002
+ export type CreateDimensionResponses = {
31003
+ /**
31004
+ * Successful Response
31005
+ */
31006
+ 200: OperationEnvelopeDimensionResponse;
31007
+ };
31008
+ export type CreateDimensionResponse = CreateDimensionResponses[keyof CreateDimensionResponses];
31009
+ export type UpdateDimensionData = {
31010
+ body: UpdateDimensionRequest;
31011
+ headers?: {
31012
+ /**
31013
+ * Idempotency-Key
31014
+ */
31015
+ 'Idempotency-Key'?: string | null;
31016
+ };
31017
+ path: {
31018
+ /**
31019
+ * Graph Id
31020
+ */
31021
+ graph_id: string;
31022
+ };
31023
+ query?: never;
31024
+ url: '/extensions/roboledger/{graph_id}/operations/update-dimension';
31025
+ };
31026
+ export type UpdateDimensionErrors = {
31027
+ /**
31028
+ * Invalid request
31029
+ */
31030
+ 400: ErrorResponse;
31031
+ /**
31032
+ * Authentication required
31033
+ */
31034
+ 401: ErrorResponse;
31035
+ /**
31036
+ * Access denied
31037
+ */
31038
+ 403: ErrorResponse;
31039
+ /**
31040
+ * Resource not found
31041
+ */
31042
+ 404: ErrorResponse;
31043
+ /**
31044
+ * Idempotency-Key conflict — key reused with different body
31045
+ */
31046
+ 409: ErrorResponse;
31047
+ /**
31048
+ * Validation error
31049
+ */
31050
+ 422: ErrorResponse;
31051
+ /**
31052
+ * Rate limit exceeded
31053
+ */
31054
+ 429: ErrorResponse;
31055
+ /**
31056
+ * Internal server error
31057
+ */
31058
+ 500: ErrorResponse;
31059
+ };
31060
+ export type UpdateDimensionError = UpdateDimensionErrors[keyof UpdateDimensionErrors];
31061
+ export type UpdateDimensionResponses = {
31062
+ /**
31063
+ * Successful Response
31064
+ */
31065
+ 200: OperationEnvelopeDimensionResponse;
31066
+ };
31067
+ export type UpdateDimensionResponse = UpdateDimensionResponses[keyof UpdateDimensionResponses];
30673
31068
  export type LearnClassificationDefaultsData = {
30674
31069
  body: LearnClassificationDefaultsRequest;
30675
31070
  headers?: {