@vrplatform/api 1.3.1-stage.1430 → 1.3.1-stage.1432

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.
@@ -1203,23 +1203,6 @@ export interface paths {
1203
1203
  patch?: never;
1204
1204
  trace?: never;
1205
1205
  };
1206
- "/reports/owner-statement-summaries-per-layout-v2": {
1207
- parameters: {
1208
- query?: never;
1209
- header?: never;
1210
- path?: never;
1211
- cookie?: never;
1212
- };
1213
- /** @description Owner statement summaries aggregated by contact (per layout, v2) */
1214
- get: operations["getOwnerStatementSummariesPerLayoutReportV2"];
1215
- put?: never;
1216
- post?: never;
1217
- delete?: never;
1218
- options?: never;
1219
- head?: never;
1220
- patch?: never;
1221
- trace?: never;
1222
- };
1223
1206
  "/reports/owner-statement-summaries-per-layout/csv": {
1224
1207
  parameters: {
1225
1208
  query?: never;
@@ -16196,133 +16179,6 @@ export interface operations {
16196
16179
  };
16197
16180
  };
16198
16181
  };
16199
- getOwnerStatementSummariesPerLayoutReportV2: {
16200
- parameters: {
16201
- query: {
16202
- startAt: string;
16203
- endAt: string;
16204
- /** @description comma separated listings */
16205
- listingIds?: string;
16206
- };
16207
- header?: never;
16208
- path?: never;
16209
- cookie?: never;
16210
- };
16211
- requestBody?: never;
16212
- responses: {
16213
- /** @description Successful response */
16214
- 200: {
16215
- headers: {
16216
- [name: string]: unknown;
16217
- };
16218
- content: {
16219
- "application/json": {
16220
- data: {
16221
- contact: {
16222
- contactId: string;
16223
- name?: string;
16224
- firstName?: string;
16225
- /** Format: email */
16226
- email?: string;
16227
- phone?: string;
16228
- };
16229
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
16230
- currency: string;
16231
- financials: {
16232
- balanceStart: number;
16233
- netRevenue: number;
16234
- expenses: number;
16235
- transfers: number;
16236
- netIncome: number;
16237
- currentBalance: number;
16238
- balanceEnd: number;
16239
- };
16240
- }[];
16241
- };
16242
- };
16243
- };
16244
- /** @description Bad request */
16245
- 400: {
16246
- headers: {
16247
- [name: string]: unknown;
16248
- };
16249
- content: {
16250
- "application/json": {
16251
- code: string;
16252
- message: string;
16253
- issues?: {
16254
- message: string;
16255
- }[];
16256
- context?: unknown;
16257
- };
16258
- };
16259
- };
16260
- /** @description Unauthorized */
16261
- 401: {
16262
- headers: {
16263
- [name: string]: unknown;
16264
- };
16265
- content: {
16266
- "application/json": {
16267
- code: string;
16268
- message: string;
16269
- issues?: {
16270
- message: string;
16271
- }[];
16272
- context?: unknown;
16273
- };
16274
- };
16275
- };
16276
- /** @description Forbidden */
16277
- 403: {
16278
- headers: {
16279
- [name: string]: unknown;
16280
- };
16281
- content: {
16282
- "application/json": {
16283
- code: string;
16284
- message: string;
16285
- issues?: {
16286
- message: string;
16287
- }[];
16288
- context?: unknown;
16289
- };
16290
- };
16291
- };
16292
- /** @description Not found */
16293
- 404: {
16294
- headers: {
16295
- [name: string]: unknown;
16296
- };
16297
- content: {
16298
- "application/json": {
16299
- code: string;
16300
- message: string;
16301
- issues?: {
16302
- message: string;
16303
- }[];
16304
- context?: unknown;
16305
- };
16306
- };
16307
- };
16308
- /** @description Internal server error */
16309
- 500: {
16310
- headers: {
16311
- [name: string]: unknown;
16312
- };
16313
- content: {
16314
- "application/json": {
16315
- code: string;
16316
- message: string;
16317
- issues?: {
16318
- message: string;
16319
- }[];
16320
- context?: unknown;
16321
- };
16322
- };
16323
- };
16324
- };
16325
- };
16326
16182
  getOwnerStatementSummariesPerLayoutReportCsv: {
16327
16183
  parameters: {
16328
16184
  query: {
@@ -16479,15 +16335,44 @@ export interface operations {
16479
16335
  layoutId: string;
16480
16336
  layoutName: string;
16481
16337
  statementIds: string[];
16338
+ draftStatementRefs?: {
16339
+ /** Format: uuid */
16340
+ ownershipPeriodId: string;
16341
+ /** @description Date in format YYYY-MM */
16342
+ month: string;
16343
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16344
+ currency: string;
16345
+ }[];
16482
16346
  netRevenueSection: {
16483
16347
  title: string;
16484
16348
  rows: {
16349
+ id: string;
16485
16350
  title: string;
16486
16351
  statementIds?: string[];
16352
+ draftStatementRefs?: {
16353
+ /** Format: uuid */
16354
+ ownershipPeriodId: string;
16355
+ /** @description Date in format YYYY-MM */
16356
+ month: string;
16357
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16358
+ currency: string;
16359
+ }[];
16360
+ ownerStatements?: {
16361
+ id?: string | null;
16362
+ /** Format: uuid */
16363
+ ownershipPeriodId: string;
16364
+ /** @enum {string} */
16365
+ status: "draft" | "inReview" | "void" | "published";
16366
+ /** @description Date in format YYYY-MM */
16367
+ month: string;
16368
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16369
+ currency: string;
16370
+ }[] | null;
16487
16371
  columns: {
16488
16372
  title: string;
16489
16373
  value: number | string;
16490
16374
  formatted: string;
16375
+ accountIds: string[];
16491
16376
  }[];
16492
16377
  }[];
16493
16378
  subtotal?: {
@@ -16496,18 +16381,40 @@ export interface operations {
16496
16381
  title: string;
16497
16382
  value: number | string;
16498
16383
  formatted: string;
16384
+ accountIds: string[];
16499
16385
  }[];
16500
16386
  };
16501
16387
  };
16502
16388
  otherSections: {
16503
16389
  title: string;
16504
16390
  rows: {
16391
+ id: string;
16505
16392
  title: string;
16506
16393
  statementIds?: string[];
16394
+ draftStatementRefs?: {
16395
+ /** Format: uuid */
16396
+ ownershipPeriodId: string;
16397
+ /** @description Date in format YYYY-MM */
16398
+ month: string;
16399
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16400
+ currency: string;
16401
+ }[];
16402
+ ownerStatements?: {
16403
+ id?: string | null;
16404
+ /** Format: uuid */
16405
+ ownershipPeriodId: string;
16406
+ /** @enum {string} */
16407
+ status: "draft" | "inReview" | "void" | "published";
16408
+ /** @description Date in format YYYY-MM */
16409
+ month: string;
16410
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16411
+ currency: string;
16412
+ }[] | null;
16507
16413
  columns: {
16508
16414
  title: string;
16509
16415
  value: number | string;
16510
16416
  formatted: string;
16417
+ accountIds: string[];
16511
16418
  }[];
16512
16419
  }[];
16513
16420
  subtotal?: {
@@ -16516,18 +16423,40 @@ export interface operations {
16516
16423
  title: string;
16517
16424
  value: number | string;
16518
16425
  formatted: string;
16426
+ accountIds: string[];
16519
16427
  }[];
16520
16428
  };
16521
16429
  }[];
16522
16430
  transfersSection?: {
16523
16431
  title: string;
16524
16432
  rows: {
16433
+ id: string;
16525
16434
  title: string;
16526
16435
  statementIds?: string[];
16436
+ draftStatementRefs?: {
16437
+ /** Format: uuid */
16438
+ ownershipPeriodId: string;
16439
+ /** @description Date in format YYYY-MM */
16440
+ month: string;
16441
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16442
+ currency: string;
16443
+ }[];
16444
+ ownerStatements?: {
16445
+ id?: string | null;
16446
+ /** Format: uuid */
16447
+ ownershipPeriodId: string;
16448
+ /** @enum {string} */
16449
+ status: "draft" | "inReview" | "void" | "published";
16450
+ /** @description Date in format YYYY-MM */
16451
+ month: string;
16452
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
16453
+ currency: string;
16454
+ }[] | null;
16527
16455
  columns: {
16528
16456
  title: string;
16529
16457
  value: number | string;
16530
16458
  formatted: string;
16459
+ accountIds: string[];
16531
16460
  }[];
16532
16461
  }[];
16533
16462
  subtotal?: {
@@ -16536,10 +16465,23 @@ export interface operations {
16536
16465
  title: string;
16537
16466
  value: number | string;
16538
16467
  formatted: string;
16468
+ accountIds: string[];
16539
16469
  }[];
16540
16470
  };
16541
16471
  };
16542
16472
  }[];
16473
+ issues?: {
16474
+ /** @constant */
16475
+ code: "orphanOwnerJournalEntries";
16476
+ /** @constant */
16477
+ severity: "warning";
16478
+ context: {
16479
+ affected: number;
16480
+ startAt: string;
16481
+ endAt: string;
16482
+ };
16483
+ message: string;
16484
+ }[];
16543
16485
  };
16544
16486
  };
16545
16487
  };
