@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/types.gen.ts
CHANGED
|
@@ -1312,6 +1312,49 @@ export type CheckoutStatusResponse = {
|
|
|
1312
1312
|
error?: string | null;
|
|
1313
1313
|
};
|
|
1314
1314
|
|
|
1315
|
+
/**
|
|
1316
|
+
* ClosePeriodRequest
|
|
1317
|
+
*/
|
|
1318
|
+
export type ClosePeriodRequest = {
|
|
1319
|
+
/**
|
|
1320
|
+
* Note
|
|
1321
|
+
*
|
|
1322
|
+
* Free-form note attached to the close event
|
|
1323
|
+
*/
|
|
1324
|
+
note?: string | null;
|
|
1325
|
+
/**
|
|
1326
|
+
* Allow Stale Sync
|
|
1327
|
+
*
|
|
1328
|
+
* Override the sync-currency gate. Only use when you have manually verified that the source data for the period is complete.
|
|
1329
|
+
*/
|
|
1330
|
+
allow_stale_sync?: boolean;
|
|
1331
|
+
};
|
|
1332
|
+
|
|
1333
|
+
/**
|
|
1334
|
+
* ClosePeriodResponse
|
|
1335
|
+
*
|
|
1336
|
+
* Response from a single-period close operation.
|
|
1337
|
+
*/
|
|
1338
|
+
export type ClosePeriodResponse = {
|
|
1339
|
+
fiscal_calendar: FiscalCalendarResponse;
|
|
1340
|
+
/**
|
|
1341
|
+
* Period
|
|
1342
|
+
*/
|
|
1343
|
+
period: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* Entries Posted
|
|
1346
|
+
*
|
|
1347
|
+
* Number of draft entries transitioned to posted
|
|
1348
|
+
*/
|
|
1349
|
+
entries_posted?: number;
|
|
1350
|
+
/**
|
|
1351
|
+
* Target Auto Advanced
|
|
1352
|
+
*
|
|
1353
|
+
* Whether close_target was auto-advanced because it was reached
|
|
1354
|
+
*/
|
|
1355
|
+
target_auto_advanced?: boolean;
|
|
1356
|
+
};
|
|
1357
|
+
|
|
1315
1358
|
/**
|
|
1316
1359
|
* ClosingBookCategory
|
|
1317
1360
|
*/
|
|
@@ -1374,34 +1417,52 @@ export type ClosingBookStructuresResponse = {
|
|
|
1374
1417
|
* ClosingEntryResponse
|
|
1375
1418
|
*/
|
|
1376
1419
|
export type ClosingEntryResponse = {
|
|
1420
|
+
/**
|
|
1421
|
+
* Outcome
|
|
1422
|
+
*
|
|
1423
|
+
* 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).
|
|
1424
|
+
*/
|
|
1425
|
+
outcome: string;
|
|
1377
1426
|
/**
|
|
1378
1427
|
* Entry Id
|
|
1428
|
+
*
|
|
1429
|
+
* The draft entry ID. None for 'removed' and 'skipped' outcomes.
|
|
1379
1430
|
*/
|
|
1380
|
-
entry_id
|
|
1431
|
+
entry_id?: string | null;
|
|
1381
1432
|
/**
|
|
1382
1433
|
* Status
|
|
1434
|
+
*
|
|
1435
|
+
* Entry status (always 'draft' when present).
|
|
1383
1436
|
*/
|
|
1384
|
-
status
|
|
1437
|
+
status?: string | null;
|
|
1385
1438
|
/**
|
|
1386
1439
|
* Posting Date
|
|
1387
1440
|
*/
|
|
1388
|
-
posting_date
|
|
1441
|
+
posting_date?: string | null;
|
|
1389
1442
|
/**
|
|
1390
1443
|
* Memo
|
|
1391
1444
|
*/
|
|
1392
|
-
memo
|
|
1445
|
+
memo?: string | null;
|
|
1393
1446
|
/**
|
|
1394
1447
|
* Debit Element Id
|
|
1395
1448
|
*/
|
|
1396
|
-
debit_element_id
|
|
1449
|
+
debit_element_id?: string | null;
|
|
1397
1450
|
/**
|
|
1398
1451
|
* Credit Element Id
|
|
1399
1452
|
*/
|
|
1400
|
-
credit_element_id
|
|
1453
|
+
credit_element_id?: string | null;
|
|
1401
1454
|
/**
|
|
1402
1455
|
* Amount
|
|
1456
|
+
*
|
|
1457
|
+
* Entry amount in dollars. None for 'removed' and 'skipped'.
|
|
1403
1458
|
*/
|
|
1404
|
-
amount
|
|
1459
|
+
amount?: number | null;
|
|
1460
|
+
/**
|
|
1461
|
+
* Reason
|
|
1462
|
+
*
|
|
1463
|
+
* Explanation for 'removed' and 'skipped' outcomes.
|
|
1464
|
+
*/
|
|
1465
|
+
reason?: string | null;
|
|
1405
1466
|
reversal?: ClosingEntryResponse | null;
|
|
1406
1467
|
};
|
|
1407
1468
|
|
|
@@ -1833,6 +1894,36 @@ export type CreateGraphRequest = {
|
|
|
1833
1894
|
tags?: Array<string>;
|
|
1834
1895
|
};
|
|
1835
1896
|
|
|
1897
|
+
/**
|
|
1898
|
+
* CreateManualClosingEntryRequest
|
|
1899
|
+
*/
|
|
1900
|
+
export type CreateManualClosingEntryRequest = {
|
|
1901
|
+
/**
|
|
1902
|
+
* Posting Date
|
|
1903
|
+
*
|
|
1904
|
+
* Posting date for the entry
|
|
1905
|
+
*/
|
|
1906
|
+
posting_date: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* Memo
|
|
1909
|
+
*
|
|
1910
|
+
* Memo describing the business event (e.g., 'Sale of computer to Vendor X on 3/15')
|
|
1911
|
+
*/
|
|
1912
|
+
memo: string;
|
|
1913
|
+
/**
|
|
1914
|
+
* Line Items
|
|
1915
|
+
*
|
|
1916
|
+
* Line items; must balance (total DR = total CR)
|
|
1917
|
+
*/
|
|
1918
|
+
line_items: Array<ManualLineItemRequest>;
|
|
1919
|
+
/**
|
|
1920
|
+
* Entry Type
|
|
1921
|
+
*
|
|
1922
|
+
* Entry type: 'closing' (default), 'adjusting', 'standard', 'reversing'
|
|
1923
|
+
*/
|
|
1924
|
+
entry_type?: 'standard' | 'adjusting' | 'closing' | 'reversing';
|
|
1925
|
+
};
|
|
1926
|
+
|
|
1836
1927
|
/**
|
|
1837
1928
|
* CreatePortfolioRequest
|
|
1838
1929
|
*/
|
|
@@ -2037,6 +2128,12 @@ export type CreateScheduleRequest = {
|
|
|
2037
2128
|
monthly_amount: number;
|
|
2038
2129
|
entry_template: EntryTemplateRequest;
|
|
2039
2130
|
schedule_metadata?: ScheduleMetadataRequest | null;
|
|
2131
|
+
/**
|
|
2132
|
+
* Closed Through
|
|
2133
|
+
*
|
|
2134
|
+
* 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.
|
|
2135
|
+
*/
|
|
2136
|
+
closed_through?: string | null;
|
|
2040
2137
|
};
|
|
2041
2138
|
|
|
2042
2139
|
/**
|
|
@@ -2094,7 +2191,7 @@ export type CreateStructureRequest = {
|
|
|
2094
2191
|
/**
|
|
2095
2192
|
* Structure Type
|
|
2096
2193
|
*/
|
|
2097
|
-
structure_type: 'chart_of_accounts' | 'income_statement' | 'balance_sheet' | '
|
|
2194
|
+
structure_type: 'chart_of_accounts' | 'income_statement' | 'balance_sheet' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'custom';
|
|
2098
2195
|
/**
|
|
2099
2196
|
* Taxonomy Id
|
|
2100
2197
|
*/
|
|
@@ -3121,6 +3218,112 @@ export type DownloadQuota = {
|
|
|
3121
3218
|
resets_at: string;
|
|
3122
3219
|
};
|
|
3123
3220
|
|
|
3221
|
+
/**
|
|
3222
|
+
* DraftEntryResponse
|
|
3223
|
+
*
|
|
3224
|
+
* A single draft entry with full line item detail for review.
|
|
3225
|
+
*/
|
|
3226
|
+
export type DraftEntryResponse = {
|
|
3227
|
+
/**
|
|
3228
|
+
* Entry Id
|
|
3229
|
+
*/
|
|
3230
|
+
entry_id: string;
|
|
3231
|
+
/**
|
|
3232
|
+
* Posting Date
|
|
3233
|
+
*/
|
|
3234
|
+
posting_date: string;
|
|
3235
|
+
/**
|
|
3236
|
+
* Type
|
|
3237
|
+
*
|
|
3238
|
+
* Entry type (e.g., 'closing', 'adjusting')
|
|
3239
|
+
*/
|
|
3240
|
+
type: string;
|
|
3241
|
+
/**
|
|
3242
|
+
* Memo
|
|
3243
|
+
*/
|
|
3244
|
+
memo?: string | null;
|
|
3245
|
+
/**
|
|
3246
|
+
* Provenance
|
|
3247
|
+
*
|
|
3248
|
+
* Where the entry came from: 'ai_generated', 'manual_entry', etc.
|
|
3249
|
+
*/
|
|
3250
|
+
provenance?: string | null;
|
|
3251
|
+
/**
|
|
3252
|
+
* Source Structure Id
|
|
3253
|
+
*
|
|
3254
|
+
* Schedule structure that generated this entry (if any)
|
|
3255
|
+
*/
|
|
3256
|
+
source_structure_id?: string | null;
|
|
3257
|
+
/**
|
|
3258
|
+
* Source Structure Name
|
|
3259
|
+
*
|
|
3260
|
+
* Human-readable name of the source schedule
|
|
3261
|
+
*/
|
|
3262
|
+
source_structure_name?: string | null;
|
|
3263
|
+
/**
|
|
3264
|
+
* Line Items
|
|
3265
|
+
*/
|
|
3266
|
+
line_items: Array<DraftLineItem>;
|
|
3267
|
+
/**
|
|
3268
|
+
* Total Debit
|
|
3269
|
+
*
|
|
3270
|
+
* Sum of debit amounts in cents
|
|
3271
|
+
*/
|
|
3272
|
+
total_debit: number;
|
|
3273
|
+
/**
|
|
3274
|
+
* Total Credit
|
|
3275
|
+
*
|
|
3276
|
+
* Sum of credit amounts in cents
|
|
3277
|
+
*/
|
|
3278
|
+
total_credit: number;
|
|
3279
|
+
/**
|
|
3280
|
+
* Balanced
|
|
3281
|
+
*
|
|
3282
|
+
* True if total_debit == total_credit
|
|
3283
|
+
*/
|
|
3284
|
+
balanced: boolean;
|
|
3285
|
+
};
|
|
3286
|
+
|
|
3287
|
+
/**
|
|
3288
|
+
* DraftLineItem
|
|
3289
|
+
*
|
|
3290
|
+
* A single line item within a draft entry.
|
|
3291
|
+
*/
|
|
3292
|
+
export type DraftLineItem = {
|
|
3293
|
+
/**
|
|
3294
|
+
* Line Item Id
|
|
3295
|
+
*/
|
|
3296
|
+
line_item_id: string;
|
|
3297
|
+
/**
|
|
3298
|
+
* Element Id
|
|
3299
|
+
*/
|
|
3300
|
+
element_id: string;
|
|
3301
|
+
/**
|
|
3302
|
+
* Element Code
|
|
3303
|
+
*/
|
|
3304
|
+
element_code?: string | null;
|
|
3305
|
+
/**
|
|
3306
|
+
* Element Name
|
|
3307
|
+
*/
|
|
3308
|
+
element_name: string;
|
|
3309
|
+
/**
|
|
3310
|
+
* Debit Amount
|
|
3311
|
+
*
|
|
3312
|
+
* Debit amount in cents
|
|
3313
|
+
*/
|
|
3314
|
+
debit_amount: number;
|
|
3315
|
+
/**
|
|
3316
|
+
* Credit Amount
|
|
3317
|
+
*
|
|
3318
|
+
* Credit amount in cents
|
|
3319
|
+
*/
|
|
3320
|
+
credit_amount: number;
|
|
3321
|
+
/**
|
|
3322
|
+
* Description
|
|
3323
|
+
*/
|
|
3324
|
+
description?: string | null;
|
|
3325
|
+
};
|
|
3326
|
+
|
|
3124
3327
|
/**
|
|
3125
3328
|
* ElementListResponse
|
|
3126
3329
|
*/
|
|
@@ -3319,7 +3522,7 @@ export type EntryTemplateRequest = {
|
|
|
3319
3522
|
*
|
|
3320
3523
|
* Entry type for generated entries
|
|
3321
3524
|
*/
|
|
3322
|
-
entry_type?:
|
|
3525
|
+
entry_type?: 'standard' | 'adjusting' | 'closing' | 'reversing';
|
|
3323
3526
|
/**
|
|
3324
3527
|
* Memo Template
|
|
3325
3528
|
*
|
|
@@ -3571,6 +3774,108 @@ export type FileUploadResponse = {
|
|
|
3571
3774
|
s3_key: string;
|
|
3572
3775
|
};
|
|
3573
3776
|
|
|
3777
|
+
/**
|
|
3778
|
+
* FiscalCalendarResponse
|
|
3779
|
+
*
|
|
3780
|
+
* Current fiscal calendar state for a graph.
|
|
3781
|
+
*/
|
|
3782
|
+
export type FiscalCalendarResponse = {
|
|
3783
|
+
/**
|
|
3784
|
+
* Graph Id
|
|
3785
|
+
*/
|
|
3786
|
+
graph_id: string;
|
|
3787
|
+
/**
|
|
3788
|
+
* Fiscal Year Start Month
|
|
3789
|
+
*/
|
|
3790
|
+
fiscal_year_start_month: number;
|
|
3791
|
+
/**
|
|
3792
|
+
* Closed Through
|
|
3793
|
+
*
|
|
3794
|
+
* Latest closed period (YYYY-MM), or null if nothing closed
|
|
3795
|
+
*/
|
|
3796
|
+
closed_through?: string | null;
|
|
3797
|
+
/**
|
|
3798
|
+
* Close Target
|
|
3799
|
+
*
|
|
3800
|
+
* Target period the user wants closed through (YYYY-MM)
|
|
3801
|
+
*/
|
|
3802
|
+
close_target?: string | null;
|
|
3803
|
+
/**
|
|
3804
|
+
* Gap Periods
|
|
3805
|
+
*
|
|
3806
|
+
* Number of periods between closed_through and close_target (inclusive of close_target). 0 means caught up.
|
|
3807
|
+
*/
|
|
3808
|
+
gap_periods?: number;
|
|
3809
|
+
/**
|
|
3810
|
+
* Catch Up Sequence
|
|
3811
|
+
*
|
|
3812
|
+
* Ordered list of periods that a close run would process
|
|
3813
|
+
*/
|
|
3814
|
+
catch_up_sequence?: Array<string>;
|
|
3815
|
+
/**
|
|
3816
|
+
* Closeable Now
|
|
3817
|
+
*
|
|
3818
|
+
* Whether the next period in the catch-up sequence passes all closeable gates
|
|
3819
|
+
*/
|
|
3820
|
+
closeable_now?: boolean;
|
|
3821
|
+
/**
|
|
3822
|
+
* Blockers
|
|
3823
|
+
*
|
|
3824
|
+
* Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed'
|
|
3825
|
+
*/
|
|
3826
|
+
blockers?: Array<string>;
|
|
3827
|
+
/**
|
|
3828
|
+
* Last Close At
|
|
3829
|
+
*/
|
|
3830
|
+
last_close_at?: string | null;
|
|
3831
|
+
/**
|
|
3832
|
+
* Initialized At
|
|
3833
|
+
*/
|
|
3834
|
+
initialized_at?: string | null;
|
|
3835
|
+
/**
|
|
3836
|
+
* Last Sync At
|
|
3837
|
+
*
|
|
3838
|
+
* Most recent QB sync timestamp (if connected)
|
|
3839
|
+
*/
|
|
3840
|
+
last_sync_at?: string | null;
|
|
3841
|
+
/**
|
|
3842
|
+
* Periods
|
|
3843
|
+
*
|
|
3844
|
+
* Fiscal period rows for this graph
|
|
3845
|
+
*/
|
|
3846
|
+
periods?: Array<FiscalPeriodSummary>;
|
|
3847
|
+
};
|
|
3848
|
+
|
|
3849
|
+
/**
|
|
3850
|
+
* FiscalPeriodSummary
|
|
3851
|
+
*/
|
|
3852
|
+
export type FiscalPeriodSummary = {
|
|
3853
|
+
/**
|
|
3854
|
+
* Name
|
|
3855
|
+
*
|
|
3856
|
+
* Period name (YYYY-MM)
|
|
3857
|
+
*/
|
|
3858
|
+
name: string;
|
|
3859
|
+
/**
|
|
3860
|
+
* Start Date
|
|
3861
|
+
*/
|
|
3862
|
+
start_date: string;
|
|
3863
|
+
/**
|
|
3864
|
+
* End Date
|
|
3865
|
+
*/
|
|
3866
|
+
end_date: string;
|
|
3867
|
+
/**
|
|
3868
|
+
* Status
|
|
3869
|
+
*
|
|
3870
|
+
* 'open' | 'closing' | 'closed'
|
|
3871
|
+
*/
|
|
3872
|
+
status: string;
|
|
3873
|
+
/**
|
|
3874
|
+
* Closed At
|
|
3875
|
+
*/
|
|
3876
|
+
closed_at?: string | null;
|
|
3877
|
+
};
|
|
3878
|
+
|
|
3574
3879
|
/**
|
|
3575
3880
|
* ForgotPasswordRequest
|
|
3576
3881
|
*
|
|
@@ -4553,6 +4858,12 @@ export type InitialEntityData = {
|
|
|
4553
4858
|
* Entity website or URI
|
|
4554
4859
|
*/
|
|
4555
4860
|
uri: string;
|
|
4861
|
+
/**
|
|
4862
|
+
* Ticker
|
|
4863
|
+
*
|
|
4864
|
+
* Entity symbol/ticker (e.g., 'HARB', 'NVDA'). Auto-generated from name if not provided.
|
|
4865
|
+
*/
|
|
4866
|
+
ticker?: string | null;
|
|
4556
4867
|
/**
|
|
4557
4868
|
* Cik
|
|
4558
4869
|
*
|
|
@@ -4597,6 +4908,61 @@ export type InitialEntityData = {
|
|
|
4597
4908
|
ein?: string | null;
|
|
4598
4909
|
};
|
|
4599
4910
|
|
|
4911
|
+
/**
|
|
4912
|
+
* InitializeLedgerRequest
|
|
4913
|
+
*/
|
|
4914
|
+
export type InitializeLedgerRequest = {
|
|
4915
|
+
/**
|
|
4916
|
+
* Closed Through
|
|
4917
|
+
*
|
|
4918
|
+
* 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.
|
|
4919
|
+
*/
|
|
4920
|
+
closed_through?: string | null;
|
|
4921
|
+
/**
|
|
4922
|
+
* Fiscal Year Start Month
|
|
4923
|
+
*
|
|
4924
|
+
* Fiscal year start month (1-12). Defaults to calendar year.
|
|
4925
|
+
*/
|
|
4926
|
+
fiscal_year_start_month?: number;
|
|
4927
|
+
/**
|
|
4928
|
+
* Auto Seed Schedules
|
|
4929
|
+
*
|
|
4930
|
+
* If true, run the SchedulerAgent to create schedules from historical BS activity. NOT YET IMPLEMENTED — returns a warning in v1.
|
|
4931
|
+
*/
|
|
4932
|
+
auto_seed_schedules?: boolean;
|
|
4933
|
+
/**
|
|
4934
|
+
* Earliest Data Period
|
|
4935
|
+
*
|
|
4936
|
+
* YYYY-MM period representing the earliest month that has transaction data. Used to create FiscalPeriod rows. Defaults to 24 months before the current month.
|
|
4937
|
+
*/
|
|
4938
|
+
earliest_data_period?: string | null;
|
|
4939
|
+
/**
|
|
4940
|
+
* Note
|
|
4941
|
+
*
|
|
4942
|
+
* Free-form note attached to the audit event
|
|
4943
|
+
*/
|
|
4944
|
+
note?: string | null;
|
|
4945
|
+
};
|
|
4946
|
+
|
|
4947
|
+
/**
|
|
4948
|
+
* InitializeLedgerResponse
|
|
4949
|
+
*/
|
|
4950
|
+
export type InitializeLedgerResponse = {
|
|
4951
|
+
fiscal_calendar: FiscalCalendarResponse;
|
|
4952
|
+
/**
|
|
4953
|
+
* Periods Created
|
|
4954
|
+
*
|
|
4955
|
+
* Number of FiscalPeriod rows created by initialization
|
|
4956
|
+
*/
|
|
4957
|
+
periods_created?: number;
|
|
4958
|
+
/**
|
|
4959
|
+
* Warnings
|
|
4960
|
+
*
|
|
4961
|
+
* Non-fatal warnings (e.g., auto_seed_schedules not implemented)
|
|
4962
|
+
*/
|
|
4963
|
+
warnings?: Array<string>;
|
|
4964
|
+
};
|
|
4965
|
+
|
|
4600
4966
|
/**
|
|
4601
4967
|
* InstanceUsage
|
|
4602
4968
|
*
|
|
@@ -5350,6 +5716,34 @@ export type McpToolsResponse = {
|
|
|
5350
5716
|
}>;
|
|
5351
5717
|
};
|
|
5352
5718
|
|
|
5719
|
+
/**
|
|
5720
|
+
* ManualLineItemRequest
|
|
5721
|
+
*/
|
|
5722
|
+
export type ManualLineItemRequest = {
|
|
5723
|
+
/**
|
|
5724
|
+
* Element Id
|
|
5725
|
+
*
|
|
5726
|
+
* Element ID (chart of accounts)
|
|
5727
|
+
*/
|
|
5728
|
+
element_id: string;
|
|
5729
|
+
/**
|
|
5730
|
+
* Debit Amount
|
|
5731
|
+
*
|
|
5732
|
+
* Debit in cents
|
|
5733
|
+
*/
|
|
5734
|
+
debit_amount?: number;
|
|
5735
|
+
/**
|
|
5736
|
+
* Credit Amount
|
|
5737
|
+
*
|
|
5738
|
+
* Credit in cents
|
|
5739
|
+
*/
|
|
5740
|
+
credit_amount?: number;
|
|
5741
|
+
/**
|
|
5742
|
+
* Description
|
|
5743
|
+
*/
|
|
5744
|
+
description?: string | null;
|
|
5745
|
+
};
|
|
5746
|
+
|
|
5353
5747
|
/**
|
|
5354
5748
|
* MappingCoverageResponse
|
|
5355
5749
|
*
|
|
@@ -6263,27 +6657,75 @@ export type PeriodCloseStatusResponse = {
|
|
|
6263
6657
|
/**
|
|
6264
6658
|
* Fiscal Period Start
|
|
6265
6659
|
*/
|
|
6266
|
-
fiscal_period_start: string;
|
|
6660
|
+
fiscal_period_start: string;
|
|
6661
|
+
/**
|
|
6662
|
+
* Fiscal Period End
|
|
6663
|
+
*/
|
|
6664
|
+
fiscal_period_end: string;
|
|
6665
|
+
/**
|
|
6666
|
+
* Period Status
|
|
6667
|
+
*/
|
|
6668
|
+
period_status: string;
|
|
6669
|
+
/**
|
|
6670
|
+
* Schedules
|
|
6671
|
+
*/
|
|
6672
|
+
schedules: Array<PeriodCloseItemResponse>;
|
|
6673
|
+
/**
|
|
6674
|
+
* Total Draft
|
|
6675
|
+
*/
|
|
6676
|
+
total_draft: number;
|
|
6677
|
+
/**
|
|
6678
|
+
* Total Posted
|
|
6679
|
+
*/
|
|
6680
|
+
total_posted: number;
|
|
6681
|
+
};
|
|
6682
|
+
|
|
6683
|
+
/**
|
|
6684
|
+
* PeriodDraftsResponse
|
|
6685
|
+
*
|
|
6686
|
+
* All draft entries for a fiscal period, ready for review before close.
|
|
6687
|
+
*/
|
|
6688
|
+
export type PeriodDraftsResponse = {
|
|
6689
|
+
/**
|
|
6690
|
+
* Period
|
|
6691
|
+
*
|
|
6692
|
+
* YYYY-MM period name
|
|
6693
|
+
*/
|
|
6694
|
+
period: string;
|
|
6695
|
+
/**
|
|
6696
|
+
* Period Start
|
|
6697
|
+
*/
|
|
6698
|
+
period_start: string;
|
|
6699
|
+
/**
|
|
6700
|
+
* Period End
|
|
6701
|
+
*/
|
|
6702
|
+
period_end: string;
|
|
6267
6703
|
/**
|
|
6268
|
-
*
|
|
6704
|
+
* Draft Count
|
|
6269
6705
|
*/
|
|
6270
|
-
|
|
6706
|
+
draft_count: number;
|
|
6271
6707
|
/**
|
|
6272
|
-
*
|
|
6708
|
+
* Total Debit
|
|
6709
|
+
*
|
|
6710
|
+
* Sum across all drafts, in cents
|
|
6273
6711
|
*/
|
|
6274
|
-
|
|
6712
|
+
total_debit: number;
|
|
6275
6713
|
/**
|
|
6276
|
-
*
|
|
6714
|
+
* Total Credit
|
|
6715
|
+
*
|
|
6716
|
+
* Sum across all drafts, in cents
|
|
6277
6717
|
*/
|
|
6278
|
-
|
|
6718
|
+
total_credit: number;
|
|
6279
6719
|
/**
|
|
6280
|
-
*
|
|
6720
|
+
* All Balanced
|
|
6721
|
+
*
|
|
6722
|
+
* True if every draft entry has debit == credit
|
|
6281
6723
|
*/
|
|
6282
|
-
|
|
6724
|
+
all_balanced: boolean;
|
|
6283
6725
|
/**
|
|
6284
|
-
*
|
|
6726
|
+
* Drafts
|
|
6285
6727
|
*/
|
|
6286
|
-
|
|
6728
|
+
drafts: Array<DraftEntryResponse>;
|
|
6287
6729
|
};
|
|
6288
6730
|
|
|
6289
6731
|
/**
|
|
@@ -6715,6 +7157,24 @@ export type RegisterRequest = {
|
|
|
6715
7157
|
captcha_token?: string | null;
|
|
6716
7158
|
};
|
|
6717
7159
|
|
|
7160
|
+
/**
|
|
7161
|
+
* ReopenPeriodRequest
|
|
7162
|
+
*/
|
|
7163
|
+
export type ReopenPeriodRequest = {
|
|
7164
|
+
/**
|
|
7165
|
+
* Reason
|
|
7166
|
+
*
|
|
7167
|
+
* Required reason for the reopen (captured in audit log)
|
|
7168
|
+
*/
|
|
7169
|
+
reason: string;
|
|
7170
|
+
/**
|
|
7171
|
+
* Note
|
|
7172
|
+
*
|
|
7173
|
+
* Additional free-form note
|
|
7174
|
+
*/
|
|
7175
|
+
note?: string | null;
|
|
7176
|
+
};
|
|
7177
|
+
|
|
6718
7178
|
/**
|
|
6719
7179
|
* ReportListResponse
|
|
6720
7180
|
*/
|
|
@@ -7687,6 +8147,24 @@ export type ServiceOfferingsResponse = {
|
|
|
7687
8147
|
summary: ServiceOfferingSummary;
|
|
7688
8148
|
};
|
|
7689
8149
|
|
|
8150
|
+
/**
|
|
8151
|
+
* SetCloseTargetRequest
|
|
8152
|
+
*/
|
|
8153
|
+
export type SetCloseTargetRequest = {
|
|
8154
|
+
/**
|
|
8155
|
+
* Period
|
|
8156
|
+
*
|
|
8157
|
+
* Target period in YYYY-MM format
|
|
8158
|
+
*/
|
|
8159
|
+
period: string;
|
|
8160
|
+
/**
|
|
8161
|
+
* Note
|
|
8162
|
+
*
|
|
8163
|
+
* Free-form note attached to the audit event
|
|
8164
|
+
*/
|
|
8165
|
+
note?: string | null;
|
|
8166
|
+
};
|
|
8167
|
+
|
|
7690
8168
|
/**
|
|
7691
8169
|
* ShareReportRequest
|
|
7692
8170
|
*/
|
|
@@ -8491,6 +8969,46 @@ export type TrialBalanceRow = {
|
|
|
8491
8969
|
net_balance: number;
|
|
8492
8970
|
};
|
|
8493
8971
|
|
|
8972
|
+
/**
|
|
8973
|
+
* TruncateScheduleRequest
|
|
8974
|
+
*/
|
|
8975
|
+
export type TruncateScheduleRequest = {
|
|
8976
|
+
/**
|
|
8977
|
+
* New End Date
|
|
8978
|
+
*
|
|
8979
|
+
* 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.
|
|
8980
|
+
*/
|
|
8981
|
+
new_end_date: string;
|
|
8982
|
+
/**
|
|
8983
|
+
* Reason
|
|
8984
|
+
*
|
|
8985
|
+
* Required reason for the truncation (captured in audit log).
|
|
8986
|
+
*/
|
|
8987
|
+
reason: string;
|
|
8988
|
+
};
|
|
8989
|
+
|
|
8990
|
+
/**
|
|
8991
|
+
* TruncateScheduleResponse
|
|
8992
|
+
*/
|
|
8993
|
+
export type TruncateScheduleResponse = {
|
|
8994
|
+
/**
|
|
8995
|
+
* Structure Id
|
|
8996
|
+
*/
|
|
8997
|
+
structure_id: string;
|
|
8998
|
+
/**
|
|
8999
|
+
* New End Date
|
|
9000
|
+
*/
|
|
9001
|
+
new_end_date: string;
|
|
9002
|
+
/**
|
|
9003
|
+
* Facts Deleted
|
|
9004
|
+
*/
|
|
9005
|
+
facts_deleted: number;
|
|
9006
|
+
/**
|
|
9007
|
+
* Reason
|
|
9008
|
+
*/
|
|
9009
|
+
reason: string;
|
|
9010
|
+
};
|
|
9011
|
+
|
|
8494
9012
|
/**
|
|
8495
9013
|
* UnmappedElementResponse
|
|
8496
9014
|
*
|
|
@@ -14368,7 +14886,7 @@ export type GetStatementData = {
|
|
|
14368
14886
|
/**
|
|
14369
14887
|
* Structure Type
|
|
14370
14888
|
*
|
|
14371
|
-
* Structure type: income_statement, balance_sheet,
|
|
14889
|
+
* Structure type: income_statement, balance_sheet, equity_statement
|
|
14372
14890
|
*/
|
|
14373
14891
|
structure_type: string;
|
|
14374
14892
|
};
|
|
@@ -14654,6 +15172,72 @@ export type CreateClosingEntryResponses = {
|
|
|
14654
15172
|
|
|
14655
15173
|
export type CreateClosingEntryResponse = CreateClosingEntryResponses[keyof CreateClosingEntryResponses];
|
|
14656
15174
|
|
|
15175
|
+
export type TruncateScheduleData = {
|
|
15176
|
+
body: TruncateScheduleRequest;
|
|
15177
|
+
path: {
|
|
15178
|
+
/**
|
|
15179
|
+
* Graph Id
|
|
15180
|
+
*/
|
|
15181
|
+
graph_id: string;
|
|
15182
|
+
/**
|
|
15183
|
+
* Structure Id
|
|
15184
|
+
*
|
|
15185
|
+
* Schedule structure ID
|
|
15186
|
+
*/
|
|
15187
|
+
structure_id: string;
|
|
15188
|
+
};
|
|
15189
|
+
query?: never;
|
|
15190
|
+
url: '/v1/ledger/{graph_id}/schedules/{structure_id}/truncate';
|
|
15191
|
+
};
|
|
15192
|
+
|
|
15193
|
+
export type TruncateScheduleErrors = {
|
|
15194
|
+
/**
|
|
15195
|
+
* Validation Error
|
|
15196
|
+
*/
|
|
15197
|
+
422: HttpValidationError;
|
|
15198
|
+
};
|
|
15199
|
+
|
|
15200
|
+
export type TruncateScheduleError = TruncateScheduleErrors[keyof TruncateScheduleErrors];
|
|
15201
|
+
|
|
15202
|
+
export type TruncateScheduleResponses = {
|
|
15203
|
+
/**
|
|
15204
|
+
* Successful Response
|
|
15205
|
+
*/
|
|
15206
|
+
200: TruncateScheduleResponse;
|
|
15207
|
+
};
|
|
15208
|
+
|
|
15209
|
+
export type TruncateScheduleResponse2 = TruncateScheduleResponses[keyof TruncateScheduleResponses];
|
|
15210
|
+
|
|
15211
|
+
export type CreateManualClosingEntryData = {
|
|
15212
|
+
body: CreateManualClosingEntryRequest;
|
|
15213
|
+
path: {
|
|
15214
|
+
/**
|
|
15215
|
+
* Graph Id
|
|
15216
|
+
*/
|
|
15217
|
+
graph_id: string;
|
|
15218
|
+
};
|
|
15219
|
+
query?: never;
|
|
15220
|
+
url: '/v1/ledger/{graph_id}/manual-closing-entry';
|
|
15221
|
+
};
|
|
15222
|
+
|
|
15223
|
+
export type CreateManualClosingEntryErrors = {
|
|
15224
|
+
/**
|
|
15225
|
+
* Validation Error
|
|
15226
|
+
*/
|
|
15227
|
+
422: HttpValidationError;
|
|
15228
|
+
};
|
|
15229
|
+
|
|
15230
|
+
export type CreateManualClosingEntryError = CreateManualClosingEntryErrors[keyof CreateManualClosingEntryErrors];
|
|
15231
|
+
|
|
15232
|
+
export type CreateManualClosingEntryResponses = {
|
|
15233
|
+
/**
|
|
15234
|
+
* Successful Response
|
|
15235
|
+
*/
|
|
15236
|
+
201: ClosingEntryResponse;
|
|
15237
|
+
};
|
|
15238
|
+
|
|
15239
|
+
export type CreateManualClosingEntryResponse = CreateManualClosingEntryResponses[keyof CreateManualClosingEntryResponses];
|
|
15240
|
+
|
|
14657
15241
|
export type ListPublishListsData = {
|
|
14658
15242
|
body?: never;
|
|
14659
15243
|
path: {
|
|
@@ -14978,6 +15562,204 @@ export type GetClosingBookStructuresResponses = {
|
|
|
14978
15562
|
|
|
14979
15563
|
export type GetClosingBookStructuresResponse = GetClosingBookStructuresResponses[keyof GetClosingBookStructuresResponses];
|
|
14980
15564
|
|
|
15565
|
+
export type InitializeLedgerData = {
|
|
15566
|
+
body: InitializeLedgerRequest;
|
|
15567
|
+
path: {
|
|
15568
|
+
/**
|
|
15569
|
+
* Graph Id
|
|
15570
|
+
*/
|
|
15571
|
+
graph_id: string;
|
|
15572
|
+
};
|
|
15573
|
+
query?: never;
|
|
15574
|
+
url: '/v1/ledger/{graph_id}/initialize';
|
|
15575
|
+
};
|
|
15576
|
+
|
|
15577
|
+
export type InitializeLedgerErrors = {
|
|
15578
|
+
/**
|
|
15579
|
+
* Validation Error
|
|
15580
|
+
*/
|
|
15581
|
+
422: HttpValidationError;
|
|
15582
|
+
};
|
|
15583
|
+
|
|
15584
|
+
export type InitializeLedgerError = InitializeLedgerErrors[keyof InitializeLedgerErrors];
|
|
15585
|
+
|
|
15586
|
+
export type InitializeLedgerResponses = {
|
|
15587
|
+
/**
|
|
15588
|
+
* Successful Response
|
|
15589
|
+
*/
|
|
15590
|
+
201: InitializeLedgerResponse;
|
|
15591
|
+
};
|
|
15592
|
+
|
|
15593
|
+
export type InitializeLedgerResponse2 = InitializeLedgerResponses[keyof InitializeLedgerResponses];
|
|
15594
|
+
|
|
15595
|
+
export type GetFiscalCalendarData = {
|
|
15596
|
+
body?: never;
|
|
15597
|
+
path: {
|
|
15598
|
+
/**
|
|
15599
|
+
* Graph Id
|
|
15600
|
+
*/
|
|
15601
|
+
graph_id: string;
|
|
15602
|
+
};
|
|
15603
|
+
query?: never;
|
|
15604
|
+
url: '/v1/ledger/{graph_id}/fiscal-calendar';
|
|
15605
|
+
};
|
|
15606
|
+
|
|
15607
|
+
export type GetFiscalCalendarErrors = {
|
|
15608
|
+
/**
|
|
15609
|
+
* Validation Error
|
|
15610
|
+
*/
|
|
15611
|
+
422: HttpValidationError;
|
|
15612
|
+
};
|
|
15613
|
+
|
|
15614
|
+
export type GetFiscalCalendarError = GetFiscalCalendarErrors[keyof GetFiscalCalendarErrors];
|
|
15615
|
+
|
|
15616
|
+
export type GetFiscalCalendarResponses = {
|
|
15617
|
+
/**
|
|
15618
|
+
* Successful Response
|
|
15619
|
+
*/
|
|
15620
|
+
200: FiscalCalendarResponse;
|
|
15621
|
+
};
|
|
15622
|
+
|
|
15623
|
+
export type GetFiscalCalendarResponse = GetFiscalCalendarResponses[keyof GetFiscalCalendarResponses];
|
|
15624
|
+
|
|
15625
|
+
export type SetCloseTargetData = {
|
|
15626
|
+
body: SetCloseTargetRequest;
|
|
15627
|
+
path: {
|
|
15628
|
+
/**
|
|
15629
|
+
* Graph Id
|
|
15630
|
+
*/
|
|
15631
|
+
graph_id: string;
|
|
15632
|
+
};
|
|
15633
|
+
query?: never;
|
|
15634
|
+
url: '/v1/ledger/{graph_id}/fiscal-calendar/close-target';
|
|
15635
|
+
};
|
|
15636
|
+
|
|
15637
|
+
export type SetCloseTargetErrors = {
|
|
15638
|
+
/**
|
|
15639
|
+
* Validation Error
|
|
15640
|
+
*/
|
|
15641
|
+
422: HttpValidationError;
|
|
15642
|
+
};
|
|
15643
|
+
|
|
15644
|
+
export type SetCloseTargetError = SetCloseTargetErrors[keyof SetCloseTargetErrors];
|
|
15645
|
+
|
|
15646
|
+
export type SetCloseTargetResponses = {
|
|
15647
|
+
/**
|
|
15648
|
+
* Successful Response
|
|
15649
|
+
*/
|
|
15650
|
+
200: FiscalCalendarResponse;
|
|
15651
|
+
};
|
|
15652
|
+
|
|
15653
|
+
export type SetCloseTargetResponse = SetCloseTargetResponses[keyof SetCloseTargetResponses];
|
|
15654
|
+
|
|
15655
|
+
export type CloseFiscalPeriodData = {
|
|
15656
|
+
body?: ClosePeriodRequest;
|
|
15657
|
+
path: {
|
|
15658
|
+
/**
|
|
15659
|
+
* Graph Id
|
|
15660
|
+
*/
|
|
15661
|
+
graph_id: string;
|
|
15662
|
+
/**
|
|
15663
|
+
* Period
|
|
15664
|
+
*
|
|
15665
|
+
* Target period in YYYY-MM format
|
|
15666
|
+
*/
|
|
15667
|
+
period: string;
|
|
15668
|
+
};
|
|
15669
|
+
query?: never;
|
|
15670
|
+
url: '/v1/ledger/{graph_id}/periods/{period}/close';
|
|
15671
|
+
};
|
|
15672
|
+
|
|
15673
|
+
export type CloseFiscalPeriodErrors = {
|
|
15674
|
+
/**
|
|
15675
|
+
* Validation Error
|
|
15676
|
+
*/
|
|
15677
|
+
422: HttpValidationError;
|
|
15678
|
+
};
|
|
15679
|
+
|
|
15680
|
+
export type CloseFiscalPeriodError = CloseFiscalPeriodErrors[keyof CloseFiscalPeriodErrors];
|
|
15681
|
+
|
|
15682
|
+
export type CloseFiscalPeriodResponses = {
|
|
15683
|
+
/**
|
|
15684
|
+
* Successful Response
|
|
15685
|
+
*/
|
|
15686
|
+
200: ClosePeriodResponse;
|
|
15687
|
+
};
|
|
15688
|
+
|
|
15689
|
+
export type CloseFiscalPeriodResponse = CloseFiscalPeriodResponses[keyof CloseFiscalPeriodResponses];
|
|
15690
|
+
|
|
15691
|
+
export type ReopenFiscalPeriodData = {
|
|
15692
|
+
body: ReopenPeriodRequest;
|
|
15693
|
+
path: {
|
|
15694
|
+
/**
|
|
15695
|
+
* Graph Id
|
|
15696
|
+
*/
|
|
15697
|
+
graph_id: string;
|
|
15698
|
+
/**
|
|
15699
|
+
* Period
|
|
15700
|
+
*
|
|
15701
|
+
* Period to reopen (YYYY-MM)
|
|
15702
|
+
*/
|
|
15703
|
+
period: string;
|
|
15704
|
+
};
|
|
15705
|
+
query?: never;
|
|
15706
|
+
url: '/v1/ledger/{graph_id}/periods/{period}/reopen';
|
|
15707
|
+
};
|
|
15708
|
+
|
|
15709
|
+
export type ReopenFiscalPeriodErrors = {
|
|
15710
|
+
/**
|
|
15711
|
+
* Validation Error
|
|
15712
|
+
*/
|
|
15713
|
+
422: HttpValidationError;
|
|
15714
|
+
};
|
|
15715
|
+
|
|
15716
|
+
export type ReopenFiscalPeriodError = ReopenFiscalPeriodErrors[keyof ReopenFiscalPeriodErrors];
|
|
15717
|
+
|
|
15718
|
+
export type ReopenFiscalPeriodResponses = {
|
|
15719
|
+
/**
|
|
15720
|
+
* Successful Response
|
|
15721
|
+
*/
|
|
15722
|
+
200: FiscalCalendarResponse;
|
|
15723
|
+
};
|
|
15724
|
+
|
|
15725
|
+
export type ReopenFiscalPeriodResponse = ReopenFiscalPeriodResponses[keyof ReopenFiscalPeriodResponses];
|
|
15726
|
+
|
|
15727
|
+
export type ListPeriodDraftsData = {
|
|
15728
|
+
body?: never;
|
|
15729
|
+
path: {
|
|
15730
|
+
/**
|
|
15731
|
+
* Graph Id
|
|
15732
|
+
*/
|
|
15733
|
+
graph_id: string;
|
|
15734
|
+
/**
|
|
15735
|
+
* Period
|
|
15736
|
+
*
|
|
15737
|
+
* Period in YYYY-MM format
|
|
15738
|
+
*/
|
|
15739
|
+
period: string;
|
|
15740
|
+
};
|
|
15741
|
+
query?: never;
|
|
15742
|
+
url: '/v1/ledger/{graph_id}/periods/{period}/drafts';
|
|
15743
|
+
};
|
|
15744
|
+
|
|
15745
|
+
export type ListPeriodDraftsErrors = {
|
|
15746
|
+
/**
|
|
15747
|
+
* Validation Error
|
|
15748
|
+
*/
|
|
15749
|
+
422: HttpValidationError;
|
|
15750
|
+
};
|
|
15751
|
+
|
|
15752
|
+
export type ListPeriodDraftsError = ListPeriodDraftsErrors[keyof ListPeriodDraftsErrors];
|
|
15753
|
+
|
|
15754
|
+
export type ListPeriodDraftsResponses = {
|
|
15755
|
+
/**
|
|
15756
|
+
* Successful Response
|
|
15757
|
+
*/
|
|
15758
|
+
200: PeriodDraftsResponse;
|
|
15759
|
+
};
|
|
15760
|
+
|
|
15761
|
+
export type ListPeriodDraftsResponse = ListPeriodDraftsResponses[keyof ListPeriodDraftsResponses];
|
|
15762
|
+
|
|
14981
15763
|
export type ListPortfoliosData = {
|
|
14982
15764
|
body?: never;
|
|
14983
15765
|
path: {
|