@vrplatform/api 1.3.1-6519 → 1.3.1-6528

package/build/main/generated/v1.d.ts

@@ -3633,7 +3633,7 @@ export interface paths {
         };
         get?: never;
         /**
-         * @description Set Listing Parent. A child with a non-zero opening balance must be cleared before grouping. A current in-review child statement can join a matching published parent statement.
+         * @description Set a listing's group parent. Grouping requires compatible ownership and unlocked child history; a current in-review child statement can join a matching published parent statement.
          *
          *     Required scope: listings:write
          */
@@ -7154,20 +7154,20 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description Get a transaction. Ramp payout reads include the latest immutable provider attempt and server-owned payment and recovery action capabilities with disabled reasons.
+         * @description Get a transaction. Ramp expense and payout reads include the latest immutable provider attempt and server-owned payment and recovery action capabilities with disabled reasons.
          *
          *     Required scope: transactions:read
          */
         get: operations["getTransactionsById"];
         /**
-         * @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. A bank-record match alone still permits deposit and expense description, line account, party, listing, reservation, and expense-markup changes. Amount, date, root bank account, line creation, and line deletion require unmatching first. Books-closed and statement locks still take precedence. After the first Ramp payment attempt, ordinary payout mutations accept only description updates. A status-only archive or unarchive additionally requires durable Ramp bill archive or verified no-bill recovery evidence. 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. A uniqueRef already used by another team transaction returns a structured user error.
+         * @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. A bank-record match alone still permits deposit and expense description, line account, party, listing, reservation, and expense-markup changes. Amount, date, root bank account, line creation, and line deletion require unmatching first. Books-closed and statement locks still take precedence. After the first Ramp payment attempt, ordinary expense and payout mutations accept only description updates. A status-only archive or unarchive additionally requires durable Ramp bill archive or verified no-bill recovery evidence. 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. A uniqueRef already used by another team transaction returns a structured user error.
          *
          *     Required scope: transactions:write
          */
         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. Payouts with a Requested, Processing, or Paid Ramp payment cannot be deleted until the provider attempt becomes terminal. A concurrent duplicate delete returns the standard not-found response after the first request removes the transaction.
+         * @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. Expenses and payouts with Ramp payment history cannot be deleted. A concurrent duplicate delete returns the standard not-found response after the first request removes the transaction.
          *
          *     Required scope: transactions:delete
          */
@@ -7251,7 +7251,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @description Archive a failed, returned, or canceled Ramp bill before archiving payout accounting. Poll the returned `operationId` through `GET /operations/{id}`; paid payouts cannot be archived.
+         * @description Archive a failed, returned, or canceled Ramp bill before archiving expense or payout accounting. Poll the returned `operationId` through `GET /operations/{id}`; paid provider payments cannot be archived.
          *
          *     Required scope: transactions:write, ach-payments:execute
          */
@@ -7272,7 +7272,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @description Request cancellation of a requested or processing Ramp payment, optionally followed by payout accounting archive. Poll the returned `operationId` through `GET /operations/{id}`; Ramp remains authoritative about cancellation eligibility.
+         * @description Request cancellation of a requested or processing Ramp payment, optionally followed by transaction accounting archive. Poll the returned `operationId` through `GET /operations/{id}`; Ramp remains authoritative about cancellation eligibility.
          *
          *     Required scope: transactions:mark-paid, ach-payments:execute
          */
