@robosystems/client 2.11.2 → 2.12.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
@@ -136,6 +136,62 @@ export type AddPublishListMembersOperation = {
136
136
  */
137
137
  list_id: string;
138
138
  };
139
+ /**
140
+ * AgentClassification
141
+ *
142
+ * A counterparty's default account, learned from committed lines or set by
143
+ * hand.
144
+ */
145
+ export type AgentClassification = {
146
+ /**
147
+ * Element Id
148
+ *
149
+ * The default chart account.
150
+ */
151
+ element_id: string;
152
+ /**
153
+ * Account Name
154
+ *
155
+ * The account's name.
156
+ */
157
+ account_name?: string | null;
158
+ /**
159
+ * Mode
160
+ *
161
+ * `suggest`: offered on each new line. `always_ask`: never offered.
162
+ */
163
+ mode: string;
164
+ /**
165
+ * Confirmations
166
+ *
167
+ * Committed lines that went to this account.
168
+ */
169
+ confirmations: number;
170
+ /**
171
+ * Overrides
172
+ *
173
+ * Committed lines that went elsewhere while it was the default.
174
+ */
175
+ overrides: number;
176
+ /**
177
+ * Set By
178
+ *
179
+ * Who set or last moved it.
180
+ */
181
+ set_by?: string | null;
182
+ /**
183
+ * Set At
184
+ *
185
+ * When it was set or last moved.
186
+ */
187
+ set_at?: string | null;
188
+ /**
189
+ * Learned From
190
+ *
191
+ * The committed line it was learned from, when it was.
192
+ */
193
+ learned_from?: string | null;
194
+ };
139
195
  /**
140
196
  * AnalyticalStatementFactRow
141
197
  *
@@ -8578,6 +8634,54 @@ export type JournalEntryResponse = {
8578
8634
  */
8579
8635
  total_credit: number;
8580
8636
  };
8637
+ /**
8638
+ * LearnClassificationDefaultsRequest
8639
+ *
8640
+ * Seed counterparty defaults from the bank lines already committed.
8641
+ */
8642
+ export type LearnClassificationDefaultsRequest = {
8643
+ /**
8644
+ * Dry Run
8645
+ *
8646
+ * Report what would be learned without writing it.
8647
+ */
8648
+ dry_run?: boolean;
8649
+ };
8650
+ /**
8651
+ * LearnClassificationDefaultsResponse
8652
+ *
8653
+ * What seeding the defaults learned.
8654
+ */
8655
+ export type LearnClassificationDefaultsResponse = {
8656
+ /**
8657
+ * Agents Learned
8658
+ *
8659
+ * Counterparties given a default from their committed lines.
8660
+ */
8661
+ agents_learned: number;
8662
+ /**
8663
+ * Agents Kept
8664
+ *
8665
+ * Counterparties that already had a default, left as they were.
8666
+ */
8667
+ agents_kept: number;
8668
+ /**
8669
+ * Lines Read
8670
+ *
8671
+ * Committed lines classified to a single account that were read.
8672
+ */
8673
+ lines_read: number;
8674
+ /**
8675
+ * Open Lines Resuggested
8676
+ *
8677
+ * Still-open lines whose suggestion changed as a result.
8678
+ */
8679
+ open_lines_resuggested: number;
8680
+ /**
8681
+ * Dry Run
8682
+ */
8683
+ dry_run: boolean;
8684
+ };
8581
8685
  /**
8582
8686
  * LedgerAgentResponse
8583
8687
  */
