@vrplatform/api 1.3.1-stage.4424 → 1.3.1-stage.4427

package/src/generated/v1.ts

@@ -1124,7 +1124,7 @@ export interface paths {
         };
         /** @description Retrieve opening balance accounts payable summary by party */
         get: operations["getGeneralLedgerOpeningBalancesAccountsPayable"];
-        /** @description Update opening balance accounts payable by party */
+        /** @description Update opening balance accounts payable by party. Replaces the accounts payable opening balance postings for the given party as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
         put: operations["putGeneralLedgerOpeningBalancesAccountsPayable"];
         post?: never;
         delete?: never;
@@ -1142,7 +1142,7 @@ export interface paths {
         };
         /** @description Retrieve opening balance accounts receivable / deferred revenue summary */
         get: operations["getGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
-        /** @description Update opening balance accounts receivable / deferred revenue summary */
+        /** @description Update opening balance accounts receivable / deferred revenue. Replaces the receivable and deferred revenue opening balance postings as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
         put: operations["putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
         post?: never;
         delete?: never;
@@ -1160,7 +1160,7 @@ export interface paths {
         };
         /** @description Retrieve opening balance advanced deposits summary */
         get: operations["getGeneralLedgerOpeningBalancesAdvancedDeposits"];
-        /** @description Update opening balance advanced deposits */
+        /** @description Update opening balance advanced deposits. Replaces the advanced deposit opening balance postings for stays that were paid before the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
         put: operations["putGeneralLedgerOpeningBalancesAdvancedDeposits"];
         post?: never;
         delete?: never;
@@ -1176,7 +1176,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Retrieve synced payments/refunds for review advanced deposits modal */
+        /** @description Retrieve synced payments and refunds that are candidates for advanced deposit opening balances */
         get: operations["getGeneralLedgerOpeningBalancesAdvancedDepositsSyncedPaymentsRefunds"];
         put?: never;
         post?: never;
@@ -1195,7 +1195,7 @@ export interface paths {
         };
         /** @description Retrieve opening balance tax payable summary */
         get: operations["getGeneralLedgerOpeningBalancesTaxPayable"];
-        /** @description Update opening balance tax payable */
+        /** @description Update opening balance tax payable. Replaces the tax payable opening balance postings as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
         put: operations["putGeneralLedgerOpeningBalancesTaxPayable"];
         post?: never;
         delete?: never;
@@ -1213,7 +1213,7 @@ export interface paths {
         };
         /** @description Retrieve opening trial balance */
         get: operations["getGeneralLedgerOpeningTrialBalance"];
-        /** @description Update opening trial balance */
+        /** @description Update the manual opening trial balance. Replaces the manually entered opening balance postings that seed each account as of the go-live date; existing journal activity after that date is not touched. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
         put: operations["putGeneralLedgerOpeningTrialBalance"];
         post?: never;
         delete?: never;
@@ -1717,7 +1717,7 @@ export interface paths {
         /** @description List listing ownership periods */
         get: operations["getListingsOwnershipPeriods"];
         put?: never;
-        /** @description Create a listing ownership period */
+        /** @description Create a listing ownership period. Periods cannot overlap; onConflict controls how date-range conflicts with existing periods are resolved (updateExisting by default, or error / adjustInsertingItem). Journal entries in the range are relinked to the new period, and setListingInactive=true marks entries in the range inactive so they are excluded from the books and owner statements. Changes touching books-closed or statement-locked months are rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/portfolio. */
         post: operations["postListingsOwnershipPeriods"];
         delete?: never;
         options?: never;
@@ -1734,10 +1734,10 @@ export interface paths {
         };
         /** @description Get a listing ownership period by ID */
         get: operations["getListingsOwnershipPeriodsById"];
-        /** @description Update a listing ownership period by ID */
+        /** @description Update a listing ownership period by ID. Date-range changes relink journal entries to the adjusted period, with onConflict controlling how overlaps with neighboring periods are resolved (updateExisting by default). Toggling setListingInactive flips the active flag of the journal entries in the range and refreshes affected reservation totals. Changes touching books-closed or statement-locked months are rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/portfolio. */
         put: operations["putListingsOwnershipPeriodsById"];
         post?: never;
-        /** @description Delete a listing ownership period by ID */
+        /** @description Delete a listing ownership period by ID. When deleting the last period, the default onLast=extendPrevious extends the previous period to cover the deleted range so journal entries keep an owning period; onLast=none leaves the gap open. Deletion is rejected when the period is locked by closed books or finalized statements unless onLocked=archive is passed, which archives instead of deleting. Supports dryRun. See https://docs.vrplatform.app/guides/build/portfolio. */
         delete: operations["deleteListingsOwnershipPeriodsById"];
         options?: never;
         head?: never;
@@ -3003,7 +3003,7 @@ export interface paths {
         /** @description Get reservations */
         get: operations["getReservations"];
         put?: never;
-        /** @description Create reservation */
+        /** @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations. */
         post: operations["postReservations"];
         delete?: never;
         options?: never;
@@ -3054,7 +3054,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Generate reservation journal entries */
+        /** @description Regenerate reservation journal entries. Recomputes postings from the current reservation financials for the given ids (or the whole portfolio) and rewrites unlocked entries; lockPolicy controls how lock-flagged reservations are handled, while books-closed and owner-statement attachment locks always apply. bypassStatementPeriod is only supported for a single-reservation refresh. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. See https://docs.vrplatform.app/guides/build/reservations. */
         post: operations["postReservationsJournalEntries"];
         delete?: never;
         options?: never;
@@ -3123,10 +3123,10 @@ export interface paths {
         };
         /** @description Get reservation By ID */
         get: operations["getReservationsById"];
-        /** @description Update Reservation By ID */
+        /** @description Update a reservation by ID. Financial changes refresh the reservation journal inline; a reservation locked by closed books, a finalized statement period, or entries attached to an owner statement rejects them unless the change posts via a generalLedgerPostingAt date after the locked range. Owner API keys cannot update reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#editability. */
         put: operations["putReservationsById"];
         post?: never;
-        /** @description Delete reservation By ID */
+        /** @description Delete a reservation by ID. Removes the reservation and its journal entries; deletion is rejected when the reservation is locked by closed books or statement attachments unless onLocked=archive is passed, which archives it instead while keeping the locked postings intact. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#editability. */
         delete: operations["deleteReservationsById"];
         options?: never;
         head?: never;
@@ -3141,7 +3141,7 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** @description Update reservation general ledger status (active/inactive) */
+        /** @description Update reservation general ledger status (active/inactive). Setting inactive flips the active flag of the reservation journal entries so they are excluded from the books and owner statements; setting active restores them. The change is rejected for entries locked by closed books or an owner statement attachment. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations. */
         put: operations["putReservationsByIdStatus"];
         post?: never;
         delete?: never;
@@ -3159,7 +3159,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Create a reservation adjustment line */
+        /** @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations: give the line a generalLedgerPostingAt date after the locked range and it posts into the open month instead of being rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates. */
         post: operations["postReservationsByReservationIdAdjustments"];
         delete?: never;
         options?: never;
@@ -3175,10 +3175,10 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** @description Update a reservation adjustment line */
+        /** @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. */
         put: operations["putReservationsByReservationIdAdjustmentsById"];
         post?: never;
-        /** @description Delete a reservation adjustment line */
+        /** @description Delete a reservation adjustment line. Removes the adjustment and its journal entries and refreshes the reservation journal inline; deletion is rejected when the entries fall into a books-closed month or are attached to an owner statement. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates. */
         delete: operations["deleteReservationsByReservationIdAdjustmentsById"];
         options?: never;
         head?: never;
@@ -3212,7 +3212,7 @@ export interface paths {
         /** @description Get Statements List. Get Statements, either by year or dateRange + a single listing or owner or by month */
         get: operations["getStatements"];
         put?: never;
-        /** @description Create Statements */
+        /** @description Create an owner statement for an ownership period and month. Freezes the statement layout, and creating with a finalized status (inReview or published) attaches the period journal entries to the statement, locking them against further changes. Statements with blocking issues cannot be created in a non-draft status, and publishing out of month order is rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements. */
         post: operations["postStatements"];
         delete?: never;
         options?: never;
@@ -3244,7 +3244,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get Owner Statement CSV export (detailed) */
+        /** @description Get owner statement detailed CSV export for a single ownership period and month. Renders the projected statement even when no statement record has been persisted yet, so drafts and previews can be exported. Returns a short-lived download URL. */
         get: operations["getStatementsByPeriodCsv"];
         put?: never;
         post?: never;
@@ -3261,7 +3261,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get Owner Statement CSV export */
+        /** @description Get owner statement list CSV export. Produces a summary CSV with one row per matched statement (status, payment, and balance columns) for a month, year, date range, or explicit statement IDs. Returns a short-lived download URL. */
         get: operations["getStatementsCsv"];
         put?: never;
         post?: never;
@@ -3278,7 +3278,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get Owner Statement CSV export (detailed) */
+        /** @description Get owner statement detailed CSV export. Produces a combined line-level CSV across all statements matched by the list filters, with rows rendered through the statement layout. Returns a short-lived download URL. */
         get: operations["getStatementsDetailCsv"];
         put?: never;
         post?: never;
@@ -3402,7 +3402,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Pay a property manager out */
+        /** @description Pay the property manager out. Creates a payout transaction with a single manager-party line against either a bank account (bankAccountId) or an explicit ledger account (lineAccountId) - exactly one of the two must be provided - and posts the resulting journal entries on the payout date. Creation respects books-closed and statement locks and supports dryRun. See https://docs.vrplatform.app/guides/build/statements. */
         post: operations["postStatementsManagerPay"];
         delete?: never;
         options?: never;
@@ -3417,7 +3417,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get Owner Statement by ID */
+        /** @description Get owner statement PDF by ownership period and month */
         get: operations["getStatementsPdf"];
         put?: never;
         post?: never;
@@ -3434,7 +3434,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get Owner Statements ZIP by month or listing month range */
+        /** @description Get owner statements PDF ZIP by month or listing month range */
         get: operations["getStatementsPdfBatch"];
         put?: never;
         post?: never;
@@ -3470,10 +3470,10 @@ export interface paths {
         };
         /** @description Get Statements by period. Get Statements by ownership period, can be multiple if multiple currencies are found in a month */
         get: operations["getStatementsById"];
-        /** @description Update Statements by Id */
+        /** @description Update an owner statement status (draft, inReview, published). Moving to a finalized status attaches the period journal entries to the statement and locks writes that reference the same ownership period; moving back to draft detaches them again. Transitions are rejected when the statement has blocking issues, when a later statement for the period is already finalized, or when a prior month is still unfinalized. Publishing can optionally email owners via emailDelivery. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements#status-transitions. */
         put: operations["putStatementsById"];
         post?: never;
-        /** @description Update Statements by Id */
+        /** @description Delete an owner statement by ID. Deleting a finalized statement is rejected unless onLocked=unlockAndDelete is passed, which detaches the attached journal entries before deleting; historic-ledger entries that exist only for the statement are removed with it. Books-closed periods still deny the operation. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements. */
         delete: operations["deleteStatementsById"];
         options?: never;
         head?: never;
@@ -3489,7 +3489,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Pay a statement */
+        /** @description Pay an owner statement. Creates one payout transfer transaction per ownership member, split by ownership percentage, with each line referencing the paid statement; the resulting journal entries post on the payout date and are consumed by the statement of that month. Omitting amount pays the full net income and is rejected with 409 if an active payout already exists for the statement; pass an explicit amount to record additional partial payments. Payout creation respects books-closed and statement-period locks and supports dryRun. See https://docs.vrplatform.app/guides/build/statements#pay-a-published-statement. */
         post: operations["postStatementsByIdPay"];
         delete?: never;
         options?: never;
@@ -3699,7 +3699,7 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** @description Update the books closing date of the current team (the team in scope via the x-team-id header) */
+        /** @description Update the books closing date of the current team (the team in scope via the x-team-id header). Books closed is the hard accounting lock: journal-affecting writes to reservations, transactions, statements, and ownership periods dated on or before booksClosedAt are rejected across the API. Set booksClosedAt to null to reopen the books. See https://docs.vrplatform.app/guides/build/accounting-administration. */
         put: operations["putTeamBooksClosing"];
         post?: never;
         delete?: never;
@@ -3732,9 +3732,9 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get the current team VRPilot Onboarding Guide state */
+        /** @description Get the current team's onboarding guide state */
         get: operations["getTeamGuidesOnboarding"];
-        /** @description Update the current team VRPilot Onboarding Guide state */
+        /** @description Update the current team's onboarding guide state */
         put: operations["putTeamGuidesOnboarding"];
         post?: never;
         delete?: never;
@@ -3909,7 +3909,7 @@ export interface paths {
         /** @description Transactions List */
         get: operations["getTransactions"];
         put?: never;
-        /** @description Create a transaction. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/build/transactions#decision-table. For expense attachments, first upload each file with POST /transactions/attachments, then pass the returned ids in attachmentIds. Attachments are only supported for expense transactions. */
+        /** @description Create a transaction. Journal entries post inline per line; creation into a books-closed month or a statement-locked listing period is rejected. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, first upload each file with POST /transactions/attachments, then pass the returned ids in attachmentIds. Attachments are only supported for expense transactions. */
         post: operations["postTransactions"];
         delete?: never;
         options?: never;
@@ -4029,7 +4029,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Regenerate transaction journal entries. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. */
+        /** @description Regenerate transaction journal entries. Recomputes postings from the current transaction lines for the given ids, listings, or date and rewrites unlocked entries; books-closed and owner-statement attachment locks always apply. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. See https://docs.vrplatform.app/guides/build/transactions. */
         post: operations["postTransactionsJournalEntries"];
         delete?: never;
         options?: never;
@@ -4151,7 +4151,7 @@ export interface paths {
         };
         /** @description Transactions List */
         get: operations["getTransactionsById"];
-        /** @description Update a transaction by ID. Changing line account, assignment, listing, or reservation context can recompute a default or forced party. See https://docs.vrplatform.app/build/transactions#decision-table. For expense attachments, pass attachmentIds to replace the attached set. Omit attachmentIds to keep current attachments. Attachments are only supported for expense transactions. */
+        /** @description Update a transaction by ID. Locks apply per line: lines whose journal entries are attached to an owner statement or fall into a books-closed month are locked while the remaining lines stay editable. Changing line account, assignment, listing, or reservation context can recompute a default or forced party. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, pass attachmentIds to replace the attached set. Omit attachmentIds to keep current attachments. Attachments are only supported for expense transactions. */
         put: operations["putTransactionsById"];
         post?: never;
         /** @description Delete a transaction by ID. Use onLocked=archive to archive eligible locked transactions; the option does not bypass statement, books-closed, or reconciliation rules. */
@@ -4169,7 +4169,7 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** @description Update a transaction line by ID. Account, assignment, listing, and reservation changes can recompute a default or forced party. See https://docs.vrplatform.app/build/transactions#decision-table. */
+        /** @description Update a transaction line by ID. Account, assignment, listing, and reservation changes can recompute a default or forced party. See https://docs.vrplatform.app/guides/build/transactions#decision-table. */
         put: operations["putTransactionsByTransactionIdLinesById"];
         post?: never;
         delete?: never;
@@ -4593,6 +4593,7 @@ export interface operations {
     postAccounts: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -5449,6 +5450,7 @@ export interface operations {
     putAccountsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -5730,6 +5732,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -5893,6 +5896,7 @@ export interface operations {
     postAccountsByIdBankingInit: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -9419,6 +9423,7 @@ export interface operations {
     batchBankAccounts: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -9792,6 +9797,7 @@ export interface operations {
     updateBankAccount: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -10368,6 +10374,7 @@ export interface operations {
     postBankRecordsBatch: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -11091,6 +11098,7 @@ export interface operations {
     putBankRecordsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -11260,6 +11268,7 @@ export interface operations {
     deleteBankRecordsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -13023,6 +13032,7 @@ export interface operations {
     postBankRulesByIdRun: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -17087,6 +17097,7 @@ export interface operations {
     postContacts: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -17333,6 +17344,7 @@ export interface operations {
     postContactsBatch: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -17918,6 +17930,7 @@ export interface operations {
     putContactsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -18166,6 +18179,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -22658,6 +22672,7 @@ export interface operations {
     postGeneralLedgerHistorical: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -23003,6 +23018,7 @@ export interface operations {
     putGeneralLedgerOpeningBalancesAccountsPayable: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -23337,6 +23353,7 @@ export interface operations {
     putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -23682,6 +23699,7 @@ export interface operations {
     putGeneralLedgerOpeningBalancesAdvancedDeposits: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -24214,6 +24232,7 @@ export interface operations {
     putGeneralLedgerOpeningBalancesTaxPayable: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -24581,6 +24600,7 @@ export interface operations {
     putGeneralLedgerOpeningTrialBalance: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -31010,6 +31030,7 @@ export interface operations {
     postListings: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -31364,6 +31385,7 @@ export interface operations {
     postListingsBatch: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -32320,6 +32342,7 @@ export interface operations {
     postListingsOwnershipPeriods: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -32699,6 +32722,7 @@ export interface operations {
     putListingsOwnershipPeriodsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -32901,6 +32925,7 @@ export interface operations {
             query?: {
                 onLocked?: "error" | "archive";
                 onLast?: "extendPrevious" | "none";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -33371,6 +33396,7 @@ export interface operations {
     putListingsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -33728,6 +33754,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -34053,6 +34080,7 @@ export interface operations {
     putListingsByIdOpeningBalance: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -34225,6 +34253,7 @@ export interface operations {
     putListingsByIdParent: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -34538,6 +34567,7 @@ export interface operations {
     deleteListingsByIdParent: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -40938,6 +40968,7 @@ export interface operations {
     postRecurringFees: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -41418,6 +41449,7 @@ export interface operations {
     postRecurringFeesListingPeriods: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -41603,6 +41635,7 @@ export interface operations {
     putRecurringFeesListingPeriodsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -41789,6 +41822,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -42524,6 +42558,7 @@ export interface operations {
     putRecurringFeesById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -42815,6 +42850,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -55520,6 +55556,7 @@ export interface operations {
     postReservations: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -56128,6 +56165,7 @@ export interface operations {
                  * @description Deprecated: use allowReferenceChange
                  */
                 noReferenceChange?: boolean;
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -57999,6 +58037,7 @@ export interface operations {
     putReservationsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -58677,6 +58716,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -58840,6 +58880,7 @@ export interface operations {
     putReservationsByIdStatus: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -59008,6 +59049,7 @@ export interface operations {
     postReservationsByReservationIdAdjustments: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -59577,6 +59619,7 @@ export interface operations {
     putReservationsByReservationIdAdjustmentsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -60146,6 +60189,7 @@ export interface operations {
     deleteReservationsByReservationIdAdjustmentsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -61415,6 +61459,7 @@ export interface operations {
     postStatements: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -64773,6 +64818,7 @@ export interface operations {
     postStatementsHistorical: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -66790,6 +66836,7 @@ export interface operations {
     putStatementsLinesByLineIdDescription: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -66957,6 +67004,7 @@ export interface operations {
     postStatementsManagerPay: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -69343,6 +69391,7 @@ export interface operations {
     putStatementsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -70767,6 +70816,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "unlockAndDelete";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -70932,6 +70982,7 @@ export interface operations {
     postStatementsByIdPay: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -73137,6 +73188,7 @@ export interface operations {
     createRate: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -73499,6 +73551,7 @@ export interface operations {
     updateRate: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -73693,6 +73746,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -75472,6 +75526,7 @@ export interface operations {
     postTeamInit: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -79507,6 +79562,7 @@ export interface operations {
     postTransactions: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -80717,6 +80773,7 @@ export interface operations {
     postTransactionsBatch: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -82211,6 +82268,7 @@ export interface operations {
     postTransactionsRecurringTemplates: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -83100,6 +83158,7 @@ export interface operations {
     putTransactionsRecurringTemplatesById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -83481,6 +83540,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive" | "detach";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -83644,6 +83704,7 @@ export interface operations {
     postTransactionsRecurringTemplatesByIdRun: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -84544,6 +84605,7 @@ export interface operations {
     putTransactionsById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -85169,6 +85231,7 @@ export interface operations {
         parameters: {
             query?: {
                 onLocked?: "error" | "archive";
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;
@@ -85328,6 +85391,7 @@ export interface operations {
     putTransactionsByTransactionIdLinesById: {
         parameters: {
             query?: {
+                /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
                 dryRun?: boolean;
             };
             header?: never;