@vrplatform/api 1.3.0-stage.1168 → 1.3.0-stage.1170

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.
@@ -1562,6 +1562,40 @@ export interface paths {
1562
1562
  patch?: never;
1563
1563
  trace?: never;
1564
1564
  };
1565
+ "/reports/trust-reconciliation/by-listing": {
1566
+ parameters: {
1567
+ query?: never;
1568
+ header?: never;
1569
+ path?: never;
1570
+ cookie?: never;
1571
+ };
1572
+ /** @description Trust reconciliation grouped by listing */
1573
+ get: operations["getTrustReconciliationReportByListing"];
1574
+ put?: never;
1575
+ post?: never;
1576
+ delete?: never;
1577
+ options?: never;
1578
+ head?: never;
1579
+ patch?: never;
1580
+ trace?: never;
1581
+ };
1582
+ "/reports/trust-reconciliation/by-listing/csv": {
1583
+ parameters: {
1584
+ query?: never;
1585
+ header?: never;
1586
+ path?: never;
1587
+ cookie?: never;
1588
+ };
1589
+ /** @description Trust reconciliation grouped by listing (CSV) */
1590
+ get: operations["getTrustReconciliationReportByListingCsv"];
1591
+ put?: never;
1592
+ post?: never;
1593
+ delete?: never;
1594
+ options?: never;
1595
+ head?: never;
1596
+ patch?: never;
1597
+ trace?: never;
1598
+ };
1565
1599
  "/reports/trust-reconciliation/csv": {
1566
1600
  parameters: {
1567
1601
  query?: never;
@@ -6469,14 +6503,19 @@ export interface operations {
6469
6503
  status?: "active" | "inactive";
6470
6504
  defaultCurrency?: string | null;
6471
6505
  activeRecurringFeePeriods?: {
6472
- listingId: string;
6473
6506
  startAt?: string | null;
6474
6507
  endAt?: string | null;
6475
6508
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6476
6509
  rate?: number | null;
6477
- recurringFeeId: string;
6478
6510
  /** Format: uuid */
6479
6511
  id: string;
6512
+ recurringFee: {
6513
+ /** Format: uuid */
6514
+ id: string;
6515
+ title: string;
6516
+ /** @enum {string} */
6517
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6518
+ };
6480
6519
  }[] | null;
6481
6520
  /** Format: uuid */
6482
6521
  sourceId?: string | null;
@@ -6558,14 +6597,19 @@ export interface operations {
6558
6597
  id: string;
6559
6598
  } | null;
6560
6599
  activeRecurringFeePeriods?: {
6561
- listingId: string;
6562
6600
  startAt?: string | null;
6563
6601
  endAt?: string | null;
6564
6602
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6565
6603
  rate?: number | null;
6566
- recurringFeeId: string;
6567
6604
  /** Format: uuid */
6568
6605
  id: string;
6606
+ recurringFee: {
6607
+ /** Format: uuid */
6608
+ id: string;
6609
+ title: string;
6610
+ /** @enum {string} */
6611
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6612
+ };
6569
6613
  }[] | null;
6570
6614
  source?: {
6571
6615
  /** Format: uuid */
@@ -6799,14 +6843,19 @@ export interface operations {
6799
6843
  id: string;
6800
6844
  } | null;
6801
6845
  activeRecurringFeePeriods?: {
6802
- listingId: string;
6803
6846
  startAt?: string | null;
6804
6847
  endAt?: string | null;
6805
6848
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6806
6849
  rate?: number | null;
6807
- recurringFeeId: string;
6808
6850
  /** Format: uuid */
6809
6851
  id: string;
6852
+ recurringFee: {
6853
+ /** Format: uuid */
6854
+ id: string;
6855
+ title: string;
6856
+ /** @enum {string} */
6857
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6858
+ };
6810
6859
  }[] | null;
6811
6860
  source?: {
6812
6861
  /** Format: uuid */
@@ -6907,14 +6956,19 @@ export interface operations {
6907
6956
  status?: "active" | "inactive";
6908
6957
  defaultCurrency?: string | null;
6909
6958
  activeRecurringFeePeriods?: {
6910
- listingId: string;
6911
6959
  startAt?: string | null;
6912
6960
  endAt?: string | null;
6913
6961
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6914
6962
  rate?: number | null;
6915
- recurringFeeId: string;
6916
6963
  /** Format: uuid */
6917
6964
  id: string;
6965
+ recurringFee: {
6966
+ /** Format: uuid */
6967
+ id: string;
6968
+ title: string;
6969
+ /** @enum {string} */
6970
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6971
+ };
6918
6972
  }[] | null;
6919
6973
  /** Format: uuid */
6920
6974
  sourceId?: string | null;
@@ -6992,14 +7046,19 @@ export interface operations {
6992
7046
  id: string;
6993
7047
  } | null;
6994
7048
  activeRecurringFeePeriods?: {
6995
- listingId: string;
6996
7049
  startAt?: string | null;
6997
7050
  endAt?: string | null;
6998
7051
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6999
7052
  rate?: number | null;
7000
- recurringFeeId: string;
7001
7053
  /** Format: uuid */
7002
7054
  id: string;
7055
+ recurringFee: {
7056
+ /** Format: uuid */
7057
+ id: string;
7058
+ title: string;
7059
+ /** @enum {string} */
7060
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7061
+ };
7003
7062
  }[] | null;
7004
7063
  source?: {
7005
7064
  /** Format: uuid */
@@ -7209,14 +7268,19 @@ export interface operations {
7209
7268
  id: string;
7210
7269
  } | null;
7211
7270
  activeRecurringFeePeriods?: {
7212
- listingId: string;
7213
7271
  startAt?: string | null;
7214
7272
  endAt?: string | null;
7215
7273
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
7216
7274
  rate?: number | null;
7217
- recurringFeeId: string;
7218
7275
  /** Format: uuid */
7219
7276
  id: string;
7277
+ recurringFee: {
7278
+ /** Format: uuid */
7279
+ id: string;
7280
+ title: string;
7281
+ /** @enum {string} */
7282
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7283
+ };
7220
7284
  }[] | null;
7221
7285
  source?: {
7222
7286
  /** Format: uuid */
@@ -7325,14 +7389,19 @@ export interface operations {
7325
7389
  status?: "active" | "inactive";
7326
7390
  defaultCurrency?: string | null;
7327
7391
  activeRecurringFeePeriods?: {
7328
- listingId: string;
7329
7392
  startAt?: string | null;
7330
7393
  endAt?: string | null;
7331
7394
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
7332
7395
  rate?: number | null;
7333
- recurringFeeId: string;
7334
7396
  /** Format: uuid */
7335
7397
  id: string;
7398
+ recurringFee: {
7399
+ /** Format: uuid */
7400
+ id: string;
7401
+ title: string;
7402
+ /** @enum {string} */
7403
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7404
+ };
7336
7405
  }[] | null;
7337
7406
  /** Format: uuid */
7338
7407
  sourceId?: string | null;
@@ -7410,14 +7479,19 @@ export interface operations {
7410
7479
  id: string;
7411
7480
  } | null;
7412
7481
  activeRecurringFeePeriods?: {
7413
- listingId: string;
7414
7482
  startAt?: string | null;
7415
7483
  endAt?: string | null;
7416
7484
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
7417
7485
  rate?: number | null;
7418
- recurringFeeId: string;
7419
7486
  /** Format: uuid */
7420
7487
  id: string;
7488
+ recurringFee: {
7489
+ /** Format: uuid */
7490
+ id: string;
7491
+ title: string;
7492
+ /** @enum {string} */
7493
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7494
+ };
7421
7495
  }[] | null;
7422
7496
  source?: {
7423
7497
  /** Format: uuid */
@@ -9273,9 +9347,15 @@ export interface operations {
9273
9347
  endAt?: string | null;
9274
9348
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9275
9349
  rate?: number | null;
9276
- recurringFeeId: string;
9277
9350
  /** Format: uuid */
9278
9351
  id: string;
9352
+ recurringFee: {
9353
+ /** Format: uuid */
9354
+ id: string;
9355
+ title: string;
9356
+ /** @enum {string} */
9357
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9358
+ };
9279
9359
  }[];
9280
9360
  pagination: {
9281
9361
  /** @default 100 */
@@ -9379,9 +9459,15 @@ export interface operations {
9379
9459
  endAt?: string | null;
9380
9460
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9381
9461
  rate?: number | null;
9382
- recurringFeeId: string;
9383
9462
  /** Format: uuid */
9384
9463
  id: string;
9464
+ recurringFee: {
9465
+ /** Format: uuid */
9466
+ id: string;
9467
+ title: string;
9468
+ /** @enum {string} */
9469
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9470
+ };
9385
9471
  }[];
9386
9472
  };
9387
9473
  };
@@ -9473,9 +9559,15 @@ export interface operations {
9473
9559
  endAt?: string | null;
9474
9560
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9475
9561
  rate?: number | null;
9476
- recurringFeeId: string;
9477
9562
  /** Format: uuid */
9478
9563
  id: string;
9564
+ recurringFee: {
9565
+ /** Format: uuid */
9566
+ id: string;
9567
+ title: string;
9568
+ /** @enum {string} */
9569
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9570
+ };
9479
9571
  };
9480
9572
  };
9481
9573
  };
@@ -9557,9 +9649,15 @@ export interface operations {
9557
9649
  endAt?: string | null;
9558
9650
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9559
9651
  rate?: number | null;
9560
- recurringFeeId: string;
9561
9652
  /** Format: uuid */
9562
9653
  id: string;
9654
+ recurringFee: {
9655
+ /** Format: uuid */
9656
+ id: string;
9657
+ title: string;
9658
+ /** @enum {string} */
9659
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9660
+ };
9563
9661
  };
9564
9662
  };
9565
9663
  };
@@ -22426,6 +22524,168 @@ export interface operations {
22426
22524
  };
22427
22525
  };
22428
22526
  };
22527
+ getTrustReconciliationReportByListing: {
22528
+ parameters: {
22529
+ query: {
22530
+ endDate: string;
22531
+ listingId?: string;
22532
+ };
22533
+ header?: {
22534
+ "X-Team-Id"?: string;
22535
+ };
22536
+ path?: never;
22537
+ cookie?: never;
22538
+ };
22539
+ requestBody?: never;
22540
+ responses: {
22541
+ /** @description Successful response */
22542
+ 200: {
22543
+ headers: {
22544
+ [name: string]: unknown;
22545
+ };
22546
+ content: {
22547
+ "application/json": {
22548
+ data: {
22549
+ id: string;
22550
+ name: string;
22551
+ total: number;
22552
+ sections: {
22553
+ /** @enum {string} */
22554
+ name: "Owner Balance" | "Other Net Liabilities";
22555
+ total: number;
22556
+ /** @enum {string} */
22557
+ type: "accounts";
22558
+ accounts: {
22559
+ id: string;
22560
+ name: string;
22561
+ categoryId: string;
22562
+ total: number;
22563
+ }[];
22564
+ }[];
22565
+ }[];
22566
+ total: number;
22567
+ };
22568
+ };
22569
+ };
22570
+ /** @description Invalid input data */
22571
+ 400: {
22572
+ headers: {
22573
+ [name: string]: unknown;
22574
+ };
22575
+ content: {
22576
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
22577
+ };
22578
+ };
22579
+ /** @description Authorization not provided */
22580
+ 401: {
22581
+ headers: {
22582
+ [name: string]: unknown;
22583
+ };
22584
+ content: {
22585
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
22586
+ };
22587
+ };
22588
+ /** @description Insufficient access */
22589
+ 403: {
22590
+ headers: {
22591
+ [name: string]: unknown;
22592
+ };
22593
+ content: {
22594
+ "application/json": components["schemas"]["error.FORBIDDEN"];
22595
+ };
22596
+ };
22597
+ /** @description Not found */
22598
+ 404: {
22599
+ headers: {
22600
+ [name: string]: unknown;
22601
+ };
22602
+ content: {
22603
+ "application/json": components["schemas"]["error.NOT_FOUND"];
22604
+ };
22605
+ };
22606
+ /** @description Internal server error */
22607
+ 500: {
22608
+ headers: {
22609
+ [name: string]: unknown;
22610
+ };
22611
+ content: {
22612
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
22613
+ };
22614
+ };
22615
+ };
22616
+ };
22617
+ getTrustReconciliationReportByListingCsv: {
22618
+ parameters: {
22619
+ query: {
22620
+ endDate: string;
22621
+ listingId?: string;
22622
+ };
22623
+ header?: {
22624
+ "X-Team-Id"?: string;
22625
+ };
22626
+ path?: never;
22627
+ cookie?: never;
22628
+ };
22629
+ requestBody?: never;
22630
+ responses: {
22631
+ /** @description Successful response */
22632
+ 200: {
22633
+ headers: {
22634
+ [name: string]: unknown;
22635
+ };
22636
+ content: {
22637
+ "application/json": {
22638
+ url: string;
22639
+ };
22640
+ };
22641
+ };
22642
+ /** @description Invalid input data */
22643
+ 400: {
22644
+ headers: {
22645
+ [name: string]: unknown;
22646
+ };
22647
+ content: {
22648
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
22649
+ };
22650
+ };
22651
+ /** @description Authorization not provided */
22652
+ 401: {
22653
+ headers: {
22654
+ [name: string]: unknown;
22655
+ };
22656
+ content: {
22657
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
22658
+ };
22659
+ };
22660
+ /** @description Insufficient access */
22661
+ 403: {
22662
+ headers: {
22663
+ [name: string]: unknown;
22664
+ };
22665
+ content: {
22666
+ "application/json": components["schemas"]["error.FORBIDDEN"];
22667
+ };
22668
+ };
22669
+ /** @description Not found */
22670
+ 404: {
22671
+ headers: {
22672
+ [name: string]: unknown;
22673
+ };
22674
+ content: {
22675
+ "application/json": components["schemas"]["error.NOT_FOUND"];
22676
+ };
22677
+ };
22678
+ /** @description Internal server error */
22679
+ 500: {
22680
+ headers: {
22681
+ [name: string]: unknown;
22682
+ };
22683
+ content: {
22684
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
22685
+ };
22686
+ };
22687
+ };
22688
+ };
22429
22689
  getTrustReconciliationReportCsv: {
22430
22690
  parameters: {
22431
22691
  query: {
@@ -22943,7 +23203,10 @@ export interface operations {
22943
23203
  /** @description comma separated categories */
22944
23204
  categoryIds?: string;
22945
23205
  classifications?: string;
23206
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23207
+ /** @description comma separated journal entry types */
22946
23208
  types?: string;
23209
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
22947
23210
  entityTypes?: string;
22948
23211
  party?: "owners" | "manager";
22949
23212
  includeDetails?: boolean;
@@ -23091,7 +23354,10 @@ export interface operations {
23091
23354
  /** @description comma separated categories */
23092
23355
  categoryIds?: string;
23093
23356
  classifications?: string;
23357
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23358
+ /** @description comma separated journal entry types */
23094
23359
  types?: string;
23360
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
23095
23361
  entityTypes?: string;
23096
23362
  party?: "owners" | "manager";
23097
23363
  };
@@ -23397,7 +23663,10 @@ export interface operations {
23397
23663
  /** @description comma separated categories */
23398
23664
  categoryIds?: string;
23399
23665
  classifications?: string;
23666
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23667
+ /** @description comma separated journal entry types */
23400
23668
  types?: string;
23669
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
23401
23670
  entityTypes?: string;
23402
23671
  limit?: number;
23403
23672
  page?: number;
@@ -23543,7 +23812,10 @@ export interface operations {
23543
23812
  /** @description comma separated categories */
23544
23813
  categoryIds?: string;
23545
23814
  classifications?: string;
23815
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23816
+ /** @description comma separated journal entry types */
23546
23817
  types?: string;
23818
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
23547
23819
  entityTypes?: string;
23548
23820
  };
23549
23821
  header?: {