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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/build/main/generated/v1.d.ts +189 -83
  2. package/build/main/generated/v1.js.map +1 -1
  3. package/build/module/generated/v1.d.ts +189 -83
  4. package/build/module/generated/v1.js.map +1 -1
  5. package/package.json +1 -1
  6. package/src/generated/v1.ts +189 -83
package/build/main/generated/v1.d.ts CHANGED
@@ -1009,15 +1009,15 @@ export interface paths {
1009
1009
  patch?: never;
1010
1010
  trace?: never;
1011
1011
  };
1012
- "/metrics/listing-journal-entries": {
1012
+ "/metrics/listing-revenue": {
1013
1013
  parameters: {
1014
1014
  query?: never;
1015
1015
  header?: never;
1016
1016
  path?: never;
1017
1017
  cookie?: never;
1018
1018
  };
1019
- /** @description Listing journal totals by owner-statement bucket and party */
1020
- get: operations["getMetricListingJournalEntries"];
1019
+ /** @description Listing revenue split by lock state and party */
1020
+ get: operations["getMetricListingRevenue"];
1021
1021
  put?: never;
1022
1022
  post?: never;
1023
1023
  delete?: never;
@@ -3899,7 +3899,7 @@ export interface operations {
3899
3899
  uniqueRef?: string | null;
3900
3900
  isOpeningBalance: boolean;
3901
3901
  /** @enum {string} */
3902
- type: "deposit" | "expense" | "transfer";
3902
+ type: "deposit" | "expense" | "transfer" | "payout";
3903
3903
  date: string;
3904
3904
  lines: {
3905
3905
  uniqueRef?: string | null;
@@ -4978,7 +4978,7 @@ export interface operations {
4978
4978
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
4979
4979
  currency: string;
4980
4980
  /** @enum {string} */
4981
- type: "deposit" | "expense" | "transfer";
4981
+ type: "deposit" | "expense" | "transfer" | "payout";
4982
4982
  isOpeningBalance: boolean;
4983
4983
  contact?: {
4984
4984
  /** Format: uuid */
@@ -5024,7 +5024,7 @@ export interface operations {
5024
5024
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
5025
5025
  currency: string;
5026
5026
  /** @enum {string} */
5027
- type: "deposit" | "expense" | "transfer";
5027
+ type: "deposit" | "expense" | "transfer" | "payout";
5028
5028
  isOpeningBalance: boolean;
5029
5029
  contact?: {
5030
5030
  /** Format: uuid */
@@ -5508,11 +5508,16 @@ export interface operations {
5508
5508
  query: {
5509
5509
  rootEntityType: string;
5510
5510
  rootEntityId: string;
5511
+ /** @description Timeline item type filter. Accepts repeated `types=value` query params or one comma-separated string. */
5511
5512
  types?: ("action" | "effect" | "effect_attempt" | "mutation" | "journal_delta")[];
5513
+ /** @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. */
5512
5514
  from?: string;
5515
+ /** @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. */
5513
5516
  to?: string;
5517
+ /** @description When true, include diff payloads in audit timeline journal delta entries. */
5514
5518
  includeDiff?: boolean;
5515
5519
  limit?: number;
5520
+ /** @description Opaque pagination cursor returned by a previous response. Pass it back unchanged. */
5516
5521
  cursor?: string;
5517
5522
  };
5518
5523
  header?: never;
@@ -6044,9 +6049,9 @@ export interface operations {
6044
6049
  search?: string;
6045
6050
  /** @description Amount in cents, also accepts ranges like 100...200 */
6046
6051
  amount?: string;
6047
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
6052
+ /** @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. */
6048
6053
  dateRange?: string;
6049
- /** @description Whether the end date is inclusive or exclusive */
6054
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
6050
6055
  isDateRangeEndInclusive?: boolean;
6051
6056
  bankAccountId?: string;
6052
6057
  accountId?: string;
@@ -6126,7 +6131,7 @@ export interface operations {
6126
6131
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
6127
6132
  currency: string;
6128
6133
  /** @enum {string} */
6129
- type: "deposit" | "expense" | "transfer";
6134
+ type: "deposit" | "expense" | "transfer" | "payout";
6130
6135
  isOpeningBalance: boolean;
6131
6136
  contact?: {
6132
6137
  /** Format: uuid */
@@ -6402,9 +6407,9 @@ export interface operations {
6402
6407
  search?: string;
6403
6408
  /** @description Amount in cents, also accepts ranges like 100...200 */
6404
6409
  amount?: string;
6405
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
6410
+ /** @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. */
6406
6411
  dateRange?: string;
6407
- /** @description Whether the end date is inclusive or exclusive */
6412
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
6408
6413
  isDateRangeEndInclusive?: boolean;
6409
6414
  bankAccountId?: string;
6410
6415
  accountId?: string;
@@ -6588,7 +6593,7 @@ export interface operations {
6588
6593
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
6589
6594
  currency: string;
6590
6595
  /** @enum {string} */
6591
- type: "deposit" | "expense" | "transfer";
6596
+ type: "deposit" | "expense" | "transfer" | "payout";
6592
6597
  isOpeningBalance: boolean;
6593
6598
  contact?: {
6594
6599
  /** Format: uuid */
@@ -11617,13 +11622,15 @@ export interface operations {
11617
11622
  query?: {
11618
11623
  status?: "active" | "inactive";
11619
11624
  connectionId?: string;
11620
- /** @description comma separated listing ids */
11625
+ /** @description Comma-separated listing ids. */
11621
11626
  ids?: string;
11622
11627
  search?: string;
11623
11628
  contactId?: string;
11624
- /** @description comma separated listing short refs */
11629
+ /** @description Comma-separated listing short refs. */
11625
11630
  shortRefs?: string;
11631
+ /** @description Filter listings by whether they currently have an active ownership period. */
11626
11632
  activeOwnership?: boolean;
11633
+ /** @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. */
11627
11634
  activeRecurringFeePeriods?: string;
11628
11635
  /** @description Filter listings that have (true) or lack (false) opening balances */
11629
11636
  openingBalance?: boolean;
@@ -12245,13 +12252,15 @@ export interface operations {
12245
12252
  query?: {
12246
12253
  status?: "active" | "inactive";
12247
12254
  connectionId?: string;
12248
- /** @description comma separated listing ids */
12255
+ /** @description Comma-separated listing ids. */
12249
12256
  ids?: string;
12250
12257
  search?: string;
12251
12258
  contactId?: string;
12252
- /** @description comma separated listing short refs */
12259
+ /** @description Comma-separated listing short refs. */
12253
12260
  shortRefs?: string;
12261
+ /** @description Filter listings by whether they currently have an active ownership period. */
12254
12262
  activeOwnership?: boolean;
12263
+ /** @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. */
12255
12264
  activeRecurringFeePeriods?: string;
12256
12265
  /** @description Filter listings that have (true) or lack (false) opening balances */
12257
12266
  openingBalance?: boolean;
@@ -12362,13 +12371,15 @@ export interface operations {
12362
12371
  query?: {
12363
12372
  status?: "active" | "inactive";
12364
12373
  connectionId?: string;
12365
- /** @description comma separated listing ids */
12374
+ /** @description Comma-separated listing ids. */
12366
12375
  ids?: string;
12367
12376
  search?: string;
12368
12377
  contactId?: string;
12369
- /** @description comma separated listing short refs */
12378
+ /** @description Comma-separated listing short refs. */
12370
12379
  shortRefs?: string;
12380
+ /** @description Filter listings by whether they currently have an active ownership period. */
12371
12381
  activeOwnership?: boolean;
12382
+ /** @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. */
12372
12383
  activeRecurringFeePeriods?: string;
12373
12384
  /** @description Filter listings that have (true) or lack (false) opening balances */
12374
12385
  openingBalance?: boolean;
@@ -13939,7 +13950,9 @@ export interface operations {
13939
13950
  getMetricActiveListings: {
13940
13951
  parameters: {
13941
13952
  query: {
13953
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
13942
13954
  startDate: string;
13955
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
13943
13956
  endDate: string;
13944
13957
  };
13945
13958
  header?: never;
@@ -14049,7 +14062,9 @@ export interface operations {
14049
14062
  getMetricAverageDailyRate: {
14050
14063
  parameters: {
14051
14064
  query: {
14065
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14052
14066
  startDate: string;
14067
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14053
14068
  endDate: string;
14054
14069
  };
14055
14070
  header?: never;
@@ -14160,7 +14175,9 @@ export interface operations {
14160
14175
  parameters: {
14161
14176
  query: {
14162
14177
  dimension?: "month" | "week" | "day" | "year";
14178
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14163
14179
  startDate: string;
14180
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14164
14181
  endDate: string;
14165
14182
  };
14166
14183
  header?: never;
@@ -14270,7 +14287,9 @@ export interface operations {
14270
14287
  getMetricCheckinCounts: {
14271
14288
  parameters: {
14272
14289
  query: {
14290
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14273
14291
  startDate: string;
14292
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14274
14293
  endDate: string;
14275
14294
  };
14276
14295
  header?: never;
@@ -14381,7 +14400,9 @@ export interface operations {
14381
14400
  parameters: {
14382
14401
  query: {
14383
14402
  dimension?: "month" | "week" | "day" | "year";
14403
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14384
14404
  startDate: string;
14405
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14385
14406
  endDate: string;
14386
14407
  };
14387
14408
  header?: never;
@@ -14487,13 +14508,15 @@ export interface operations {
14487
14508
  };
14488
14509
  };
14489
14510
  };
14490
- getMetricListingJournalEntries: {
14511
+ getMetricListingRevenue: {
14491
14512
  parameters: {
14492
14513
  query: {
14493
14514
  listingId: string;
14494
14515
  party: "owners" | "manager";
14495
14516
  dimension?: "month" | "week" | "day" | "year";
14517
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14496
14518
  startDate: string;
14519
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14497
14520
  endDate: string;
14498
14521
  };
14499
14522
  header?: never;
@@ -14511,7 +14534,8 @@ export interface operations {
14511
14534
  "application/json": {
14512
14535
  data: {
14513
14536
  date: string;
14514
- total: number;
14537
+ lockedRevenue?: number;
14538
+ unlockedRevenue: number;
14515
14539
  currency: string;
14516
14540
  }[];
14517
14541
  };
@@ -14603,7 +14627,9 @@ export interface operations {
14603
14627
  parameters: {
14604
14628
  query: {
14605
14629
  dimension?: "month" | "week" | "day" | "year";
14630
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14606
14631
  startDate: string;
14632
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14607
14633
  endDate: string;
14608
14634
  };
14609
14635
  header?: never;
@@ -14714,7 +14740,9 @@ export interface operations {
14714
14740
  parameters: {
14715
14741
  query: {
14716
14742
  ownerId: string;
14743
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14717
14744
  startDate: string;
14745
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14718
14746
  endDate: string;
14719
14747
  currency?: string;
14720
14748
  };
@@ -14824,7 +14852,9 @@ export interface operations {
14824
14852
  getMetricReservationCount: {
14825
14853
  parameters: {
14826
14854
  query: {
14855
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14827
14856
  startDate: string;
14857
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
14828
14858
  endDate: string;
14829
14859
  };
14830
14860
  header?: never;
@@ -14935,9 +14965,9 @@ export interface operations {
14935
14965
  parameters: {
14936
14966
  query?: {
14937
14967
  dimension?: "month" | "week" | "day" | "year";
14938
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
14968
+ /** @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. */
14939
14969
  dateRange?: string;
14940
- /** @description Whether the end date is inclusive or exclusive */
14970
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
14941
14971
  isDateRangeEndInclusive?: boolean;
14942
14972
  };
14943
14973
  header?: never;
@@ -15047,7 +15077,9 @@ export interface operations {
15047
15077
  parameters: {
15048
15078
  query: {
15049
15079
  dimension?: "month" | "week" | "day" | "year";
15080
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
15050
15081
  startDate: string;
15082
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
15051
15083
  endDate: string;
15052
15084
  };
15053
15085
  header?: never;
@@ -15159,9 +15191,9 @@ export interface operations {
15159
15191
  dimension?: "month" | "week" | "day" | "year";
15160
15192
  connectionId: string;
15161
15193
  view: "automate" | "extract";
15162
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
15194
+ /** @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. */
15163
15195
  dateRange?: string;
15164
- /** @description Whether the end date is inclusive or exclusive */
15196
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
15165
15197
  isDateRangeEndInclusive?: boolean;
15166
15198
  };
15167
15199
  header?: never;
@@ -15284,7 +15316,9 @@ export interface operations {
15284
15316
  parameters: {
15285
15317
  query: {
15286
15318
  dimension?: "month" | "week" | "day" | "year";
15319
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
15287
15320
  startDate: string;
15321
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
15288
15322
  endDate: string;
15289
15323
  };
15290
15324
  header?: never;
@@ -16908,6 +16942,7 @@ export interface operations {
16908
16942
  query?: {
16909
16943
  recurringFeeId?: string;
16910
16944
  listingId?: string;
16945
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
16911
16946
  date?: string;
16912
16947
  recurringFeeType?: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
16913
16948
  limit?: number;
@@ -17512,7 +17547,7 @@ export interface operations {
17512
17547
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
17513
17548
  currency: string;
17514
17549
  /** @enum {string} */
17515
- type: "deposit" | "expense" | "transfer";
17550
+ type: "deposit" | "expense" | "transfer" | "payout";
17516
17551
  isOpeningBalance: boolean;
17517
17552
  contact?: {
17518
17553
  /** Format: uuid */
@@ -18863,7 +18898,7 @@ export interface operations {
18863
18898
  search?: string;
18864
18899
  date?: string;
18865
18900
  amount?: string;
18866
- /** @description Whether the end date is inclusive or exclusive */
18901
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
18867
18902
  isDateRangeEndInclusive?: boolean;
18868
18903
  /** @description comma separated reservation ids */
18869
18904
  reservationIds?: string;
@@ -19120,7 +19155,7 @@ export interface operations {
19120
19155
  search?: string;
19121
19156
  date?: string;
19122
19157
  amount?: string;
19123
- /** @description Whether the end date is inclusive or exclusive */
19158
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
19124
19159
  isDateRangeEndInclusive?: boolean;
19125
19160
  /** @description comma separated reservation ids */
19126
19161
  reservationIds?: string;
@@ -19746,7 +19781,7 @@ export interface operations {
19746
19781
  search?: string;
19747
19782
  date?: string;
19748
19783
  amount?: string;
19749
- /** @description Whether the end date is inclusive or exclusive */
19784
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
19750
19785
  isDateRangeEndInclusive?: boolean;
19751
19786
  /** @description comma separated reservation ids */
19752
19787
  reservationIds?: string;
@@ -20002,7 +20037,7 @@ export interface operations {
20002
20037
  search?: string;
20003
20038
  date?: string;
20004
20039
  amount?: string;
20005
- /** @description Whether the end date is inclusive or exclusive */
20040
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
20006
20041
  isDateRangeEndInclusive?: boolean;
20007
20042
  /** @description comma separated reservation ids */
20008
20043
  reservationIds?: string;
@@ -20540,7 +20575,11 @@ export interface operations {
20540
20575
  ownershipPeriodId: string;
20541
20576
  /** @enum {string} */
20542
20577
  status: "draft" | "inReview" | "published";
20543
- /** @description Date in format YYYY-MM */
20578
+ /**
20579
+ * Format: vrp-month
20580
+ * @description Month string in format `YYYY-MM`.
20581
+ * @example 2024-01
20582
+ */
20544
20583
  month: string;
20545
20584
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
20546
20585
  currency: string;
@@ -20574,7 +20613,11 @@ export interface operations {
20574
20613
  ownershipPeriodId: string;
20575
20614
  /** @enum {string} */
20576
20615
  status: "draft" | "inReview" | "published";
20577
- /** @description Date in format YYYY-MM */
20616
+ /**
20617
+ * Format: vrp-month
20618
+ * @description Month string in format `YYYY-MM`.
20619
+ * @example 2024-01
20620
+ */
20578
20621
  month: string;
20579
20622
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
20580
20623
  currency: string;
@@ -20607,7 +20650,11 @@ export interface operations {
20607
20650
  ownershipPeriodId: string;
20608
20651
  /** @enum {string} */
20609
20652
  status: "draft" | "inReview" | "published";
20610
- /** @description Date in format YYYY-MM */
20653
+ /**
20654
+ * Format: vrp-month
20655
+ * @description Month string in format `YYYY-MM`.
20656
+ * @example 2024-01
20657
+ */
20611
20658
  month: string;
20612
20659
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
20613
20660
  currency: string;
@@ -21197,7 +21244,9 @@ export interface operations {
21197
21244
  getSalesTaxLiabilityReport: {
21198
21245
  parameters: {
21199
21246
  query: {
21247
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
21200
21248
  startDate: string;
21249
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
21201
21250
  endDate: string;
21202
21251
  taxableLineIds: string;
21203
21252
  channels?: string;
@@ -21329,7 +21378,9 @@ export interface operations {
21329
21378
  getSalesTaxLiabilityReportCsv: {
21330
21379
  parameters: {
21331
21380
  query: {
21381
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
21332
21382
  startDate: string;
21383
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. */
21333
21384
  endDate: string;
21334
21385
  taxableLineIds: string;
21335
21386
  channels?: string;
@@ -22166,14 +22217,16 @@ export interface operations {
22166
22217
  getReservations: {
22167
22218
  parameters: {
22168
22219
  query?: {
22169
- /** @description comma separated reservation ids, negate with ! prefix */
22220
+ /** @description Comma-separated reservation ids. Prefix with `!` to exclude matching ids. */
22170
22221
  ids?: string;
22171
- /** @description comma separated reservation short refs */
22222
+ /** @description Comma-separated reservation short refs. */
22172
22223
  shortRefs?: string;
22173
22224
  status?: "booked" | "canceled" | "inactive";
22174
22225
  generalLedgerStatus?: "active" | "inactive";
22175
22226
  listingId?: string;
22227
+ /** @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. */
22176
22228
  date?: string;
22229
+ /** @description Choose which reservation date field the `date` filter applies to. */
22177
22230
  dateField?: "bookedAt" | "checkIn" | "checkOut" | "payment" | "intersection";
22178
22231
  search?: string;
22179
22232
  /** @description unpaid, underpaid, overpaid, paid, !unpaid, !underpaid, !overpaid, !paid */
@@ -22184,6 +22237,7 @@ export interface operations {
22184
22237
  businessModel?: "managed" | "co_host" | "co_host_airbnb";
22185
22238
  /** @description Filter by reservation line type (paymentLine.effectiveType), only when not excluded */
22186
22239
  lineType?: string;
22240
+ /** @description When true, include nested line items in each returned reservation. */
22187
22241
  includeLines?: boolean;
22188
22242
  limit?: number;
22189
22243
  page?: number;
@@ -22732,7 +22786,7 @@ export interface operations {
22732
22786
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
22733
22787
  currency: string;
22734
22788
  /** @enum {string} */
22735
- type: "deposit" | "expense" | "transfer";
22789
+ type: "deposit" | "expense" | "transfer" | "payout";
22736
22790
  isOpeningBalance: boolean;
22737
22791
  contact?: {
22738
22792
  /** Format: uuid */
@@ -23146,14 +23200,16 @@ export interface operations {
23146
23200
  getReservationsCsv: {
23147
23201
  parameters: {
23148
23202
  query?: {
23149
- /** @description comma separated reservation ids, negate with ! prefix */
23203
+ /** @description Comma-separated reservation ids. Prefix with `!` to exclude matching ids. */
23150
23204
  ids?: string;
23151
- /** @description comma separated reservation short refs */
23205
+ /** @description Comma-separated reservation short refs. */
23152
23206
  shortRefs?: string;
23153
23207
  status?: "booked" | "canceled" | "inactive";
23154
23208
  generalLedgerStatus?: "active" | "inactive";
23155
23209
  listingId?: string;
23210
+ /** @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. */
23156
23211
  date?: string;
23212
+ /** @description Choose which reservation date field the `date` filter applies to. */
23157
23213
  dateField?: "bookedAt" | "checkIn" | "checkOut" | "payment" | "intersection";
23158
23214
  search?: string;
23159
23215
  /** @description unpaid, underpaid, overpaid, paid, !unpaid, !underpaid, !overpaid, !paid */
@@ -23164,6 +23220,7 @@ export interface operations {
23164
23220
  businessModel?: "managed" | "co_host" | "co_host_airbnb";
23165
23221
  /** @description Filter by reservation line type (paymentLine.effectiveType), only when not excluded */
23166
23222
  lineType?: string;
23223
+ /** @description When true, include nested line items in each returned reservation. */
23167
23224
  includeLines?: boolean;
23168
23225
  };
23169
23226
  header?: never;
@@ -24116,7 +24173,7 @@ export interface operations {
24116
24173
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
24117
24174
  currency: string;
24118
24175
  /** @enum {string} */
24119
- type: "deposit" | "expense" | "transfer";
24176
+ type: "deposit" | "expense" | "transfer" | "payout";
24120
24177
  isOpeningBalance: boolean;
24121
24178
  contact?: {
24122
24179
  /** Format: uuid */
@@ -24679,7 +24736,7 @@ export interface operations {
24679
24736
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
24680
24737
  currency: string;
24681
24738
  /** @enum {string} */
24682
- type: "deposit" | "expense" | "transfer";
24739
+ type: "deposit" | "expense" | "transfer" | "payout";
24683
24740
  isOpeningBalance: boolean;
24684
24741
  contact?: {
24685
24742
  /** Format: uuid */
@@ -25359,7 +25416,7 @@ export interface operations {
25359
25416
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
25360
25417
  currency: string;
25361
25418
  /** @enum {string} */
25362
- type: "deposit" | "expense" | "transfer";
25419
+ type: "deposit" | "expense" | "transfer" | "payout";
25363
25420
  isOpeningBalance: boolean;
25364
25421
  contact?: {
25365
25422
  /** Format: uuid */
@@ -25814,7 +25871,7 @@ export interface operations {
25814
25871
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
25815
25872
  currency: string;
25816
25873
  /** @enum {string} */
25817
- type: "deposit" | "expense" | "transfer";
25874
+ type: "deposit" | "expense" | "transfer" | "payout";
25818
25875
  isOpeningBalance: boolean;
25819
25876
  contact?: {
25820
25877
  /** Format: uuid */
@@ -26255,7 +26312,7 @@ export interface operations {
26255
26312
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
26256
26313
  currency: string;
26257
26314
  /** @enum {string} */
26258
- type: "deposit" | "expense" | "transfer";
26315
+ type: "deposit" | "expense" | "transfer" | "payout";
26259
26316
  isOpeningBalance: boolean;
26260
26317
  contact?: {
26261
26318
  /** Format: uuid */
@@ -26499,14 +26556,14 @@ export interface operations {
26499
26556
  year?: number;
26500
26557
  listingIds?: string;
26501
26558
  statementIds?: string;
26502
- /** @description Date in format YYYY-MM */
26559
+ /** @description Month string in format `YYYY-MM`. */
26503
26560
  month?: string;
26504
26561
  search?: string;
26505
26562
  status?: ("draft" | "inReview" | "published") | "all";
26506
26563
  ownerIds?: string;
26507
26564
  listingCollectionIds?: string;
26508
26565
  recurringFeeIds?: string;
26509
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
26566
+ /** @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. */
26510
26567
  dateRange?: string;
26511
26568
  isDateRangeEndInclusive?: boolean;
26512
26569
  };
@@ -26857,7 +26914,11 @@ export interface operations {
26857
26914
  requestBody?: {
26858
26915
  content: {
26859
26916
  "application/json": {
26860
- /** @description Date in format YYYY-MM */
26917
+ /**
26918
+ * Format: vrp-month
26919
+ * @description Month string in format `YYYY-MM`.
26920
+ * @example 2024-01
26921
+ */
26861
26922
  month: string;
26862
26923
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
26863
26924
  currency?: string;
@@ -27222,7 +27283,7 @@ export interface operations {
27222
27283
  source: {
27223
27284
  id: string;
27224
27285
  /** @enum {string} */
27225
- type: "deposit" | "expense" | "transfer";
27286
+ type: "deposit" | "expense" | "payout";
27226
27287
  description: string;
27227
27288
  lines: {
27228
27289
  id: string;
@@ -27454,7 +27515,7 @@ export interface operations {
27454
27515
  query: {
27455
27516
  viewAs?: "owner" | "manager";
27456
27517
  ownershipPeriodId: string;
27457
- /** @description Date in format YYYY-MM */
27518
+ /** @description Month string in format `YYYY-MM`. */
27458
27519
  month: string;
27459
27520
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
27460
27521
  currency?: string;
@@ -27811,7 +27872,7 @@ export interface operations {
27811
27872
  source: {
27812
27873
  id: string;
27813
27874
  /** @enum {string} */
27814
- type: "deposit" | "expense" | "transfer";
27875
+ type: "deposit" | "expense" | "payout";
27815
27876
  description: string;
27816
27877
  lines: {
27817
27878
  id: string;
@@ -28043,7 +28104,7 @@ export interface operations {
28043
28104
  query: {
28044
28105
  viewAs?: "owner" | "manager";
28045
28106
  ownershipPeriodId: string;
28046
- /** @description Date in format YYYY-MM */
28107
+ /** @description Month string in format `YYYY-MM`. */
28047
28108
  month: string;
28048
28109
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
28049
28110
  currency?: string;
@@ -28156,14 +28217,14 @@ export interface operations {
28156
28217
  year?: number;
28157
28218
  listingIds?: string;
28158
28219
  statementIds?: string;
28159
- /** @description Date in format YYYY-MM */
28220
+ /** @description Month string in format `YYYY-MM`. */
28160
28221
  month?: string;
28161
28222
  search?: string;
28162
28223
  status?: ("draft" | "inReview" | "published") | "all";
28163
28224
  ownerIds?: string;
28164
28225
  listingCollectionIds?: string;
28165
28226
  recurringFeeIds?: string;
28166
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
28227
+ /** @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. */
28167
28228
  dateRange?: string;
28168
28229
  isDateRangeEndInclusive?: boolean;
28169
28230
  };
@@ -29300,7 +29361,7 @@ export interface operations {
29300
29361
  uniqueRef?: string | null;
29301
29362
  isOpeningBalance: boolean;
29302
29363
  /** @enum {string} */
29303
- type: "deposit" | "expense" | "transfer";
29364
+ type: "deposit" | "expense" | "transfer" | "payout";
29304
29365
  date: string;
29305
29366
  lines: {
29306
29367
  uniqueRef?: string | null;
@@ -29616,7 +29677,7 @@ export interface operations {
29616
29677
  query: {
29617
29678
  viewAs?: "owner" | "manager";
29618
29679
  ownershipPeriodId: string;
29619
- /** @description Date in format YYYY-MM */
29680
+ /** @description Month string in format `YYYY-MM`. */
29620
29681
  month: string;
29621
29682
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
29622
29683
  currency?: string;
@@ -29730,12 +29791,12 @@ export interface operations {
29730
29791
  query?: {
29731
29792
  /** @description comma separated ownership periods */
29732
29793
  ownershipPeriodIds?: string;
29733
- /** @description Date in format YYYY-MM */
29794
+ /** @description Month string in format `YYYY-MM`. */
29734
29795
  month?: string;
29735
29796
  listingId?: string;
29736
- /** @description Date in format YYYY-MM */
29797
+ /** @description Month string in format `YYYY-MM`. */
29737
29798
  startMonth?: string;
29738
- /** @description Date in format YYYY-MM */
29799
+ /** @description Month string in format `YYYY-MM`. */
29739
29800
  endMonth?: string;
29740
29801
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
29741
29802
  currency?: string;
@@ -29843,7 +29904,7 @@ export interface operations {
29843
29904
  getStatementsTotals: {
29844
29905
  parameters: {
29845
29906
  query: {
29846
- /** @description Date in format YYYY-MM */
29907
+ /** @description Month string in format `YYYY-MM`. */
29847
29908
  month: string;
29848
29909
  /** @description comma separated listings */
29849
29910
  listingIds?: string;
@@ -30332,7 +30393,7 @@ export interface operations {
30332
30393
  source: {
30333
30394
  id: string;
30334
30395
  /** @enum {string} */
30335
- type: "deposit" | "expense" | "transfer";
30396
+ type: "deposit" | "expense" | "payout";
30336
30397
  description: string;
30337
30398
  lines: {
30338
30399
  id: string;
@@ -30926,7 +30987,7 @@ export interface operations {
30926
30987
  source: {
30927
30988
  id: string;
30928
30989
  /** @enum {string} */
30929
- type: "deposit" | "expense" | "transfer";
30990
+ type: "deposit" | "expense" | "payout";
30930
30991
  description: string;
30931
30992
  lines: {
30932
30993
  id: string;
@@ -35398,31 +35459,40 @@ export interface operations {
35398
35459
  getTransactions: {
35399
35460
  parameters: {
35400
35461
  query?: {
35401
- type?: "deposit" | "expense" | "transfer";
35462
+ type?: "deposit" | "expense" | "transfer" | "payout";
35402
35463
  isOpeningBalance?: boolean;
35403
35464
  status?: "active" | "inactive";
35465
+ /** @description When true, include nested line items in each returned transaction. */
35404
35466
  includeLines?: boolean;
35405
35467
  accountId?: string;
35406
35468
  last4?: string;
35469
+ /** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
35407
35470
  isLocked?: boolean;
35471
+ /** @description Filter by whether the transaction has at least one active journal entry. */
35408
35472
  hasActiveJournalEntries?: boolean;
35409
35473
  /** @description connection id or 'null' */
35410
35474
  connectionId?: string;
35411
35475
  /** @description Amount in cents, also accepts ranges like 100...200 */
35412
35476
  amount?: string;
35477
+ /** @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. */
35413
35478
  paidAtRange?: string;
35414
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
35479
+ /** @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. */
35415
35480
  dateRange?: string;
35416
- /** @description Whether the end date is inclusive or exclusive */
35481
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
35417
35482
  isDateRangeEndInclusive?: boolean;
35483
+ /** @description Comma-separated transaction unique refs. */
35418
35484
  uniqueRefs?: string;
35485
+ /** @description Comma-separated transaction short refs. */
35419
35486
  shortRefs?: string;
35487
+ /** @description Comma-separated transaction ids. */
35420
35488
  ids?: string;
35421
35489
  search?: string;
35422
35490
  recurringTemplateId?: string;
35423
35491
  paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
35492
+ /** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
35424
35493
  reconciled?: boolean;
35425
35494
  contactId?: string;
35495
+ /** @description Comma-separated listing ids. */
35426
35496
  listingIds?: string;
35427
35497
  limit?: number;
35428
35498
  page?: number;
@@ -35447,7 +35517,7 @@ export interface operations {
35447
35517
  uniqueRef?: string | null;
35448
35518
  isOpeningBalance: boolean;
35449
35519
  /** @enum {string} */
35450
- type: "deposit" | "expense" | "transfer";
35520
+ type: "deposit" | "expense" | "transfer" | "payout";
35451
35521
  date: string;
35452
35522
  lines?: {
35453
35523
  uniqueRef?: string | null;
@@ -35785,7 +35855,7 @@ export interface operations {
35785
35855
  uniqueRef?: string | null;
35786
35856
  isOpeningBalance?: boolean;
35787
35857
  /** @enum {string} */
35788
- type: "deposit" | "expense" | "transfer";
35858
+ type: "deposit" | "expense" | "transfer" | "payout";
35789
35859
  date: string;
35790
35860
  currency?: string | null;
35791
35861
  lines: {
@@ -35863,7 +35933,7 @@ export interface operations {
35863
35933
  uniqueRef?: string | null;
35864
35934
  isOpeningBalance: boolean;
35865
35935
  /** @enum {string} */
35866
- type: "deposit" | "expense" | "transfer";
35936
+ type: "deposit" | "expense" | "transfer" | "payout";
35867
35937
  date: string;
35868
35938
  lines: {
35869
35939
  uniqueRef?: string | null;
@@ -36194,7 +36264,7 @@ export interface operations {
36194
36264
  uniqueRef?: string | null;
36195
36265
  isOpeningBalance?: boolean;
36196
36266
  /** @enum {string} */
36197
- type: "deposit" | "expense" | "transfer";
36267
+ type: "deposit" | "expense" | "transfer" | "payout";
36198
36268
  date: string;
36199
36269
  currency?: string | null;
36200
36270
  lines: {
@@ -36488,31 +36558,40 @@ export interface operations {
36488
36558
  getTransactionsCsv: {
36489
36559
  parameters: {
36490
36560
  query?: {
36491
- type?: "deposit" | "expense" | "transfer";
36561
+ type?: "deposit" | "expense" | "transfer" | "payout";
36492
36562
  isOpeningBalance?: boolean;
36493
36563
  status?: "active" | "inactive";
36564
+ /** @description When true, include nested line items in each returned transaction. */
36494
36565
  includeLines?: boolean;
36495
36566
  accountId?: string;
36496
36567
  last4?: string;
36568
+ /** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
36497
36569
  isLocked?: boolean;
36570
+ /** @description Filter by whether the transaction has at least one active journal entry. */
36498
36571
  hasActiveJournalEntries?: boolean;
36499
36572
  /** @description connection id or 'null' */
36500
36573
  connectionId?: string;
36501
36574
  /** @description Amount in cents, also accepts ranges like 100...200 */
36502
36575
  amount?: string;
36576
+ /** @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. */
36503
36577
  paidAtRange?: string;
36504
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
36578
+ /** @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. */
36505
36579
  dateRange?: string;
36506
- /** @description Whether the end date is inclusive or exclusive */
36580
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
36507
36581
  isDateRangeEndInclusive?: boolean;
36582
+ /** @description Comma-separated transaction unique refs. */
36508
36583
  uniqueRefs?: string;
36584
+ /** @description Comma-separated transaction short refs. */
36509
36585
  shortRefs?: string;
36586
+ /** @description Comma-separated transaction ids. */
36510
36587
  ids?: string;
36511
36588
  search?: string;
36512
36589
  recurringTemplateId?: string;
36513
36590
  paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
36591
+ /** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
36514
36592
  reconciled?: boolean;
36515
36593
  contactId?: string;
36594
+ /** @description Comma-separated listing ids. */
36516
36595
  listingIds?: string;
36517
36596
  };
36518
36597
  header?: never;
@@ -36617,31 +36696,40 @@ export interface operations {
36617
36696
  getTransactionsDepositsCsv: {
36618
36697
  parameters: {
36619
36698
  query?: {
36620
- type?: "deposit" | "expense" | "transfer";
36699
+ type?: "deposit" | "expense" | "transfer" | "payout";
36621
36700
  isOpeningBalance?: boolean;
36622
36701
  status?: "active" | "inactive";
36702
+ /** @description When true, include nested line items in each returned transaction. */
36623
36703
  includeLines?: boolean;
36624
36704
  accountId?: string;
36625
36705
  last4?: string;
36706
+ /** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
36626
36707
  isLocked?: boolean;
36708
+ /** @description Filter by whether the transaction has at least one active journal entry. */
36627
36709
  hasActiveJournalEntries?: boolean;
36628
36710
  /** @description connection id or 'null' */
36629
36711
  connectionId?: string;
36630
36712
  /** @description Amount in cents, also accepts ranges like 100...200 */
36631
36713
  amount?: string;
36714
+ /** @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. */
36632
36715
  paidAtRange?: string;
36633
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
36716
+ /** @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. */
36634
36717
  dateRange?: string;
36635
- /** @description Whether the end date is inclusive or exclusive */
36718
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
36636
36719
  isDateRangeEndInclusive?: boolean;
36720
+ /** @description Comma-separated transaction unique refs. */
36637
36721
  uniqueRefs?: string;
36722
+ /** @description Comma-separated transaction short refs. */
36638
36723
  shortRefs?: string;
36724
+ /** @description Comma-separated transaction ids. */
36639
36725
  ids?: string;
36640
36726
  search?: string;
36641
36727
  recurringTemplateId?: string;
36642
36728
  paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
36729
+ /** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
36643
36730
  reconciled?: boolean;
36644
36731
  contactId?: string;
36732
+ /** @description Comma-separated listing ids. */
36645
36733
  listingIds?: string;
36646
36734
  };
36647
36735
  header?: never;
@@ -36746,31 +36834,40 @@ export interface operations {
36746
36834
  getTransactionsExpensesCsv: {
36747
36835
  parameters: {
36748
36836
  query?: {
36749
- type?: "deposit" | "expense" | "transfer";
36837
+ type?: "deposit" | "expense" | "transfer" | "payout";
36750
36838
  isOpeningBalance?: boolean;
36751
36839
  status?: "active" | "inactive";
36840
+ /** @description When true, include nested line items in each returned transaction. */
36752
36841
  includeLines?: boolean;
36753
36842
  accountId?: string;
36754
36843
  last4?: string;
36844
+ /** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
36755
36845
  isLocked?: boolean;
36846
+ /** @description Filter by whether the transaction has at least one active journal entry. */
36756
36847
  hasActiveJournalEntries?: boolean;
36757
36848
  /** @description connection id or 'null' */
36758
36849
  connectionId?: string;
36759
36850
  /** @description Amount in cents, also accepts ranges like 100...200 */
36760
36851
  amount?: string;
36852
+ /** @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. */
36761
36853
  paidAtRange?: string;
36762
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
36854
+ /** @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. */
36763
36855
  dateRange?: string;
36764
- /** @description Whether the end date is inclusive or exclusive */
36856
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
36765
36857
  isDateRangeEndInclusive?: boolean;
36858
+ /** @description Comma-separated transaction unique refs. */
36766
36859
  uniqueRefs?: string;
36860
+ /** @description Comma-separated transaction short refs. */
36767
36861
  shortRefs?: string;
36862
+ /** @description Comma-separated transaction ids. */
36768
36863
  ids?: string;
36769
36864
  search?: string;
36770
36865
  recurringTemplateId?: string;
36771
36866
  paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
36867
+ /** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
36772
36868
  reconciled?: boolean;
36773
36869
  contactId?: string;
36870
+ /** @description Comma-separated listing ids. */
36774
36871
  listingIds?: string;
36775
36872
  };
36776
36873
  header?: never;
@@ -38623,7 +38720,7 @@ export interface operations {
38623
38720
  uniqueRef?: string | null;
38624
38721
  isOpeningBalance: boolean;
38625
38722
  /** @enum {string} */
38626
- type: "deposit" | "expense" | "transfer";
38723
+ type: "deposit" | "expense" | "transfer" | "payout";
38627
38724
  date: string;
38628
38725
  lines: {
38629
38726
  uniqueRef?: string | null;
@@ -38938,31 +39035,40 @@ export interface operations {
38938
39035
  getTransactionsTransfersCsv: {
38939
39036
  parameters: {
38940
39037
  query?: {
38941
- type?: "deposit" | "expense" | "transfer";
39038
+ type?: "deposit" | "expense" | "transfer" | "payout";
38942
39039
  isOpeningBalance?: boolean;
38943
39040
  status?: "active" | "inactive";
39041
+ /** @description When true, include nested line items in each returned transaction. */
38944
39042
  includeLines?: boolean;
38945
39043
  accountId?: string;
38946
39044
  last4?: string;
39045
+ /** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
38947
39046
  isLocked?: boolean;
39047
+ /** @description Filter by whether the transaction has at least one active journal entry. */
38948
39048
  hasActiveJournalEntries?: boolean;
38949
39049
  /** @description connection id or 'null' */
38950
39050
  connectionId?: string;
38951
39051
  /** @description Amount in cents, also accepts ranges like 100...200 */
38952
39052
  amount?: string;
39053
+ /** @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. */
38953
39054
  paidAtRange?: string;
38954
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
39055
+ /** @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. */
38955
39056
  dateRange?: string;
38956
- /** @description Whether the end date is inclusive or exclusive */
39057
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
38957
39058
  isDateRangeEndInclusive?: boolean;
39059
+ /** @description Comma-separated transaction unique refs. */
38958
39060
  uniqueRefs?: string;
39061
+ /** @description Comma-separated transaction short refs. */
38959
39062
  shortRefs?: string;
39063
+ /** @description Comma-separated transaction ids. */
38960
39064
  ids?: string;
38961
39065
  search?: string;
38962
39066
  recurringTemplateId?: string;
38963
39067
  paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
39068
+ /** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
38964
39069
  reconciled?: boolean;
38965
39070
  contactId?: string;
39071
+ /** @description Comma-separated listing ids. */
38966
39072
  listingIds?: string;
38967
39073
  };
38968
39074
  header?: never;
@@ -39088,7 +39194,7 @@ export interface operations {
39088
39194
  uniqueRef?: string | null;
39089
39195
  isOpeningBalance: boolean;
39090
39196
  /** @enum {string} */
39091
- type: "deposit" | "expense" | "transfer";
39197
+ type: "deposit" | "expense" | "transfer" | "payout";
39092
39198
  date: string;
39093
39199
  lines: {
39094
39200
  uniqueRef?: string | null;
@@ -39418,7 +39524,7 @@ export interface operations {
39418
39524
  uniqueRef?: string | null;
39419
39525
  isOpeningBalance?: boolean;
39420
39526
  /** @enum {string} */
39421
- type?: "deposit" | "expense" | "transfer";
39527
+ type?: "deposit" | "expense" | "transfer" | "payout";
39422
39528
  date?: string;
39423
39529
  currency?: string | null;
39424
39530
  attachmentIds?: string[] | null;
@@ -39556,7 +39662,7 @@ export interface operations {
39556
39662
  uniqueRef?: string | null;
39557
39663
  isOpeningBalance: boolean;
39558
39664
  /** @enum {string} */
39559
- type: "deposit" | "expense" | "transfer";
39665
+ type: "deposit" | "expense" | "transfer" | "payout";
39560
39666
  date: string;
39561
39667
  lines: {
39562
39668
  uniqueRef?: string | null;
@@ -40032,7 +40138,7 @@ export interface operations {
40032
40138
  uniqueRef?: string | null;
40033
40139
  isOpeningBalance: boolean;
40034
40140
  /** @enum {string} */
40035
- type: "deposit" | "expense" | "transfer";
40141
+ type: "deposit" | "expense" | "transfer" | "payout";
40036
40142
  date: string;
40037
40143
  lines: {
40038
40144
  uniqueRef?: string | null;