@@ -11115,7 +11115,7 @@ export interface operations {
                             /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                             attachmentIds?: string[] | null;
                             recurringTemplateId?: string | null;
-                            /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                            /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                             recreatedFromTransactionId?: string | null;
                             matchBankAccountLast4?: string | null;
                             id: string;
@@ -17964,7 +17964,7 @@ export interface operations {
                                         connectionId?: string | null;
                                         sourceId?: string | null;
                                         recurringTemplateId?: string | null;
-                                        /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                                        /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                                         recreatedFromTransactionId?: string | null;
                                         matchBankAccountLast4?: string | null;
                                     };
@@ -19148,7 +19148,7 @@ export interface operations {
                                     connectionId?: string | null;
                                     sourceId?: string | null;
                                     recurringTemplateId?: string | null;
-                                    /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                                    /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                                     recreatedFromTransactionId?: string | null;
                                     matchBankAccountLast4?: string | null;
                                 };
@@ -20839,7 +20839,7 @@ export interface operations {
                                 connectionId?: string | null;
                                 sourceId?: string | null;
                                 recurringTemplateId?: string | null;
-                                /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                                /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                                 recreatedFromTransactionId?: string | null;
                                 matchBankAccountLast4?: string | null;
                             };
@@ -22188,7 +22188,7 @@ export interface operations {
                                     connectionId?: string | null;
                                     sourceId?: string | null;
                                     recurringTemplateId?: string | null;
-                                    /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                                    /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                                     recreatedFromTransactionId?: string | null;
                                     matchBankAccountLast4?: string | null;
                                 };
@@ -35364,7 +35364,7 @@ export interface operations {
                                 } | null;
                                 sourceId?: string | null;
                                 recurringTemplateId?: string | null;
-                                /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                                /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                                 recreatedFromTransactionId?: string | null;
                                 matchBankAccountLast4?: string | null;
                                 id?: string;
@@ -35579,7 +35579,7 @@ export interface operations {
                                 } | null;
                                 sourceId?: string | null;
                                 recurringTemplateId?: string | null;
-                                /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                                /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                                 recreatedFromTransactionId?: string | null;
                                 matchBankAccountLast4?: string | null;
                                 id?: string;
@@ -130540,7 +130540,7 @@ export interface operations {
                         /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                         attachmentIds?: string[] | null;
                         recurringTemplateId?: string | null;
-                        /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                        /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                         recreatedFromTransactionId?: string | null;
                         matchBankAccountLast4?: string | null;
                         id: string;
@@ -148727,7 +148727,7 @@ export interface operations {
                             /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                             attachmentIds?: string[] | null;
                             recurringTemplateId?: string | null;
-                            /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                            /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                             recreatedFromTransactionId?: string | null;
                             matchBankAccountLast4?: string | null;
                             id: string;
@@ -148933,7 +148933,7 @@ export interface operations {
                                  */
                                 updatedAt: string;
                             } | null;
-                            /** @description Server-owned Ramp payout recovery capabilities. Permissions remain independently enforced. */
+                            /** @description Server-owned Ramp expense and payout recovery capabilities. Permissions remain independently enforced. */
                             providerPaymentActions: {
                                 pay: {
                                     /** @description Whether current provider and accounting state allows the action. */
@@ -149329,7 +149329,7 @@ export interface operations {
                     connectionId?: string | null;
                     sourceId?: string | null;
                     recurringTemplateId?: string | null;
-                    /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                    /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                     recreatedFromTransactionId?: string | null;
                     matchBankAccountLast4?: string | null;
                 };
@@ -149480,7 +149480,7 @@ export interface operations {
                         /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                         attachmentIds?: string[] | null;
                         recurringTemplateId?: string | null;
-                        /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                        /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                         recreatedFromTransactionId?: string | null;
                         matchBankAccountLast4?: string | null;
                         id: string;
@@ -151264,7 +151264,7 @@ export interface operations {
                         } | null;
                         sourceId?: string | null;
                         recurringTemplateId?: string | null;
-                        /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                        /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                         recreatedFromTransactionId?: string | null;
                         matchBankAccountLast4?: string | null;
                         id?: string;
@@ -154861,7 +154861,7 @@ export interface operations {
                             /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                             attachmentIds?: string[] | null;
                             recurringTemplateId?: string | null;
-                            /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                            /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                             recreatedFromTransactionId?: string | null;
                             matchBankAccountLast4?: string | null;
                             id: string;
@@ -155404,7 +155404,7 @@ export interface operations {
                         /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                         attachmentIds?: string[] | null;
                         recurringTemplateId?: string | null;
-                        /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                        /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                         recreatedFromTransactionId?: string | null;
                         matchBankAccountLast4?: string | null;
                         id: string;
@@ -155610,7 +155610,7 @@ export interface operations {
                              */
                             updatedAt: string;
                         } | null;
-                        /** @description Server-owned Ramp payout recovery capabilities. Permissions remain independently enforced. */
+                        /** @description Server-owned Ramp expense and payout recovery capabilities. Permissions remain independently enforced. */
                         providerPaymentActions: {
                             pay: {
                                 /** @description Whether current provider and accounting state allows the action. */
@@ -156218,7 +156218,7 @@ export interface operations {
                         /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                         attachmentIds?: string[] | null;
                         recurringTemplateId?: string | null;
-                        /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                        /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                         recreatedFromTransactionId?: string | null;
                         matchBankAccountLast4?: string | null;
                         id: string;
@@ -158444,7 +158444,7 @@ export interface operations {
                         /** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
                         attachmentIds?: string[] | null;
                         recurringTemplateId?: string | null;
-                        /** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
+                        /** @description Archived expense or payout replaced by this transaction. The source and every other transaction in its replacement chain must remain inactive. */
                         recreatedFromTransactionId?: string | null;
                         matchBankAccountLast4?: string | null;
                         id: string;