@vrplatform/api 1.3.1-stage.2140 → 1.3.1-stage.2142

package/src/generated/v1.ts

@@ -409,7 +409,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Preview an unsaved bank rule against one bank record */
+        /** @description Preview an unsaved bank rule against unmatched bank records it would affect */
         post: operations["postBankRulesPreview"];
         delete?: never;
         options?: never;
@@ -2406,6 +2406,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/statements/csv/detailed": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get Owner Statement CSV export (detailed) */
+        get: operations["getStatementsCsvDetailed"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/statements/layouts": {
         parameters: {
             query?: never;
@@ -7170,78 +7187,13 @@ export interface operations {
                                     /** Format: uuid */
                                     id: string;
                                     name: string;
-                                    /** @enum {string} */
-                                    status: "active" | "inactive";
                                     priority: number;
                                     /** @enum {string} */
                                     transactionType: "deposit" | "expense";
                                     /** @enum {string} */
                                     mode: "suggest" | "autoCreateAndMatch";
-                                    descriptionOperator?: ("contains" | "equals" | "startsWith") | null;
-                                    descriptionValue?: string | null;
-                                    amountMinCent?: number | null;
-                                    amountMaxCent?: number | null;
-                                    descriptionOverride?: string | null;
-                                    usePriorMonthEnd: boolean;
-                                    version: number;
-                                    vendorContact?: {
-                                        /** Format: uuid */
-                                        id: string;
-                                        name?: string | null;
-                                        firstName?: string | null;
-                                        uniqueRef?: string | null;
-                                        shortRef?: string | null;
-                                    } | null;
-                                    accounts: {
-                                        id: string;
-                                        name: string;
-                                        uniqueRef?: string | null;
-                                        /** @enum {string} */
-                                        status: "active" | "inactive";
-                                    }[];
-                                    lines: {
-                                        /** Format: uuid */
-                                        id: string;
-                                        sortOrder: number;
-                                        /** @enum {string} */
-                                        splitMode: "fixed" | "percentage" | "remainder";
-                                        fixedCentAmount?: number | null;
-                                        percentageBps?: number | null;
-                                        party?: ("owners" | "manager") | null;
-                                        taxBehavior?: ("excluded" | "included") | null;
-                                        descriptionOverride?: string | null;
-                                        account: {
-                                            id: string;
-                                            name: string;
-                                            uniqueRef?: string | null;
-                                            /** @enum {string} */
-                                            status: "active" | "inactive";
-                                        };
-                                        listing?: {
-                                            /** Format: uuid */
-                                            id: string;
-                                            name: string;
-                                            uniqueRef?: string | null;
-                                            shortRef?: string | null;
-                                        } | null;
-                                        contact?: {
-                                            /** Format: uuid */
-                                            id: string;
-                                            name?: string | null;
-                                            firstName?: string | null;
-                                            uniqueRef?: string | null;
-                                            shortRef?: string | null;
-                                        } | null;
-                                        taxRate?: {
-                                            id: string;
-                                            name: string;
-                                            /**
-                                             * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
-                                             * @example 100000
-                                             */
-                                            basisPoints: number;
-                                        } | null;
-                                    }[];
+                                    /** @enum {string} */
+                                    status: "active" | "inactive";
                                 };
                                 preview: {
                                     matches: boolean;
@@ -7271,13 +7223,17 @@ export interface operations {
                                             uniqueRef?: string | null;
                                             description: string;
                                             accountId?: string | null;
-                                            assignment?: string | null;
+                                            assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
                                             amount: number;
                                             appliedAmount?: {
                                                 taxRateId?: string | null;
                                                 taxBehavior?: ("excluded" | "included") | null;
                                             } | null;
-                                            markup: null;
+                                            markup?: {
+                                                amount?: number | null;
+                                                taxRateId?: string | null;
+                                                taxBehavior?: ("excluded" | "included") | null;
+                                            } | null;
                                             listingId?: string | null;
                                             reservationId?: string | null;
                                             ownerStatementId?: string | null;
@@ -7775,78 +7731,13 @@ export interface operations {
                                 /** Format: uuid */
                                 id: string;
                                 name: string;
-                                /** @enum {string} */
-                                status: "active" | "inactive";
                                 priority: number;
                                 /** @enum {string} */
                                 transactionType: "deposit" | "expense";
                                 /** @enum {string} */
                                 mode: "suggest" | "autoCreateAndMatch";
-                                descriptionOperator?: ("contains" | "equals" | "startsWith") | null;
-                                descriptionValue?: string | null;
-                                amountMinCent?: number | null;
-                                amountMaxCent?: number | null;
-                                descriptionOverride?: string | null;
-                                usePriorMonthEnd: boolean;
-                                version: number;
-                                vendorContact?: {
-                                    /** Format: uuid */
-                                    id: string;
-                                    name?: string | null;
-                                    firstName?: string | null;
-                                    uniqueRef?: string | null;
-                                    shortRef?: string | null;
-                                } | null;
-                                accounts: {
-                                    id: string;
-                                    name: string;
-                                    uniqueRef?: string | null;
-                                    /** @enum {string} */
-                                    status: "active" | "inactive";
-                                }[];
-                                lines: {
-                                    /** Format: uuid */
-                                    id: string;
-                                    sortOrder: number;
-                                    /** @enum {string} */
-                                    splitMode: "fixed" | "percentage" | "remainder";
-                                    fixedCentAmount?: number | null;
-                                    percentageBps?: number | null;
-                                    party?: ("owners" | "manager") | null;
-                                    taxBehavior?: ("excluded" | "included") | null;
-                                    descriptionOverride?: string | null;
-                                    account: {
-                                        id: string;
-                                        name: string;
-                                        uniqueRef?: string | null;
-                                        /** @enum {string} */
-                                        status: "active" | "inactive";
-                                    };
-                                    listing?: {
-                                        /** Format: uuid */
-                                        id: string;
-                                        name: string;
-                                        uniqueRef?: string | null;
-                                        shortRef?: string | null;
-                                    } | null;
-                                    contact?: {
-                                        /** Format: uuid */
-                                        id: string;
-                                        name?: string | null;
-                                        firstName?: string | null;
-                                        uniqueRef?: string | null;
-                                        shortRef?: string | null;
-                                    } | null;
-                                    taxRate?: {
-                                        id: string;
-                                        name: string;
-                                        /**
-                                         * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
-                                         * @example 100000
-                                         */
-                                        basisPoints: number;
-                                    } | null;
-                                }[];
+                                /** @enum {string} */
+                                status: "active" | "inactive";
                             };
                             preview: {
                                 matches: boolean;
@@ -7876,13 +7767,17 @@ export interface operations {
                                         uniqueRef?: string | null;
                                         description: string;
                                         accountId?: string | null;
-                                        assignment?: string | null;
+                                        assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
                                         amount: number;
                                         appliedAmount?: {
                                             taxRateId?: string | null;
                                             taxBehavior?: ("excluded" | "included") | null;
                                         } | null;
-                                        markup: null;
+                                        markup?: {
+                                            amount?: number | null;
+                                            taxRateId?: string | null;
+                                            taxBehavior?: ("excluded" | "included") | null;
+                                        } | null;
                                         listingId?: string | null;
                                         reservationId?: string | null;
                                         ownerStatementId?: string | null;
@@ -8174,16 +8069,30 @@ export interface operations {
                                 splitMode: "fixed" | "percentage" | "remainder";
                                 fixedCentAmount?: number | null;
                                 percentageBps?: number | null;
+                                assignment?: "deposit_merchantFee" | null;
                                 party?: ("owners" | "manager") | null;
                                 taxBehavior?: ("excluded" | "included") | null;
                                 descriptionOverride?: string | null;
-                                account: {
+                                markup?: {
+                                    amount?: number | null;
+                                    taxBehavior?: ("excluded" | "included") | null;
+                                    taxRate?: {
+                                        id: string;
+                                        name: string;
+                                        /**
+                                         * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
+                                         * @example 100000
+                                         */
+                                        basisPoints: number;
+                                    } | null;
+                                } | null;
+                                account?: {
                                     id: string;
                                     name: string;
                                     uniqueRef?: string | null;
                                     /** @enum {string} */
                                     status: "active" | "inactive";
-                                };
+                                } | null;
                                 listing?: {
                                     /** Format: uuid */
                                     id: string;
@@ -8334,13 +8243,18 @@ export interface operations {
                         splitMode: "fixed" | "percentage" | "remainder";
                         fixedCentAmount?: number | null;
                         percentageBps?: number | null;
-                        /** Format: uuid */
-                        accountId: string;
+                        accountId?: string | null;
+                        assignment?: "deposit_merchantFee" | null;
                         listingId?: string | null;
                         contactId?: string | null;
                         party?: ("owners" | "manager") | null;
                         taxRateId?: string | null;
                         taxBehavior?: ("excluded" | "included") | null;
+                        markup?: {
+                            amount?: number | null;
+                            taxRateId?: string | null;
+                            taxBehavior?: ("excluded" | "included") | null;
+                        } | null;
                         descriptionOverride?: string | null;
                     }[];
                 };
@@ -8394,16 +8308,30 @@ export interface operations {
                             splitMode: "fixed" | "percentage" | "remainder";
                             fixedCentAmount?: number | null;
                             percentageBps?: number | null;
+                            assignment?: "deposit_merchantFee" | null;
                             party?: ("owners" | "manager") | null;
                             taxBehavior?: ("excluded" | "included") | null;
                             descriptionOverride?: string | null;
-                            account: {
+                            markup?: {
+                                amount?: number | null;
+                                taxBehavior?: ("excluded" | "included") | null;
+                                taxRate?: {
+                                    id: string;
+                                    name: string;
+                                    /**
+                                     * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
+                                     * @example 100000
+                                     */
+                                    basisPoints: number;
+                                } | null;
+                            } | null;
+                            account?: {
                                 id: string;
                                 name: string;
                                 uniqueRef?: string | null;
                                 /** @enum {string} */
                                 status: "active" | "inactive";
-                            };
+                            } | null;
                             listing?: {
                                 /** Format: uuid */
                                 id: string;
@@ -8544,17 +8472,20 @@ export interface operations {
                         splitMode: "fixed" | "percentage" | "remainder";
                         fixedCentAmount?: number | null;
                         percentageBps?: number | null;
-                        /** Format: uuid */
-                        accountId: string;
+                        accountId?: string | null;
+                        assignment?: "deposit_merchantFee" | null;
                         listingId?: string | null;
                         contactId?: string | null;
                         party?: ("owners" | "manager") | null;
                         taxRateId?: string | null;
                         taxBehavior?: ("excluded" | "included") | null;
+                        markup?: {
+                            amount?: number | null;
+                            taxRateId?: string | null;
+                            taxBehavior?: ("excluded" | "included") | null;
+                        } | null;
                         descriptionOverride?: string | null;
                     }[];
-                    /** Format: uuid */
-                    bankRecordId: string;
                 };
             };
         };
@@ -8566,62 +8497,68 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        matches: boolean;
-                        isAutoApplicable: boolean;
-                        bankRecord: {
-                            /** Format: uuid */
-                            id: string;
-                            date: string;
-                            description: string;
-                            amount: number;
-                            bankAccountId?: string | null;
-                            accountId?: string | null;
-                        };
-                        transaction: {
-                            description: string;
-                            status?: ("active" | "inactive") | null;
-                            accountId?: string | null;
-                            contactId?: string | null;
-                            uniqueRef?: string | null;
-                            isOpeningBalance?: boolean;
-                            /** @enum {string} */
-                            type: "deposit" | "expense";
-                            date: string;
-                            currency?: string | null;
-                            lines: {
-                                recurringTemplateId?: string | null;
-                                uniqueRef?: string | null;
+                        data: {
+                            matches: boolean;
+                            isAutoApplicable: boolean;
+                            bankRecord: {
+                                /** Format: uuid */
+                                id: string;
+                                date: string;
                                 description: string;
-                                accountId?: string | null;
-                                assignment?: string | null;
                                 amount: number;
-                                appliedAmount?: {
-                                    taxRateId?: string | null;
-                                    taxBehavior?: ("excluded" | "included") | null;
-                                } | null;
-                                markup: null;
-                                listingId?: string | null;
-                                reservationId?: string | null;
-                                ownerStatementId?: string | null;
-                                party?: ("owners" | "manager") | null;
+                                bankAccountId?: string | null;
+                                accountId?: string | null;
+                            };
+                            transaction: {
+                                description: string;
+                                status?: ("active" | "inactive") | null;
+                                accountId?: string | null;
                                 contactId?: string | null;
-                                matchReservationConfirmationCode?: string | null;
-                                matchReservationStripeGuestRef?: string | null;
-                                matchLineTypeClassification?: string | null;
-                            }[];
-                            attachmentIds?: string[] | null;
-                            payment?: {
-                                bankRecordIds: string[];
+                                uniqueRef?: string | null;
+                                isOpeningBalance?: boolean;
                                 /** @enum {string} */
-                                status: "unpaid" | "underpaid" | "overpaid" | "paid";
-                                date?: string | null;
-                                lock: null;
-                            } | null;
-                            connectionId?: string | null;
-                            sourceId?: string | null;
-                            recurringTemplateId?: string | null;
-                            matchBankAccountLast4?: string | null;
-                        };
+                                type: "deposit" | "expense";
+                                date: string;
+                                currency?: string | null;
+                                lines: {
+                                    recurringTemplateId?: string | null;
+                                    uniqueRef?: string | null;
+                                    description: string;
+                                    accountId?: string | null;
+                                    assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
+                                    amount: number;
+                                    appliedAmount?: {
+                                        taxRateId?: string | null;
+                                        taxBehavior?: ("excluded" | "included") | null;
+                                    } | null;
+                                    markup?: {
+                                        amount?: number | null;
+                                        taxRateId?: string | null;
+                                        taxBehavior?: ("excluded" | "included") | null;
+                                    } | null;
+                                    listingId?: string | null;
+                                    reservationId?: string | null;
+                                    ownerStatementId?: string | null;
+                                    party?: ("owners" | "manager") | null;
+                                    contactId?: string | null;
+                                    matchReservationConfirmationCode?: string | null;
+                                    matchReservationStripeGuestRef?: string | null;
+                                    matchLineTypeClassification?: string | null;
+                                }[];
+                                attachmentIds?: string[] | null;
+                                payment?: {
+                                    bankRecordIds: string[];
+                                    /** @enum {string} */
+                                    status: "unpaid" | "underpaid" | "overpaid" | "paid";
+                                    date?: string | null;
+                                    lock: null;
+                                } | null;
+                                connectionId?: string | null;
+                                sourceId?: string | null;
+                                recurringTemplateId?: string | null;
+                                matchBankAccountLast4?: string | null;
+                            };
+                        }[];
                     };
                 };
             };
@@ -8765,16 +8702,30 @@ export interface operations {
                             splitMode: "fixed" | "percentage" | "remainder";
                             fixedCentAmount?: number | null;
                             percentageBps?: number | null;
+                            assignment?: "deposit_merchantFee" | null;
                             party?: ("owners" | "manager") | null;
                             taxBehavior?: ("excluded" | "included") | null;
                             descriptionOverride?: string | null;
-                            account: {
+                            markup?: {
+                                amount?: number | null;
+                                taxBehavior?: ("excluded" | "included") | null;
+                                taxRate?: {
+                                    id: string;
+                                    name: string;
+                                    /**
+                                     * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
+                                     * @example 100000
+                                     */
+                                    basisPoints: number;
+                                } | null;
+                            } | null;
+                            account?: {
                                 id: string;
                                 name: string;
                                 uniqueRef?: string | null;
                                 /** @enum {string} */
                                 status: "active" | "inactive";
-                            };
+                            } | null;
                             listing?: {
                                 /** Format: uuid */
                                 id: string;
@@ -8918,13 +8869,18 @@ export interface operations {
                         splitMode: "fixed" | "percentage" | "remainder";
                         fixedCentAmount?: number | null;
                         percentageBps?: number | null;
-                        /** Format: uuid */
-                        accountId: string;
+                        accountId?: string | null;
+                        assignment?: "deposit_merchantFee" | null;
                         listingId?: string | null;
                         contactId?: string | null;
                         party?: ("owners" | "manager") | null;
                         taxRateId?: string | null;
                         taxBehavior?: ("excluded" | "included") | null;
+                        markup?: {
+                            amount?: number | null;
+                            taxRateId?: string | null;
+                            taxBehavior?: ("excluded" | "included") | null;
+                        } | null;
                         descriptionOverride?: string | null;
                     }[];
                 };
@@ -8978,16 +8934,30 @@ export interface operations {
                             splitMode: "fixed" | "percentage" | "remainder";
                             fixedCentAmount?: number | null;
                             percentageBps?: number | null;
+                            assignment?: "deposit_merchantFee" | null;
                             party?: ("owners" | "manager") | null;
                             taxBehavior?: ("excluded" | "included") | null;
                             descriptionOverride?: string | null;
-                            account: {
+                            markup?: {
+                                amount?: number | null;
+                                taxBehavior?: ("excluded" | "included") | null;
+                                taxRate?: {
+                                    id: string;
+                                    name: string;
+                                    /**
+                                     * @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
+                                     * @example 100000
+                                     */
+                                    basisPoints: number;
+                                } | null;
+                            } | null;
+                            account?: {
                                 id: string;
                                 name: string;
                                 uniqueRef?: string | null;
                                 /** @enum {string} */
                                 status: "active" | "inactive";
-                            };
+                            } | null;
                             listing?: {
                                 /** Format: uuid */
                                 id: string;
@@ -9267,13 +9237,17 @@ export interface operations {
                                         uniqueRef?: string | null;
                                         description: string;
                                         accountId?: string | null;
-                                        assignment?: string | null;
+                                        assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "payout_bankAccount" | "payout_distribution") | null;
                                         amount: number;
                                         appliedAmount?: {
                                             taxRateId?: string | null;
                                             taxBehavior?: ("excluded" | "included") | null;
                                         } | null;
-                                        markup: null;
+                                        markup?: {
+                                            amount?: number | null;
+                                            taxRateId?: string | null;
+                                            taxBehavior?: ("excluded" | "included") | null;
+                                        } | null;
                                         listingId?: string | null;
                                         reservationId?: string | null;
                                         ownerStatementId?: string | null;
@@ -32831,6 +32805,126 @@ export interface operations {
             };
         };
     };
+    getStatementsCsvDetailed: {
+        parameters: {
+            query?: {
+                periodIds?: string;
+                /** @description Year in format YYYY */
+                year?: number;
+                listingIds?: string;
+                statementIds?: string;
+                /** @description Month string in format `YYYY-MM`. */
+                month?: string;
+                search?: string;
+                status?: ("draft" | "inReview" | "published") | "all";
+                ownerIds?: string;
+                listingCollectionIds?: string;
+                recurringFeeIds?: string;
+                /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
+                dateRange?: string;
+                isDateRangeEndInclusive?: boolean;
+                layoutId?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        url: string;
+                        expIn: number;
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+        };
+    };
     getStatementsLayouts: {
         parameters: {
             query?: {