@robosystems/client 0.2.48 → 0.2.49
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/extensions/LedgerClient.d.ts +180 -6
- package/extensions/LedgerClient.js +251 -10
- package/extensions/LedgerClient.test.ts +528 -11
- package/extensions/LedgerClient.ts +464 -15
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +12 -4
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +107 -1
- package/sdk/sdk.gen.js +172 -2
- package/sdk/sdk.gen.ts +171 -1
- package/sdk/types.gen.d.ts +737 -10
- package/sdk/types.gen.ts +803 -21
- package/sdk-extensions/LedgerClient.d.ts +180 -6
- package/sdk-extensions/LedgerClient.js +251 -10
- package/sdk-extensions/LedgerClient.test.ts +528 -11
- package/sdk-extensions/LedgerClient.ts +464 -15
- package/sdk.gen.d.ts +107 -1
- package/sdk.gen.js +172 -2
- package/sdk.gen.ts +171 -1
- package/types.gen.d.ts +737 -10
- package/types.gen.ts +803 -21
package/sdk/types.gen.d.ts
CHANGED
|
@@ -1270,6 +1270,47 @@ export type CheckoutStatusResponse = {
|
|
|
1270
1270
|
*/
|
|
1271
1271
|
error?: string | null;
|
|
1272
1272
|
};
|
|
1273
|
+
/**
|
|
1274
|
+
* ClosePeriodRequest
|
|
1275
|
+
*/
|
|
1276
|
+
export type ClosePeriodRequest = {
|
|
1277
|
+
/**
|
|
1278
|
+
* Note
|
|
1279
|
+
*
|
|
1280
|
+
* Free-form note attached to the close event
|
|
1281
|
+
*/
|
|
1282
|
+
note?: string | null;
|
|
1283
|
+
/**
|
|
1284
|
+
* Allow Stale Sync
|
|
1285
|
+
*
|
|
1286
|
+
* Override the sync-currency gate. Only use when you have manually verified that the source data for the period is complete.
|
|
1287
|
+
*/
|
|
1288
|
+
allow_stale_sync?: boolean;
|
|
1289
|
+
};
|
|
1290
|
+
/**
|
|
1291
|
+
* ClosePeriodResponse
|
|
1292
|
+
*
|
|
1293
|
+
* Response from a single-period close operation.
|
|
1294
|
+
*/
|
|
1295
|
+
export type ClosePeriodResponse = {
|
|
1296
|
+
fiscal_calendar: FiscalCalendarResponse;
|
|
1297
|
+
/**
|
|
1298
|
+
* Period
|
|
1299
|
+
*/
|
|
1300
|
+
period: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* Entries Posted
|
|
1303
|
+
*
|
|
1304
|
+
* Number of draft entries transitioned to posted
|
|
1305
|
+
*/
|
|
1306
|
+
entries_posted?: number;
|
|
1307
|
+
/**
|
|
1308
|
+
* Target Auto Advanced
|
|
1309
|
+
*
|
|
1310
|
+
* Whether close_target was auto-advanced because it was reached
|
|
1311
|
+
*/
|
|
1312
|
+
target_auto_advanced?: boolean;
|
|
1313
|
+
};
|
|
1273
1314
|
/**
|
|
1274
1315
|
* ClosingBookCategory
|
|
1275
1316
|
*/
|
|
@@ -1329,34 +1370,52 @@ export type ClosingBookStructuresResponse = {
|
|
|
1329
1370
|
* ClosingEntryResponse
|
|
1330
1371
|
*/
|
|
1331
1372
|
export type ClosingEntryResponse = {
|
|
1373
|
+
/**
|
|
1374
|
+
* Outcome
|
|
1375
|
+
*
|
|
1376
|
+
* What the idempotent call did: 'created' (new draft), 'unchanged' (existing draft still matches), 'regenerated' (stale draft replaced with fresh one), 'removed' (stale draft deleted; schedule no longer covers this period), 'skipped' (nothing to do — no draft and no in-scope fact).
|
|
1377
|
+
*/
|
|
1378
|
+
outcome: string;
|
|
1332
1379
|
/**
|
|
1333
1380
|
* Entry Id
|
|
1381
|
+
*
|
|
1382
|
+
* The draft entry ID. None for 'removed' and 'skipped' outcomes.
|
|
1334
1383
|
*/
|
|
1335
|
-
entry_id
|
|
1384
|
+
entry_id?: string | null;
|
|
1336
1385
|
/**
|
|
1337
1386
|
* Status
|
|
1387
|
+
*
|
|
1388
|
+
* Entry status (always 'draft' when present).
|
|
1338
1389
|
*/
|
|
1339
|
-
status
|
|
1390
|
+
status?: string | null;
|
|
1340
1391
|
/**
|
|
1341
1392
|
* Posting Date
|
|
1342
1393
|
*/
|
|
1343
|
-
posting_date
|
|
1394
|
+
posting_date?: string | null;
|
|
1344
1395
|
/**
|
|
1345
1396
|
* Memo
|
|
1346
1397
|
*/
|
|
1347
|
-
memo
|
|
1398
|
+
memo?: string | null;
|
|
1348
1399
|
/**
|
|
1349
1400
|
* Debit Element Id
|
|
1350
1401
|
*/
|
|
1351
|
-
debit_element_id
|
|
1402
|
+
debit_element_id?: string | null;
|
|
1352
1403
|
/**
|
|
1353
1404
|
* Credit Element Id
|
|
1354
1405
|
*/
|
|
1355
|
-
credit_element_id
|
|
1406
|
+
credit_element_id?: string | null;
|
|
1356
1407
|
/**
|
|
1357
1408
|
* Amount
|
|
1409
|
+
*
|
|
1410
|
+
* Entry amount in dollars. None for 'removed' and 'skipped'.
|
|
1358
1411
|
*/
|
|
1359
|
-
amount
|
|
1412
|
+
amount?: number | null;
|
|
1413
|
+
/**
|
|
1414
|
+
* Reason
|
|
1415
|
+
*
|
|
1416
|
+
* Explanation for 'removed' and 'skipped' outcomes.
|
|
1417
|
+
*/
|
|
1418
|
+
reason?: string | null;
|
|
1360
1419
|
reversal?: ClosingEntryResponse | null;
|
|
1361
1420
|
};
|
|
1362
1421
|
/**
|
|
@@ -1775,6 +1834,35 @@ export type CreateGraphRequest = {
|
|
|
1775
1834
|
*/
|
|
1776
1835
|
tags?: Array<string>;
|
|
1777
1836
|
};
|
|
1837
|
+
/**
|
|
1838
|
+
* CreateManualClosingEntryRequest
|
|
1839
|
+
*/
|
|
1840
|
+
export type CreateManualClosingEntryRequest = {
|
|
1841
|
+
/**
|
|
1842
|
+
* Posting Date
|
|
1843
|
+
*
|
|
1844
|
+
* Posting date for the entry
|
|
1845
|
+
*/
|
|
1846
|
+
posting_date: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* Memo
|
|
1849
|
+
*
|
|
1850
|
+
* Memo describing the business event (e.g., 'Sale of computer to Vendor X on 3/15')
|
|
1851
|
+
*/
|
|
1852
|
+
memo: string;
|
|
1853
|
+
/**
|
|
1854
|
+
* Line Items
|
|
1855
|
+
*
|
|
1856
|
+
* Line items; must balance (total DR = total CR)
|
|
1857
|
+
*/
|
|
1858
|
+
line_items: Array<ManualLineItemRequest>;
|
|
1859
|
+
/**
|
|
1860
|
+
* Entry Type
|
|
1861
|
+
*
|
|
1862
|
+
* Entry type: 'closing' (default), 'adjusting', 'standard', 'reversing'
|
|
1863
|
+
*/
|
|
1864
|
+
entry_type?: 'standard' | 'adjusting' | 'closing' | 'reversing';
|
|
1865
|
+
};
|
|
1778
1866
|
/**
|
|
1779
1867
|
* CreatePortfolioRequest
|
|
1780
1868
|
*/
|
|
@@ -1974,6 +2062,12 @@ export type CreateScheduleRequest = {
|
|
|
1974
2062
|
monthly_amount: number;
|
|
1975
2063
|
entry_template: EntryTemplateRequest;
|
|
1976
2064
|
schedule_metadata?: ScheduleMetadataRequest | null;
|
|
2065
|
+
/**
|
|
2066
|
+
* Closed Through
|
|
2067
|
+
*
|
|
2068
|
+
* If provided, facts with period_end ≤ this date are flagged as 'historical' (already reflected in opening balances, ignored by the close workflow). Used during initial ledger setup to create schedules whose early facts have already been captured elsewhere.
|
|
2069
|
+
*/
|
|
2070
|
+
closed_through?: string | null;
|
|
1977
2071
|
};
|
|
1978
2072
|
/**
|
|
1979
2073
|
* CreateSecurityRequest
|
|
@@ -2029,7 +2123,7 @@ export type CreateStructureRequest = {
|
|
|
2029
2123
|
/**
|
|
2030
2124
|
* Structure Type
|
|
2031
2125
|
*/
|
|
2032
|
-
structure_type: 'chart_of_accounts' | 'income_statement' | 'balance_sheet' | '
|
|
2126
|
+
structure_type: 'chart_of_accounts' | 'income_statement' | 'balance_sheet' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'custom';
|
|
2033
2127
|
/**
|
|
2034
2128
|
* Taxonomy Id
|
|
2035
2129
|
*/
|
|
@@ -3032,6 +3126,110 @@ export type DownloadQuota = {
|
|
|
3032
3126
|
*/
|
|
3033
3127
|
resets_at: string;
|
|
3034
3128
|
};
|
|
3129
|
+
/**
|
|
3130
|
+
* DraftEntryResponse
|
|
3131
|
+
*
|
|
3132
|
+
* A single draft entry with full line item detail for review.
|
|
3133
|
+
*/
|
|
3134
|
+
export type DraftEntryResponse = {
|
|
3135
|
+
/**
|
|
3136
|
+
* Entry Id
|
|
3137
|
+
*/
|
|
3138
|
+
entry_id: string;
|
|
3139
|
+
/**
|
|
3140
|
+
* Posting Date
|
|
3141
|
+
*/
|
|
3142
|
+
posting_date: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* Type
|
|
3145
|
+
*
|
|
3146
|
+
* Entry type (e.g., 'closing', 'adjusting')
|
|
3147
|
+
*/
|
|
3148
|
+
type: string;
|
|
3149
|
+
/**
|
|
3150
|
+
* Memo
|
|
3151
|
+
*/
|
|
3152
|
+
memo?: string | null;
|
|
3153
|
+
/**
|
|
3154
|
+
* Provenance
|
|
3155
|
+
*
|
|
3156
|
+
* Where the entry came from: 'ai_generated', 'manual_entry', etc.
|
|
3157
|
+
*/
|
|
3158
|
+
provenance?: string | null;
|
|
3159
|
+
/**
|
|
3160
|
+
* Source Structure Id
|
|
3161
|
+
*
|
|
3162
|
+
* Schedule structure that generated this entry (if any)
|
|
3163
|
+
*/
|
|
3164
|
+
source_structure_id?: string | null;
|
|
3165
|
+
/**
|
|
3166
|
+
* Source Structure Name
|
|
3167
|
+
*
|
|
3168
|
+
* Human-readable name of the source schedule
|
|
3169
|
+
*/
|
|
3170
|
+
source_structure_name?: string | null;
|
|
3171
|
+
/**
|
|
3172
|
+
* Line Items
|
|
3173
|
+
*/
|
|
3174
|
+
line_items: Array<DraftLineItem>;
|
|
3175
|
+
/**
|
|
3176
|
+
* Total Debit
|
|
3177
|
+
*
|
|
3178
|
+
* Sum of debit amounts in cents
|
|
3179
|
+
*/
|
|
3180
|
+
total_debit: number;
|
|
3181
|
+
/**
|
|
3182
|
+
* Total Credit
|
|
3183
|
+
*
|
|
3184
|
+
* Sum of credit amounts in cents
|
|
3185
|
+
*/
|
|
3186
|
+
total_credit: number;
|
|
3187
|
+
/**
|
|
3188
|
+
* Balanced
|
|
3189
|
+
*
|
|
3190
|
+
* True if total_debit == total_credit
|
|
3191
|
+
*/
|
|
3192
|
+
balanced: boolean;
|
|
3193
|
+
};
|
|
3194
|
+
/**
|
|
3195
|
+
* DraftLineItem
|
|
3196
|
+
*
|
|
3197
|
+
* A single line item within a draft entry.
|
|
3198
|
+
*/
|
|
3199
|
+
export type DraftLineItem = {
|
|
3200
|
+
/**
|
|
3201
|
+
* Line Item Id
|
|
3202
|
+
*/
|
|
3203
|
+
line_item_id: string;
|
|
3204
|
+
/**
|
|
3205
|
+
* Element Id
|
|
3206
|
+
*/
|
|
3207
|
+
element_id: string;
|
|
3208
|
+
/**
|
|
3209
|
+
* Element Code
|
|
3210
|
+
*/
|
|
3211
|
+
element_code?: string | null;
|
|
3212
|
+
/**
|
|
3213
|
+
* Element Name
|
|
3214
|
+
*/
|
|
3215
|
+
element_name: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* Debit Amount
|
|
3218
|
+
*
|
|
3219
|
+
* Debit amount in cents
|
|
3220
|
+
*/
|
|
3221
|
+
debit_amount: number;
|
|
3222
|
+
/**
|
|
3223
|
+
* Credit Amount
|
|
3224
|
+
*
|
|
3225
|
+
* Credit amount in cents
|
|
3226
|
+
*/
|
|
3227
|
+
credit_amount: number;
|
|
3228
|
+
/**
|
|
3229
|
+
* Description
|
|
3230
|
+
*/
|
|
3231
|
+
description?: string | null;
|
|
3232
|
+
};
|
|
3035
3233
|
/**
|
|
3036
3234
|
* ElementListResponse
|
|
3037
3235
|
*/
|
|
@@ -3225,7 +3423,7 @@ export type EntryTemplateRequest = {
|
|
|
3225
3423
|
*
|
|
3226
3424
|
* Entry type for generated entries
|
|
3227
3425
|
*/
|
|
3228
|
-
entry_type?:
|
|
3426
|
+
entry_type?: 'standard' | 'adjusting' | 'closing' | 'reversing';
|
|
3229
3427
|
/**
|
|
3230
3428
|
* Memo Template
|
|
3231
3429
|
*
|
|
@@ -3469,6 +3667,106 @@ export type FileUploadResponse = {
|
|
|
3469
3667
|
*/
|
|
3470
3668
|
s3_key: string;
|
|
3471
3669
|
};
|
|
3670
|
+
/**
|
|
3671
|
+
* FiscalCalendarResponse
|
|
3672
|
+
*
|
|
3673
|
+
* Current fiscal calendar state for a graph.
|
|
3674
|
+
*/
|
|
3675
|
+
export type FiscalCalendarResponse = {
|
|
3676
|
+
/**
|
|
3677
|
+
* Graph Id
|
|
3678
|
+
*/
|
|
3679
|
+
graph_id: string;
|
|
3680
|
+
/**
|
|
3681
|
+
* Fiscal Year Start Month
|
|
3682
|
+
*/
|
|
3683
|
+
fiscal_year_start_month: number;
|
|
3684
|
+
/**
|
|
3685
|
+
* Closed Through
|
|
3686
|
+
*
|
|
3687
|
+
* Latest closed period (YYYY-MM), or null if nothing closed
|
|
3688
|
+
*/
|
|
3689
|
+
closed_through?: string | null;
|
|
3690
|
+
/**
|
|
3691
|
+
* Close Target
|
|
3692
|
+
*
|
|
3693
|
+
* Target period the user wants closed through (YYYY-MM)
|
|
3694
|
+
*/
|
|
3695
|
+
close_target?: string | null;
|
|
3696
|
+
/**
|
|
3697
|
+
* Gap Periods
|
|
3698
|
+
*
|
|
3699
|
+
* Number of periods between closed_through and close_target (inclusive of close_target). 0 means caught up.
|
|
3700
|
+
*/
|
|
3701
|
+
gap_periods?: number;
|
|
3702
|
+
/**
|
|
3703
|
+
* Catch Up Sequence
|
|
3704
|
+
*
|
|
3705
|
+
* Ordered list of periods that a close run would process
|
|
3706
|
+
*/
|
|
3707
|
+
catch_up_sequence?: Array<string>;
|
|
3708
|
+
/**
|
|
3709
|
+
* Closeable Now
|
|
3710
|
+
*
|
|
3711
|
+
* Whether the next period in the catch-up sequence passes all closeable gates
|
|
3712
|
+
*/
|
|
3713
|
+
closeable_now?: boolean;
|
|
3714
|
+
/**
|
|
3715
|
+
* Blockers
|
|
3716
|
+
*
|
|
3717
|
+
* Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed'
|
|
3718
|
+
*/
|
|
3719
|
+
blockers?: Array<string>;
|
|
3720
|
+
/**
|
|
3721
|
+
* Last Close At
|
|
3722
|
+
*/
|
|
3723
|
+
last_close_at?: string | null;
|
|
3724
|
+
/**
|
|
3725
|
+
* Initialized At
|
|
3726
|
+
*/
|
|
3727
|
+
initialized_at?: string | null;
|
|
3728
|
+
/**
|
|
3729
|
+
* Last Sync At
|
|
3730
|
+
*
|
|
3731
|
+
* Most recent QB sync timestamp (if connected)
|
|
3732
|
+
*/
|
|
3733
|
+
last_sync_at?: string | null;
|
|
3734
|
+
/**
|
|
3735
|
+
* Periods
|
|
3736
|
+
*
|
|
3737
|
+
* Fiscal period rows for this graph
|
|
3738
|
+
*/
|
|
3739
|
+
periods?: Array<FiscalPeriodSummary>;
|
|
3740
|
+
};
|
|
3741
|
+
/**
|
|
3742
|
+
* FiscalPeriodSummary
|
|
3743
|
+
*/
|
|
3744
|
+
export type FiscalPeriodSummary = {
|
|
3745
|
+
/**
|
|
3746
|
+
* Name
|
|
3747
|
+
*
|
|
3748
|
+
* Period name (YYYY-MM)
|
|
3749
|
+
*/
|
|
3750
|
+
name: string;
|
|
3751
|
+
/**
|
|
3752
|
+
* Start Date
|
|
3753
|
+
*/
|
|
3754
|
+
start_date: string;
|
|
3755
|
+
/**
|
|
3756
|
+
* End Date
|
|
3757
|
+
*/
|
|
3758
|
+
end_date: string;
|
|
3759
|
+
/**
|
|
3760
|
+
* Status
|
|
3761
|
+
*
|
|
3762
|
+
* 'open' | 'closing' | 'closed'
|
|
3763
|
+
*/
|
|
3764
|
+
status: string;
|
|
3765
|
+
/**
|
|
3766
|
+
* Closed At
|
|
3767
|
+
*/
|
|
3768
|
+
closed_at?: string | null;
|
|
3769
|
+
};
|
|
3472
3770
|
/**
|
|
3473
3771
|
* ForgotPasswordRequest
|
|
3474
3772
|
*
|
|
@@ -4430,6 +4728,12 @@ export type InitialEntityData = {
|
|
|
4430
4728
|
* Entity website or URI
|
|
4431
4729
|
*/
|
|
4432
4730
|
uri: string;
|
|
4731
|
+
/**
|
|
4732
|
+
* Ticker
|
|
4733
|
+
*
|
|
4734
|
+
* Entity symbol/ticker (e.g., 'HARB', 'NVDA'). Auto-generated from name if not provided.
|
|
4735
|
+
*/
|
|
4736
|
+
ticker?: string | null;
|
|
4433
4737
|
/**
|
|
4434
4738
|
* Cik
|
|
4435
4739
|
*
|
|
@@ -4473,6 +4777,59 @@ export type InitialEntityData = {
|
|
|
4473
4777
|
*/
|
|
4474
4778
|
ein?: string | null;
|
|
4475
4779
|
};
|
|
4780
|
+
/**
|
|
4781
|
+
* InitializeLedgerRequest
|
|
4782
|
+
*/
|
|
4783
|
+
export type InitializeLedgerRequest = {
|
|
4784
|
+
/**
|
|
4785
|
+
* Closed Through
|
|
4786
|
+
*
|
|
4787
|
+
* YYYY-MM period. Periods ≤ this date are treated as historical (already closed before the user joined). Set to null for a fresh business with no prior close state.
|
|
4788
|
+
*/
|
|
4789
|
+
closed_through?: string | null;
|
|
4790
|
+
/**
|
|
4791
|
+
* Fiscal Year Start Month
|
|
4792
|
+
*
|
|
4793
|
+
* Fiscal year start month (1-12). Defaults to calendar year.
|
|
4794
|
+
*/
|
|
4795
|
+
fiscal_year_start_month?: number;
|
|
4796
|
+
/**
|
|
4797
|
+
* Auto Seed Schedules
|
|
4798
|
+
*
|
|
4799
|
+
* If true, run the SchedulerAgent to create schedules from historical BS activity. NOT YET IMPLEMENTED — returns a warning in v1.
|
|
4800
|
+
*/
|
|
4801
|
+
auto_seed_schedules?: boolean;
|
|
4802
|
+
/**
|
|
4803
|
+
* Earliest Data Period
|
|
4804
|
+
*
|
|
4805
|
+
* YYYY-MM period representing the earliest month that has transaction data. Used to create FiscalPeriod rows. Defaults to 24 months before the current month.
|
|
4806
|
+
*/
|
|
4807
|
+
earliest_data_period?: string | null;
|
|
4808
|
+
/**
|
|
4809
|
+
* Note
|
|
4810
|
+
*
|
|
4811
|
+
* Free-form note attached to the audit event
|
|
4812
|
+
*/
|
|
4813
|
+
note?: string | null;
|
|
4814
|
+
};
|
|
4815
|
+
/**
|
|
4816
|
+
* InitializeLedgerResponse
|
|
4817
|
+
*/
|
|
4818
|
+
export type InitializeLedgerResponse = {
|
|
4819
|
+
fiscal_calendar: FiscalCalendarResponse;
|
|
4820
|
+
/**
|
|
4821
|
+
* Periods Created
|
|
4822
|
+
*
|
|
4823
|
+
* Number of FiscalPeriod rows created by initialization
|
|
4824
|
+
*/
|
|
4825
|
+
periods_created?: number;
|
|
4826
|
+
/**
|
|
4827
|
+
* Warnings
|
|
4828
|
+
*
|
|
4829
|
+
* Non-fatal warnings (e.g., auto_seed_schedules not implemented)
|
|
4830
|
+
*/
|
|
4831
|
+
warnings?: Array<string>;
|
|
4832
|
+
};
|
|
4476
4833
|
/**
|
|
4477
4834
|
* InstanceUsage
|
|
4478
4835
|
*
|
|
@@ -5209,6 +5566,33 @@ export type McpToolsResponse = {
|
|
|
5209
5566
|
[key: string]: unknown;
|
|
5210
5567
|
}>;
|
|
5211
5568
|
};
|
|
5569
|
+
/**
|
|
5570
|
+
* ManualLineItemRequest
|
|
5571
|
+
*/
|
|
5572
|
+
export type ManualLineItemRequest = {
|
|
5573
|
+
/**
|
|
5574
|
+
* Element Id
|
|
5575
|
+
*
|
|
5576
|
+
* Element ID (chart of accounts)
|
|
5577
|
+
*/
|
|
5578
|
+
element_id: string;
|
|
5579
|
+
/**
|
|
5580
|
+
* Debit Amount
|
|
5581
|
+
*
|
|
5582
|
+
* Debit in cents
|
|
5583
|
+
*/
|
|
5584
|
+
debit_amount?: number;
|
|
5585
|
+
/**
|
|
5586
|
+
* Credit Amount
|
|
5587
|
+
*
|
|
5588
|
+
* Credit in cents
|
|
5589
|
+
*/
|
|
5590
|
+
credit_amount?: number;
|
|
5591
|
+
/**
|
|
5592
|
+
* Description
|
|
5593
|
+
*/
|
|
5594
|
+
description?: string | null;
|
|
5595
|
+
};
|
|
5212
5596
|
/**
|
|
5213
5597
|
* MappingCoverageResponse
|
|
5214
5598
|
*
|
|
@@ -6117,6 +6501,53 @@ export type PeriodCloseStatusResponse = {
|
|
|
6117
6501
|
*/
|
|
6118
6502
|
total_posted: number;
|
|
6119
6503
|
};
|
|
6504
|
+
/**
|
|
6505
|
+
* PeriodDraftsResponse
|
|
6506
|
+
*
|
|
6507
|
+
* All draft entries for a fiscal period, ready for review before close.
|
|
6508
|
+
*/
|
|
6509
|
+
export type PeriodDraftsResponse = {
|
|
6510
|
+
/**
|
|
6511
|
+
* Period
|
|
6512
|
+
*
|
|
6513
|
+
* YYYY-MM period name
|
|
6514
|
+
*/
|
|
6515
|
+
period: string;
|
|
6516
|
+
/**
|
|
6517
|
+
* Period Start
|
|
6518
|
+
*/
|
|
6519
|
+
period_start: string;
|
|
6520
|
+
/**
|
|
6521
|
+
* Period End
|
|
6522
|
+
*/
|
|
6523
|
+
period_end: string;
|
|
6524
|
+
/**
|
|
6525
|
+
* Draft Count
|
|
6526
|
+
*/
|
|
6527
|
+
draft_count: number;
|
|
6528
|
+
/**
|
|
6529
|
+
* Total Debit
|
|
6530
|
+
*
|
|
6531
|
+
* Sum across all drafts, in cents
|
|
6532
|
+
*/
|
|
6533
|
+
total_debit: number;
|
|
6534
|
+
/**
|
|
6535
|
+
* Total Credit
|
|
6536
|
+
*
|
|
6537
|
+
* Sum across all drafts, in cents
|
|
6538
|
+
*/
|
|
6539
|
+
total_credit: number;
|
|
6540
|
+
/**
|
|
6541
|
+
* All Balanced
|
|
6542
|
+
*
|
|
6543
|
+
* True if every draft entry has debit == credit
|
|
6544
|
+
*/
|
|
6545
|
+
all_balanced: boolean;
|
|
6546
|
+
/**
|
|
6547
|
+
* Drafts
|
|
6548
|
+
*/
|
|
6549
|
+
drafts: Array<DraftEntryResponse>;
|
|
6550
|
+
};
|
|
6120
6551
|
/**
|
|
6121
6552
|
* PeriodSpec
|
|
6122
6553
|
*
|
|
@@ -6531,6 +6962,23 @@ export type RegisterRequest = {
|
|
|
6531
6962
|
*/
|
|
6532
6963
|
captcha_token?: string | null;
|
|
6533
6964
|
};
|
|
6965
|
+
/**
|
|
6966
|
+
* ReopenPeriodRequest
|
|
6967
|
+
*/
|
|
6968
|
+
export type ReopenPeriodRequest = {
|
|
6969
|
+
/**
|
|
6970
|
+
* Reason
|
|
6971
|
+
*
|
|
6972
|
+
* Required reason for the reopen (captured in audit log)
|
|
6973
|
+
*/
|
|
6974
|
+
reason: string;
|
|
6975
|
+
/**
|
|
6976
|
+
* Note
|
|
6977
|
+
*
|
|
6978
|
+
* Additional free-form note
|
|
6979
|
+
*/
|
|
6980
|
+
note?: string | null;
|
|
6981
|
+
};
|
|
6534
6982
|
/**
|
|
6535
6983
|
* ReportListResponse
|
|
6536
6984
|
*/
|
|
@@ -7473,6 +7921,23 @@ export type ServiceOfferingsResponse = {
|
|
|
7473
7921
|
*/
|
|
7474
7922
|
summary: ServiceOfferingSummary;
|
|
7475
7923
|
};
|
|
7924
|
+
/**
|
|
7925
|
+
* SetCloseTargetRequest
|
|
7926
|
+
*/
|
|
7927
|
+
export type SetCloseTargetRequest = {
|
|
7928
|
+
/**
|
|
7929
|
+
* Period
|
|
7930
|
+
*
|
|
7931
|
+
* Target period in YYYY-MM format
|
|
7932
|
+
*/
|
|
7933
|
+
period: string;
|
|
7934
|
+
/**
|
|
7935
|
+
* Note
|
|
7936
|
+
*
|
|
7937
|
+
* Free-form note attached to the audit event
|
|
7938
|
+
*/
|
|
7939
|
+
note?: string | null;
|
|
7940
|
+
};
|
|
7476
7941
|
/**
|
|
7477
7942
|
* ShareReportRequest
|
|
7478
7943
|
*/
|
|
@@ -8250,6 +8715,44 @@ export type TrialBalanceRow = {
|
|
|
8250
8715
|
*/
|
|
8251
8716
|
net_balance: number;
|
|
8252
8717
|
};
|
|
8718
|
+
/**
|
|
8719
|
+
* TruncateScheduleRequest
|
|
8720
|
+
*/
|
|
8721
|
+
export type TruncateScheduleRequest = {
|
|
8722
|
+
/**
|
|
8723
|
+
* New End Date
|
|
8724
|
+
*
|
|
8725
|
+
* New last-covered date for the schedule. Facts with period_start > this date are deleted (along with any stale draft entries they produced). Historical facts (already posted) are preserved.
|
|
8726
|
+
*/
|
|
8727
|
+
new_end_date: string;
|
|
8728
|
+
/**
|
|
8729
|
+
* Reason
|
|
8730
|
+
*
|
|
8731
|
+
* Required reason for the truncation (captured in audit log).
|
|
8732
|
+
*/
|
|
8733
|
+
reason: string;
|
|
8734
|
+
};
|
|
8735
|
+
/**
|
|
8736
|
+
* TruncateScheduleResponse
|
|
8737
|
+
*/
|
|
8738
|
+
export type TruncateScheduleResponse = {
|
|
8739
|
+
/**
|
|
8740
|
+
* Structure Id
|
|
8741
|
+
*/
|
|
8742
|
+
structure_id: string;
|
|
8743
|
+
/**
|
|
8744
|
+
* New End Date
|
|
8745
|
+
*/
|
|
8746
|
+
new_end_date: string;
|
|
8747
|
+
/**
|
|
8748
|
+
* Facts Deleted
|
|
8749
|
+
*/
|
|
8750
|
+
facts_deleted: number;
|
|
8751
|
+
/**
|
|
8752
|
+
* Reason
|
|
8753
|
+
*/
|
|
8754
|
+
reason: string;
|
|
8755
|
+
};
|
|
8253
8756
|
/**
|
|
8254
8757
|
* UnmappedElementResponse
|
|
8255
8758
|
*
|
|
@@ -13446,7 +13949,7 @@ export type GetStatementData = {
|
|
|
13446
13949
|
/**
|
|
13447
13950
|
* Structure Type
|
|
13448
13951
|
*
|
|
13449
|
-
* Structure type: income_statement, balance_sheet,
|
|
13952
|
+
* Structure type: income_statement, balance_sheet, equity_statement
|
|
13450
13953
|
*/
|
|
13451
13954
|
structure_type: string;
|
|
13452
13955
|
};
|
|
@@ -13692,6 +14195,62 @@ export type CreateClosingEntryResponses = {
|
|
|
13692
14195
|
201: ClosingEntryResponse;
|
|
13693
14196
|
};
|
|
13694
14197
|
export type CreateClosingEntryResponse = CreateClosingEntryResponses[keyof CreateClosingEntryResponses];
|
|
14198
|
+
export type TruncateScheduleData = {
|
|
14199
|
+
body: TruncateScheduleRequest;
|
|
14200
|
+
path: {
|
|
14201
|
+
/**
|
|
14202
|
+
* Graph Id
|
|
14203
|
+
*/
|
|
14204
|
+
graph_id: string;
|
|
14205
|
+
/**
|
|
14206
|
+
* Structure Id
|
|
14207
|
+
*
|
|
14208
|
+
* Schedule structure ID
|
|
14209
|
+
*/
|
|
14210
|
+
structure_id: string;
|
|
14211
|
+
};
|
|
14212
|
+
query?: never;
|
|
14213
|
+
url: '/v1/ledger/{graph_id}/schedules/{structure_id}/truncate';
|
|
14214
|
+
};
|
|
14215
|
+
export type TruncateScheduleErrors = {
|
|
14216
|
+
/**
|
|
14217
|
+
* Validation Error
|
|
14218
|
+
*/
|
|
14219
|
+
422: HttpValidationError;
|
|
14220
|
+
};
|
|
14221
|
+
export type TruncateScheduleError = TruncateScheduleErrors[keyof TruncateScheduleErrors];
|
|
14222
|
+
export type TruncateScheduleResponses = {
|
|
14223
|
+
/**
|
|
14224
|
+
* Successful Response
|
|
14225
|
+
*/
|
|
14226
|
+
200: TruncateScheduleResponse;
|
|
14227
|
+
};
|
|
14228
|
+
export type TruncateScheduleResponse2 = TruncateScheduleResponses[keyof TruncateScheduleResponses];
|
|
14229
|
+
export type CreateManualClosingEntryData = {
|
|
14230
|
+
body: CreateManualClosingEntryRequest;
|
|
14231
|
+
path: {
|
|
14232
|
+
/**
|
|
14233
|
+
* Graph Id
|
|
14234
|
+
*/
|
|
14235
|
+
graph_id: string;
|
|
14236
|
+
};
|
|
14237
|
+
query?: never;
|
|
14238
|
+
url: '/v1/ledger/{graph_id}/manual-closing-entry';
|
|
14239
|
+
};
|
|
14240
|
+
export type CreateManualClosingEntryErrors = {
|
|
14241
|
+
/**
|
|
14242
|
+
* Validation Error
|
|
14243
|
+
*/
|
|
14244
|
+
422: HttpValidationError;
|
|
14245
|
+
};
|
|
14246
|
+
export type CreateManualClosingEntryError = CreateManualClosingEntryErrors[keyof CreateManualClosingEntryErrors];
|
|
14247
|
+
export type CreateManualClosingEntryResponses = {
|
|
14248
|
+
/**
|
|
14249
|
+
* Successful Response
|
|
14250
|
+
*/
|
|
14251
|
+
201: ClosingEntryResponse;
|
|
14252
|
+
};
|
|
14253
|
+
export type CreateManualClosingEntryResponse = CreateManualClosingEntryResponses[keyof CreateManualClosingEntryResponses];
|
|
13695
14254
|
export type ListPublishListsData = {
|
|
13696
14255
|
body?: never;
|
|
13697
14256
|
path: {
|
|
@@ -13971,6 +14530,174 @@ export type GetClosingBookStructuresResponses = {
|
|
|
13971
14530
|
200: ClosingBookStructuresResponse;
|
|
13972
14531
|
};
|
|
13973
14532
|
export type GetClosingBookStructuresResponse = GetClosingBookStructuresResponses[keyof GetClosingBookStructuresResponses];
|
|
14533
|
+
export type InitializeLedgerData = {
|
|
14534
|
+
body: InitializeLedgerRequest;
|
|
14535
|
+
path: {
|
|
14536
|
+
/**
|
|
14537
|
+
* Graph Id
|
|
14538
|
+
*/
|
|
14539
|
+
graph_id: string;
|
|
14540
|
+
};
|
|
14541
|
+
query?: never;
|
|
14542
|
+
url: '/v1/ledger/{graph_id}/initialize';
|
|
14543
|
+
};
|
|
14544
|
+
export type InitializeLedgerErrors = {
|
|
14545
|
+
/**
|
|
14546
|
+
* Validation Error
|
|
14547
|
+
*/
|
|
14548
|
+
422: HttpValidationError;
|
|
14549
|
+
};
|
|
14550
|
+
export type InitializeLedgerError = InitializeLedgerErrors[keyof InitializeLedgerErrors];
|
|
14551
|
+
export type InitializeLedgerResponses = {
|
|
14552
|
+
/**
|
|
14553
|
+
* Successful Response
|
|
14554
|
+
*/
|
|
14555
|
+
201: InitializeLedgerResponse;
|
|
14556
|
+
};
|
|
14557
|
+
export type InitializeLedgerResponse2 = InitializeLedgerResponses[keyof InitializeLedgerResponses];
|
|
14558
|
+
export type GetFiscalCalendarData = {
|
|
14559
|
+
body?: never;
|
|
14560
|
+
path: {
|
|
14561
|
+
/**
|
|
14562
|
+
* Graph Id
|
|
14563
|
+
*/
|
|
14564
|
+
graph_id: string;
|
|
14565
|
+
};
|
|
14566
|
+
query?: never;
|
|
14567
|
+
url: '/v1/ledger/{graph_id}/fiscal-calendar';
|
|
14568
|
+
};
|
|
14569
|
+
export type GetFiscalCalendarErrors = {
|
|
14570
|
+
/**
|
|
14571
|
+
* Validation Error
|
|
14572
|
+
*/
|
|
14573
|
+
422: HttpValidationError;
|
|
14574
|
+
};
|
|
14575
|
+
export type GetFiscalCalendarError = GetFiscalCalendarErrors[keyof GetFiscalCalendarErrors];
|
|
14576
|
+
export type GetFiscalCalendarResponses = {
|
|
14577
|
+
/**
|
|
14578
|
+
* Successful Response
|
|
14579
|
+
*/
|
|
14580
|
+
200: FiscalCalendarResponse;
|
|
14581
|
+
};
|
|
14582
|
+
export type GetFiscalCalendarResponse = GetFiscalCalendarResponses[keyof GetFiscalCalendarResponses];
|
|
14583
|
+
export type SetCloseTargetData = {
|
|
14584
|
+
body: SetCloseTargetRequest;
|
|
14585
|
+
path: {
|
|
14586
|
+
/**
|
|
14587
|
+
* Graph Id
|
|
14588
|
+
*/
|
|
14589
|
+
graph_id: string;
|
|
14590
|
+
};
|
|
14591
|
+
query?: never;
|
|
14592
|
+
url: '/v1/ledger/{graph_id}/fiscal-calendar/close-target';
|
|
14593
|
+
};
|
|
14594
|
+
export type SetCloseTargetErrors = {
|
|
14595
|
+
/**
|
|
14596
|
+
* Validation Error
|
|
14597
|
+
*/
|
|
14598
|
+
422: HttpValidationError;
|
|
14599
|
+
};
|
|
14600
|
+
export type SetCloseTargetError = SetCloseTargetErrors[keyof SetCloseTargetErrors];
|
|
14601
|
+
export type SetCloseTargetResponses = {
|
|
14602
|
+
/**
|
|
14603
|
+
* Successful Response
|
|
14604
|
+
*/
|
|
14605
|
+
200: FiscalCalendarResponse;
|
|
14606
|
+
};
|
|
14607
|
+
export type SetCloseTargetResponse = SetCloseTargetResponses[keyof SetCloseTargetResponses];
|
|
14608
|
+
export type CloseFiscalPeriodData = {
|
|
14609
|
+
body?: ClosePeriodRequest;
|
|
14610
|
+
path: {
|
|
14611
|
+
/**
|
|
14612
|
+
* Graph Id
|
|
14613
|
+
*/
|
|
14614
|
+
graph_id: string;
|
|
14615
|
+
/**
|
|
14616
|
+
* Period
|
|
14617
|
+
*
|
|
14618
|
+
* Target period in YYYY-MM format
|
|
14619
|
+
*/
|
|
14620
|
+
period: string;
|
|
14621
|
+
};
|
|
14622
|
+
query?: never;
|
|
14623
|
+
url: '/v1/ledger/{graph_id}/periods/{period}/close';
|
|
14624
|
+
};
|
|
14625
|
+
export type CloseFiscalPeriodErrors = {
|
|
14626
|
+
/**
|
|
14627
|
+
* Validation Error
|
|
14628
|
+
*/
|
|
14629
|
+
422: HttpValidationError;
|
|
14630
|
+
};
|
|
14631
|
+
export type CloseFiscalPeriodError = CloseFiscalPeriodErrors[keyof CloseFiscalPeriodErrors];
|
|
14632
|
+
export type CloseFiscalPeriodResponses = {
|
|
14633
|
+
/**
|
|
14634
|
+
* Successful Response
|
|
14635
|
+
*/
|
|
14636
|
+
200: ClosePeriodResponse;
|
|
14637
|
+
};
|
|
14638
|
+
export type CloseFiscalPeriodResponse = CloseFiscalPeriodResponses[keyof CloseFiscalPeriodResponses];
|
|
14639
|
+
export type ReopenFiscalPeriodData = {
|
|
14640
|
+
body: ReopenPeriodRequest;
|
|
14641
|
+
path: {
|
|
14642
|
+
/**
|
|
14643
|
+
* Graph Id
|
|
14644
|
+
*/
|
|
14645
|
+
graph_id: string;
|
|
14646
|
+
/**
|
|
14647
|
+
* Period
|
|
14648
|
+
*
|
|
14649
|
+
* Period to reopen (YYYY-MM)
|
|
14650
|
+
*/
|
|
14651
|
+
period: string;
|
|
14652
|
+
};
|
|
14653
|
+
query?: never;
|
|
14654
|
+
url: '/v1/ledger/{graph_id}/periods/{period}/reopen';
|
|
14655
|
+
};
|
|
14656
|
+
export type ReopenFiscalPeriodErrors = {
|
|
14657
|
+
/**
|
|
14658
|
+
* Validation Error
|
|
14659
|
+
*/
|
|
14660
|
+
422: HttpValidationError;
|
|
14661
|
+
};
|
|
14662
|
+
export type ReopenFiscalPeriodError = ReopenFiscalPeriodErrors[keyof ReopenFiscalPeriodErrors];
|
|
14663
|
+
export type ReopenFiscalPeriodResponses = {
|
|
14664
|
+
/**
|
|
14665
|
+
* Successful Response
|
|
14666
|
+
*/
|
|
14667
|
+
200: FiscalCalendarResponse;
|
|
14668
|
+
};
|
|
14669
|
+
export type ReopenFiscalPeriodResponse = ReopenFiscalPeriodResponses[keyof ReopenFiscalPeriodResponses];
|
|
14670
|
+
export type ListPeriodDraftsData = {
|
|
14671
|
+
body?: never;
|
|
14672
|
+
path: {
|
|
14673
|
+
/**
|
|
14674
|
+
* Graph Id
|
|
14675
|
+
*/
|
|
14676
|
+
graph_id: string;
|
|
14677
|
+
/**
|
|
14678
|
+
* Period
|
|
14679
|
+
*
|
|
14680
|
+
* Period in YYYY-MM format
|
|
14681
|
+
*/
|
|
14682
|
+
period: string;
|
|
14683
|
+
};
|
|
14684
|
+
query?: never;
|
|
14685
|
+
url: '/v1/ledger/{graph_id}/periods/{period}/drafts';
|
|
14686
|
+
};
|
|
14687
|
+
export type ListPeriodDraftsErrors = {
|
|
14688
|
+
/**
|
|
14689
|
+
* Validation Error
|
|
14690
|
+
*/
|
|
14691
|
+
422: HttpValidationError;
|
|
14692
|
+
};
|
|
14693
|
+
export type ListPeriodDraftsError = ListPeriodDraftsErrors[keyof ListPeriodDraftsErrors];
|
|
14694
|
+
export type ListPeriodDraftsResponses = {
|
|
14695
|
+
/**
|
|
14696
|
+
* Successful Response
|
|
14697
|
+
*/
|
|
14698
|
+
200: PeriodDraftsResponse;
|
|
14699
|
+
};
|
|
14700
|
+
export type ListPeriodDraftsResponse = ListPeriodDraftsResponses[keyof ListPeriodDraftsResponses];
|
|
13974
14701
|
export type ListPortfoliosData = {
|
|
13975
14702
|
body?: never;
|
|
13976
14703
|
path: {
|