@vrplatform/api 1.3.0-stage.1281 → 1.3.0-stage.1284

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.
@@ -1867,6 +1867,74 @@ export interface paths {
1867
1867
  patch?: never;
1868
1868
  trace?: never;
1869
1869
  };
1870
+ "/reports/owner-statement-summaries-per-layout": {
1871
+ parameters: {
1872
+ query?: never;
1873
+ header?: never;
1874
+ path?: never;
1875
+ cookie?: never;
1876
+ };
1877
+ /** @description Owner statement summaries aggregated by contact (per layout) */
1878
+ get: operations["getOwnerStatementSummariesPerLayoutReport"];
1879
+ put?: never;
1880
+ post?: never;
1881
+ delete?: never;
1882
+ options?: never;
1883
+ head?: never;
1884
+ patch?: never;
1885
+ trace?: never;
1886
+ };
1887
+ "/reports/owner-statement-summaries-per-layout/csv": {
1888
+ parameters: {
1889
+ query?: never;
1890
+ header?: never;
1891
+ path?: never;
1892
+ cookie?: never;
1893
+ };
1894
+ /** @description Owner statement summaries aggregated by contact (per layout, CSV) */
1895
+ get: operations["getOwnerStatementSummariesPerLayoutReportCsv"];
1896
+ put?: never;
1897
+ post?: never;
1898
+ delete?: never;
1899
+ options?: never;
1900
+ head?: never;
1901
+ patch?: never;
1902
+ trace?: never;
1903
+ };
1904
+ "/reports/owner-statement-summaries-per-layout/details/{contactId}": {
1905
+ parameters: {
1906
+ query?: never;
1907
+ header?: never;
1908
+ path?: never;
1909
+ cookie?: never;
1910
+ };
1911
+ /** @description Owner statement summary detail aggregated by listing, month, reservation, or booking channel (per layout) */
1912
+ get: operations["getOwnerStatementSummaryPerLayoutDetailsReport"];
1913
+ put?: never;
1914
+ post?: never;
1915
+ delete?: never;
1916
+ options?: never;
1917
+ head?: never;
1918
+ patch?: never;
1919
+ trace?: never;
1920
+ };
1921
+ "/reports/owner-statement-summaries-per-layout/details/{contactId}/csv": {
1922
+ parameters: {
1923
+ query?: never;
1924
+ header?: never;
1925
+ path?: never;
1926
+ cookie?: never;
1927
+ };
1928
+ /** @description Owner statement summary detail aggregated by listing, month, reservation, or booking channel (per layout, CSV) */
1929
+ get: operations["getOwnerStatementSummaryPerLayoutDetailsReportCsv"];
1930
+ put?: never;
1931
+ post?: never;
1932
+ delete?: never;
1933
+ options?: never;
1934
+ head?: never;
1935
+ patch?: never;
1936
+ trace?: never;
1937
+ };
1870
1938
  "/reports/trial-balance": {
1871
1939
  parameters: {
1872
1940
  query?: never;
@@ -4289,6 +4357,7 @@ export interface operations {
4289
4357
  "application/json": {
4290
4358
  dangerouslyAllowLocked?: boolean;
4291
4359
  ids?: string[];
4360
+ repairManagerFeeBalance?: boolean;
4292
4361
  };
4293
4362
  };
4294
4363
  };
@@ -24027,6 +24096,413 @@ export interface operations {
24027
24096
  };
24028
24097
  };
24029
24098
  };
