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