@vrplatform/api 1.3.1-stage.5543 → 1.3.1-stage.5554

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.5543",
6
+ "version": "1.3.1-stage.5554",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -154,14 +154,14 @@ export interface paths {
154
154
  */
155
155
  get: operations["getAccountsById"];
156
156
  /**
157
- * @description Update account by ID
157
+ * @description Update an account by ID. Status cannot be changed to inactive while an active recurring fee uses the account for direct or tax posting.
158
158
  *
159
159
  * Required scope: accounts:write
160
160
  */
161
161
  put: operations["putAccountsById"];
162
162
  post?: never;
163
163
  /**
164
- * @description Delete Account By ID
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.
165
165
  *
166
166
  * Required scope: accounts:delete
167
167
  */
@@ -3492,7 +3492,7 @@ export interface paths {
3492
3492
  get: operations["getRecurringFees"];
3493
3493
  put?: never;
3494
3494
  /**
3495
- * @description Create Recurring Fees
3495
+ * @description Create a recurring fee. Active fees require tenant-owned active direct and tax posting accounts.
3496
3496
  *
3497
3497
  * Required scope: recurring-fees:write
3498
3498
  */
@@ -3590,7 +3590,7 @@ export interface paths {
3590
3590
  */
3591
3591
  get: operations["getRecurringFeesById"];
3592
3592
  /**
3593
- * @description Update Recurring Fees
3593
+ * @description Update a recurring fee. Active fees require tenant-owned active direct and tax posting accounts, including on reactivation.
3594
3594
  *
3595
3595
  * Required scope: recurring-fees:write
3596
3596
  */
@@ -4498,7 +4498,7 @@ export interface paths {
4498
4498
  get?: never;
4499
4499
  put?: never;
4500
4500
  /**
4501
- * @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations. Pass type or recurringFeeId when the booking is active; canceled bookings may create an unclassified adjustment. onLocked=nextOpen to resolve and persist the earliest valid posting date, or provide generalLedgerPostingAt explicitly. The two options cannot be combined. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4501
+ * @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations. Pass type or recurringFeeId when the booking is active; canceled bookings may create an unclassified adjustment. A recurring-fee adjustment is rejected before persistence when the fee uses an inactive posting account. onLocked=nextOpen to resolve and persist the earliest valid posting date, or provide generalLedgerPostingAt explicitly. The two options cannot be combined. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4502
4502
  *
4503
4503
  * Required scope: reservations:write
4504
4504
  */
@@ -4518,7 +4518,7 @@ export interface paths {
4518
4518
  };
4519
4519
  get?: never;
4520
4520
  /**
4521
- * @description Update a reservation adjustment line. Refreshes the reservation journal inline; the update is rejected when the adjustment posts into a books-closed month or its journal entries are attached to an owner statement. Move the generalLedgerPostingAt date after the locked range to adjust a locked reservation. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4521
+ * @description Update a reservation adjustment line. Refreshes the reservation journal inline; the update is rejected when the adjustment posts into a books-closed month or its journal entries are attached to an owner statement. A recurring-fee adjustment is also rejected before persistence when the fee uses an inactive posting account. Move the generalLedgerPostingAt date after the locked range to adjust a locked reservation. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4522
4522
  *
4523
4523
  * Required scope: reservations:write
4524
4524
  */
@@ -5182,7 +5182,7 @@ export interface paths {
5182
5182
  */
5183
5183
  get: operations["getRate"];
5184
5184
  /**
5185
- * @description Update a tax rate
5185
+ * @description Update a tax rate. Posting accounts must remain active while the rate is used by an active recurring fee.
5186
5186
  *
5187
5187
  * Required scope: tax-rates:write
5188
5188
  */