24099
+ getOwnerStatementSummariesPerLayoutReport: {
24100
+ parameters: {
24101
+ query: {
24102
+ startAt: string;
24103
+ endAt: string;
24104
+ /** @description comma separated listings */
24105
+ listingIds?: string;
24106
+ };
24107
+ header?: {
24108
+ "X-Team-Id"?: string;
24109
+ };
24110
+ path?: never;
24111
+ cookie?: never;
24112
+ };
24113
+ requestBody?: never;
24114
+ responses: {
24115
+ /** @description Successful response */
24116
+ 200: {
24117
+ headers: {
24118
+ [name: string]: unknown;
24119
+ };
24120
+ content: {
24121
+ "application/json": {
24122
+ data: {
24123
+ contact: {
24124
+ contactId: string;
24125
+ name?: string;
24126
+ firstName?: string;
24127
+ /** Format: email */
24128
+ email?: string;
24129
+ phone?: string;
24130
+ };
24131
+ currency: string;
24132
+ financials: {
24133
+ balanceStart: number;
24134
+ netRevenue: number;
24135
+ expenses: number;
24136
+ transfers: number;
24137
+ netIncome: number;
24138
+ currentBalance: number;
24139
+ balanceEnd: number;
24140
+ };
24141
+ }[];
24142
+ };
24143
+ };
24144
+ };
24145
+ /** @description Invalid input data */
24146
+ 400: {
24147
+ headers: {
24148
+ [name: string]: unknown;
24149
+ };
24150
+ content: {
24151
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
24152
+ };
24153
+ };
24154
+ /** @description Authorization not provided */
24155
+ 401: {
24156
+ headers: {
24157
+ [name: string]: unknown;
24158
+ };
24159
+ content: {
24160
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
24161
+ };
24162
+ };
24163
+ /** @description Insufficient access */
24164
+ 403: {
24165
+ headers: {
24166
+ [name: string]: unknown;
24167
+ };
24168
+ content: {
24169
+ "application/json": components["schemas"]["error.FORBIDDEN"];
24170
+ };
24171
+ };
24172
+ /** @description Not found */
24173
+ 404: {
24174
+ headers: {
24175
+ [name: string]: unknown;
24176
+ };
24177
+ content: {
24178
+ "application/json": components["schemas"]["error.NOT_FOUND"];
24179
+ };
24180
+ };
24181
+ /** @description Internal server error */
24182
+ 500: {
24183
+ headers: {
24184
+ [name: string]: unknown;
24185
+ };
24186
+ content: {
24187
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
24188
+ };
24189
+ };
24190
+ };
24191
+ };
24192
+ getOwnerStatementSummariesPerLayoutReportCsv: {
24193
+ parameters: {
24194
+ query: {
24195
+ startAt: string;
24196
+ endAt: string;
24197
+ /** @description comma separated listings */
24198
+ listingIds?: string;
24199
+ };
24200
+ header?: {
24201
+ "X-Team-Id"?: string;
24202
+ };
24203
+ path?: never;
24204
+ cookie?: never;
24205
+ };
24206
+ requestBody?: never;
24207
+ responses: {
24208
+ /** @description Successful response */
24209
+ 200: {
24210
+ headers: {
24211
+ [name: string]: unknown;
24212
+ };
24213
+ content: {
24214
+ "application/json": {
24215
+ url: string;
24216
+ };
24217
+ };
24218
+ };
24219
+ /** @description Invalid input data */
24220
+ 400: {
24221
+ headers: {
24222
+ [name: string]: unknown;
24223
+ };
24224
+ content: {
24225
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
24226
+ };
24227
+ };
24228
+ /** @description Authorization not provided */
24229
+ 401: {
24230
+ headers: {
24231
+ [name: string]: unknown;
24232
+ };
24233
+ content: {
24234
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
24235
+ };
24236
+ };
24237
+ /** @description Insufficient access */
24238
+ 403: {
24239
+ headers: {
24240
+ [name: string]: unknown;
24241
+ };
24242
+ content: {
24243
+ "application/json": components["schemas"]["error.FORBIDDEN"];
24244
+ };
24245
+ };
24246
+ /** @description Not found */
24247
+ 404: {
24248
+ headers: {
24249
+ [name: string]: unknown;
24250
+ };
24251
+ content: {
24252
+ "application/json": components["schemas"]["error.NOT_FOUND"];
24253
+ };
24254
+ };
24255
+ /** @description Internal server error */
24256
+ 500: {
24257
+ headers: {
24258
+ [name: string]: unknown;
24259
+ };
24260
+ content: {
24261
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
24262
+ };
24263
+ };
24264
+ };
24265
+ };
24266
+ getOwnerStatementSummaryPerLayoutDetailsReport: {
24267
+ parameters: {
24268
+ query: {
24269
+ view: "listing" | "month" | "reservation" | "bookingChannel";
24270
+ startAt: string;
24271
+ endAt: string;
24272
+ /** @description comma separated listings */
24273
+ listingIds?: string;
24274
+ currency?: string;
24275
+ viewAs?: "owner" | "manager";
24276
+ };
24277
+ header?: {
24278
+ "X-Team-Id"?: string;
24279
+ };
24280
+ path: {
24281
+ contactId: string;
24282
+ };
24283
+ cookie?: never;
24284
+ };
24285
+ requestBody?: never;
24286
+ responses: {
24287
+ /** @description Successful response */
24288
+ 200: {
24289
+ headers: {
24290
+ [name: string]: unknown;
24291
+ };
24292
+ content: {
24293
+ "application/json": {
24294
+ currency: string;
24295
+ contact: {
24296
+ contactId: string;
24297
+ name?: string;
24298
+ firstName?: string;
24299
+ /** Format: email */
24300
+ email?: string;
24301
+ phone?: string;
24302
+ };
24303
+ financials: {
24304
+ balanceStart: number;
24305
+ netRevenue: number;
24306
+ expenses: number;
24307
+ transfers: number;
24308
+ netIncome: number;
24309
+ currentBalance: number;
24310
+ balanceEnd: number;
24311
+ };
24312
+ layouts: {
24313
+ layoutId: string;
24314
+ layoutName: string;
24315
+ statementIds: string[];
24316
+ netRevenueSection: {
24317
+ title: string;
24318
+ rows: {
24319
+ title: string;
24320
+ statementIds?: string[];
24321
+ columns: {
24322
+ title: string;
24323
+ value: number | string;
24324
+ formatted: string;
24325
+ }[];
24326
+ }[];
24327
+ subtotal?: {
24328
+ title: string;
24329
+ columns: {
24330
+ title: string;
24331
+ value: number | string;
24332
+ formatted: string;
24333
+ }[];
24334
+ };
24335
+ };
24336
+ otherSections: {
24337
+ title: string;
24338
+ rows: {
24339
+ title: string;
24340
+ statementIds?: string[];
24341
+ columns: {
24342
+ title: string;
24343
+ value: number | string;
24344
+ formatted: string;
24345
+ }[];
24346
+ }[];
24347
+ subtotal?: {
24348
+ title: string;
24349
+ columns: {
24350
+ title: string;
24351
+ value: number | string;
24352
+ formatted: string;
24353
+ }[];
24354
+ };
24355
+ }[];
24356
+ transfersSection?: {
24357
+ title: string;
24358
+ rows: {
24359
+ title: string;
24360
+ statementIds?: string[];
24361
+ columns: {
24362
+ title: string;
24363
+ value: number | string;
24364
+ formatted: string;
24365
+ }[];
24366
+ }[];
24367
+ subtotal?: {
24368
+ title: string;
24369
+ columns: {
24370
+ title: string;
24371
+ value: number | string;
24372
+ formatted: string;
24373
+ }[];
24374
+ };
24375
+ };
24376
+ }[];
24377
+ };
24378
+ };
24379
+ };
24380
+ /** @description Invalid input data */
24381
+ 400: {
24382
+ headers: {
24383
+ [name: string]: unknown;
24384
+ };
24385
+ content: {
24386
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
24387
+ };
24388
+ };
24389
+ /** @description Authorization not provided */
24390
+ 401: {
24391
+ headers: {
24392
+ [name: string]: unknown;
24393
+ };
24394
+ content: {
24395
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
24396
+ };
24397
+ };
24398
+ /** @description Insufficient access */
24399
+ 403: {
24400
+ headers: {
24401
+ [name: string]: unknown;
24402
+ };
24403
+ content: {
24404
+ "application/json": components["schemas"]["error.FORBIDDEN"];
24405
+ };
24406
+ };
24407
+ /** @description Not found */
24408
+ 404: {
24409
+ headers: {
24410
+ [name: string]: unknown;
24411
+ };
24412
+ content: {
24413
+ "application/json": components["schemas"]["error.NOT_FOUND"];
24414
+ };
24415
+ };
24416
+ /** @description Internal server error */
24417
+ 500: {
24418
+ headers: {
24419
+ [name: string]: unknown;
24420
+ };
24421
+ content: {
24422
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
24423
+ };
24424
+ };
24425
+ };
24426
+ };
24427
+ getOwnerStatementSummaryPerLayoutDetailsReportCsv: {
24428
+ parameters: {
24429
+ query: {
24430
+ view: "listing" | "month" | "reservation" | "bookingChannel";
24431
+ startAt: string;
24432
+ endAt: string;
24433
+ /** @description comma separated listings */
24434
+ listingIds?: string;
24435
+ currency?: string;
24436
+ viewAs?: "owner" | "manager";
24437
+ };
24438
+ header?: {
24439
+ "X-Team-Id"?: string;
24440
+ };
24441
+ path: {
24442
+ contactId: string;
24443
+ };
24444
+ cookie?: never;
24445
+ };
24446
+ requestBody?: never;
24447
+ responses: {
24448
+ /** @description Successful response */
24449
+ 200: {
24450
+ headers: {
24451
+ [name: string]: unknown;
24452
+ };
24453
+ content: {
24454
+ "application/json": {
24455
+ url: string;
24456
+ };
24457
+ };
24458
+ };
24459
+ /** @description Invalid input data */
24460
+ 400: {
24461
+ headers: {
24462
+ [name: string]: unknown;
24463
+ };
24464
+ content: {
24465
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
24466
+ };
24467
+ };
24468
+ /** @description Authorization not provided */
24469
+ 401: {
24470
+ headers: {
24471
+ [name: string]: unknown;
24472
+ };
24473
+ content: {
24474
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
24475
+ };
24476
+ };
24477
+ /** @description Insufficient access */
24478
+ 403: {
24479
+ headers: {
24480
+ [name: string]: unknown;
24481
+ };
24482
+ content: {
24483
+ "application/json": components["schemas"]["error.FORBIDDEN"];
24484
+ };
24485
+ };
24486
+ /** @description Not found */
24487
+ 404: {
24488
+ headers: {
24489
+ [name: string]: unknown;
24490
+ };
24491
+ content: {
24492
+ "application/json": components["schemas"]["error.NOT_FOUND"];
24493
+ };
24494
+ };
24495
+ /** @description Internal server error */
24496
+ 500: {
24497
+ headers: {
24498
+ [name: string]: unknown;
24499
+ };
24500
+ content: {
24501
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
24502
+ };
24503
+ };
24504
+ };
24505
+ };
24030
24506
  getTrialBalanceReport: {
24031
24507
  parameters: {
24032
24508
  query: {