@vrplatform/api 1.3.1-stage.4722 → 1.3.1-stage.4728

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.
@@ -1416,9 +1416,9 @@ export interface paths {
1416
1416
  path?: never;
1417
1417
  cookie?: never;
1418
1418
  };
1419
- /** @description Retrieve opening trial balance */
1419
+ /** @description Retrieve active balance-sheet and equity opening trial balance rows. Operating is editable for non-bank ledger accounts, Trust is read-only, and Combined is calculated as Operating plus Trust. Bank rows are visible but cannot be edited or imported. Trust totals aggregate active Trust journal activity across all party attribution before the GL start date. */
1420
1420
  get: operations["getGeneralLedgerOpeningTrialBalance"];
1421
- /** @description Update the manual opening trial balance. Replaces the manually entered opening balance postings that seed each account as of the go-live date; existing journal activity after that date is not touched. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1421
+ /** @description Update the manual opening trial balance. Replaces Operating values for editable non-bank ledger rows. Trust-backed rows return importable=false but remain manually editable. Bank rows and existing journal activity after the go-live date are not changed. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1422
1422
  put: operations["putGeneralLedgerOpeningTrialBalance"];
1423
1423
  post?: never;
1424
1424
  delete?: never;
@@ -11682,12 +11682,8 @@ export interface operations {
11682
11682
  includeMatchingTransactions?: string;
11683
11683
  hasMatchingTransactions?: boolean;
11684
11684
  reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
11685
- /** @description Field to sort by */
11686
- sortBy?: "created" | "amount" | "matched";
11687
- /** @description Sort direction, defaults to desc */
11688
- sortDirection?: "asc" | "desc";
11689
- /** @description Deprecated: use sortBy + sortDirection */
11690
- sort?: "created_desc" | "created_asc" | "amount_desc" | "amount_asc" | "matched_desc" | "matched_asc";
11685
+ /** @description Sort field; prefix with - for descending order */
11686
+ sort?: "date" | "-date" | "amount" | "-amount" | "matched" | "-matched";
11691
11687
  limit?: number;
11692
11688
  page?: number;
11693
11689
  offset?: number;
@@ -12260,12 +12256,8 @@ export interface operations {
12260
12256
  includeMatchingTransactions?: string;
12261
12257
  hasMatchingTransactions?: boolean;
12262
12258
  reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
12263
- /** @description Field to sort by */
12264
- sortBy?: "created" | "amount" | "matched";
12265
- /** @description Sort direction, defaults to desc */
12266
- sortDirection?: "asc" | "desc";
12267
- /** @description Deprecated: use sortBy + sortDirection */
12268
- sort?: "created_desc" | "created_asc" | "amount_desc" | "amount_asc" | "matched_desc" | "matched_asc";
12259
+ /** @description Sort field; prefix with - for descending order */
12260
+ sort?: "date" | "-date" | "amount" | "-amount" | "matched" | "-matched";
12269
12261
  };
12270
12262
  header?: never;
12271
12263
  path?: never;
@@ -21581,10 +21573,8 @@ export interface operations {
21581
21573
  search?: string;
21582
21574
  /** @description Filter files by their upload purpose. */
21583
21575
  type?: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
21584
- /** @description Field to sort files by. */
21585
- sortBy?: "filename" | "startDate" | "endDate" | "createdAt" | "contactName";
21586
- /** @description Sort direction. */
21587
- sortDirection?: "asc" | "desc";
21576
+ /** @description Sort field; prefix with - for descending order. */
21577
+ sort?: "filename" | "-filename" | "startDate" | "-startDate" | "endDate" | "-endDate" | "createdAt" | "-createdAt" | "contactName" | "-contactName";
21588
21578
  limit?: number;
21589
21579
  page?: number;
21590
21580
  offset?: number;
@@ -26500,6 +26490,7 @@ export interface operations {
26500
26490
  /** @description Value in cents (100 = 1€) */
26501
26491
  operatingCentTotal: number;
26502
26492
  editable: boolean;
26493
+ importable: boolean;
26503
26494
  }[];
26504
26495
  assignment: {
26505
26496
  /** Format: uuid */
@@ -26512,12 +26503,6 @@ export interface operations {
26512
26503
  /** @description Value in cents (100 = 1€) */
26513
26504
  operatingCentTotal: number;
26514
26505
  };
26515
- trustReversal: {
26516
- /** @enum {string} */
26517
- status: "not_created" | "active" | "locked";
26518
- journalEntryIds: string[];
26519
- lastRefreshedAt?: string | null;
26520
- };
26521
26506
  };
26522
26507
  };
26523
26508
  };
@@ -26672,7 +26657,7 @@ export interface operations {
26672
26657
  /** Format: uuid */
26673
26658
  accountId: string;
26674
26659
  /** @description Value in cents (100 = 1€) */
26675
- combinedCentTotal: number;
26660
+ operatingCentTotal: number;
26676
26661
  }[];
26677
26662
  };
26678
26663
  };
@@ -26712,6 +26697,7 @@ export interface operations {
26712
26697
  /** @description Value in cents (100 = 1€) */
26713
26698
  operatingCentTotal: number;
26714
26699
  editable: boolean;
26700
+ importable: boolean;
26715
26701
  }[];
26716
26702
  assignment: {
26717
26703
  /** Format: uuid */
@@ -26724,12 +26710,6 @@ export interface operations {
26724
26710
  /** @description Value in cents (100 = 1€) */
26725
26711
  operatingCentTotal: number;
26726
26712
  };
26727
- trustReversal: {
26728
- /** @enum {string} */
26729
- status: "not_created" | "active" | "locked";
26730
- journalEntryIds: string[];
26731
- lastRefreshedAt?: string | null;
26732
- };
26733
26713
  };
