@vrplatform/api 1.3.1-stage.2035 → 1.3.1-stage.2043

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

@@ -1009,15 +1009,15 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/metrics/listing-journal-entries": {
+    "/metrics/listing-revenue": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Listing journal totals by owner-statement bucket and party */
-        get: operations["getMetricListingJournalEntries"];
+        /** @description Listing revenue split by lock state and party */
+        get: operations["getMetricListingRevenue"];
         put?: never;
         post?: never;
         delete?: never;
@@ -5508,11 +5508,16 @@ export interface operations {
             query: {
                 rootEntityType: string;
                 rootEntityId: string;
+                /** @description Timeline item type filter. Accepts repeated `types=value` query params or one comma-separated string. */
                 types?: ("action" | "effect" | "effect_attempt" | "mutation" | "journal_delta")[];
+                /** @description Temporal boundary string parsed by the API. Prefer `YYYY-MM-DD` for day-granularity filters or an ISO 8601 timestamp for exact time bounds. */
                 from?: string;
+                /** @description Temporal boundary string parsed by the API. Prefer `YYYY-MM-DD` for day-granularity filters or an ISO 8601 timestamp for exact time bounds. */
                 to?: string;
+                /** @description When true, include diff payloads in audit timeline journal delta entries. */
                 includeDiff?: boolean;
                 limit?: number;
+                /** @description Opaque pagination cursor returned by a previous response. Pass it back unchanged. */
                 cursor?: string;
             };
             header?: never;
@@ -6044,9 +6049,9 @@ export interface operations {
                 search?: string;
                 /** @description Amount in cents, also accepts ranges like 100...200 */
                 amount?: string;
-                /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
                 bankAccountId?: string;
                 accountId?: string;
@@ -6402,9 +6407,9 @@ export interface operations {
                 search?: string;
                 /** @description Amount in cents, also accepts ranges like 100...200 */
                 amount?: string;
-                /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
                 bankAccountId?: string;
                 accountId?: string;
@@ -11617,13 +11622,15 @@ export interface operations {
             query?: {
                 status?: "active" | "inactive";
                 connectionId?: string;
-                /** @description comma separated listing ids */
+                /** @description Comma-separated listing ids. */
                 ids?: string;
                 search?: string;
                 contactId?: string;
-                /** @description comma separated listing short refs */
+                /** @description Comma-separated listing short refs. */
                 shortRefs?: string;
+                /** @description Filter listings by whether they currently have an active ownership period. */
                 activeOwnership?: boolean;
+                /** @description Filter by active recurring fee coverage. Use `active` or `inactive` for any recurring fee type, prefix a fee type with `!` to exclude it, or pass a recurring fee UUID for one specific fee. */
                 activeRecurringFeePeriods?: string;
                 /** @description Filter listings that have (true) or lack (false) opening balances */
                 openingBalance?: boolean;
@@ -12245,13 +12252,15 @@ export interface operations {
             query?: {
                 status?: "active" | "inactive";
                 connectionId?: string;
-                /** @description comma separated listing ids */
+                /** @description Comma-separated listing ids. */
                 ids?: string;
                 search?: string;
                 contactId?: string;
-                /** @description comma separated listing short refs */
+                /** @description Comma-separated listing short refs. */
                 shortRefs?: string;
+                /** @description Filter listings by whether they currently have an active ownership period. */
                 activeOwnership?: boolean;
+                /** @description Filter by active recurring fee coverage. Use `active` or `inactive` for any recurring fee type, prefix a fee type with `!` to exclude it, or pass a recurring fee UUID for one specific fee. */
                 activeRecurringFeePeriods?: string;
                 /** @description Filter listings that have (true) or lack (false) opening balances */
                 openingBalance?: boolean;
@@ -12362,13 +12371,15 @@ export interface operations {
             query?: {
                 status?: "active" | "inactive";
                 connectionId?: string;
-                /** @description comma separated listing ids */
+                /** @description Comma-separated listing ids. */
                 ids?: string;
                 search?: string;
                 contactId?: string;
-                /** @description comma separated listing short refs */
+                /** @description Comma-separated listing short refs. */
                 shortRefs?: string;
+                /** @description Filter listings by whether they currently have an active ownership period. */
                 activeOwnership?: boolean;
+                /** @description Filter by active recurring fee coverage. Use `active` or `inactive` for any recurring fee type, prefix a fee type with `!` to exclude it, or pass a recurring fee UUID for one specific fee. */
                 activeRecurringFeePeriods?: string;
                 /** @description Filter listings that have (true) or lack (false) opening balances */
                 openingBalance?: boolean;
@@ -13939,7 +13950,9 @@ export interface operations {
     getMetricActiveListings: {
         parameters: {
             query: {
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14049,7 +14062,9 @@ export interface operations {
     getMetricAverageDailyRate: {
         parameters: {
             query: {
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14160,7 +14175,9 @@ export interface operations {
         parameters: {
             query: {
                 dimension?: "month" | "week" | "day" | "year";
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14270,7 +14287,9 @@ export interface operations {
     getMetricCheckinCounts: {
         parameters: {
             query: {
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14381,7 +14400,9 @@ export interface operations {
         parameters: {
             query: {
                 dimension?: "month" | "week" | "day" | "year";
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14487,13 +14508,15 @@ export interface operations {
             };
         };
     };
-    getMetricListingJournalEntries: {
+    getMetricListingRevenue: {
         parameters: {
             query: {
                 listingId: string;
                 party: "owners" | "manager";
                 dimension?: "month" | "week" | "day" | "year";
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14511,7 +14534,8 @@ export interface operations {
                     "application/json": {
                         data: {
                             date: string;
-                            total: number;
+                            lockedRevenue?: number;
+                            unlockedRevenue: number;
                             currency: string;
                         }[];
                     };
@@ -14603,7 +14627,9 @@ export interface operations {
         parameters: {
             query: {
                 dimension?: "month" | "week" | "day" | "year";
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14714,7 +14740,9 @@ export interface operations {
         parameters: {
             query: {
                 ownerId: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
                 currency?: string;
             };
@@ -14824,7 +14852,9 @@ export interface operations {
     getMetricReservationCount: {
         parameters: {
             query: {
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -14935,9 +14965,9 @@ export interface operations {
         parameters: {
             query?: {
                 dimension?: "month" | "week" | "day" | "year";
-                /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
             };
             header?: never;
@@ -15047,7 +15077,9 @@ export interface operations {
         parameters: {
             query: {
                 dimension?: "month" | "week" | "day" | "year";
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -15159,9 +15191,9 @@ export interface operations {
                 dimension?: "month" | "week" | "day" | "year";
                 connectionId: string;
                 view: "automate" | "extract";
-                /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
             };
             header?: never;
@@ -15284,7 +15316,9 @@ export interface operations {
         parameters: {
             query: {
                 dimension?: "month" | "week" | "day" | "year";
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
             };
             header?: never;
@@ -16908,6 +16942,7 @@ export interface operations {
             query?: {
                 recurringFeeId?: string;
                 listingId?: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 date?: string;
                 recurringFeeType?: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
                 limit?: number;
@@ -18863,7 +18898,7 @@ export interface operations {
                 search?: string;
                 date?: string;
                 amount?: string;
-                /** @description Whether the end date is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
                 /** @description comma separated reservation ids */
                 reservationIds?: string;
@@ -19120,7 +19155,7 @@ export interface operations {
                 search?: string;
                 date?: string;
                 amount?: string;
-                /** @description Whether the end date is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
                 /** @description comma separated reservation ids */
                 reservationIds?: string;
@@ -19746,7 +19781,7 @@ export interface operations {
                 search?: string;
                 date?: string;
                 amount?: string;
-                /** @description Whether the end date is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
                 /** @description comma separated reservation ids */
                 reservationIds?: string;
@@ -20002,7 +20037,7 @@ export interface operations {
                 search?: string;
                 date?: string;
                 amount?: string;
-                /** @description Whether the end date is inclusive or exclusive */
+                /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
                 isDateRangeEndInclusive?: boolean;
                 /** @description comma separated reservation ids */
                 reservationIds?: string;
@@ -20540,7 +20575,11 @@ export interface operations {
                                         ownershipPeriodId: string;
                                         /** @enum {string} */
                                         status: "draft" | "inReview" | "published";
-                                        /** @description Date in format YYYY-MM */
+                                        /**
+                                         * Format: vrp-month
+                                         * @description Month string in format `YYYY-MM`.
+                                         * @example 2024-01
+                                         */
                                         month: string;
                                         /** @description Currency in ISO 4217 format, will be converted to lowercase */
                                         currency: string;
@@ -20574,7 +20613,11 @@ export interface operations {
                                         ownershipPeriodId: string;
                                         /** @enum {string} */
                                         status: "draft" | "inReview" | "published";
-                                        /** @description Date in format YYYY-MM */
+                                        /**
+                                         * Format: vrp-month
+                                         * @description Month string in format `YYYY-MM`.
+                                         * @example 2024-01
+                                         */
                                         month: string;
                                         /** @description Currency in ISO 4217 format, will be converted to lowercase */
                                         currency: string;
@@ -20607,7 +20650,11 @@ export interface operations {
                                         ownershipPeriodId: string;
                                         /** @enum {string} */
                                         status: "draft" | "inReview" | "published";
-                                        /** @description Date in format YYYY-MM */
+                                        /**
+                                         * Format: vrp-month
+                                         * @description Month string in format `YYYY-MM`.
+                                         * @example 2024-01
+                                         */
                                         month: string;
                                         /** @description Currency in ISO 4217 format, will be converted to lowercase */
                                         currency: string;
@@ -21197,7 +21244,9 @@ export interface operations {
     getSalesTaxLiabilityReport: {
         parameters: {
             query: {
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
                 taxableLineIds: string;
                 channels?: string;
@@ -21329,7 +21378,9 @@ export interface operations {
     getSalesTaxLiabilityReportCsv: {
         parameters: {
             query: {
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 startDate: string;
+                /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
                 endDate: string;
                 taxableLineIds: string;
                 channels?: string;
@@ -22166,14 +22217,16 @@ export interface operations {
     getReservations: {
         parameters: {
             query?: {
-                /** @description comma separated reservation ids, negate with ! prefix */
+                /** @description Comma-separated reservation ids. Prefix with `!` to exclude matching ids. */
                 ids?: string;
-                /** @description comma separated reservation short refs */
+                /** @description Comma-separated reservation short refs. */
                 shortRefs?: string;
                 status?: "booked" | "canceled" | "inactive";
                 generalLedgerStatus?: "active" | "inactive";
                 listingId?: string;
+                /** @description Date filter 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. */
                 date?: string;
+                /** @description Choose which reservation date field the `date` filter applies to. */
                 dateField?: "bookedAt" | "checkIn" | "checkOut" | "payment" | "intersection";
                 search?: string;
                 /** @description unpaid, underpaid, overpaid, paid, !unpaid, !underpaid, !overpaid, !paid */
@@ -22184,6 +22237,7 @@ export interface operations {
                 businessModel?: "managed" | "co_host" | "co_host_airbnb";
                 /** @description Filter by reservation line type (paymentLine.effectiveType), only when not excluded */
                 lineType?: string;
+                /** @description When true, include nested line items in each returned reservation. */
                 includeLines?: boolean;
                 limit?: number;
                 page?: number;
@@ -23146,14 +23200,16 @@ export interface operations {
     getReservationsCsv: {
         parameters: {
             query?: {
-                /** @description comma separated reservation ids, negate with ! prefix */
+                /** @description Comma-separated reservation ids. Prefix with `!` to exclude matching ids. */
                 ids?: string;
-                /** @description comma separated reservation short refs */
+                /** @description Comma-separated reservation short refs. */
                 shortRefs?: string;
                 status?: "booked" | "canceled" | "inactive";
                 generalLedgerStatus?: "active" | "inactive";
                 listingId?: string;
+                /** @description Date filter 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. */
                 date?: string;
+                /** @description Choose which reservation date field the `date` filter applies to. */
                 dateField?: "bookedAt" | "checkIn" | "checkOut" | "payment" | "intersection";
                 search?: string;
                 /** @description unpaid, underpaid, overpaid, paid, !unpaid, !underpaid, !overpaid, !paid */
@@ -23164,6 +23220,7 @@ export interface operations {
                 businessModel?: "managed" | "co_host" | "co_host_airbnb";
                 /** @description Filter by reservation line type (paymentLine.effectiveType), only when not excluded */
                 lineType?: string;
+                /** @description When true, include nested line items in each returned reservation. */
                 includeLines?: boolean;
             };
             header?: never;
@@ -26499,14 +26556,14 @@ export interface operations {
                 year?: number;
                 listingIds?: string;
                 statementIds?: string;
-                /** @description Date in format YYYY-MM */
+                /** @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 in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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;
             };
@@ -26857,7 +26914,11 @@ export interface operations {
         requestBody?: {
             content: {
                 "application/json": {
-                    /** @description Date in format YYYY-MM */
+                    /**
+                     * Format: vrp-month
+                     * @description Month string in format `YYYY-MM`.
+                     * @example 2024-01
+                     */
                     month: string;
                     /** @description Currency in ISO 4217 format, will be converted to lowercase */
                     currency?: string;
@@ -27454,7 +27515,7 @@ export interface operations {
             query: {
                 viewAs?: "owner" | "manager";
                 ownershipPeriodId: string;
-                /** @description Date in format YYYY-MM */
+                /** @description Month string in format `YYYY-MM`. */
                 month: string;
                 /** @description Currency in ISO 4217 format, will be converted to lowercase */
                 currency?: string;
@@ -28043,7 +28104,7 @@ export interface operations {
             query: {
                 viewAs?: "owner" | "manager";
                 ownershipPeriodId: string;
-                /** @description Date in format YYYY-MM */
+                /** @description Month string in format `YYYY-MM`. */
                 month: string;
                 /** @description Currency in ISO 4217 format, will be converted to lowercase */
                 currency?: string;
@@ -28156,14 +28217,14 @@ export interface operations {
                 year?: number;
                 listingIds?: string;
                 statementIds?: string;
-                /** @description Date in format YYYY-MM */
+                /** @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 in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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;
             };
@@ -29616,7 +29677,7 @@ export interface operations {
             query: {
                 viewAs?: "owner" | "manager";
                 ownershipPeriodId: string;
-                /** @description Date in format YYYY-MM */
+                /** @description Month string in format `YYYY-MM`. */
                 month: string;
                 /** @description Currency in ISO 4217 format, will be converted to lowercase */
                 currency?: string;
@@ -29730,12 +29791,12 @@ export interface operations {
             query?: {
                 /** @description comma separated ownership periods */
                 ownershipPeriodIds?: string;
-                /** @description Date in format YYYY-MM */
+                /** @description Month string in format `YYYY-MM`. */
                 month?: string;
                 listingId?: string;
-                /** @description Date in format YYYY-MM */
+                /** @description Month string in format `YYYY-MM`. */
                 startMonth?: string;
-                /** @description Date in format YYYY-MM */
+                /** @description Month string in format `YYYY-MM`. */
                 endMonth?: string;
                 /** @description Currency in ISO 4217 format, will be converted to lowercase */
                 currency?: string;
@@ -29843,7 +29904,7 @@ export interface operations {
     getStatementsTotals: {
         parameters: {
             query: {
-                /** @description Date in format YYYY-MM */
+                /** @description Month string in format `YYYY-MM`. */
                 month: string;
                 /** @description comma separated listings */
                 listingIds?: string;
@@ -35401,28 +35462,37 @@ export interface operations {
                 type?: "deposit" | "expense" | "transfer";
                 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 in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @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;
                 limit?: number;
                 page?: number;
@@ -36491,28 +36561,37 @@ export interface operations {
                 type?: "deposit" | "expense" | "transfer";
                 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 in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @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;
@@ -36620,28 +36699,37 @@ export interface operations {
                 type?: "deposit" | "expense" | "transfer";
                 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 in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @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;
@@ -36749,28 +36837,37 @@ export interface operations {
                 type?: "deposit" | "expense" | "transfer";
                 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 in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @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;
@@ -38941,28 +39038,37 @@ export interface operations {
                 type?: "deposit" | "expense" | "transfer";
                 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 in format YYYY-MM-DD...YYYY-MM-DD */
+                /** @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 is inclusive or exclusive */
+                /** @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;