@vrplatform/api 1.3.1-1776 → 1.3.1-1789

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.
@@ -1736,32 +1736,15 @@ export interface paths {
1736
1736
  patch?: never;
1737
1737
  trace?: never;
1738
1738
  };
1739
- "/statements/csv": {
1740
- parameters: {
1741
- query?: never;
1742
- header?: never;
1743
- path?: never;
1744
- cookie?: never;
1745
- };
1746
- /** @description Get Owner Statement CSV export */
1747
- get: operations["getStatementsCsv"];
1748
- put?: never;
1749
- post?: never;
1750
- delete?: never;
1751
- options?: never;
1752
- head?: never;
1753
- patch?: never;
1754
- trace?: never;
1755
- };
1756
- "/statements/csv/batch": {
1739
+ "/statements/batch/csv": {
1757
1740
  parameters: {
1758
1741
  query?: never;
1759
1742
  header?: never;
1760
1743
  path?: never;
1761
1744
  cookie?: never;
1762
1745
  };
1763
- /** @description Get Owner Statement CSV ZIP export */
1764
- get: operations["getStatementsCsvBatch"];
1746
+ /** @description Get Owner Statement CSV export (detailed) */
1747
+ get: operations["getStatementsBatchCsv"];
1765
1748
  put?: never;
1766
1749
  post?: never;
1767
1750
  delete?: never;
@@ -1770,15 +1753,15 @@ export interface paths {
1770
1753
  patch?: never;
1771
1754
  trace?: never;
1772
1755
  };
1773
- "/statements/csv/detailed": {
1756
+ "/statements/csv": {
1774
1757
  parameters: {
1775
1758
  query?: never;
1776
1759
  header?: never;
1777
1760
  path?: never;
1778
1761
  cookie?: never;
1779
1762
  };
1780
- /** @description Get Owner Statement CSV export (detailed) */
1781
- get: operations["getStatementsCsvDetailed"];
1763
+ /** @description Get Owner Statement CSV export */
1764
+ get: operations["getStatementsCsv"];
1782
1765
  put?: never;
1783
1766
  post?: never;
1784
1767
  delete?: never;
@@ -2085,23 +2068,6 @@ export interface paths {
2085
2068
  patch?: never;
2086
2069
  trace?: never;
2087
2070
  };
2088
- "/teams/opening-balances/advanced-deposits/synced-payments-refunds/{reservationId}": {
2089
- parameters: {
2090
- query?: never;
2091
- header?: never;
2092
- path?: never;
2093
- cookie?: never;
2094
- };
2095
- /** @description Retrieve synced payments/refunds for a single reservation (review advanced deposits) */
2096
- get: operations["getTeamsOpening-balancesAdvanced-depositsSynced-payments-refunds:reservationId"];
2097
- put?: never;
2098
- post?: never;
2099
- delete?: never;
2100
- options?: never;
2101
- head?: never;
2102
- patch?: never;
2103
- trace?: never;
2104
- };
2105
2071
  "/teams/opening-balances/tax-payable": {
2106
2072
  parameters: {
2107
2073
  query?: never;
@@ -15758,6 +15724,8 @@ export interface operations {
15758
15724
  id: string;
15759
15725
  title: string;
15760
15726
  categoryId: string;
15727
+ /** @enum {string} */
15728
+ party?: "owners" | "manager";
15761
15729
  values: {
15762
15730
  id: string;
15763
15731
  title: string;
@@ -15788,6 +15756,8 @@ export interface operations {
15788
15756
  id: string;
15789
15757
  title: string;
15790
15758
  categoryId: string;
15759
+ /** @enum {string} */
15760
+ party?: "owners" | "manager";
15791
15761
  values: {
15792
15762
  id: string;
15793
15763
  title: string;
@@ -15818,6 +15788,8 @@ export interface operations {
15818
15788
  id: string;
15819
15789
  title: string;
15820
15790
  categoryId: string;
15791
+ /** @enum {string} */
15792
+ party?: "owners" | "manager";
15821
15793
  values: {
15822
15794
  id: string;
15823
15795
  title: string;
@@ -15848,6 +15820,8 @@ export interface operations {
15848
15820
  id: string;
15849
15821
  title: string;
15850
15822
  categoryId: string;
15823
+ /** @enum {string} */
15824
+ party?: "owners" | "manager";
15851
15825
  values: {
15852
15826
  id: string;
15853
15827
  title: string;
@@ -16455,6 +16429,62 @@ export interface operations {
16455
16429
  id: string;
16456
16430
  /** @enum {string} */
16457
16431
  active: "active" | "inactive";
16432
+ issues: ({
16433
+ /** @constant */
16434
+ code: "generalLedgerStartAt";
16435
+ /** @constant */
16436
+ severity: "warning";
16437
+ context: {
16438
+ statementStartAt?: string | null;
16439
+ };
16440
+ } | {
16441
+ /** @constant */
16442
+ code: "listingInactive";
16443
+ /** @constant */
16444
+ severity: "warning";
16445
+ context: {
16446
+ listingOwnershipPeriodId?: string | null;
16447
+ };
16448
+ } | {
16449
+ /** @constant */
16450
+ code: "reservationGeneralLedgerStatusInactive";
16451
+ /** @constant */
16452
+ severity: "warning";
16453
+ context: {
16454
+ reservationId?: string | null;
16455
+ };
16456
+ } | {
16457
+ /** @constant */
16458
+ code: "cancelledReservationLine";
16459
+ /** @constant */
16460
+ severity: "warning";
16461
+ context: {
16462
+ reservationId?: string | null;
16463
+ };
16464
+ } | {
16465
+ /** @constant */
16466
+ code: "inactiveAccount";
16467
+ /** @constant */
16468
+ severity: "warning";
16469
+ context: {
16470
+ accountId?: string | null;
16471
+ };
16472
+ } | {
16473
+ /** @constant */
16474
+ code: "nonPostingAccount";
16475
+ /** @constant */
16476
+ severity: "warning";
16477
+ context: {
16478
+ accountId?: string | null;
16479
+ };
16480
+ } | {
16481
+ /** @constant */
16482
+ code: "unknownInactiveReason";
16483
+ /** @constant */
16484
+ severity: "error";
16485
+ context: Record<string, never>;
16486
+ message: string;
16487
+ })[];
16458
16488
  txnCode: string;
16459
16489
  txnAt: string;
16460
16490
  description: string;
@@ -17059,6 +17089,62 @@ export interface operations {
17059
17089
  id: string;
17060
17090
  /** @enum {string} */
17061
17091
  active: "active" | "inactive";
17092
+ issues: ({
17093
+ /** @constant */
17094
+ code: "generalLedgerStartAt";
17095
+ /** @constant */
17096
+ severity: "warning";
17097
+ context: {
17098
+ statementStartAt?: string | null;
17099
+ };
17100
+ } | {
17101
+ /** @constant */
17102
+ code: "listingInactive";
17103
+ /** @constant */
17104
+ severity: "warning";
17105
+ context: {
17106
+ listingOwnershipPeriodId?: string | null;
17107
+ };
17108
+ } | {
17109
+ /** @constant */
17110
+ code: "reservationGeneralLedgerStatusInactive";
17111
+ /** @constant */
17112
+ severity: "warning";
17113
+ context: {
17114
+ reservationId?: string | null;
17115
+ };
17116
+ } | {
17117
+ /** @constant */
17118
+ code: "cancelledReservationLine";
17119
+ /** @constant */
17120
+ severity: "warning";
17121
+ context: {
17122
+ reservationId?: string | null;
17123
+ };
17124
+ } | {
17125
+ /** @constant */
17126
+ code: "inactiveAccount";
17127
+ /** @constant */
17128
+ severity: "warning";
17129
+ context: {
17130
+ accountId?: string | null;
17131
+ };
17132
+ } | {
17133
+ /** @constant */
17134
+ code: "nonPostingAccount";
17135
+ /** @constant */
17136
+ severity: "warning";
17137
+ context: {
17138
+ accountId?: string | null;
17139
+ };
17140
+ } | {
17141
+ /** @constant */
17142
+ code: "unknownInactiveReason";
17143
+ /** @constant */
17144
+ severity: "error";
17145
+ context: Record<string, never>;
17146
+ message: string;
17147
+ })[];
17062
17148
  txnCode: string;
17063
17149
  txnAt: string;
17064
17150
  description: string;
@@ -20459,6 +20545,8 @@ export interface operations {
20459
20545
  "application/json": {
20460
20546
  dangerouslyAllowLocked?: boolean;
20461
20547
  ids?: string[];
20548
+ /** @enum {string} */
20549
+ mode?: "full" | "recurringFeesOnly" | "decoupledAdjustmentsOnly" | "arOnly";
20462
20550
  repairManagerFeeBalance?: boolean;
20463
20551
  };
20464
20552
  };
@@ -24967,139 +25055,11 @@ export interface operations {
24967
25055
  };
24968
25056
  };
24969
25057
  };
24970
- getStatementsCsv: {
24971
- parameters: {
24972
- query?: {
24973
- limit?: number;
24974
- page?: number;
24975
- /** @description comma separated periods */
24976
- periodIds?: string;
24977
- /** @description Year in format YYYY */
24978
- year?: number;
24979
- /** @description comma separated listings */
24980
- listingIds?: string;
24981
- /** @description comma separated statements */
24982
- statementIds?: string;
24983
- /** @description Date in format YYYY-MM */
24984
- month?: string;
24985
- search?: string;
24986
- status?: ("draft" | "inReview" | "published") | "all";
24987
- /** @description comma separated owners */
24988
- ownerIds?: string;
24989
- /** @description comma separated owners */
24990
- listingCollectionIds?: string;
24991
- /** @description comma separated recurring fees */
24992
- recurringFeeIds?: string;
24993
- /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
24994
- dateRange?: string;
24995
- /** @description Whether the end date is inclusive or exclusive */
24996
- isDateRangeEndInclusive?: boolean;
24997
- };
24998
- header?: never;
24999
- path?: never;
25000
- cookie?: never;
25001
- };
25002
- requestBody?: never;
25003
- responses: {
25004
- /** @description Successful response */
25005
- 200: {
25006
- headers: {
25007
- [name: string]: unknown;
25008
- };
25009
- content: {
25010
- "application/json": {
25011
- url: string;
25012
- expIn: number;
25013
- };
25014
- };
25015
- };
25016
- /** @description Bad request */
25017
- 400: {
25018
- headers: {
25019
- [name: string]: unknown;
25020
- };
25021
- content: {
25022
- "application/json": {
25023
- code: string;
25024
- message: string;
25025
- issues?: {
25026
- message: string;
25027
- }[];
25028
- context?: unknown;
25029
- };
25030
- };
25031
- };
25032
- /** @description Unauthorized */
25033
- 401: {
25034
- headers: {
25035
- [name: string]: unknown;
25036
- };
25037
- content: {
25038
- "application/json": {
25039
- code: string;
25040
- message: string;
25041
- issues?: {
25042
- message: string;
25043
- }[];
25044
- context?: unknown;
25045
- };
25046
- };
25047
- };
25048
- /** @description Forbidden */
25049
- 403: {
25050
- headers: {
25051
- [name: string]: unknown;
25052
- };
25053
- content: {
25054
- "application/json": {
25055
- code: string;
25056
- message: string;
25057
- issues?: {
25058
- message: string;
25059
- }[];
25060
- context?: unknown;
25061
- };
25062
- };
25063
- };
25064
- /** @description Not found */
25065
- 404: {
25066
- headers: {
25067
- [name: string]: unknown;
25068
- };
25069
- content: {
25070
- "application/json": {
25071
- code: string;
25072
- message: string;
25073
- issues?: {
25074
- message: string;
25075
- }[];
25076
- context?: unknown;
25077
- };
25078
- };
25079
- };
25080
- /** @description Internal server error */
25081
- 500: {
25082
- headers: {
25083
- [name: string]: unknown;
25084
- };
25085
- content: {
25086
- "application/json": {
25087
- code: string;
25088
- message: string;
25089
- issues?: {
25090
- message: string;
25091
- }[];
25092
- context?: unknown;
25093
- };
25094
- };
25095
- };
25096
- };
25097
- };
25098
- getStatementsCsvBatch: {
25058
+ getStatementsBatchCsv: {
25099
25059
  parameters: {
25100
25060
  query: {
25101
- /** @description comma separated ownership periods */
25102
- ownershipPeriodIds: string;
25061
+ viewAs?: "owner" | "manager";
25062
+ ownershipPeriodId: string;
25103
25063
  /** @description Date in format YYYY-MM */
25104
25064
  month: string;
25105
25065
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
@@ -25205,7 +25165,7 @@ export interface operations {
25205
25165
  };
25206
25166
  };
25207
25167
  };
25208
- getStatementsCsvDetailed: {
25168
+ getStatementsCsv: {
25209
25169
  parameters: {
25210
25170
  query?: {
25211
25171
  limit?: number;
@@ -25226,8 +25186,6 @@ export interface operations {
25226
25186
  ownerIds?: string;
25227
25187
  /** @description comma separated owners */
25228
25188
  listingCollectionIds?: string;
25229
- /** @description statement layout id */
25230
- layoutId?: string;
25231
25189
  /** @description comma separated recurring fees */
25232
25190
  recurringFeeIds?: string;
25233
25191
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
@@ -29626,8 +29584,6 @@ export interface operations {
29626
29584
  countryCode?: string | null;
29627
29585
  } | null;
29628
29586
  phone?: string | null;
29629
- /** Format: email */
29630
- email: string;
29631
29587
  taxId?: string | null;
29632
29588
  companyName?: string | null;
29633
29589
  /** @enum {string} */
@@ -29655,6 +29611,8 @@ export interface operations {
29655
29611
  userId: string;
29656
29612
  role: string;
29657
29613
  }[] | null;
29614
+ /** Format: email */
29615
+ email: string;
29658
29616
  };
29659
29617
  };
29660
29618
  };
@@ -30110,7 +30068,10 @@ export interface operations {
30110
30068
  };
30111
30069
  "getTeamsOpening-balancesAdvanced-depositsSynced-payments-refunds": {
30112
30070
  parameters: {
30113
- query?: never;
30071
+ query?: {
30072
+ /** @description comma separated list of reservation ids */
30073
+ reservationsIds?: string;
30074
+ };
30114
30075
  header?: never;
30115
30076
  path?: never;
30116
30077
  cookie?: never;
@@ -30240,135 +30201,6 @@ export interface operations {
30240
30201
  };
30241
30202
  };
30242
30203
  };
30243
- "getTeamsOpening-balancesAdvanced-depositsSynced-payments-refunds:reservationId": {
30244
- parameters: {
30245
- query?: never;
30246
- header?: never;
30247
- path: {
30248
- reservationId: string;
30249
- };
30250
- cookie?: never;
30251
- };
30252
- requestBody?: never;
30253
- responses: {
30254
- /** @description Successful response */
30255
- 200: {
30256
- headers: {
30257
- [name: string]: unknown;
30258
- };
30259
- content: {
30260
- "application/json": {
30261
- /** Format: uuid */
30262
- reservationId: string;
30263
- listingId?: string | null;
30264
- confirmationCode?: string | null;
30265
- guestName?: string | null;
30266
- checkIn?: string | null;
30267
- checkOut?: string | null;
30268
- bookedAt?: string | null;
30269
- reservationAmount?: number | null;
30270
- /** @description Value in cents (100 = 1€) */
30271
- payment: number;
30272
- /** @description Value in cents (100 = 1€) */
30273
- refund: number;
30274
- transactions: {
30275
- /** Format: uuid */
30276
- transactionId: string;
30277
- /** Format: uuid */
30278
- transactionLineId: string;
30279
- date: string;
30280
- uniqueRef?: string | null;
30281
- description?: string | null;
30282
- /** @description Value in cents (100 = 1€) */
30283
- amount: number;
30284
- /** @enum {string} */
30285
- direction: "payment" | "refund";
30286
- }[];
30287
- };
30288
- };
30289
- };
30290
- /** @description Bad request */
30291
- 400: {
30292
- headers: {
30293
- [name: string]: unknown;
30294
- };
30295
- content: {
30296
- "application/json": {
30297
- code: string;
30298
- message: string;
30299
- issues?: {
30300
- message: string;
30301
- }[];
30302
- context?: unknown;
30303
- };
30304
- };
30305
- };
30306
- /** @description Unauthorized */
30307
- 401: {
30308
- headers: {
30309
- [name: string]: unknown;
30310
- };
30311
- content: {
30312
- "application/json": {
30313
- code: string;
30314
- message: string;
30315
- issues?: {
30316
- message: string;
30317
- }[];
30318
- context?: unknown;
30319
- };
30320
- };
30321
- };
30322
- /** @description Forbidden */
30323
- 403: {
30324
- headers: {
30325
- [name: string]: unknown;
30326
- };
30327
- content: {
30328
- "application/json": {
30329
- code: string;
30330
- message: string;
30331
- issues?: {
30332
- message: string;
30333
- }[];
30334
- context?: unknown;
30335
- };
30336
- };
30337
- };
30338
- /** @description Not found */
30339
- 404: {
30340
- headers: {
30341
- [name: string]: unknown;
30342
- };
30343
- content: {
30344
- "application/json": {
30345
- code: string;
30346
- message: string;
30347
- issues?: {
30348
- message: string;
30349
- }[];
30350
- context?: unknown;
30351
- };
30352
- };
30353
- };
30354
- /** @description Internal server error */
30355
- 500: {
30356
- headers: {
30357
- [name: string]: unknown;
30358
- };
30359
- content: {
30360
- "application/json": {
30361
- code: string;
30362
- message: string;
30363
- issues?: {
30364
- message: string;
30365
- }[];
30366
- context?: unknown;
30367
- };
30368
- };
30369
- };
30370
- };
30371
- };
30372
30204
  "getTeamsOpening-balancesTax-payable": {
30373
30205
  parameters: {
30374
30206
  query?: never;
@@ -30835,8 +30667,6 @@ export interface operations {
30835
30667
  countryCode?: string | null;
30836
30668
  } | null;
30837
30669
  phone?: string | null;
30838
- /** Format: email */
30839
- email?: string;
30840
30670
  taxId?: string | null;
30841
30671
  companyName?: string | null;
30842
30672
  /** @enum {string} */
@@ -30852,6 +30682,8 @@ export interface operations {
30852
30682
  ownerPortalShowDraftStatements?: boolean;
30853
30683
  partnerId?: string | null;
30854
30684
  billingPartnerId?: string | null;
30685
+ /** Format: email */
30686
+ email?: string;
30855
30687
  /** @description Cancelation or Reinstatement of the team. */
30856
30688
  cancelation?: {
30857
30689
  /** @description Date on which the cancelation will take effect or null if an active cancellation should be withdrawn. */
@@ -31623,6 +31455,9 @@ export interface operations {
31623
31455
  hasActiveJournalEntries?: boolean;
31624
31456
  /** @description connection id or 'null' */
31625
31457
  connectionId?: string;
31458
+ /** @description Amount in cents, also accepts ranges like 100...200 */
31459
+ amount?: string;
31460
+ paidAtRange?: string;
31626
31461
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
31627
31462
  dateRange?: string;
31628
31463
  /** @description Whether the end date is inclusive or exclusive */
@@ -32695,6 +32530,9 @@ export interface operations {
32695
32530
  hasActiveJournalEntries?: boolean;
32696
32531
  /** @description connection id or 'null' */
32697
32532
  connectionId?: string;
32533
+ /** @description Amount in cents, also accepts ranges like 100...200 */
32534
+ amount?: string;
32535
+ paidAtRange?: string;
32698
32536
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
32699
32537
  dateRange?: string;
32700
32538
  /** @description Whether the end date is inclusive or exclusive */
@@ -32820,6 +32658,9 @@ export interface operations {
32820
32658
  hasActiveJournalEntries?: boolean;
32821
32659
  /** @description connection id or 'null' */
32822
32660
  connectionId?: string;
32661
+ /** @description Amount in cents, also accepts ranges like 100...200 */
32662
+ amount?: string;
32663
+ paidAtRange?: string;
32823
32664
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
32824
32665
  dateRange?: string;
32825
32666
  /** @description Whether the end date is inclusive or exclusive */
@@ -32945,6 +32786,9 @@ export interface operations {
32945
32786
  hasActiveJournalEntries?: boolean;
32946
32787
  /** @description connection id or 'null' */
32947
32788
  connectionId?: string;
32789
+ /** @description Amount in cents, also accepts ranges like 100...200 */
32790
+ amount?: string;
32791
+ paidAtRange?: string;
32948
32792
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
32949
32793
  dateRange?: string;
32950
32794
  /** @description Whether the end date is inclusive or exclusive */
@@ -35132,6 +34976,9 @@ export interface operations {
35132
34976
  hasActiveJournalEntries?: boolean;
35133
34977
  /** @description connection id or 'null' */
35134
34978
  connectionId?: string;
34979
+ /** @description Amount in cents, also accepts ranges like 100...200 */
34980
+ amount?: string;
34981
+ paidAtRange?: string;
35135
34982
  /** @description Date range in format YYYY-MM-DD...YYYY-MM-DD */
35136
34983
  dateRange?: string;
35137
34984
  /** @description Whether the end date is inclusive or exclusive */