26734
26714
  };
26735
26715
  };
@@ -29136,8 +29116,7 @@ export interface operations {
29136
29116
  query?: {
29137
29117
  search?: string;
29138
29118
  status?: "testing" | "ready" | "deployed";
29139
- sortBy?: "createdAt" | "title";
29140
- sortDirection?: "asc" | "desc";
29119
+ sort?: "createdAt" | "-createdAt" | "title" | "-title";
29141
29120
  limit?: number;
29142
29121
  page?: number;
29143
29122
  offset?: number;
@@ -42556,10 +42535,8 @@ export interface operations {
42556
42535
  partnerId?: string;
42557
42536
  product?: "vrtrust" | "vrintegrations";
42558
42537
  billingPlan?: string;
42559
- /** @description Field to sort by, defaults to created */
42560
- sortBy?: "name" | "created" | "partnerName" | "product" | "activeListings" | "billingPlan";
42561
- /** @description Sort direction, defaults to desc */
42562
- sortDirection?: "asc" | "desc";
42538
+ /** @description Sort field; prefix with - for descending order */
42539
+ sort?: "name" | "-name" | "created" | "-created" | "partnerName" | "-partnerName" | "product" | "-product" | "activeListings" | "-activeListings" | "billingPlan" | "-billingPlan";
42563
42540
  limit?: number;
42564
42541
  page?: number;
42565
42542
  offset?: number;
@@ -42767,10 +42744,8 @@ export interface operations {
42767
42744
  appId?: string;
42768
42745
  /** @description Filter teams by whether an active connection is in error */
42769
42746
  isErrorState?: boolean;
42770
- /** @description Team field to sort by; defaults to createdAt */
42771
- sortBy?: "name" | "createdAt";
42772
- /** @description Sort direction; defaults to desc for createdAt and asc for name */
42773
- sortDirection?: "asc" | "desc";
42747
+ /** @description Sort field; prefix with - for descending order */
42748
+ sort?: "name" | "-name" | "createdAt" | "-createdAt";
42774
42749
  limit?: number;
42775
42750
  page?: number;
42776
42751
  offset?: number;
@@ -43865,10 +43840,8 @@ export interface operations {
43865
43840
  query?: {
43866
43841
  /** @description Filter by team name */
43867
43842
  search?: string;
43868
- /** @description Owner statement status count to sort by */
43869
- sortBy?: "draft" | "inReview" | "published";
43870
- /** @description Sort direction, defaults to asc */
43871
- sortDirection?: "asc" | "desc";
43843
+ /** @description Sort field; prefix with - for descending order */
43844
+ sort?: "name" | "-name" | "draft" | "-draft" | "inReview" | "-inReview" | "published" | "-published";
43872
43845
  limit?: number;
43873
43846
  page?: number;
43874
43847
  offset?: number;
@@ -44063,10 +44036,8 @@ export interface operations {
44063
44036
  teamIds?: string;
44064
44037
  /** @description users: non-owner users with a portfolio membership; owners: owner users linked via membership or owner access; missing: users without any portfolio membership (delete candidates). Omitted returns every linked user. */
44065
44038
  view?: "users" | "owners" | "missing";
44066
- /** @description Field to sort by */
44067
- sortBy?: "name" | "email" | "lastSeen" | "created";
44068
- /** @description Sort direction, defaults to asc */
44069
- sortDirection?: "asc" | "desc";
44039
+ /** @description Sort field; prefix with - for descending order */
44040
+ sort?: "name" | "-name" | "email" | "-email" | "lastSeen" | "-lastSeen" | "created" | "-created";
44070
44041
  limit?: number;
44071
44042
  page?: number;
44072
44043
  offset?: number;
@@ -76153,14 +76124,10 @@ export interface operations {
76153
76124
  connectionId?: string;
76154
76125
  type?: "extract" | "automate" | "flow" | "webhook";
76155
76126
  status?: "queued" | "started" | "completed" | "failed" | "canceled";
76156
- /** @description Deprecated: use sortBy + sortDirection */
76157
- sort?: "created_asc" | "created_desc" | "updated_asc" | "updated_desc";
76127
+ /** @description Sort field; prefix with - for descending order */
76128
+ sort?: "created" | "-created" | "updated" | "-updated";
76158
76129
  /** @description Comma-separated sync IDs. */
76159
76130
  ids?: string;
76160
- /** @description Field to sort by */
76161
- sortBy?: "created" | "updated";
76162
- /** @description Sort direction, defaults to desc */
76163
- sortDirection?: "asc" | "desc";
76164
76131
  limit?: number;
76165
76132
  page?: number;
76166
76133
  offset?: number;
@@ -81765,12 +81732,8 @@ export interface operations {
81765
81732
  /** @description Include partner-dashboard listing, member, connection, issue, and child-team counts. */
81766
81733
  includeAggregates?: boolean;
81767
81734
  type?: "partner" | "propertyManager";
81768
- /** @description Field to sort by */
81769
- sortBy?: "created" | "name" | "type";
81770
- /** @description Sort direction, defaults to desc */
81771
- sortDirection?: "asc" | "desc";
81772
- /** @description Deprecated: use sortBy + sortDirection */
81773
- sort?: "created_desc" | "created_asc" | "name_asc" | "name_desc" | "type_asc" | "type_desc";
81735
+ /** @description Sort field; prefix with - for descending order */
81736
+ sort?: "created" | "-created" | "name" | "-name" | "type" | "-type";
81774
81737
  /** @description You can use elipisis: YYYY-MM-DD...YYYY-MM-DD */
81775
81738
  date?: string;
81776
81739
  limit?: number;