@vrplatform/api 1.3.1-stage.5789 → 1.3.1-stage.5809

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.
@@ -160,7 +160,7 @@ export interface paths {
160
160
  put: operations["putAccountsById"];
161
161
  post?: never;
162
162
  /**
163
- * @description Delete an account by ID, or archive a protected account with onLocked=archive. An account used as a direct or tax posting account by an active recurring fee cannot be deleted or archived.
163
+ * @description Delete an account by ID, or archive a protected account with onLocked=archive. An account used as a direct or tax posting account by an active recurring fee cannot be deleted or archived. Deletable bank-record and bank-rule application history is removed atomically.
164
164
  *
165
165
  * Required scope: accounts:delete
166
166
  */
@@ -3596,7 +3596,7 @@ export interface paths {
3596
3596
  get: operations["getRecurringFees"];
3597
3597
  put?: never;
3598
3598
  /**
3599
- * @description Create a recurring fee. Active fees require tenant-owned active direct and tax posting accounts.
3599
+ * @description Create a recurring fee. Active fees require tenant-owned active direct and tax posting accounts. Listing-period rates equal to the definition default are stored as inherited.
3600
3600
  *
3601
3601
  * Required scope: recurring-fees:write
3602
3602
  */
@@ -3622,7 +3622,7 @@ export interface paths {
3622
3622
  get: operations["getRecurringFeesListingPeriods"];
3623
3623
  put?: never;
3624
3624
  /**
3625
- * @description Add listing period to a recurring fee
3625
+ * @description Add a listing period to a recurring fee. A rate equal to the fee definition default is stored as inherited.
3626
3626
  *
3627
3627
  * Required scope: recurring-fees:write
3628
3628
  */
@@ -3642,7 +3642,7 @@ export interface paths {
3642
3642
  };
3643
3643
  get?: never;
3644
3644
  /**
3645
- * @description Update a listing period
3645
+ * @description Update a listing period. A rate equal to the fee definition default is stored as inherited.
3646
3646
  *
3647
3647
  * Required scope: recurring-fees:write
3648
3648
  */
@@ -3694,7 +3694,7 @@ export interface paths {
3694
3694
  */
3695
3695
  get: operations["getRecurringFeesById"];
3696
3696
  /**
3697
- * @description Update a recurring fee. Active fees require tenant-owned active direct and tax posting accounts, including on reactivation.
3697
+ * @description Update a recurring fee. Active fees require tenant-owned active direct and tax posting accounts, including on reactivation. Changing the default keeps distinct listing-period overrides and converts rates equal to the previous default back to inheritance.
3698
3698
  *
3699
3699
  * Required scope: recurring-fees:write
3700
3700
  */
@@ -3824,7 +3824,7 @@ export interface paths {
3824
3824
  cookie?: never;
3825
3825
  };
3826
3826
  /**
3827
- * @description Paginated journal entries with configurable filters
3827
+ * @description Paginated journal entries with configurable filters. A dash placeholder in a comma-separated filter is treated as no selection.
3828
3828
  *
3829
3829
  * Required scope: reports:read
3830
3830
  */
@@ -3845,7 +3845,7 @@ export interface paths {
3845
3845
  cookie?: never;
3846
3846
  };
3847
3847
  /**
3848
- * @description CSV export for journal entries
3848
+ * @description CSV export for journal entries. A dash placeholder in a comma-separated filter is treated as no selection.
3849
3849
  *
3850
3850
  * Required scope: reports:read, reports:export
3851
3851
  */
@@ -51529,6 +51529,7 @@ export interface operations {
51529
51529
  startAt?: string | null;
51530
51530
  /** @description Listing period end date; unparseable values are rejected */
51531
51531
  endAt?: string | null;
51532
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
51532
51533
  rate?: number | null;
51533
51534
  /** Format: uuid */
51534
51535
  id: string;
@@ -51868,6 +51869,7 @@ export interface operations {
51868
51869
  startAt?: string | null;
51869
51870
  /** @description Listing period end date; unparseable values are rejected */
51870
51871
  endAt?: string | null;
51872
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
51871
51873
  rate?: number | null;
51872
51874
  /** Format: uuid */
51873
51875
  id: string;
@@ -51992,6 +51994,7 @@ export interface operations {
51992
51994
  startAt?: string | null;
51993
51995
  /** @description Listing period end date; unparseable values are rejected */
51994
51996
  endAt?: string | null;
51997
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
51995
51998
  rate?: number | null;
51996
51999
  /** Format: uuid */
51997
52000
  id: string;
@@ -54936,6 +54939,7 @@ export interface operations {
54936
54939
  startAt?: string | null;
54937
54940
  /** @description Listing period end date; unparseable values are rejected */
54938
54941
  endAt?: string | null;
54942
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
54939
54943
  rate?: number | null;
54940
54944
  /** Format: uuid */
54941
54945
  id: string;
@@ -55267,6 +55271,7 @@ export interface operations {
55267
55271
  startAt?: string | null;
55268
55272
  /** @description Listing period end date; unparseable values are rejected */
55269
55273
  endAt?: string | null;
55274
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
55270
55275
  rate?: number | null;
55271
55276
  /** Format: uuid */
55272
55277
  id: string;
@@ -55391,6 +55396,7 @@ export interface operations {
55391
55396
  startAt?: string | null;
55392
55397
  /** @description Listing period end date; unparseable values are rejected */
55393
55398
  endAt?: string | null;
55399
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
55394
55400
  rate?: number | null;
55395
55401
  /** Format: uuid */
55396
55402
  id: string;
@@ -56580,6 +56586,7 @@ export interface operations {
56580
56586
  startAt?: string | null;
56581
56587
  /** @description Listing period end date; unparseable values are rejected */
56582
56588
  endAt?: string | null;
56589
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
56583
56590
  rate?: number | null;
56584
56591
  /** Format: uuid */
56585
56592
  id: string;
@@ -56987,6 +56994,7 @@ export interface operations {
56987
56994
  startAt?: string | null;
56988
56995
  /** @description Listing period end date; unparseable values are rejected */
56989
56996
  endAt?: string | null;
56997
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
56990
56998
  rate?: number | null;
56991
56999
  /** Format: uuid */
56992
57000
  id: string;
@@ -72058,6 +72066,7 @@ export interface operations {
72058
72066
  listingId: string;
72059
72067
  startAt?: string | null;
72060
72068
  endAt?: string | null;
72069
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72061
72070
  rate?: number | null;
72062
72071
  }[] | null;
72063
72072
  };
@@ -72434,6 +72443,7 @@ export interface operations {
72434
72443
  startAt?: string | null;
72435
72444
  /** @description Listing period end date; unparseable values are rejected */
72436
72445
  endAt?: string | null;
72446
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72437
72447
  rate?: number | null;
72438
72448
  /** Format: uuid */
72439
72449
  id: string;
@@ -72708,6 +72718,7 @@ export interface operations {
72708
72718
  startAt?: string | null;
72709
72719
  /** @description Listing period end date; unparseable values are rejected */
72710
72720
  endAt?: string | null;
72721
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72711
72722
  rate?: number | null;
72712
72723
  onConflict?: ("error" | "updateExisting" | "adjustInsertingItem" | "closeExistingPeriods") | null;
72713
72724
  };
@@ -72727,6 +72738,7 @@ export interface operations {
72727
72738
  startAt?: string | null;
72728
72739
  /** @description Listing period end date; unparseable values are rejected */
72729
72740
  endAt?: string | null;
72741
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72730
72742
  rate?: number | null;
72731
72743
  /** Format: uuid */
72732
72744
  id: string;
@@ -72991,6 +73003,7 @@ export interface operations {
72991
73003
  startAt?: string | null;
72992
73004
  /** @description Listing period end date; unparseable values are rejected */
72993
73005
  endAt?: string | null;
73006
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72994
73007
  rate?: number | null;
72995
73008
  onConflict?: ("error" | "updateExisting" | "adjustInsertingItem" | "closeExistingPeriods") | null;
72996
73009
  };
@@ -73010,6 +73023,7 @@ export interface operations {
73010
73023
  startAt?: string | null;
73011
73024
  /** @description Listing period end date; unparseable values are rejected */
73012
73025
  endAt?: string | null;
73026
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
73013
73027
  rate?: number | null;
73014
73028
  /** Format: uuid */
73015
73029
  id: string;
@@ -73549,6 +73563,7 @@ export interface operations {
73549
73563
  listingId: string;
73550
73564
  startAt?: string | null;
73551
73565
  endAt?: string | null;
73566
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
73552
73567
  rate?: number | null;
73553
73568
  }[] | null;
73554
73569
  id?: string | null;
@@ -74314,6 +74329,7 @@ export interface operations {
74314
74329
  listingId: string;
74315
74330
  startAt?: string | null;
74316
74331
  endAt?: string | null;
74332
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
74317
74333
  rate?: number | null;
74318
74334
  }[] | null;
74319
74335
  };