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

package/src/generated/v1.ts

@@ -1010,15 +1010,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;
@@ -5509,11 +5509,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;
@@ -6045,9 +6050,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;
@@ -6403,9 +6408,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;
@@ -11618,13 +11623,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;
@@ -12246,13 +12253,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;
@@ -12363,13 +12372,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;
@@ -13940,7 +13951,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;
@@ -14050,7 +14063,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;
@@ -14161,7 +14176,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;
@@ -14271,7 +14288,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;
@@ -14382,7 +14401,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;
@@ -14488,13 +14509,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;
@@ -14512,7 +14535,8 @@ export interface operations {
                     "application/json": {
                         data: {
                             date: string;
-                            total: number;
+                            lockedRevenue?: number;
+                            unlockedRevenue: number;
                             currency: string;
                         }[];
                     };
@@ -14604,7 +14628,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;
@@ -14715,7 +14741,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;
             };
@@ -14825,7 +14853,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;
@@ -14936,9 +14966,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;
@@ -15048,7 +15078,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;
@@ -15160,9 +15192,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;
@@ -15285,7 +15317,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;
@@ -16909,6 +16943,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;
@@ -18864,7 +18899,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;
@@ -19121,7 +19156,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;
@@ -19747,7 +19782,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;
@@ -20003,7 +20038,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;
@@ -20541,7 +20576,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;
@@ -20575,7 +20614,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;
@@ -20608,7 +20651,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;
@@ -21198,7 +21245,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;
@@ -21330,7 +21379,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;
@@ -22167,14 +22218,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 */
@@ -22185,6 +22238,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;
@@ -23147,14 +23201,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 */
@@ -23165,6 +23221,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;
@@ -26500,14 +26557,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;
             };
@@ -26858,7 +26915,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;
@@ -27455,7 +27516,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;
@@ -28044,7 +28105,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;
@@ -28157,14 +28218,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;
             };
@@ -29617,7 +29678,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;
@@ -29731,12 +29792,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;
@@ -29844,7 +29905,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;
@@ -35402,28 +35463,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;
@@ -36492,28 +36562,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;
@@ -36621,28 +36700,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;
@@ -36750,28 +36838,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;
@@ -38942,28 +39039,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;