@@ -21810,6 +21752,26 @@ export interface operations {
21810
21752
  severity: "error";
21811
21753
  context: Record<string, never>;
21812
21754
  message: string;
21755
+ } | {
21756
+ /** @constant */
21757
+ code: "previousUnpublishedStatement";
21758
+ /** @constant */
21759
+ severity: "error";
21760
+ context: {
21761
+ priorStatementStartAt: string;
21762
+ priorStatementStatus: string;
21763
+ };
21764
+ message: string;
21765
+ } | {
21766
+ /** @constant */
21767
+ code: "previousUnattachedOwnerActivity";
21768
+ /** @constant */
21769
+ severity: "error";
21770
+ context: {
21771
+ affected: number;
21772
+ windowStartAt: string;
21773
+ };
21774
+ message: string;
21813
21775
  } | {
21814
21776
  /** @constant */
21815
21777
  code: "balanceMismatch_start";
@@ -21854,6 +21816,16 @@ export interface operations {
21854
21816
  affected: number;
21855
21817
  };
21856
21818
  message: string;
21819
+ } | {
21820
+ /** @constant */
21821
+ code: "missingPreviousStatement";
21822
+ /** @constant */
21823
+ severity: "warning";
21824
+ context: {
21825
+ periodStartAt: string;
21826
+ statementStartAt: string;
21827
+ };
21828
+ message: string;
21857
21829
  } | {
21858
21830
  /** @constant */
21859
21831
  code: "unpaidReservations";
@@ -21867,8 +21839,10 @@ export interface operations {
21867
21839
  /** @constant */
21868
21840
  severity: "warning";
21869
21841
  context: {
21870
- layoutUpdatedAt: string;
21871
- statementCreatedAt: string;
21842
+ layoutVersion?: number | null;
21843
+ statementLayoutVersion?: number | null;
21844
+ layoutUpdatedAt?: string | null;
21845
+ statementCreatedAt?: string | null;
21872
21846
  };
21873
21847
  message: string;
21874
21848
  })[];