@@ -8644,6 +8748,10 @@ export type LedgerAgentResponse = {
8644
8748
  * Is 1099 Recipient
8645
8749
  */
8646
8750
  is_1099_recipient: boolean;
8751
+ /**
8752
+ * The default account its bank lines are suggested.
8753
+ */
8754
+ classification?: AgentClassification | null;
8647
8755
  /**
8648
8756
  * Created At
8649
8757
  */
@@ -11735,6 +11843,51 @@ export type OperationEnvelopeJournalEntryResponse = {
11735
11843
  */
11736
11844
  idempotentReplay?: boolean;
11737
11845
  };
11846
+ /**
11847
+ * OperationEnvelope[LearnClassificationDefaultsResponse]
11848
+ */
11849
+ export type OperationEnvelopeLearnClassificationDefaultsResponse = {
11850
+ /**
11851
+ * Operation
11852
+ *
11853
+ * Kebab-case operation name
11854
+ */
11855
+ operation: string;
11856
+ /**
11857
+ * Operationid
11858
+ *
11859
+ * op_-prefixed ULID for audit and SSE correlation
11860
+ */
11861
+ operationId: string;
11862
+ /**
11863
+ * Status
11864
+ *
11865
+ * Operation lifecycle state
11866
+ */
11867
+ status: 'completed' | 'pending' | 'failed';
11868
+ /**
11869
+ * Command-specific result payload
11870
+ */
11871
+ result?: LearnClassificationDefaultsResponse | null;
11872
+ /**
11873
+ * At
11874
+ *
11875
+ * ISO-8601 UTC timestamp
11876
+ */
11877
+ at: string;
11878
+ /**
11879
+ * Createdby
11880
+ *
11881
+ * User ID that initiated the operation
11882
+ */
11883
+ createdBy?: string | null;
11884
+ /**
11885
+ * Idempotentreplay
11886
+ *
11887
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11888
+ */
11889
+ idempotentReplay?: boolean;
11890
+ };
11738
11891
  /**
11739
11892
  * OperationEnvelope[LedgerAgentResponse]
11740
11893
  */
@@ -14366,7 +14519,7 @@ export type PreviewReconciliationsRequest = {
14366
14519
  /**
14367
14520
  * Method
14368
14521
  *
14369
- * Which check to preview. `source_ledger` compares every account with the synced accounting system's own trial balance. `schedule_register` compares each asset account a schedule carries a balance on with what its schedules say it holds. `statement` compares each account that has a statement balance recorded in the period with that balance.
14522
+ * Which check to preview. `source_ledger` compares every account with the synced accounting system's own trial balance. `schedule_register` compares each asset account a schedule carries a balance on with what its schedules say it holds. `statement` compares each account that has a statement covering the period with that balance, adjusted on a bank-fed account by the lines the bank had not cleared.
14370
14523
  */
14371
14524
  method?: 'source_ledger' | 'schedule_register' | 'statement';
14372
14525
  /**
@@ -14769,13 +14922,14 @@ export type RebuildScheduleRequest = {
14769
14922
  * ReconciliationComponent
14770
14923
  *
14771
14924
  * One part of an account's independent balance: what a single schedule
14772
- * says the account carries, or a recorded statement balance.
14925
+ * says the account carries, a recorded statement balance, or a ledger line
14926
+ * outstanding at the statement's date.
14773
14927
  */
14774
14928
  export type ReconciliationComponent = {
14775
14929
  /**
14776
14930
  * Name
14777
14931
  *
14778
- * The schedule's name, or the statement and its date.
14932
+ * The schedule's name, the statement and its date, or the outstanding line's description.
14779
14933
  */
14780
14934
  name: string;
14781
14935
  /**
@@ -14784,6 +14938,24 @@ export type ReconciliationComponent = {
14784
14938
  * What this part says the account holds, debit-positive.
14785
14939
  */
14786
14940
  amount: number;
14941
+ /**
14942
+ * Kind
14943
+ *
14944
+ * `schedule`, `statement`, or `outstanding`: a ledger line on a bank-fed account that did not come from the feed, dated on or before the statement, so the bank had not cleared it.
14945
+ */
14946
+ kind?: string | null;
14947
+ /**
14948
+ * Posting Date
14949
+ *
14950
+ * An `outstanding` line's posting date.
14951
+ */
14952
+ posting_date?: string | null;
14953
+ /**
14954
+ * Entry Id
14955
+ *
14956
+ * The journal entry an `outstanding` line belongs to.
14957
+ */
14958
+ entry_id?: string | null;
14787
14959
  /**
14788
14960
  * Structure Id
14789
14961
  *
@@ -14793,7 +14965,7 @@ export type ReconciliationComponent = {
14793
14965
  /**
14794
14966
  * Event Id
14795
14967
  *
14796
- * The recorded balance, for a `statement` part.
14968
+ * The recorded balance, for a `statement` part; the event behind an `outstanding` line, when it has one.
14797
14969
  */
14798
14970
  event_id?: string | null;
14799
14971
  /**
@@ -14897,6 +15069,12 @@ export type ReconciliationMechanics = {
14897
15069
  * Whether the person who signs off must be someone other than the person who ran the comparison.
14898
15070
  */
14899
15071
  separate_reviewer?: boolean;
15072
+ /**
15073
+ * Statement Cycle
15074
+ *
15075
+ * `statement` blocks only: how often the account's statement is issued; unset is monthly. A period is covered by the latest statement ending within the cycle that ends with it.
15076
+ */
15077
+ statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
14900
15078
  };
14901
15079
  /**
14902
15080
  * ReconciliationPolicyResponse
@@ -14924,6 +15102,12 @@ export type ReconciliationPolicyResponse = {
14924
15102
  * Separate Reviewer
14925
15103
  */
14926
15104
  separate_reviewer: boolean;
15105
+ /**
15106
+ * Statement Cycle
15107
+ *
15108
+ * `statement` blocks only: how often the statement is issued.
15109
+ */
15110
+ statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
14927
15111
  };
14928
15112
  /**
14929
15113
  * ReconciliationPreviewResponse
@@ -15004,6 +15188,68 @@ export type ReconciliationPreviewResponse = {
15004
15188
  */
15005
15189
  notes?: Array<string>;
15006
15190
  };
