@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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.5789",
6
+ "version": "1.3.1-stage.5809",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -161,7 +161,7 @@ export interface paths {
161
161
  put: operations["putAccountsById"];
162
162
  post?: never;
163
163
  /**
164
- * @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.
164
+ * @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.
165
165
  *
166
166
  * Required scope: accounts:delete
167
167
  */
@@ -3597,7 +3597,7 @@ export interface paths {
3597
3597
  get: operations["getRecurringFees"];
3598
3598
  put?: never;
3599
3599
  /**
3600
- * @description Create a recurring fee. Active fees require tenant-owned active direct and tax posting accounts.
3600
+ * @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.
3601
3601
  *
3602
3602
  * Required scope: recurring-fees:write
3603
3603
  */
@@ -3623,7 +3623,7 @@ export interface paths {
3623
3623
  get: operations["getRecurringFeesListingPeriods"];
3624
3624
  put?: never;
3625
3625
  /**
3626
- * @description Add listing period to a recurring fee
3626
+ * @description Add a listing period to a recurring fee. A rate equal to the fee definition default is stored as inherited.
3627
3627
  *
3628
3628
  * Required scope: recurring-fees:write
3629
3629
  */
@@ -3643,7 +3643,7 @@ export interface paths {
3643
3643
  };
3644
3644
  get?: never;
3645
3645
  /**
3646
- * @description Update a listing period
3646
+ * @description Update a listing period. A rate equal to the fee definition default is stored as inherited.
3647
3647
  *
3648
3648
  * Required scope: recurring-fees:write
3649
3649
  */
@@ -3695,7 +3695,7 @@ export interface paths {
3695
3695
  */
3696
3696
  get: operations["getRecurringFeesById"];
3697
3697
  /**
3698
- * @description Update a recurring fee. Active fees require tenant-owned active direct and tax posting accounts, including on reactivation.
3698
+ * @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.
3699
3699
  *
3700
3700
  * Required scope: recurring-fees:write
3701
3701
  */
@@ -3825,7 +3825,7 @@ export interface paths {
3825
3825
  cookie?: never;
3826
3826
  };
3827
3827
  /**
3828
- * @description Paginated journal entries with configurable filters
3828
+ * @description Paginated journal entries with configurable filters. A dash placeholder in a comma-separated filter is treated as no selection.
3829
3829
  *
3830
3830
  * Required scope: reports:read
3831
3831
  */
@@ -3846,7 +3846,7 @@ export interface paths {
3846
3846
  cookie?: never;
3847
3847
  };
3848
3848
  /**
3849
- * @description CSV export for journal entries
3849
+ * @description CSV export for journal entries. A dash placeholder in a comma-separated filter is treated as no selection.
3850
3850
  *
3851
3851
  * Required scope: reports:read, reports:export
3852
3852
  */
@@ -51530,6 +51530,7 @@ export interface operations {
51530
51530
  startAt?: string | null;
51531
51531
  /** @description Listing period end date; unparseable values are rejected */
51532
51532
  endAt?: string | null;
51533
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
51533
51534
  rate?: number | null;
51534
51535
  /** Format: uuid */
51535
51536
  id: string;
@@ -51869,6 +51870,7 @@ export interface operations {
51869
51870
  startAt?: string | null;
51870
51871
  /** @description Listing period end date; unparseable values are rejected */
51871
51872
  endAt?: string | null;
51873
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
51872
51874
  rate?: number | null;
51873
51875
  /** Format: uuid */
51874
51876
  id: string;
@@ -51993,6 +51995,7 @@ export interface operations {
51993
51995
  startAt?: string | null;
51994
51996
  /** @description Listing period end date; unparseable values are rejected */
51995
51997
  endAt?: string | null;
51998
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
51996
51999
  rate?: number | null;
51997
52000
  /** Format: uuid */
51998
52001
  id: string;
@@ -54937,6 +54940,7 @@ export interface operations {
54937
54940
  startAt?: string | null;
54938
54941
  /** @description Listing period end date; unparseable values are rejected */
54939
54942
  endAt?: string | null;
54943
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
54940
54944
  rate?: number | null;
54941
54945
  /** Format: uuid */
54942
54946
  id: string;
@@ -55268,6 +55272,7 @@ export interface operations {
55268
55272
  startAt?: string | null;
55269
55273
  /** @description Listing period end date; unparseable values are rejected */
55270
55274
  endAt?: string | null;
55275
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
55271
55276
  rate?: number | null;
55272
55277
  /** Format: uuid */
55273
55278
  id: string;
@@ -55392,6 +55397,7 @@ export interface operations {
55392
55397
  startAt?: string | null;
55393
55398
  /** @description Listing period end date; unparseable values are rejected */
55394
55399
  endAt?: string | null;
55400
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
55395
55401
  rate?: number | null;
55396
55402
  /** Format: uuid */
55397
55403
  id: string;
@@ -56581,6 +56587,7 @@ export interface operations {
56581
56587
  startAt?: string | null;
56582
56588
  /** @description Listing period end date; unparseable values are rejected */
56583
56589
  endAt?: string | null;
56590
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
56584
56591
  rate?: number | null;
56585
56592
  /** Format: uuid */
56586
56593
  id: string;
@@ -56988,6 +56995,7 @@ export interface operations {
56988
56995
  startAt?: string | null;
56989
56996
  /** @description Listing period end date; unparseable values are rejected */
56990
56997
  endAt?: string | null;
56998
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
56991
56999
  rate?: number | null;
56992
57000
  /** Format: uuid */
56993
57001
  id: string;
@@ -72059,6 +72067,7 @@ export interface operations {
72059
72067
  listingId: string;
72060
72068
  startAt?: string | null;
72061
72069
  endAt?: string | null;
72070
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72062
72071
  rate?: number | null;
72063
72072
  }[] | null;
72064
72073
  };
@@ -72435,6 +72444,7 @@ export interface operations {
72435
72444
  startAt?: string | null;
72436
72445
  /** @description Listing period end date; unparseable values are rejected */
72437
72446
  endAt?: string | null;
72447
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72438
72448
  rate?: number | null;
72439
72449
  /** Format: uuid */
72440
72450
  id: string;
@@ -72709,6 +72719,7 @@ export interface operations {
72709
72719
  startAt?: string | null;
72710
72720
  /** @description Listing period end date; unparseable values are rejected */
72711
72721
  endAt?: string | null;
72722
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72712
72723
  rate?: number | null;
72713
72724
  onConflict?: ("error" | "updateExisting" | "adjustInsertingItem" | "closeExistingPeriods") | null;
72714
72725
  };
@@ -72728,6 +72739,7 @@ export interface operations {
72728
72739
  startAt?: string | null;
72729
72740
  /** @description Listing period end date; unparseable values are rejected */
72730
72741
  endAt?: string | null;
72742
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72731
72743
  rate?: number | null;
72732
72744
  /** Format: uuid */
72733
72745
  id: string;
@@ -72992,6 +73004,7 @@ export interface operations {
72992
73004
  startAt?: string | null;
72993
73005
  /** @description Listing period end date; unparseable values are rejected */
72994
73006
  endAt?: string | null;
73007
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
72995
73008
  rate?: number | null;
72996
73009
  onConflict?: ("error" | "updateExisting" | "adjustInsertingItem" | "closeExistingPeriods") | null;
72997
73010
  };
@@ -73011,6 +73024,7 @@ export interface operations {
73011
73024
  startAt?: string | null;
73012
73025
  /** @description Listing period end date; unparseable values are rejected */
73013
73026
  endAt?: string | null;
73027
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
73014
73028
  rate?: number | null;
73015
73029
  /** Format: uuid */
73016
73030
  id: string;
@@ -73550,6 +73564,7 @@ export interface operations {
73550
73564
  listingId: string;
73551
73565
  startAt?: string | null;
73552
73566
  endAt?: string | null;
73567
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
73553
73568
  rate?: number | null;
73554
73569
  }[] | null;
73555
73570
  id?: string | null;
@@ -74315,6 +74330,7 @@ export interface operations {
74315
74330
  listingId: string;
74316
74331
  startAt?: string | null;
74317
74332
  endAt?: string | null;
74333
+ /** @description Optional listing-period override; a value equal to the definition default is stored as inherited */
74318
74334
  rate?: number | null;
74319
74335
  }[] | null;
74320
74336
  };