@vrplatform/api 1.3.1-6488 → 1.3.1-6500

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

@@ -4135,7 +4135,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description Get the normalized lifecycle status of one asynchronous operation owned by the requesting tenant. Payloads, errors, effect details, and runtime identifiers remain private. See https://docs.vrplatform.app/api/operation-status.
+         * @description Get the normalized lifecycle status of one public asynchronous operation owned by the requesting tenant, including provider-payment recovery. Payloads, errors, sync details, effect details, and runtime identifiers remain private. See https://docs.vrplatform.app/api/operation-status.
          *
          *     Required scope: operations:read
          */
@@ -5600,7 +5600,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @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. If applying only unlocked changes would split an otherwise balanced journal group, the refresh returns a structured journalEntries lock and writes nothing. If active reservation lines have no account mapping, the response asks the caller to map or exclude them in Reservation Accounts and returns the affected line types in structured error context. 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.
+         * @description Regenerate reservation journal entries. Recomputes postings from the current reservation financials for the given ids (or the whole portfolio) and rewrites unlocked entries; explicit ids complete inline and total counts refreshed reservations, while omitting ids queues portfolio work and total counts queued reservations. lockPolicy controls how lock-flagged reservations are handled, while books-closed and owner-statement attachment locks always apply. If applying only unlocked changes would split an otherwise balanced journal group, the refresh returns a structured journalEntries lock and writes nothing. If active reservation lines have no account mapping, the response asks the caller to map or exclude them in Reservation Accounts and returns the affected line types in structured error context. 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.
          *
          *     Required scope: reservations:post-journals
          */
@@ -6652,7 +6652,7 @@ export interface paths {
         };
         get?: never;
         /**
-         * @description Replace the UI permission bundles assigned to a team member. Requires UI Permission Roles and the team-member-roles:manage permission, rejects self-updates, and keeps the legacy role field synchronized during migration.
+         * @description Replace the UI permission bundles assigned to a team member. Self-updates are allowed, but the final direct access manager cannot remove that access.
          *
          *     Required scope: team-member-roles:manage
          */
@@ -7251,7 +7251,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @description Archive a failed, returned, or canceled Ramp bill and then archive the payout accounting. Paid payouts cannot be archived. The provider mutation completes before journal entries are made inactive.
+         * @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.
          *
          *     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. Ramp is authoritative about cancellation eligibility. archivePayout=true first validates local accounting, then archives the payout only after the Ramp bill archive is durable. archivePayout=false stops money movement without changing payout accounting.
+         * @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.
          *
          *     Required scope: transactions:mark-paid, ach-payments:execute
          */
@@ -17632,9 +17632,13 @@ export interface operations {
                 reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
                 matchedByBankRule?: boolean;
                 includeBalanceRecords?: boolean;
-                /** @description Include bank-rule suggestions; defaults to true when includeMatchingTransactions is set */
+                /** @description Include bank-rule suggestions; defaults to true with the deprecated includeMatchingTransactions parameter */
                 includeMatchingRules?: boolean;
-                /** @description Include matching transactions, optionally with max days offset */
+                /** @description Include ordered exact matching transaction sets */
+                includeMatchingTransaction?: boolean;
+                /** @description Maximum date offset for exact transaction suggestions; defaults to seven days. Multi-transaction sets remain limited to seven days. */
+                matchingTransactionDaysOffset?: number;
+                /** @description Deprecated: use includeMatchingTransaction and matchingTransactionDaysOffset. */
                 includeMatchingTransactions?: string;
                 hasMatchingTransactions?: boolean;
                 reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
@@ -17780,6 +17784,104 @@ export interface operations {
                                     shortRef?: string | null;
                                 }[];
                             }[] | null;