@@ -22101,6 +22075,26 @@ export interface operations {
22101
22075
  severity: "error";
22102
22076
  context: Record<string, never>;
22103
22077
  message: string;
22078
+ } | {
22079
+ /** @constant */
22080
+ code: "previousUnpublishedStatement";
22081
+ /** @constant */
22082
+ severity: "error";
22083
+ context: {
22084
+ priorStatementStartAt: string;
22085
+ priorStatementStatus: string;
22086
+ };
22087
+ message: string;
22088
+ } | {
22089
+ /** @constant */
22090
+ code: "previousUnattachedOwnerActivity";
22091
+ /** @constant */
22092
+ severity: "error";
22093
+ context: {
22094
+ affected: number;
22095
+ windowStartAt: string;
22096
+ };
22097
+ message: string;
22104
22098
  } | {
22105
22099
  /** @constant */
22106
22100
  code: "balanceMismatch_start";
@@ -22145,6 +22139,16 @@ export interface operations {
22145
22139
  affected: number;
22146
22140
  };
22147
22141
  message: string;
22142
+ } | {
22143
+ /** @constant */
22144
+ code: "missingPreviousStatement";
22145
+ /** @constant */
22146
+ severity: "warning";
22147
+ context: {
22148
+ periodStartAt: string;
22149
+ statementStartAt: string;
22150
+ };
22151
+ message: string;
22148
22152
  } | {
22149
22153
  /** @constant */
22150
22154
  code: "unpaidReservations";
@@ -22158,8 +22162,10 @@ export interface operations {
22158
22162
  /** @constant */
22159
22163
  severity: "warning";
22160
22164
  context: {
22161
- layoutUpdatedAt: string;
22162
- statementCreatedAt: string;
22165
+ layoutVersion?: number | null;
22166
+ statementLayoutVersion?: number | null;
22167
+ layoutUpdatedAt?: string | null;
22168
+ statementCreatedAt?: string | null;
22163
22169
  };
22164
22170
  message: string;
22165
22171
  })[];
