@firela/api-types 0.0.0-canary.ba0a88d9 → 0.0.0-canary.cf050c09

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.
@@ -249,19 +249,23 @@ export type AccountStandardResponseDto = {
249
249
  /**
250
250
  * i18n key for localized display name
251
251
  */
252
- i18nKey?: string;
252
+ i18nKey: string;
253
253
  /**
254
- * Account description
254
+ * Short localized display name
255
255
  */
256
- description?: string;
256
+ name?: string;
257
+ /**
258
+ * Account description (stable semantics only)
259
+ */
260
+ description: string;
257
261
  /**
258
262
  * Account tags for categorization
259
263
  */
260
- tags?: Array<string>;
264
+ tags: Array<string>;
261
265
  /**
262
266
  * Icon identifier for UI display
263
267
  */
264
- icon?: string;
268
+ icon: string;
265
269
  };
266
270
 
267
271
  export type AccountStandardListResponseDto = {
@@ -389,7 +393,7 @@ export type PostingResponseDto = {
389
393
  */
390
394
  account: string;
391
395
  /**
392
- * Amount (may be null if interpolated)
396
+ * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
393
397
  */
394
398
  units?: string;
395
399
  /**
@@ -540,6 +544,10 @@ export type BatchTransactionErrorDto = {
540
544
  * Error message describing the failure
541
545
  */
542
546
  error: string;
547
+ /**
548
+ * Structured error code for programmatic handling
549
+ */
550
+ errorCode?: string;
543
551
  };
544
552
 
545
553
  export type BatchTransactionResponseDto = {
@@ -553,6 +561,55 @@ export type BatchTransactionResponseDto = {
553
561
  failed: Array<BatchTransactionErrorDto>;
554
562
  };
555
563
 
564
+ export type CorrectTransactionDto = {
565
+ /**
566
+ * Transaction date (ISO 8601 format)
567
+ */
568
+ date: string;
569
+ /**
570
+ * Transaction flag: * (cleared), ! (pending)
571
+ */
572
+ flag?: '*' | '!';
573
+ /**
574
+ * Payee name
575
+ */
576
+ payee?: string;
577
+ /**
578
+ * Transaction narration/description
579
+ */
580
+ narration: string;
581
+ /**
582
+ * Transaction tags (without # prefix)
583
+ */
584
+ tags?: Array<string>;
585
+ /**
586
+ * Transaction links (without ^ prefix)
587
+ */
588
+ links?: Array<string>;
589
+ /**
590
+ * Transaction postings (minimum 1, typically 2 for double-entry)
591
+ */
592
+ postings: Array<CreatePostingDto>;
593
+ /**
594
+ * Transaction-level metadata
595
+ */
596
+ meta?: {
597
+ [key: string]: unknown;
598
+ };
599
+ /**
600
+ * Unique key for idempotent transaction creation. If provided, duplicate requests with the same key will return the existing transaction.
601
+ */
602
+ idempotencyKey?: string;
603
+ /**
604
+ * Auto-create accounts if not found. When true, missing accounts will be automatically created. When false (default for API), missing accounts will cause a validation error. Set to true for quick entry scenarios where you want to create accounts on-the-fly.
605
+ */
606
+ autoCreateAccounts?: boolean;
607
+ /**
608
+ * Reason for correcting/superseding the original transaction
609
+ */
610
+ correctionReason?: string;
611
+ };
612
+
556
613
  export type PostingDetailDto = {
557
614
  /**
558
615
  * Posting ID
@@ -567,7 +624,7 @@ export type PostingDetailDto = {
567
624
  */
568
625
  accountName: string;
569
626
  /**
570
- * Amount (may be null if interpolated)
627
+ * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
571
628
  */
572
629
  units?: string;
573
630
  /**
@@ -656,9 +713,9 @@ export type TransactionDetailDto = {
656
713
  */
657
714
  status: 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
658
715
  /**
659
- * Source type (how the transaction was created)
716
+ * Source type (free-form string from transaction metadata, e.g. import, api)
660
717
  */
661
- sourceType?: 'NLP' | 'CSV' | 'OCR' | 'API';
718
+ sourceType?: string;
662
719
  /**
663
720
  * Source platform (e.g., alipay, wechat)
664
721
  */
@@ -683,6 +740,14 @@ export type TransactionDetailDto = {
683
740
  * Correction reason (if voided or superseded)
684
741
  */
685
742
  correctionReason?: string;
743
+ /**
744
+ * ID of the transaction that supersedes this one (set when status=SUPERSEDED)
745
+ */
746
+ supersededBy?: string;
747
+ /**
748
+ * ID of the transaction this one corrected/replaced (back-link on the replacement)
749
+ */
750
+ originalTxn?: string;
686
751
  };
687
752
 
688
753
  /**
@@ -701,11 +766,6 @@ export type flag2 =
701
766
  */
702
767
  export type status2 = 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
703
768
 
704
- /**
705
- * Source type (how the transaction was created)
706
- */
707
- export type sourceType = 'NLP' | 'CSV' | 'OCR' | 'API';
708
-
709
769
  export type TransactionListResponseDto = {
710
770
  /**
711
771
  * List of transactions
@@ -725,6 +785,24 @@ export type TransactionListResponseDto = {
725
785
  offset: number;
726
786
  };
727
787
 
788
+ export type TagSuggestionDto = {
789
+ /**
790
+ * Tag name
791
+ */
792
+ tag: string;
793
+ /**
794
+ * Usage count across ACTIVE transactions
795
+ */
796
+ count: number;
797
+ };
798
+
799
+ export type TagSuggestionsResponseDto = {
800
+ /**
801
+ * Tag suggestions sorted as requested
802
+ */
803
+ data: Array<TagSuggestionDto>;
804
+ };
805
+
728
806
  export type UpdateTransactionDto = {
729
807
  /**
730
808
  * Transaction flag (CLEARED, PENDING, etc.)
@@ -826,9 +904,9 @@ export type TransactionSummaryDto = {
826
904
  */
827
905
  accountName?: string;
828
906
  /**
829
- * Source type (NLP, CSV, OCR, API)
907
+ * Source type (free-form string from transaction metadata, e.g. import, api)
830
908
  */
831
- sourceType?: 'NLP' | 'CSV' | 'OCR' | 'API';
909
+ sourceType?: string;
832
910
  /**
833
911
  * Source platform (e.g., alipay, wechat)
834
912
  */
@@ -858,9 +936,9 @@ export type ReviewSummaryDto = {
858
936
  */
859
937
  confidence: number;
860
938
  /**
861
- * Confidence level derived from score
939
+ * Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.
862
940
  */
863
- confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW';
941
+ confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW' | null;
864
942
  /**
865
943
  * i18n message key for summary (e.g., review.summary.duplicate). Translate on frontend with summaryParams.
866
944
  */
@@ -876,7 +954,7 @@ export type ReviewSummaryDto = {
876
954
  */
877
955
  matchReasons: Array<string>;
878
956
  /**
879
- * Source type (NLP, CSV, OCR, API)
957
+ * Source type (free-form string from transaction metadata, e.g. import, api)
880
958
  */
881
959
  sourceType: string;
882
960
  /**
@@ -929,7 +1007,7 @@ export type type2 =
929
1007
  export type status3 = 'PENDING' | 'RESOLVED' | 'EXPIRED' | 'CANCELLED';
930
1008
 
931
1009
  /**
932
- * Confidence level derived from score
1010
+ * Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.
933
1011
  */
934
1012
  export type confidenceLevel = 'HIGH' | 'MEDIUM' | 'LOW';
935
1013
 
@@ -974,7 +1052,18 @@ export type DecisionOptionDto = {
974
1052
  /**
975
1053
  * The action value to submit (e.g., UPGRADE_REPLACE, ACCEPT)
976
1054
  */
977
- value: string;
1055
+ value:
1056
+ | 'UPGRADE_REPLACE'
1057
+ | 'LINK_KEEP_BOTH'
1058
+ | 'IGNORE_NEW'
1059
+ | 'CONFIRM_DIFFERENT'
1060
+ | 'ACCEPT'
1061
+ | 'REJECT'
1062
+ | 'ACCEPT_AND_LEARN'
1063
+ | 'CHOOSE_OTHER'
1064
+ | 'CANCEL'
1065
+ | 'FIX'
1066
+ | 'IGNORE';
978
1067
  /**
979
1068
  * i18n message key for display label (e.g., review.payee.accept.label)
980
1069
  */
@@ -989,6 +1078,22 @@ export type DecisionOptionDto = {
989
1078
  recommended?: boolean;
990
1079
  };
991
1080
 
1081
+ /**
1082
+ * The action value to submit (e.g., UPGRADE_REPLACE, ACCEPT)
1083
+ */
1084
+ export type value =
1085
+ | 'UPGRADE_REPLACE'
1086
+ | 'LINK_KEEP_BOTH'
1087
+ | 'IGNORE_NEW'
1088
+ | 'CONFIRM_DIFFERENT'
1089
+ | 'ACCEPT'
1090
+ | 'REJECT'
1091
+ | 'ACCEPT_AND_LEARN'
1092
+ | 'CHOOSE_OTHER'
1093
+ | 'CANCEL'
1094
+ | 'FIX'
1095
+ | 'IGNORE';
1096
+
992
1097
  export type ReviewDetailDto = {
993
1098
  /**
994
1099
  * Review item ID
@@ -1012,9 +1117,9 @@ export type ReviewDetailDto = {
1012
1117
  */
1013
1118
  confidence: number;
1014
1119
  /**
1015
- * Confidence level derived from score
1120
+ * Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.
1016
1121
  */
1017
- confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW';
1122
+ confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW' | null;
1018
1123
  /**
1019
1124
  * i18n message key for summary (e.g., review.summary.duplicate). Translate on frontend with summaryParams.
1020
1125
  */
@@ -1030,7 +1135,7 @@ export type ReviewDetailDto = {
1030
1135
  */
1031
1136
  matchReasons: Array<string>;
1032
1137
  /**
1033
- * Source type (NLP, CSV, OCR, API)
1138
+ * Source type (free-form string from transaction metadata, e.g. import, api)
1034
1139
  */
1035
1140
  sourceType: string;
1036
1141
  /**
@@ -1083,9 +1188,20 @@ export type ReviewDetailDto = {
1083
1188
 
1084
1189
  export type ResolveReviewDto = {
1085
1190
  /**
1086
- * Decision action. Available actions vary by review type: DUPLICATE: UPGRADE_REPLACE, KEEP_EXISTING, KEEP_BOTH | PAYEE_MATCH: ACCEPT, REJECT, ACCEPT_AND_LEARN | ACCOUNT_VALIDATION: FIX, REJECT | RULE_MATCH: ACCEPT, REJECT, ACCEPT_AND_LEARN
1191
+ * Decision action. Valid actions vary by review type — see DecisionOptionDto.value returned by the review detail endpoint.
1087
1192
  */
1088
- action: string;
1193
+ action:
1194
+ | 'UPGRADE_REPLACE'
1195
+ | 'LINK_KEEP_BOTH'
1196
+ | 'IGNORE_NEW'
1197
+ | 'CONFIRM_DIFFERENT'
1198
+ | 'ACCEPT'
1199
+ | 'REJECT'
1200
+ | 'ACCEPT_AND_LEARN'
1201
+ | 'CHOOSE_OTHER'
1202
+ | 'CANCEL'
1203
+ | 'FIX'
1204
+ | 'IGNORE';
1089
1205
  /**
1090
1206
  * Additional data for the decision (e.g., selected account ID)
1091
1207
  */
@@ -1094,6 +1210,22 @@ export type ResolveReviewDto = {
1094
1210
  };
1095
1211
  };
1096
1212
 
1213
+ /**
1214
+ * Decision action. Valid actions vary by review type — see DecisionOptionDto.value returned by the review detail endpoint.
1215
+ */
1216
+ export type action =
1217
+ | 'UPGRADE_REPLACE'
1218
+ | 'LINK_KEEP_BOTH'
1219
+ | 'IGNORE_NEW'
1220
+ | 'CONFIRM_DIFFERENT'
1221
+ | 'ACCEPT'
1222
+ | 'REJECT'
1223
+ | 'ACCEPT_AND_LEARN'
1224
+ | 'CHOOSE_OTHER'
1225
+ | 'CANCEL'
1226
+ | 'FIX'
1227
+ | 'IGNORE';
1228
+
1097
1229
  export type ResolveResultDto = {
1098
1230
  /**
1099
1231
  * Whether resolution was successful
@@ -1150,7 +1282,18 @@ export type BatchResolveDto = {
1150
1282
  /**
1151
1283
  * Decision action to apply to all items
1152
1284
  */
1153
- action: string;
1285
+ action:
1286
+ | 'UPGRADE_REPLACE'
1287
+ | 'LINK_KEEP_BOTH'
1288
+ | 'IGNORE_NEW'
1289
+ | 'CONFIRM_DIFFERENT'
1290
+ | 'ACCEPT'
1291
+ | 'REJECT'
1292
+ | 'ACCEPT_AND_LEARN'
1293
+ | 'CHOOSE_OTHER'
1294
+ | 'CANCEL'
1295
+ | 'FIX'
1296
+ | 'IGNORE';
1154
1297
  /**
1155
1298
  * Additional data for the decision
1156
1299
  */
@@ -3277,6 +3420,12 @@ export type ProcessNlpDto = {
3277
3420
  * Session ID for multi-turn conversation (auto-generated if not provided)
3278
3421
  */
3279
3422
  sessionId?: string;
3423
+ /**
3424
+ * Parsed data from previous NLP response for session recovery. Send back the parsedData received in confirm_payee/confirm responses.
3425
+ */
3426
+ parsedData?: {
3427
+ [key: string]: unknown;
3428
+ };
3280
3429
  };
3281
3430
 
3282
3431
  export type NlpTransactionInfoDto = {
@@ -3807,7 +3956,7 @@ export type status4 = 'success' | 'pending' | 'error';
3807
3956
  /**
3808
3957
  * Action taken or requested
3809
3958
  */
3810
- export type action =
3959
+ export type action2 =
3811
3960
  | 'created'
3812
3961
  | 'ask'
3813
3962
  | 'confirm'
@@ -4339,7 +4488,7 @@ export type AccountControllerCreateData = {
4339
4488
  /**
4340
4489
  * Region code for tenant context
4341
4490
  */
4342
- region: 'cn' | 'us' | 'de';
4491
+ region: 'cn' | 'us' | 'de' | 'gb';
4343
4492
  requestBody: CreateAccountDto;
4344
4493
  };
4345
4494
 
@@ -4361,7 +4510,7 @@ export type AccountControllerFindAllData = {
4361
4510
  /**
4362
4511
  * Region code for tenant context
4363
4512
  */
4364
- region: 'cn' | 'us' | 'de';
4513
+ region: 'cn' | 'us' | 'de' | 'gb';
4365
4514
  /**
4366
4515
  * Search term for path or i18nKey
4367
4516
  */
@@ -4386,7 +4535,7 @@ export type AccountControllerFindOneData = {
4386
4535
  /**
4387
4536
  * Region code for tenant context
4388
4537
  */
4389
- region: 'cn' | 'us' | 'de';
4538
+ region: 'cn' | 'us' | 'de' | 'gb';
4390
4539
  };
4391
4540
 
4392
4541
  export type AccountControllerFindOneResponse = AccountResponseDto;
@@ -4399,7 +4548,7 @@ export type AccountControllerUpdateData = {
4399
4548
  /**
4400
4549
  * Region code for tenant context
4401
4550
  */
4402
- region: 'cn' | 'us' | 'de';
4551
+ region: 'cn' | 'us' | 'de' | 'gb';
4403
4552
  requestBody: UpdateAccountDto;
4404
4553
  };
4405
4554
 
@@ -4413,7 +4562,7 @@ export type AccountControllerDeleteData = {
4413
4562
  /**
4414
4563
  * Region code for tenant context
4415
4564
  */
4416
- region: 'cn' | 'us' | 'de';
4565
+ region: 'cn' | 'us' | 'de' | 'gb';
4417
4566
  };
4418
4567
 
4419
4568
  export type AccountControllerDeleteResponse = void;
@@ -4426,7 +4575,7 @@ export type AccountControllerCloseData = {
4426
4575
  /**
4427
4576
  * Region code for tenant context
4428
4577
  */
4429
- region: 'cn' | 'us' | 'de';
4578
+ region: 'cn' | 'us' | 'de' | 'gb';
4430
4579
  requestBody: CloseAccountDto;
4431
4580
  };
4432
4581
 
@@ -4440,7 +4589,7 @@ export type AccountControllerReopenData = {
4440
4589
  /**
4441
4590
  * Region code for tenant context
4442
4591
  */
4443
- region: 'cn' | 'us' | 'de';
4592
+ region: 'cn' | 'us' | 'de' | 'gb';
4444
4593
  requestBody: ReopenAccountDto;
4445
4594
  };
4446
4595
 
@@ -4450,7 +4599,7 @@ export type AccountStandardsControllerGetTemplatesData = {
4450
4599
  /**
4451
4600
  * Region code (cn, us, de)
4452
4601
  */
4453
- region: 'cn' | 'us' | 'de';
4602
+ region: 'cn' | 'us' | 'de' | 'gb';
4454
4603
  /**
4455
4604
  * Search term for path or description
4456
4605
  */
@@ -4472,7 +4621,7 @@ export type AccountStandardsControllerGetTemplateMetadataData = {
4472
4621
  /**
4473
4622
  * Region code for tenant context
4474
4623
  */
4475
- region: 'cn' | 'us' | 'de';
4624
+ region: 'cn' | 'us' | 'de' | 'gb';
4476
4625
  };
4477
4626
 
4478
4627
  export type AccountStandardsControllerGetTemplateMetadataResponse =
@@ -4482,7 +4631,7 @@ export type AccountStandardsControllerGetRegionsData = {
4482
4631
  /**
4483
4632
  * Region code for tenant context
4484
4633
  */
4485
- region: 'cn' | 'us' | 'de';
4634
+ region: 'cn' | 'us' | 'de' | 'gb';
4486
4635
  };
4487
4636
 
4488
4637
  export type AccountStandardsControllerGetRegionsResponse =
@@ -4492,7 +4641,7 @@ export type TransactionControllerCreateData = {
4492
4641
  /**
4493
4642
  * Region code for tenant context
4494
4643
  */
4495
- region: 'cn' | 'us' | 'de';
4644
+ region: 'cn' | 'us' | 'de' | 'gb';
4496
4645
  /**
4497
4646
  * Transaction data with postings
4498
4647
  */
@@ -4525,7 +4674,7 @@ export type TransactionControllerListData = {
4525
4674
  /**
4526
4675
  * Region code for tenant context
4527
4676
  */
4528
- region: 'cn' | 'us' | 'de';
4677
+ region: 'cn' | 'us' | 'de' | 'gb';
4529
4678
  /**
4530
4679
  * Search in narration and payee fields (max 200 chars)
4531
4680
  */
@@ -4542,13 +4691,49 @@ export type TransactionControllerCreateBatchData = {
4542
4691
  /**
4543
4692
  * Region code for tenant context
4544
4693
  */
4545
- region: 'cn' | 'us' | 'de';
4694
+ region: 'cn' | 'us' | 'de' | 'gb';
4546
4695
  requestBody: BatchCreateTransactionDto;
4547
4696
  };
4548
4697
 
4549
4698
  export type TransactionControllerCreateBatchResponse =
4550
4699
  BatchTransactionResponseDto;
4551
4700
 
4701
+ export type TransactionControllerCorrectData = {
4702
+ /**
4703
+ * Original transaction ID to correct
4704
+ */
4705
+ id: string;
4706
+ /**
4707
+ * Region code for tenant context
4708
+ */
4709
+ region: 'cn' | 'us' | 'de' | 'gb';
4710
+ requestBody: CorrectTransactionDto;
4711
+ };
4712
+
4713
+ export type TransactionControllerCorrectResponse = TransactionDetailDto;
4714
+
4715
+ export type TransactionControllerSuggestTagsData = {
4716
+ /**
4717
+ * Max suggestions (1-100, default 10)
4718
+ */
4719
+ limit?: number;
4720
+ /**
4721
+ * Prefix match, case-insensitive (max 50 chars)
4722
+ */
4723
+ q?: string;
4724
+ /**
4725
+ * Region code for tenant context
4726
+ */
4727
+ region: 'cn' | 'us' | 'de' | 'gb';
4728
+ /**
4729
+ * usage (default) or name
4730
+ */
4731
+ sort?: 'usage' | 'name';
4732
+ };
4733
+
4734
+ export type TransactionControllerSuggestTagsResponse =
4735
+ TagSuggestionsResponseDto;
4736
+
4552
4737
  export type TransactionControllerGetDetailData = {
4553
4738
  /**
4554
4739
  * Transaction ID
@@ -4557,7 +4742,7 @@ export type TransactionControllerGetDetailData = {
4557
4742
  /**
4558
4743
  * Region code for tenant context
4559
4744
  */
4560
- region: 'cn' | 'us' | 'de';
4745
+ region: 'cn' | 'us' | 'de' | 'gb';
4561
4746
  };
4562
4747
 
4563
4748
  export type TransactionControllerGetDetailResponse = TransactionDetailDto;
@@ -4570,7 +4755,7 @@ export type TransactionControllerUpdateData = {
4570
4755
  /**
4571
4756
  * Region code for tenant context
4572
4757
  */
4573
- region: 'cn' | 'us' | 'de';
4758
+ region: 'cn' | 'us' | 'de' | 'gb';
4574
4759
  /**
4575
4760
  * Fields to update (all optional)
4576
4761
  */
@@ -4587,7 +4772,7 @@ export type TransactionControllerDeleteData = {
4587
4772
  /**
4588
4773
  * Region code for tenant context
4589
4774
  */
4590
- region: 'cn' | 'us' | 'de';
4775
+ region: 'cn' | 'us' | 'de' | 'gb';
4591
4776
  };
4592
4777
 
4593
4778
  export type TransactionControllerDeleteResponse = void;
@@ -4608,7 +4793,7 @@ export type BalanceControllerGetBalanceData = {
4608
4793
  /**
4609
4794
  * Region code for tenant context
4610
4795
  */
4611
- region: 'cn' | 'us' | 'de';
4796
+ region: 'cn' | 'us' | 'de' | 'gb';
4612
4797
  };
4613
4798
 
4614
4799
  export type BalanceControllerGetBalanceResponse = BalanceResponseDto;
@@ -4617,7 +4802,7 @@ export type BalanceControllerGetMultiCurrencyBalanceData = {
4617
4802
  /**
4618
4803
  * Region code for tenant context
4619
4804
  */
4620
- region: 'cn' | 'us' | 'de';
4805
+ region: 'cn' | 'us' | 'de' | 'gb';
4621
4806
  };
4622
4807
 
4623
4808
  export type BalanceControllerGetMultiCurrencyBalanceResponse =
@@ -4639,7 +4824,7 @@ export type ReviewControllerFindAllData = {
4639
4824
  /**
4640
4825
  * Region code for tenant context
4641
4826
  */
4642
- region: 'cn' | 'us' | 'de';
4827
+ region: 'cn' | 'us' | 'de' | 'gb';
4643
4828
  /**
4644
4829
  * Sort order
4645
4830
  */
@@ -4661,7 +4846,7 @@ export type ReviewControllerGetStatsData = {
4661
4846
  /**
4662
4847
  * Region code for tenant context
4663
4848
  */
4664
- region: 'cn' | 'us' | 'de';
4849
+ region: 'cn' | 'us' | 'de' | 'gb';
4665
4850
  };
4666
4851
 
4667
4852
  export type ReviewControllerGetStatsResponse = ReviewStatsDto;
@@ -4674,7 +4859,7 @@ export type ReviewControllerFindOneData = {
4674
4859
  /**
4675
4860
  * Region code for tenant context
4676
4861
  */
4677
- region: 'cn' | 'us' | 'de';
4862
+ region: 'cn' | 'us' | 'de' | 'gb';
4678
4863
  };
4679
4864
 
4680
4865
  export type ReviewControllerFindOneResponse = ReviewDetailDto;
@@ -4687,7 +4872,7 @@ export type ReviewControllerResolveData = {
4687
4872
  /**
4688
4873
  * Region code for tenant context
4689
4874
  */
4690
- region: 'cn' | 'us' | 'de';
4875
+ region: 'cn' | 'us' | 'de' | 'gb';
4691
4876
  requestBody: ResolveReviewDto;
4692
4877
  };
4693
4878
 
@@ -4701,7 +4886,7 @@ export type ReviewControllerUndoData = {
4701
4886
  /**
4702
4887
  * Region code for tenant context
4703
4888
  */
4704
- region: 'cn' | 'us' | 'de';
4889
+ region: 'cn' | 'us' | 'de' | 'gb';
4705
4890
  };
4706
4891
 
4707
4892
  export type ReviewControllerUndoResponse = UndoResultDto;
@@ -4710,7 +4895,7 @@ export type ReviewControllerBatchResolveData = {
4710
4895
  /**
4711
4896
  * Region code for tenant context
4712
4897
  */
4713
- region: 'cn' | 'us' | 'de';
4898
+ region: 'cn' | 'us' | 'de' | 'gb';
4714
4899
  /**
4715
4900
  * Batch resolution request containing review IDs and action
4716
4901
  */
@@ -4911,7 +5096,7 @@ export type CommodityControllerCreateData = {
4911
5096
  /**
4912
5097
  * Region code for tenant context
4913
5098
  */
4914
- region: 'cn' | 'us' | 'de';
5099
+ region: 'cn' | 'us' | 'de' | 'gb';
4915
5100
  requestBody: CreateCommodityDto;
4916
5101
  };
4917
5102
 
@@ -4921,7 +5106,7 @@ export type CommodityControllerFindAllData = {
4921
5106
  /**
4922
5107
  * Region code for tenant context
4923
5108
  */
4924
- region: 'cn' | 'us' | 'de';
5109
+ region: 'cn' | 'us' | 'de' | 'gb';
4925
5110
  /**
4926
5111
  * Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
4927
5112
  */
@@ -4938,7 +5123,7 @@ export type CommodityControllerFindOneData = {
4938
5123
  /**
4939
5124
  * Region code for tenant context
4940
5125
  */
4941
- region: 'cn' | 'us' | 'de';
5126
+ region: 'cn' | 'us' | 'de' | 'gb';
4942
5127
  /**
4943
5128
  * Commodity symbol
4944
5129
  */
@@ -4951,7 +5136,7 @@ export type CommodityControllerUpdateData = {
4951
5136
  /**
4952
5137
  * Region code for tenant context
4953
5138
  */
4954
- region: 'cn' | 'us' | 'de';
5139
+ region: 'cn' | 'us' | 'de' | 'gb';
4955
5140
  requestBody: UpdateCommodityDto;
4956
5141
  /**
4957
5142
  * Commodity symbol
@@ -4965,7 +5150,7 @@ export type CommodityControllerDeleteData = {
4965
5150
  /**
4966
5151
  * Region code for tenant context
4967
5152
  */
4968
- region: 'cn' | 'us' | 'de';
5153
+ region: 'cn' | 'us' | 'de' | 'gb';
4969
5154
  /**
4970
5155
  * Commodity symbol
4971
5156
  */
@@ -4978,7 +5163,7 @@ export type CommodityControllerGetOrCreateData = {
4978
5163
  /**
4979
5164
  * Region code for tenant context
4980
5165
  */
4981
- region: 'cn' | 'us' | 'de';
5166
+ region: 'cn' | 'us' | 'de' | 'gb';
4982
5167
  /**
4983
5168
  * Commodity symbol
4984
5169
  */
@@ -4991,7 +5176,7 @@ export type CommodityControllerBulkCreateData = {
4991
5176
  /**
4992
5177
  * Region code for tenant context
4993
5178
  */
4994
- region: 'cn' | 'us' | 'de';
5179
+ region: 'cn' | 'us' | 'de' | 'gb';
4995
5180
  };
4996
5181
 
4997
5182
  export type CommodityControllerBulkCreateResponse = Array<CommodityResponseDto>;
@@ -5000,7 +5185,7 @@ export type RecurringRuleControllerCreateData = {
5000
5185
  /**
5001
5186
  * Region code for tenant context
5002
5187
  */
5003
- region: 'cn' | 'us' | 'de';
5188
+ region: 'cn' | 'us' | 'de' | 'gb';
5004
5189
  requestBody: CreateRecurringRuleDto;
5005
5190
  };
5006
5191
 
@@ -5022,7 +5207,7 @@ export type RecurringRuleControllerFindAllData = {
5022
5207
  /**
5023
5208
  * Region code for tenant context
5024
5209
  */
5025
- region: 'cn' | 'us' | 'de';
5210
+ region: 'cn' | 'us' | 'de' | 'gb';
5026
5211
  };
5027
5212
 
5028
5213
  export type RecurringRuleControllerFindAllResponse =
@@ -5032,7 +5217,7 @@ export type RecurringRuleControllerCreateFromTransactionData = {
5032
5217
  /**
5033
5218
  * Region code for tenant context
5034
5219
  */
5035
- region: 'cn' | 'us' | 'de';
5220
+ region: 'cn' | 'us' | 'de' | 'gb';
5036
5221
  requestBody: CreateRuleFromTransactionDto;
5037
5222
  /**
5038
5223
  * Source transaction ID
@@ -5051,7 +5236,7 @@ export type RecurringRuleControllerFindOneData = {
5051
5236
  /**
5052
5237
  * Region code for tenant context
5053
5238
  */
5054
- region: 'cn' | 'us' | 'de';
5239
+ region: 'cn' | 'us' | 'de' | 'gb';
5055
5240
  };
5056
5241
 
5057
5242
  export type RecurringRuleControllerFindOneResponse = RecurringRuleResponseDto;
@@ -5064,7 +5249,7 @@ export type RecurringRuleControllerUpdateData = {
5064
5249
  /**
5065
5250
  * Region code for tenant context
5066
5251
  */
5067
- region: 'cn' | 'us' | 'de';
5252
+ region: 'cn' | 'us' | 'de' | 'gb';
5068
5253
  requestBody: UpdateRecurringRuleDto;
5069
5254
  };
5070
5255
 
@@ -5078,7 +5263,7 @@ export type RecurringRuleControllerDeleteData = {
5078
5263
  /**
5079
5264
  * Region code for tenant context
5080
5265
  */
5081
- region: 'cn' | 'us' | 'de';
5266
+ region: 'cn' | 'us' | 'de' | 'gb';
5082
5267
  };
5083
5268
 
5084
5269
  export type RecurringRuleControllerDeleteResponse = void;
@@ -5091,7 +5276,7 @@ export type RecurringRuleControllerGetWithStatsData = {
5091
5276
  /**
5092
5277
  * Region code for tenant context
5093
5278
  */
5094
- region: 'cn' | 'us' | 'de';
5279
+ region: 'cn' | 'us' | 'de' | 'gb';
5095
5280
  };
5096
5281
 
5097
5282
  export type RecurringRuleControllerGetWithStatsResponse =
@@ -5105,7 +5290,7 @@ export type ExpectedTransactionControllerFindAllData = {
5105
5290
  /**
5106
5291
  * Region code for tenant context
5107
5292
  */
5108
- region: 'cn' | 'us' | 'de';
5293
+ region: 'cn' | 'us' | 'de' | 'gb';
5109
5294
  /**
5110
5295
  * Filter by recurring rule ID
5111
5296
  */
@@ -5127,7 +5312,7 @@ export type ExpectedTransactionControllerFindOverdueData = {
5127
5312
  /**
5128
5313
  * Region code for tenant context
5129
5314
  */
5130
- region: 'cn' | 'us' | 'de';
5315
+ region: 'cn' | 'us' | 'de' | 'gb';
5131
5316
  };
5132
5317
 
5133
5318
  export type ExpectedTransactionControllerFindOverdueResponse =
@@ -5141,7 +5326,7 @@ export type ExpectedTransactionControllerFindOneData = {
5141
5326
  /**
5142
5327
  * Region code for tenant context
5143
5328
  */
5144
- region: 'cn' | 'us' | 'de';
5329
+ region: 'cn' | 'us' | 'de' | 'gb';
5145
5330
  };
5146
5331
 
5147
5332
  export type ExpectedTransactionControllerFindOneResponse =
@@ -5155,7 +5340,7 @@ export type ExpectedTransactionControllerSkipData = {
5155
5340
  /**
5156
5341
  * Region code for tenant context
5157
5342
  */
5158
- region: 'cn' | 'us' | 'de';
5343
+ region: 'cn' | 'us' | 'de' | 'gb';
5159
5344
  };
5160
5345
 
5161
5346
  export type ExpectedTransactionControllerSkipResponse =
@@ -5169,7 +5354,7 @@ export type ExpectedTransactionControllerUndoSkipData = {
5169
5354
  /**
5170
5355
  * Region code for tenant context
5171
5356
  */
5172
- region: 'cn' | 'us' | 'de';
5357
+ region: 'cn' | 'us' | 'de' | 'gb';
5173
5358
  };
5174
5359
 
5175
5360
  export type ExpectedTransactionControllerUndoSkipResponse =
@@ -5183,7 +5368,7 @@ export type ExpectedTransactionControllerConfirmMatchData = {
5183
5368
  /**
5184
5369
  * Region code for tenant context
5185
5370
  */
5186
- region: 'cn' | 'us' | 'de';
5371
+ region: 'cn' | 'us' | 'de' | 'gb';
5187
5372
  requestBody: ConfirmMatchDto;
5188
5373
  };
5189
5374
 
@@ -5197,7 +5382,7 @@ export type ExpectedTransactionControllerUnmatchData = {
5197
5382
  /**
5198
5383
  * Region code for tenant context
5199
5384
  */
5200
- region: 'cn' | 'us' | 'de';
5385
+ region: 'cn' | 'us' | 'de' | 'gb';
5201
5386
  };
5202
5387
 
5203
5388
  export type ExpectedTransactionControllerUnmatchResponse = unknown;
@@ -5210,7 +5395,7 @@ export type ExpectedTransactionControllerEnterNowData = {
5210
5395
  /**
5211
5396
  * Region code for tenant context
5212
5397
  */
5213
- region: 'cn' | 'us' | 'de';
5398
+ region: 'cn' | 'us' | 'de' | 'gb';
5214
5399
  requestBody: EnterNowDto;
5215
5400
  };
5216
5401
 
@@ -5224,7 +5409,7 @@ export type ForecastControllerGetForecastData = {
5224
5409
  /**
5225
5410
  * Region code for tenant context
5226
5411
  */
5227
- region: 'cn' | 'us' | 'de';
5412
+ region: 'cn' | 'us' | 'de' | 'gb';
5228
5413
  };
5229
5414
 
5230
5415
  export type ForecastControllerGetForecastResponse = ForecastResponseDto;
@@ -5233,7 +5418,7 @@ export type TransactionRuleControllerCreateData = {
5233
5418
  /**
5234
5419
  * Region code for tenant context
5235
5420
  */
5236
- region: 'cn' | 'us' | 'de';
5421
+ region: 'cn' | 'us' | 'de' | 'gb';
5237
5422
  requestBody: CreateTransactionRuleDto;
5238
5423
  };
5239
5424
 
@@ -5264,7 +5449,7 @@ export type TransactionRuleControllerListData = {
5264
5449
  /**
5265
5450
  * Region code for tenant context
5266
5451
  */
5267
- region: 'cn' | 'us' | 'de';
5452
+ region: 'cn' | 'us' | 'de' | 'gb';
5268
5453
  };
5269
5454
 
5270
5455
  export type TransactionRuleControllerListResponse =
@@ -5274,7 +5459,7 @@ export type TransactionRuleControllerValidateData = {
5274
5459
  /**
5275
5460
  * Region code for tenant context
5276
5461
  */
5277
- region: 'cn' | 'us' | 'de';
5462
+ region: 'cn' | 'us' | 'de' | 'gb';
5278
5463
  requestBody: ValidateRuleDto;
5279
5464
  };
5280
5465
 
@@ -5284,7 +5469,7 @@ export type TransactionRuleControllerBulkCreateData = {
5284
5469
  /**
5285
5470
  * Region code for tenant context
5286
5471
  */
5287
- region: 'cn' | 'us' | 'de';
5472
+ region: 'cn' | 'us' | 'de' | 'gb';
5288
5473
  requestBody: BulkCreateRulesDto;
5289
5474
  };
5290
5475
 
@@ -5299,7 +5484,7 @@ export type TransactionRuleControllerExportData = {
5299
5484
  /**
5300
5485
  * Region code for tenant context
5301
5486
  */
5302
- region: 'cn' | 'us' | 'de';
5487
+ region: 'cn' | 'us' | 'de' | 'gb';
5303
5488
  };
5304
5489
 
5305
5490
  export type TransactionRuleControllerExportResponse = ExportRulesResponseDto;
@@ -5312,7 +5497,7 @@ export type TransactionRuleControllerGetStatisticsData = {
5312
5497
  /**
5313
5498
  * Region code for tenant context
5314
5499
  */
5315
- region: 'cn' | 'us' | 'de';
5500
+ region: 'cn' | 'us' | 'de' | 'gb';
5316
5501
  };
5317
5502
 
5318
5503
  export type TransactionRuleControllerGetStatisticsResponse =
@@ -5322,7 +5507,7 @@ export type TransactionRuleControllerGetDetailData = {
5322
5507
  /**
5323
5508
  * Region code for tenant context
5324
5509
  */
5325
- region: 'cn' | 'us' | 'de';
5510
+ region: 'cn' | 'us' | 'de' | 'gb';
5326
5511
  /**
5327
5512
  * Rule ID
5328
5513
  */
@@ -5336,7 +5521,7 @@ export type TransactionRuleControllerUpdateData = {
5336
5521
  /**
5337
5522
  * Region code for tenant context
5338
5523
  */
5339
- region: 'cn' | 'us' | 'de';
5524
+ region: 'cn' | 'us' | 'de' | 'gb';
5340
5525
  requestBody: UpdateTransactionRuleDto;
5341
5526
  /**
5342
5527
  * Rule ID to update
@@ -5351,7 +5536,7 @@ export type TransactionRuleControllerDeleteData = {
5351
5536
  /**
5352
5537
  * Region code for tenant context
5353
5538
  */
5354
- region: 'cn' | 'us' | 'de';
5539
+ region: 'cn' | 'us' | 'de' | 'gb';
5355
5540
  /**
5356
5541
  * Rule ID to delete
5357
5542
  */
@@ -5364,7 +5549,7 @@ export type TransactionRuleControllerTestData = {
5364
5549
  /**
5365
5550
  * Region code for tenant context
5366
5551
  */
5367
- region: 'cn' | 'us' | 'de';
5552
+ region: 'cn' | 'us' | 'de' | 'gb';
5368
5553
  requestBody: TestRuleDto;
5369
5554
  /**
5370
5555
  * Rule ID to test
@@ -5471,7 +5656,7 @@ export type FileImportControllerImportFileData = {
5471
5656
  /**
5472
5657
  * Region code for tenant context
5473
5658
  */
5474
- region: 'cn' | 'us' | 'de';
5659
+ region: 'cn' | 'us' | 'de' | 'gb';
5475
5660
  };
5476
5661
 
5477
5662
  export type FileImportControllerImportFileResponse = ImportResultDto;
@@ -5484,7 +5669,7 @@ export type FileImportControllerIdentifyFileData = {
5484
5669
  /**
5485
5670
  * Region code for tenant context
5486
5671
  */
5487
- region: 'cn' | 'us' | 'de';
5672
+ region: 'cn' | 'us' | 'de' | 'gb';
5488
5673
  };
5489
5674
 
5490
5675
  export type FileImportControllerIdentifyFileResponse = IdentifyResultDto;
@@ -5497,7 +5682,7 @@ export type FileImportControllerImportBeancountData = {
5497
5682
  /**
5498
5683
  * Region code for tenant context
5499
5684
  */
5500
- region: 'cn' | 'us' | 'de';
5685
+ region: 'cn' | 'us' | 'de' | 'gb';
5501
5686
  };
5502
5687
 
5503
5688
  export type FileImportControllerImportBeancountResponse = {
@@ -5518,7 +5703,7 @@ export type ImporterConfigControllerGetConfigData = {
5518
5703
  /**
5519
5704
  * Region code for tenant context
5520
5705
  */
5521
- region: 'cn' | 'us' | 'de';
5706
+ region: 'cn' | 'us' | 'de' | 'gb';
5522
5707
  };
5523
5708
 
5524
5709
  export type ImporterConfigControllerGetConfigResponse = ImporterConfigDto;
@@ -5531,7 +5716,7 @@ export type ImporterConfigControllerUpdateConfigData = {
5531
5716
  /**
5532
5717
  * Region code for tenant context
5533
5718
  */
5534
- region: 'cn' | 'us' | 'de';
5719
+ region: 'cn' | 'us' | 'de' | 'gb';
5535
5720
  /**
5536
5721
  * Partial configuration update. Only provided fields will be updated.
5537
5722
  */
@@ -5548,7 +5733,7 @@ export type ImporterConfigControllerResetConfigData = {
5548
5733
  /**
5549
5734
  * Region code for tenant context
5550
5735
  */
5551
- region: 'cn' | 'us' | 'de';
5736
+ region: 'cn' | 'us' | 'de' | 'gb';
5552
5737
  };
5553
5738
 
5554
5739
  export type ImporterConfigControllerResetConfigResponse = ImporterConfigDto;
@@ -5621,7 +5806,7 @@ export type ProviderSyncControllerGetSupportedProvidersData = {
5621
5806
  /**
5622
5807
  * Region code for tenant context
5623
5808
  */
5624
- region: 'cn' | 'us' | 'de';
5809
+ region: 'cn' | 'us' | 'de' | 'gb';
5625
5810
  };
5626
5811
 
5627
5812
  export type ProviderSyncControllerGetSupportedProvidersResponse =
@@ -5635,7 +5820,7 @@ export type ProviderSyncControllerIsProviderSupportedData = {
5635
5820
  /**
5636
5821
  * Region code for tenant context
5637
5822
  */
5638
- region: 'cn' | 'us' | 'de';
5823
+ region: 'cn' | 'us' | 'de' | 'gb';
5639
5824
  };
5640
5825
 
5641
5826
  export type ProviderSyncControllerIsProviderSupportedResponse = unknown;
@@ -5644,7 +5829,7 @@ export type TelemetryControllerReportTelemetryData = {
5644
5829
  /**
5645
5830
  * Region code for tenant context
5646
5831
  */
5647
- region: 'cn' | 'us' | 'de';
5832
+ region: 'cn' | 'us' | 'de' | 'gb';
5648
5833
  requestBody: ParserTelemetryReportDto;
5649
5834
  };
5650
5835
 
@@ -5654,7 +5839,7 @@ export type NlpControllerProcessNaturalLanguageData = {
5654
5839
  /**
5655
5840
  * Region code for tenant context
5656
5841
  */
5657
- region: 'cn' | 'us' | 'de';
5842
+ region: 'cn' | 'us' | 'de' | 'gb';
5658
5843
  /**
5659
5844
  * Natural language transaction input with optional session ID
5660
5845
  */
@@ -5667,7 +5852,7 @@ export type NlpControllerClearSessionData = {
5667
5852
  /**
5668
5853
  * Region code for tenant context
5669
5854
  */
5670
- region: 'cn' | 'us' | 'de';
5855
+ region: 'cn' | 'us' | 'de' | 'gb';
5671
5856
  /**
5672
5857
  * Specific session ID to clear (defaults to user session)
5673
5858
  */
@@ -5680,7 +5865,7 @@ export type NlpControllerGetSessionData = {
5680
5865
  /**
5681
5866
  * Region code for tenant context
5682
5867
  */
5683
- region: 'cn' | 'us' | 'de';
5868
+ region: 'cn' | 'us' | 'de' | 'gb';
5684
5869
  /**
5685
5870
  * Specific session ID to get (defaults to user session)
5686
5871
  */
@@ -5697,7 +5882,7 @@ export type DashboardControllerGetNetWorthData = {
5697
5882
  /**
5698
5883
  * Region code for tenant context
5699
5884
  */
5700
- region: 'cn' | 'us' | 'de';
5885
+ region: 'cn' | 'us' | 'de' | 'gb';
5701
5886
  };
5702
5887
 
5703
5888
  export type DashboardControllerGetNetWorthResponse = NetWorthResponseDto;
@@ -5714,7 +5899,7 @@ export type DashboardControllerGetAccountsData = {
5714
5899
  /**
5715
5900
  * Region code for tenant context
5716
5901
  */
5717
- region: 'cn' | 'us' | 'de';
5902
+ region: 'cn' | 'us' | 'de' | 'gb';
5718
5903
  };
5719
5904
 
5720
5905
  export type DashboardControllerGetAccountsResponse =
@@ -5729,7 +5914,7 @@ export type DashboardControllerGetCashFlowData = {
5729
5914
  /**
5730
5915
  * Region code for tenant context
5731
5916
  */
5732
- region: 'cn' | 'us' | 'de';
5917
+ region: 'cn' | 'us' | 'de' | 'gb';
5733
5918
  };
5734
5919
 
5735
5920
  export type DashboardControllerGetCashFlowResponse = CashFlowResponseDto;
@@ -5746,7 +5931,7 @@ export type ReportingControllerGetPortfolioTrendsData = {
5746
5931
  /**
5747
5932
  * Region code for tenant context
5748
5933
  */
5749
- region: 'cn' | 'us' | 'de';
5934
+ region: 'cn' | 'us' | 'de' | 'gb';
5750
5935
  };
5751
5936
 
5752
5937
  export type ReportingControllerGetPortfolioTrendsResponse =
@@ -5756,7 +5941,7 @@ export type ReportingControllerGenerateSnapshotData = {
5756
5941
  /**
5757
5942
  * Region code for tenant context
5758
5943
  */
5759
- region: 'cn' | 'us' | 'de';
5944
+ region: 'cn' | 'us' | 'de' | 'gb';
5760
5945
  /**
5761
5946
  * Optional date (defaults to today)
5762
5947
  */
@@ -5770,7 +5955,7 @@ export type ReportingControllerBackfillSnapshotsData = {
5770
5955
  /**
5771
5956
  * Region code for tenant context
5772
5957
  */
5773
- region: 'cn' | 'us' | 'de';
5958
+ region: 'cn' | 'us' | 'de' | 'gb';
5774
5959
  requestBody: BackfillSnapshotsBody;
5775
5960
  };
5776
5961
 
@@ -6027,6 +6212,48 @@ export type $OpenApiTs = {
6027
6212
  };
6028
6213
  };
6029
6214
  };
6215
+ '/api/v1/{region}/bean/transactions/{id}/correct': {
6216
+ post: {
6217
+ req: TransactionControllerCorrectData;
6218
+ res: {
6219
+ /**
6220
+ * Corrected transaction created
6221
+ */
6222
+ 201: TransactionDetailDto;
6223
+ /**
6224
+ * Original transaction not found
6225
+ */
6226
+ 404: ApiProblemResponseDto;
6227
+ /**
6228
+ * Original no longer ACTIVE (concurrent modification)
6229
+ */
6230
+ 409: ApiProblemResponseDto;
6231
+ /**
6232
+ * Pipeline validation failed (does not balance, invalid accounts)
6233
+ */
6234
+ 422: ApiProblemResponseDto;
6235
+ };
6236
+ };
6237
+ };
6238
+ '/api/v1/{region}/bean/transactions/tags': {
6239
+ get: {
6240
+ req: TransactionControllerSuggestTagsData;
6241
+ res: {
6242
+ /**
6243
+ * Tag suggestions
6244
+ */
6245
+ 200: TagSuggestionsResponseDto;
6246
+ /**
6247
+ * Validation failed
6248
+ */
6249
+ 400: ApiProblemResponseDto;
6250
+ /**
6251
+ * Authentication required
6252
+ */
6253
+ 401: ApiProblemResponseDto;
6254
+ };
6255
+ };
6256
+ };
6030
6257
  '/api/v1/{region}/bean/transactions/{id}': {
6031
6258
  get: {
6032
6259
  req: TransactionControllerGetDetailData;