+                            /** @description Ordered exact transaction sets matching this bank record */
+                            matchingTransactionSets?: {
+                                /** @description Eligible transactions whose signed amounts form this set */
+                                transactions: {
+                                    id: string;
+                                    /** @enum {string} */
+                                    status: "active" | "inactive";
+                                    /** @description Value in cents (100 = 1€) */
+                                    amount: number;
+                                    account?: {
+                                        id: string;
+                                        name: string;
+                                        uniqueRef?: string | null;
+                                        /** @enum {string} */
+                                        status: "active" | "inactive";
+                                    } | null;
+                                    date: string;
+                                    description: string;
+                                    /** @description Currency in ISO 4217 format, will be converted to lowercase */
+                                    currency: string;
+                                    /** @enum {string} */
+                                    type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
+                                    isOpeningBalance: boolean;
+                                    contact?: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        name?: string | null;
+                                        firstName?: string | null;
+                                        uniqueRef?: string | null;
+                                        shortRef?: string | null;
+                                        email?: string | null;
+                                        /** @enum {string} */
+                                        type: "owner" | "vendor";
+                                    } | null;
+                                    connection?: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        name: string;
+                                        /** @enum {string} */
+                                        status: "active" | "inactive";
+                                        uniqueRef?: string | null;
+                                        appId: string;
+                                    } | null;
+                                    uniqueRef?: string | null;
+                                    shortRef?: string | null;
+                                    recurringTemplate?: {
+                                        id: string;
+                                    } | null;
+                                    /** @description Absolute difference in days from the bank record date */
+                                    dateOffset: number;
+                                    /** @description Structured explanation for the transaction suggestion */
+                                    matchDetails: {
+                                        /** @description Whether another candidate has the same date offset */
+                                        ambiguous: boolean;
+                                        /** @description Candidate amount minus bank record amount, in cents; exact matches return zero */
+                                        amountDifference: number;
+                                        /** @description Transaction date used to evaluate the bank-record date window */
+                                        matchingDate: string;
+                                        /** @description Maximum eligible difference in days */
+                                        maxDateOffset: number;
+                                        /** @description Typed criteria satisfied by this candidate */
+                                        reasons: ("exactAmount" | "sameBankAccount" | "bankAccountAssignedOnMatch" | "dateWithinWindow")[];
+                                    };
+                                    /** @description Unique listings referenced by the transaction lines */
+                                    listings: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        name: string;
+                                        uniqueRef?: string | null;
+                                        shortRef?: string | null;
+                                    }[];
+                                    /** @description Unique reservations referenced by the transaction lines */
+                                    reservations: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        confirmationCode?: string | null;
+                                        uniqueRef?: string | null;
+                                        shortRef?: string | null;
+                                    }[];
+                                }[];
+                                /** @description Combined signed transaction amount in cents */
+                                combinedAmount: number;
+                                /** @description Currency in ISO 4217 format, will be converted to lowercase */
+                                currency: string;
+                                dateEvidence: {
+                                    /** @description Sum of member date offsets used for deterministic ranking */
+                                    totalDateOffset: number;
+                                    /** @description Largest member date offset in the group */
+                                    maxDateOffset: number;
+                                };
+                                matchDetails: {
+                                    /** @description Whether another transaction set has the same member count and total date offset */
+                                    ambiguous: boolean;
+                                    /** @description Combined set amount minus bank record amount, in cents; exact suggestions return zero */
+                                    amountDifference: number;
+                                    reasons: ("exactAmount" | "sameCurrency" | "allTransactionsEligible" | "dateWithinWindow")[];
+                                };
+                            }[] | null;
                             matchingRules?: {
                                 rule: {
                                     /** Format: uuid */
@@ -18460,9 +18562,13 @@ export interface operations {
                 reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
                 matchedByBankRule?: boolean;
                 includeBalanceRecords?: boolean;
-                /** @description Include bank-rule suggestions; defaults to true when includeMatchingTransactions is set */
+                /** @description Include bank-rule suggestions; defaults to true with the deprecated includeMatchingTransactions parameter */
                 includeMatchingRules?: boolean;
-                /** @description Include matching transactions, optionally with max days offset */
+                /** @description Include ordered exact matching transaction sets */
+                includeMatchingTransaction?: boolean;
+                /** @description Maximum date offset for exact transaction suggestions; defaults to seven days. Multi-transaction sets remain limited to seven days. */
+                matchingTransactionDaysOffset?: number;
+                /** @description Deprecated: use includeMatchingTransaction and matchingTransactionDaysOffset. */
                 includeMatchingTransactions?: string;
                 hasMatchingTransactions?: boolean;
                 reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
@@ -18716,9 +18822,13 @@ export interface operations {
     getBankRecordsById: {
         parameters: {
             query?: {
-                /** @description Include bank-rule suggestions; defaults to true when includeMatchingTransactions is set */
+                /** @description Include bank-rule suggestions; defaults to true with the deprecated includeMatchingTransactions parameter */
                 includeMatchingRules?: boolean;
-                /** @description Include matching transactions, optionally with max days offset */
+                /** @description Include ordered exact matching transaction sets */
+                includeMatchingTransaction?: boolean;
+                /** @description Maximum date offset for exact transaction suggestions; defaults to seven days. Multi-transaction sets remain limited to seven days. */
+                matchingTransactionDaysOffset?: number;
+                /** @description Deprecated: use includeMatchingTransaction and matchingTransactionDaysOffset. */
                 includeMatchingTransactions?: string;
             };
             header?: never;
@@ -18858,6 +18968,104 @@ export interface operations {
                                 shortRef?: string | null;
                             }[];
                         }[] | null;
+                        /** @description Ordered exact transaction sets matching this bank record */
+                        matchingTransactionSets?: {
+                            /** @description Eligible transactions whose signed amounts form this set */
+                            transactions: {
+                                id: string;
+                                /** @enum {string} */
+                                status: "active" | "inactive";
+                                /** @description Value in cents (100 = 1€) */
+                                amount: number;
+                                account?: {
+                                    id: string;
+                                    name: string;
+                                    uniqueRef?: string | null;
+                                    /** @enum {string} */
+                                    status: "active" | "inactive";
+                                } | null;
+                                date: string;
+                                description: string;
+                                /** @description Currency in ISO 4217 format, will be converted to lowercase */
+                                currency: string;
+                                /** @enum {string} */
+                                type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
+                                isOpeningBalance: boolean;
+                                contact?: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    name?: string | null;
+                                    firstName?: string | null;
+                                    uniqueRef?: string | null;
+                                    shortRef?: string | null;
+                                    email?: string | null;
+                                    /** @enum {string} */
+                                    type: "owner" | "vendor";
+                                } | null;
+                                connection?: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    name: string;
+                                    /** @enum {string} */
+                                    status: "active" | "inactive";
+                                    uniqueRef?: string | null;
+                                    appId: string;
+                                } | null;
+                                uniqueRef?: string | null;
+                                shortRef?: string | null;
+                                recurringTemplate?: {
+                                    id: string;
+                                } | null;
+                                /** @description Absolute difference in days from the bank record date */
+                                dateOffset: number;
+                                /** @description Structured explanation for the transaction suggestion */
+                                matchDetails: {
+                                    /** @description Whether another candidate has the same date offset */
+                                    ambiguous: boolean;
+                                    /** @description Candidate amount minus bank record amount, in cents; exact matches return zero */
+                                    amountDifference: number;
+                                    /** @description Transaction date used to evaluate the bank-record date window */
+                                    matchingDate: string;
+                                    /** @description Maximum eligible difference in days */
+                                    maxDateOffset: number;
+                                    /** @description Typed criteria satisfied by this candidate */
+                                    reasons: ("exactAmount" | "sameBankAccount" | "bankAccountAssignedOnMatch" | "dateWithinWindow")[];
+                                };
+                                /** @description Unique listings referenced by the transaction lines */
+                                listings: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    name: string;
+                                    uniqueRef?: string | null;
+                                    shortRef?: string | null;
+                                }[];
+                                /** @description Unique reservations referenced by the transaction lines */
+                                reservations: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    confirmationCode?: string | null;
+                                    uniqueRef?: string | null;
+                                    shortRef?: string | null;
+                                }[];
+                            }[];
+                            /** @description Combined signed transaction amount in cents */
+                            combinedAmount: number;
+                            /** @description Currency in ISO 4217 format, will be converted to lowercase */
+                            currency: string;
+                            dateEvidence: {
+                                /** @description Sum of member date offsets used for deterministic ranking */
+                                totalDateOffset: number;
+                                /** @description Largest member date offset in the group */
+                                maxDateOffset: number;
+                            };
+                            matchDetails: {
+                                /** @description Whether another transaction set has the same member count and total date offset */
+                                ambiguous: boolean;
+                                /** @description Combined set amount minus bank record amount, in cents; exact suggestions return zero */
+                                amountDifference: number;
+                                reasons: ("exactAmount" | "sameCurrency" | "allTransactionsEligible" | "dateWithinWindow")[];
+                            };
+                        }[] | null;
                         matchingRules?: {
                             rule: {
                                 /** Format: uuid */
@@ -35062,6 +35270,7 @@ export interface operations {
                                 };
                             }[];
                             transaction?: {
+                                /** @description Required for every transaction except transfers */
                                 description?: string;
                                 status?: ("active" | "inactive") | null;
                                 /** @description Root bank account; the source account for transfers */
@@ -35276,6 +35485,7 @@ export interface operations {
                                 };
                             }[];
                             transaction?: {
+                                /** @description Required for every transaction except transfers */
                                 description?: string;
                                 status?: ("active" | "inactive") | null;
                                 /** @description Root bank account; the source account for transfers */
@@ -87693,9 +87903,9 @@ export interface operations {
                         /** Format: uuid */
                         id: string;
                         /** @enum {string} */
-                        type: "vri-statement-import";
+                        type: "vri-statement-import" | "provider-payment-recovery";
                         /** @enum {string} */
-                        status: "queued" | "running" | "completed" | "failed";
+                        status: "queued" | "running" | "completed" | "failed" | "canceled";
                         /**
                          * Format: date-time
                          * @description Timestamp string with date, time, milliseconds, and timezone.
@@ -149021,6 +149231,7 @@ export interface operations {
         requestBody?: {
             content: {
                 "application/json": {
+                    /** @description Required for every transaction except transfers */
                     description?: string;
                     status?: ("active" | "inactive") | null;
                     /** @description Root bank account; the source account for transfers */
@@ -150956,6 +151167,7 @@ export interface operations {
                     connectionId: string;
                     createOnly?: boolean;
                     data: {
+                        /** @description Required for every transaction except transfers */
                         description?: string;
                         status?: ("active" | "inactive") | null;
                         /** @description Root bank account; the source account for transfers */
@@ -157533,15 +157745,16 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** Format: uuid */
-                        providerPaymentId: string;
-                        /** Format: uuid */
-                        syncId: string;
-                        /** @enum {string} */
-                        operation: "cancel" | "archive";
-                        archivePayout: boolean;
-                        /** @constant */
-                        status: "requested";
+                        /**
+                         * Format: uuid
+                         * @description Public operation ID for GET /operations/{id} polling.
+                         */
+                        operationId: string;
+                        /**
+                         * @description Current asynchronous operation status.
+                         * @enum {string}
+                         */
+                        status: "queued" | "running";
                     };
                 };
             };
@@ -157797,15 +158010,16 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** Format: uuid */
-                        providerPaymentId: string;
-                        /** Format: uuid */
-                        syncId: string;
-                        /** @enum {string} */
-                        operation: "cancel" | "archive";
-                        archivePayout: boolean;
-                        /** @constant */
-                        status: "requested";
+                        /**
+                         * Format: uuid
+                         * @description Public operation ID for GET /operations/{id} polling.
+                         */
+                        operationId: string;
+                        /**
+                         * @description Current asynchronous operation status.
+                         * @enum {string}
+                         */
+                        status: "queued" | "running";
                     };
                 };
             };