@@ -22238,6 +22244,7 @@ export interface operations {
22238
22244
  })[];
22239
22245
  }[];
22240
22246
  id: string;
22247
+ version: number;
22241
22248
  activeListings: {
22242
22249
  id: string;
22243
22250
  name?: string | null;
@@ -22591,6 +22598,26 @@ export interface operations {
22591
22598
  severity: "error";
22592
22599
  context: Record<string, never>;
22593
22600
  message: string;
22601
+ } | {
22602
+ /** @constant */
22603
+ code: "previousUnpublishedStatement";
22604
+ /** @constant */
22605
+ severity: "error";
22606
+ context: {
22607
+ priorStatementStartAt: string;
22608
+ priorStatementStatus: string;
22609
+ };
22610
+ message: string;
22611
+ } | {
22612
+ /** @constant */
22613
+ code: "previousUnattachedOwnerActivity";
22614
+ /** @constant */
22615
+ severity: "error";
22616
+ context: {
22617
+ affected: number;
22618
+ windowStartAt: string;
22619
+ };
22620
+ message: string;
22594
22621
  } | {
22595
22622
  /** @constant */
22596
22623
  code: "balanceMismatch_start";
@@ -22635,6 +22662,16 @@ export interface operations {
22635
22662
  affected: number;
22636
22663
  };
22637
22664
  message: string;
22665
+ } | {
22666
+ /** @constant */
22667
+ code: "missingPreviousStatement";
22668
+ /** @constant */
22669
+ severity: "warning";
22670
+ context: {
22671
+ periodStartAt: string;
22672
+ statementStartAt: string;
22673
+ };
22674
+ message: string;
22638
22675
  } | {
22639
22676
  /** @constant */
22640
22677
  code: "unpaidReservations";
@@ -22648,8 +22685,10 @@ export interface operations {
22648
22685
  /** @constant */
22649
22686
  severity: "warning";
22650
22687
  context: {
22651
- layoutUpdatedAt: string;
22652
- statementCreatedAt: string;
22688
+ layoutVersion?: number | null;
22689
+ statementLayoutVersion?: number | null;
22690
+ layoutUpdatedAt?: string | null;
22691
+ statementCreatedAt?: string | null;
22653
22692
  };
22654
22693
  message: string;
22655
22694
  })[];
@@ -22728,6 +22767,7 @@ export interface operations {
22728
22767
  })[];
22729
22768
  }[];
22730
22769
  id: string;
22770
+ version: number;
22731
22771
  activeListings: {
22732
22772
  id: string;
22733
22773
  name?: string | null;
@@ -23085,6 +23125,7 @@ export interface operations {
23085
23125
  })[];
23086
23126
  }[];
23087
23127
  id: string;
23128
+ version: number;
23088
23129
  activeListings: {
23089
23130
  id: string;
23090
23131
  name?: string | null;
@@ -23336,6 +23377,7 @@ export interface operations {
23336
23377
  })[];
23337
23378
  }[];
23338
23379
  id: string;
23380
+ version: number;
23339
23381
  activeListings: {
23340
23382
  id: string;
23341
23383
  name?: string | null;
@@ -23524,6 +23566,7 @@ export interface operations {
23524
23566
  })[];
23525
23567
  }[];
23526
23568
  id: string;
23569
+ version: number;
23527
23570
  activeListings: {
23528
23571
  id: string;
23529
23572
  name?: string | null;
@@ -23767,6 +23810,7 @@ export interface operations {
23767
23810
  })[];
23768
23811
  }[];
23769
23812
  id: string;