15191
+ /**
15192
+ * ReconciliationRollForward
15193
+ *
15194
+ * A statement carried from its ending date to the period's last day on a
15195
+ * bank-fed account, where every line the feed brought is the bank's own.
15196
+ */
15197
+ export type ReconciliationRollForward = {
15198
+ /**
15199
+ * Statement As Of
15200
+ *
15201
+ * The statement's ending date.
15202
+ */
15203
+ statement_as_of: string;
15204
+ /**
15205
+ * Through
15206
+ *
15207
+ * The period's last day.
15208
+ */
15209
+ through: string;
15210
+ /**
15211
+ * Bank Lines
15212
+ *
15213
+ * Booked feed lines dated after the statement, to the period end.
15214
+ */
15215
+ bank_lines: number;
15216
+ /**
15217
+ * Bank Activity
15218
+ *
15219
+ * Their net effect on the account, debit-positive.
15220
+ */
15221
+ bank_activity: number;
15222
+ /**
15223
+ * Bank Balance
15224
+ *
15225
+ * The statement balance carried to the period end by those lines: what the bank held then, debit-positive.
15226
+ */
15227
+ bank_balance: number;
15228
+ /**
15229
+ * Ledger Balance
15230
+ *
15231
+ * The ledger's balance at the period end, as the close will leave it, debit-positive.
15232
+ */
15233
+ ledger_balance: number;
15234
+ /**
15235
+ * Outstanding
15236
+ *
15237
+ * Ledger lines not from the feed and dated on or before the period end, net: the ledger minus the carried bank balance.
15238
+ */
15239
+ outstanding: number;
15240
+ /**
15241
+ * Feed Balance
15242
+ *
15243
+ * A cross-check, never the figure reconciled: the bank feed's own balance from the first reading on or after the period end, less the booked feed lines between the period end and that reading. Null when the feed has no reading within ten days.
15244
+ */
15245
+ feed_balance?: number | null;
15246
+ /**
15247
+ * Feed Balance Read On
15248
+ *
15249
+ * The day of the feed reading `feed_balance` starts from.
15250
+ */
15251
+ feed_balance_read_on?: string | null;
15252
+ };
15007
15253
  /**
15008
15254
  * ReconciliationRow
15009
15255
  *
@@ -15051,7 +15297,7 @@ export type ReconciliationRow = {
15051
15297
  /**
15052
15298
  * Independent Balance
15053
15299
  *
15054
- * What the independent source says.
15300
+ * What the independent source says. For a `statement` on a bank-fed account, the statement balance adjusted by its outstanding lines.
15055
15301
  */
15056
15302
  independent_balance: number;
15057
15303
  /**
@@ -15075,9 +15321,13 @@ export type ReconciliationRow = {
15075
15321
  /**
15076
15322
  * Components
15077
15323
  *
15078
- * Account-scope methods only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`.
15324
+ * Account-scope methods only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`, then each outstanding line.
15079
15325
  */
15080
15326
  components?: Array<ReconciliationComponent>;
15327
+ /**
15328
+ * `statement` on a bank-fed account whose statement ends before the period's last day: the statement carried to it by the feed's lines.
15329
+ */
15330
+ roll_forward?: ReconciliationRollForward | null;
15081
15331
  };
15082
15332
  /**
15083
15333
  * ReconciliationSummary
@@ -15127,6 +15377,12 @@ export type ReconciliationSummary = {
15127
15377
  * A difference up to this amount still counts as reconciled.
15128
15378
  */
15129
15379
  materiality: number;
15380
+ /**
15381
+ * Statement Cycle
15382
+ *
15383
+ * `statement` blocks only: how often the account's statement is issued, `monthly`, `quarterly` or `annual`.
15384
+ */
15385
+ statement_cycle?: string | null;
15130
15386
  /**
15131
15387
  * Period
15132
15388
  *
@@ -15178,15 +15434,19 @@ export type ReconciliationSummary = {
15178
15434
  /**
15179
15435
  * Balance As Of
15180
15436
  *
15181
- * Account-scope only: the date the two balances are stated at. The period's last day, unless a statement ended earlier in the period.
15437
+ * Account-scope only: the date the two balances are stated at. The period's last day, unless the statement covering it ended earlier.
15182
15438
  */
15183
15439
  balance_as_of?: string | null;
15184
15440
  /**
15185
15441
  * Components
15186
15442
  *
15187
- * Account-scope only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`.
15443
+ * Account-scope only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`, then each outstanding line.
15188
15444
  */
15189
15445
  components?: Array<ReconciliationComponent>;
