@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.
@@ -153,14 +153,14 @@ export interface paths {
153
153
  */
154
154
  get: operations["getAccountsById"];
155
155
  /**
156
- * @description Update account by ID
156
+ * @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.
157
157
  *
158
158
  * Required scope: accounts:write
159
159
  */
160
160
  put: operations["putAccountsById"];
161
161
  post?: never;
162
162
  /**
163
- * @description Delete Account By ID
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.
164
164
  *
165
165
  * Required scope: accounts:delete
166
166
  */
@@ -3491,7 +3491,7 @@ export interface paths {
3491
3491
  get: operations["getRecurringFees"];
3492
3492
  put?: never;
3493
3493
  /**
3494
- * @description Create Recurring Fees
3494
+ * @description Create a recurring fee. Active fees require tenant-owned active direct and tax posting accounts.
3495
3495
  *
3496
3496
  * Required scope: recurring-fees:write
3497
3497
  */
@@ -3589,7 +3589,7 @@ export interface paths {
3589
3589
  */
3590
3590
  get: operations["getRecurringFeesById"];
3591
3591
  /**
3592
- * @description Update Recurring Fees
3592
+ * @description Update a recurring fee. Active fees require tenant-owned active direct and tax posting accounts, including on reactivation.
3593
3593
  *
3594
3594
  * Required scope: recurring-fees:write
3595
3595
  */
@@ -4497,7 +4497,7 @@ export interface paths {
4497
4497
  get?: never;
4498
4498
  put?: never;
4499
4499
  /**
4500
- * @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.
4500
+ * @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.
4501
4501
  *
4502
4502
  * Required scope: reservations:write
4503
4503
  */
@@ -4517,7 +4517,7 @@ export interface paths {
4517
4517
  };
4518
4518
  get?: never;
4519
4519
  /**
4520
- * @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.
4520
+ * @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.
4521
4521
  *
4522
4522
  * Required scope: reservations:write
4523
4523
  */
@@ -5181,7 +5181,7 @@ export interface paths {
5181
5181
  */
5182
5182
  get: operations["getRate"];
5183
5183
  /**
5184
- * @description Update a tax rate
5184
+ * @description Update a tax rate. Posting accounts must remain active while the rate is used by an active recurring fee.
5185
5185
  *
5186
5186
  * Required scope: tax-rates:write
5187
5187
  */