23813
+ version: number;
23770
23814
  activeListings: {
23771
23815
  id: string;
23772
23816
  name?: string | null;
@@ -24599,6 +24643,26 @@ export interface operations {
24599
24643
  severity: "error";
24600
24644
  context: Record<string, never>;
24601
24645
  message: string;
24646
+ } | {
24647
+ /** @constant */
24648
+ code: "previousUnpublishedStatement";
24649
+ /** @constant */
24650
+ severity: "error";
24651
+ context: {
24652
+ priorStatementStartAt: string;
24653
+ priorStatementStatus: string;
24654
+ };
24655
+ message: string;
24656
+ } | {
24657
+ /** @constant */
24658
+ code: "previousUnattachedOwnerActivity";
24659
+ /** @constant */
24660
+ severity: "error";
24661
+ context: {
24662
+ affected: number;
24663
+ windowStartAt: string;
24664
+ };
24665
+ message: string;
24602
24666
  } | {
24603
24667
  /** @constant */
24604
24668
  code: "balanceMismatch_start";
@@ -24643,6 +24707,16 @@ export interface operations {
24643
24707
  affected: number;
24644
24708
  };
24645
24709
  message: string;
24710
+ } | {
24711
+ /** @constant */
24712
+ code: "missingPreviousStatement";
24713
+ /** @constant */
24714
+ severity: "warning";
24715
+ context: {
24716
+ periodStartAt: string;
24717
+ statementStartAt: string;
24718
+ };
24719
+ message: string;
24646
24720
  } | {
24647
24721
  /** @constant */
24648
24722
  code: "unpaidReservations";
@@ -24656,8 +24730,10 @@ export interface operations {
24656
24730
  /** @constant */
24657
24731
  severity: "warning";
24658
24732
  context: {
24659
- layoutUpdatedAt: string;
24660
- statementCreatedAt: string;
24733
+ layoutVersion?: number | null;
24734
+ statementLayoutVersion?: number | null;
24735
+ layoutUpdatedAt?: string | null;
24736
+ statementCreatedAt?: string | null;
24661
24737
  };
24662
24738
  message: string;
24663
24739
  })[];
@@ -24736,6 +24812,7 @@ export interface operations {
24736
24812
  })[];
24737
24813
  }[];
24738
24814
  id: string;
24815
+ version: number;
24739
24816
  activeListings: {
24740
24817
  id: string;
24741
24818
  name?: string | null;
@@ -25094,6 +25171,26 @@ export interface operations {
25094
25171
  severity: "error";
25095
25172
  context: Record<string, never>;
25096
25173
  message: string;
25174
+ } | {
25175
+ /** @constant */
25176
+ code: "previousUnpublishedStatement";
25177
+ /** @constant */
25178
+ severity: "error";
25179
+ context: {
25180
+ priorStatementStartAt: string;
25181
+ priorStatementStatus: string;
25182
+ };
25183
+ message: string;
25184
+ } | {
25185
+ /** @constant */
25186
+ code: "previousUnattachedOwnerActivity";
25187
+ /** @constant */
25188
+ severity: "error";
25189
+ context: {
25190
+ affected: number;
25191
+ windowStartAt: string;
25192
+ };
25193
+ message: string;
25097
25194
  } | {
25098
25195
  /** @constant */
25099
25196
  code: "balanceMismatch_start";
@@ -25138,6 +25235,16 @@ export interface operations {
25138
25235
  affected: number;
25139
25236
  };
25140
25237
  message: string;
25238
+ } | {
25239
+ /** @constant */
25240
+ code: "missingPreviousStatement";
25241
+ /** @constant */
25242
+ severity: "warning";
25243
+ context: {
25244
+ periodStartAt: string;
25245
+ statementStartAt: string;
25246
+ };
25247
+ message: string;
25141
25248
  } | {
25142
25249
  /** @constant */
25143
25250
  code: "unpaidReservations";
@@ -25151,8 +25258,10 @@ export interface operations {
25151
25258
  /** @constant */
25152
25259
  severity: "warning";
25153
25260
  context: {
25154
- layoutUpdatedAt: string;
25155
- statementCreatedAt: string;
25261
+ layoutVersion?: number | null;
25262
+ statementLayoutVersion?: number | null;
25263
+ layoutUpdatedAt?: string | null;
25264
+ statementCreatedAt?: string | null;
25156
25265
  };
25157
25266
  message: string;
25158
25267
  })[];
@@ -25231,6 +25340,7 @@ export interface operations {
25231
25340
  })[];
25232
25341
  }[];
25233
25342
  id: string;
25343
+ version: number;
25234
25344
  activeListings: {
25235
25345
  id: string;
25236
25346
  name?: string | null;