15446
+ /**
15447
+ * `statement` on a bank-fed account whose statement ends before the period's last day: the statement carried to it by the feed's lines.
15448
+ */
15449
+ roll_forward?: ReconciliationRollForward | null;
15190
15450
  /**
15191
15451
  * Source
15192
15452
  *
@@ -17462,6 +17722,12 @@ export type SetReconciliationPolicyRequest = {
17462
17722
  * Whether the person who signs off must be someone other than the person who ran the comparison. It can only be turned on when the graph has at least two members who can write. Omit to keep.
17463
17723
  */
17464
17724
  separate_reviewer?: boolean | null;
17725
+ /**
17726
+ * Statement Cycle
17727
+ *
17728
+ * `statement` blocks only: how often the account's statement is issued. A period is covered by the latest statement ending within the cycle that ends with it, so a quarterly statement covers the two months before the next one. Omit to keep.
17729
+ */
17730
+ statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
17465
17731
  };
17466
17732
  /**
17467
17733
  * SetSelectedGraphRequest
@@ -19148,10 +19414,22 @@ export type UpdateAgentRequest = {
19148
19414
  * Is 1099 Recipient
19149
19415
  */
19150
19416
  is_1099_recipient?: boolean | null;
19417
+ /**
19418
+ * Classification Element Id
19419
+ *
19420
+ * The chart account this counterparty's bank lines are usually classified to, suggested on each new line. An empty string clears it. Its still-open lines are re-suggested at once. Omit to keep.
19421
+ */
19422
+ classification_element_id?: string | null;
19423
+ /**
19424
+ * Classification Mode
19425
+ *
19426
+ * `suggest` offers the default on each line; `always_ask` offers none, for a counterparty whose lines go to different accounts. Omit to keep.
19427
+ */
19428
+ classification_mode?: 'suggest' | 'always_ask' | null;
19151
19429
  /**
19152
19430
  * Metadata Patch
19153
19431
  *
19154
- * Deep-merged into agent.metadata. Pass `{}` to leave unchanged.
19432
+ * Deep-merged into agent.metadata. Pass `{}` to leave unchanged. The default classification is set with the fields above, not here.
19155
19433
  */
19156
19434
  metadata_patch?: {
19157
19435
  [key: string]: unknown;
@@ -29096,6 +29374,65 @@ export type UpdateAgentResponses = {
29096
29374
  200: OperationEnvelopeLedgerAgentResponse;
29097
29375
  };
29098
29376
  export type UpdateAgentResponse = UpdateAgentResponses[keyof UpdateAgentResponses];
29377
+ export type LearnClassificationDefaultsData = {
29378
+ body: LearnClassificationDefaultsRequest;
29379
+ headers?: {
29380
+ /**
29381
+ * Idempotency-Key
29382
+ */
29383
+ 'Idempotency-Key'?: string | null;
29384
+ };
29385
+ path: {
29386
+ /**
29387
+ * Graph Id
29388
+ */
29389
+ graph_id: string;
29390
+ };
29391
+ query?: never;
29392
+ url: '/extensions/roboledger/{graph_id}/operations/learn-classification-defaults';
29393
+ };
29394
+ export type LearnClassificationDefaultsErrors = {
29395
+ /**
29396
+ * Invalid request
29397
+ */
29398
+ 400: ErrorResponse;
29399
+ /**
29400
+ * Authentication required
29401
+ */
29402
+ 401: ErrorResponse;
29403
+ /**
29404
+ * Access denied
29405
+ */
29406
+ 403: ErrorResponse;
29407
+ /**
29408
+ * Resource not found
29409
+ */
29410
+ 404: ErrorResponse;
29411
+ /**
29412
+ * Idempotency-Key conflict — key reused with different body
29413
+ */
29414
+ 409: ErrorResponse;
29415
+ /**
29416
+ * Validation error
29417
+ */
29418
+ 422: ErrorResponse;
29419
+ /**
29420
+ * Rate limit exceeded
29421
+ */
29422
+ 429: ErrorResponse;
29423
+ /**
29424
+ * Internal server error
29425
+ */
29426
+ 500: ErrorResponse;
29427
+ };
29428
+ export type LearnClassificationDefaultsError = LearnClassificationDefaultsErrors[keyof LearnClassificationDefaultsErrors];
29429
+ export type LearnClassificationDefaultsResponses = {
29430
+ /**
29431
+ * Successful Response
29432
+ */
29433
+ 200: OperationEnvelopeLearnClassificationDefaultsResponse;
29434
+ };
29435
+ export type LearnClassificationDefaultsResponse2 = LearnClassificationDefaultsResponses[keyof LearnClassificationDefaultsResponses];
29099
29436
  export type CreateEventBlockData = {
29100
29437
  body: CreateEventBlockRequest;
29101
29438
  headers?: {