@vrplatform/api 1.3.1-stage.2069 → 1.3.1-stage.2071

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

@@ -2873,6 +2873,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/transactions/payouts/csv": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Payout transactions CSV export */
+        get: operations["getTransactionsPayoutsCsv"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/transactions/recurring-templates": {
         parameters: {
             query?: never;
@@ -2951,7 +2968,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Transfer transactions CSV export */
+        /** @description Legacy transfer transactions CSV export */
         get: operations["getTransactionsTransfersCsv"];
         put?: never;
         post?: never;
@@ -19493,6 +19510,7 @@ export interface operations {
                 startDate?: string;
                 endDate?: string;
                 view?: "month" | "quarter" | "year";
+                ledger?: "trust" | "operating";
             };
             header?: never;
             path?: never;
@@ -19727,9 +19745,10 @@ export interface operations {
     getBalanceSheetReportCsv: {
         parameters: {
             query?: {
-                view?: "month" | "quarter" | "year";
                 startDate?: string;
                 endDate?: string;
+                view?: "month" | "quarter" | "year";
+                ledger?: "trust" | "operating";
             };
             header?: never;
             path?: never;
@@ -20224,6 +20243,7 @@ export interface operations {
                 bookingChannels?: string;
                 party?: "owners" | "manager";
                 openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
+                ledger?: "trust" | "operating";
                 includeDetails?: boolean;
                 limit?: number;
                 page?: number;
@@ -20481,6 +20501,7 @@ export interface operations {
                 bookingChannels?: string;
                 party?: "owners" | "manager";
                 openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
+                ledger?: "trust" | "operating";
             };
             header?: never;
             path?: never;
@@ -20614,6 +20635,7 @@ export interface operations {
                                 netIncome: number;
                                 adjustments: number;
                                 transfers: number;
+                                payouts: number;
                             };
                         }[];
                     };
@@ -20838,6 +20860,7 @@ export interface operations {
                             netIncome: number;
                             adjustments: number;
                             transfers: number;
+                            payouts: number;
                         };
                         accounts: {
                             id: string;
@@ -21072,6 +21095,7 @@ export interface operations {
                 txnCode?: string;
                 published?: boolean;
                 status?: "active" | "inactive";
+                ledger?: "trust" | "operating";
                 startAt?: string;
                 endAt?: string;
                 search?: string;
@@ -21328,6 +21352,7 @@ export interface operations {
                 txnCode?: string;
                 published?: boolean;
                 status?: "active" | "inactive";
+                ledger?: "trust" | "operating";
                 startAt?: string;
                 endAt?: string;
                 search?: string;
@@ -21502,6 +21527,7 @@ export interface operations {
                                 expenses: number;
                                 reserve: number;
                                 transfers: number;
+                                payouts: number;
                                 netIncome: number;
                                 currentBalance: number;
                                 balanceEnd: number;
@@ -21852,6 +21878,7 @@ export interface operations {
                             expenses: number;
                             reserve: number;
                             transfers: number;
+                            payouts: number;
                             netIncome: number;
                             currentBalance: number;
                             balanceEnd: number;
@@ -22190,6 +22217,7 @@ export interface operations {
                 party?: "manager" | "owners";
                 view?: "party" | "listing" | "month" | "quarter" | "year";
                 listingIds?: string;
+                ledger?: "trust" | "operating";
             };
             header?: never;
             path?: never;
@@ -22437,6 +22465,7 @@ export interface operations {
                 party?: "manager" | "owners";
                 view?: "party" | "listing" | "month" | "quarter" | "year";
                 listingIds?: string;
+                ledger?: "trust" | "operating";
             };
             header?: never;
             path?: never;
@@ -22786,6 +22815,7 @@ export interface operations {
                 startDate: string;
                 endDate: string;
                 classification?: string;
+                ledger?: "trust" | "operating";
                 type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
                 party?: "owners" | "manager";
                 accountIds?: string;
@@ -22908,6 +22938,7 @@ export interface operations {
                 startDate: string;
                 endDate: string;
                 classification?: string;
+                ledger?: "trust" | "operating";
                 type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
                 party?: "owners" | "manager";
                 accountIds?: string;
@@ -27894,6 +27925,8 @@ export interface operations {
                                 /** @description Value in cents (100 = 1€) */
                                 transfers: number;
                                 /** @description Value in cents (100 = 1€) */
+                                payouts?: number;
+                                /** @description Value in cents (100 = 1€) */
                                 balanceEnd: number;
                             };
                             payment: {
@@ -28077,6 +28110,12 @@ export interface operations {
                                 total: number;
                                 totalFormatted: string;
                             }[];
+                            payouts?: {
+                                id: string;
+                                date: string;
+                                total: number;
+                                totalFormatted: string;
+                            }[];
                             listing: {
                                 id: string;
                                 name: string;
@@ -28119,6 +28158,8 @@ export interface operations {
                             /** @description Value in cents (100 = 1€) */
                             transfers: number;
                             /** @description Value in cents (100 = 1€) */
+                            payouts?: number;
+                            /** @description Value in cents (100 = 1€) */
                             balanceEnd: number;
                             /** @description Currency in ISO 4217 format, will be converted to lowercase */
                             currency: string;
@@ -28266,6 +28307,8 @@ export interface operations {
                                 /** @description Value in cents (100 = 1€) */
                                 transfers: number;
                                 /** @description Value in cents (100 = 1€) */
+                                payouts?: number;
+                                /** @description Value in cents (100 = 1€) */
                                 balanceEnd: number;
                             };
                             payment: {
@@ -28449,6 +28492,12 @@ export interface operations {
                                 total: number;
                                 totalFormatted: string;
                             }[];
+                            payouts?: {
+                                id: string;
+                                date: string;
+                                total: number;
+                                totalFormatted: string;
+                            }[];
                             listing: {
                                 id: string;
                                 name: string;
@@ -28863,6 +28912,8 @@ export interface operations {
                                 /** @description Value in cents (100 = 1€) */
                                 transfers: number;
                                 /** @description Value in cents (100 = 1€) */
+                                payouts?: number;
+                                /** @description Value in cents (100 = 1€) */
                                 balanceEnd: number;
                             };
                             payment: {
@@ -29046,6 +29097,12 @@ export interface operations {
                                 total: number;
                                 totalFormatted: string;
                             }[];
+                            payouts?: {
+                                id: string;
+                                date: string;
+                                total: number;
+                                totalFormatted: string;
+                            }[];
                             listing: {
                                 id: string;
                                 name: string;
@@ -31263,6 +31320,8 @@ export interface operations {
                             /** @description Value in cents (100 = 1€) */
                             transfers: number;
                             /** @description Value in cents (100 = 1€) */
+                            payouts?: number;
+                            /** @description Value in cents (100 = 1€) */
                             balanceEnd: number;
                             /** @description Currency in ISO 4217 format, will be converted to lowercase */
                             currency: string;
@@ -31392,6 +31451,8 @@ export interface operations {
                             /** @description Value in cents (100 = 1€) */
                             transfers: number;
                             /** @description Value in cents (100 = 1€) */
+                            payouts?: number;
+                            /** @description Value in cents (100 = 1€) */
                             balanceEnd: number;
                         };
                         payment: {
@@ -31575,6 +31636,12 @@ export interface operations {
                             total: number;
                             totalFormatted: string;
                         }[];
+                        payouts?: {
+                            id: string;
+                            date: string;
+                            total: number;
+                            totalFormatted: string;
+                        }[];
                         listing: {
                             id: string;
                             name: string;
@@ -31994,6 +32061,8 @@ export interface operations {
                             /** @description Value in cents (100 = 1€) */
                             transfers: number;
                             /** @description Value in cents (100 = 1€) */
+                            payouts?: number;
+                            /** @description Value in cents (100 = 1€) */
                             balanceEnd: number;
                         };
                         payment: {
@@ -32177,6 +32246,12 @@ export interface operations {
                             total: number;
                             totalFormatted: string;
                         }[];
+                        payouts?: {
+                            id: string;
+                            date: string;
+                            total: number;
+                            totalFormatted: string;
+                        }[];
                         listing: {
                             id: string;
                             name: string;
@@ -39091,6 +39166,144 @@ export interface operations {
             };
         };
     };
+    getTransactionsPayoutsCsv: {
+        parameters: {
+            query?: {
+                type?: "deposit" | "expense" | "transfer" | "payout";
+                isOpeningBalance?: boolean;
+                status?: "active" | "inactive";
+                /** @description When true, include nested line items in each returned transaction. */
+                includeLines?: boolean;
+                accountId?: string;
+                last4?: string;
+                /** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
+                isLocked?: boolean;
+                /** @description Filter by whether the transaction has at least one active journal entry. */
+                hasActiveJournalEntries?: boolean;
+                /** @description connection id or 'null' */
+                connectionId?: string;
+                /** @description Amount in cents, also accepts ranges like 100...200 */
+                amount?: 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. */
+                paidAtRange?: 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;
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
+                isDateRangeEndInclusive?: boolean;
+                /** @description Comma-separated transaction unique refs. */
+                uniqueRefs?: string;
+                /** @description Comma-separated transaction short refs. */
+                shortRefs?: string;
+                /** @description Comma-separated transaction ids. */
+                ids?: string;
+                search?: string;
+                recurringTemplateId?: string;
+                paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
+                /** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
+                reconciled?: boolean;
+                contactId?: string;
+                /** @description Comma-separated listing ids. */
+                listingIds?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        url: string;
+                    };
+                };
+            };
+            /** @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;
+                    };
+                };
+            };
+        };
+    };
     getTransactionsRecurringTemplates: {
         parameters: {
             query?: {