@vrplatform/api 1.3.1-stage.2069 → 1.3.1-stage.2070

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.
@@ -2873,6 +2873,23 @@ export interface paths {
2873
2873
  patch?: never;
2874
2874
  trace?: never;
2875
2875
  };
2876
+ "/transactions/payouts/csv": {
2877
+ parameters: {
2878
+ query?: never;
2879
+ header?: never;
2880
+ path?: never;
2881
+ cookie?: never;
2882
+ };
2883
+ /** @description Payout transactions CSV export */
2884
+ get: operations["getTransactionsPayoutsCsv"];
2885
+ put?: never;
2886
+ post?: never;
2887
+ delete?: never;
2888
+ options?: never;
2889
+ head?: never;
2890
+ patch?: never;
2891
+ trace?: never;
2892
+ };
2876
2893
  "/transactions/recurring-templates": {
2877
2894
  parameters: {
2878
2895
  query?: never;
@@ -2951,7 +2968,7 @@ export interface paths {
2951
2968
  path?: never;
2952
2969
  cookie?: never;
2953
2970
  };
2954
- /** @description Transfer transactions CSV export */
2971
+ /** @description Legacy transfer transactions CSV export */
2955
2972
  get: operations["getTransactionsTransfersCsv"];
2956
2973
  put?: never;
2957
2974
  post?: never;
@@ -19493,6 +19510,7 @@ export interface operations {
19493
19510
  startDate?: string;
19494
19511
  endDate?: string;
19495
19512
  view?: "month" | "quarter" | "year";
19513
+ ledger?: "trust" | "operating";
19496
19514
  };
19497
19515
  header?: never;
19498
19516
  path?: never;
@@ -19727,9 +19745,10 @@ export interface operations {
19727
19745
  getBalanceSheetReportCsv: {
19728
19746
  parameters: {
19729
19747
  query?: {
19730
- view?: "month" | "quarter" | "year";
19731
19748
  startDate?: string;
19732
19749
  endDate?: string;
19750
+ view?: "month" | "quarter" | "year";
19751
+ ledger?: "trust" | "operating";
19733
19752
  };
19734
19753
  header?: never;
19735
19754
  path?: never;
@@ -20224,6 +20243,7 @@ export interface operations {
20224
20243
  bookingChannels?: string;
20225
20244
  party?: "owners" | "manager";
20226
20245
  openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
20246
+ ledger?: "trust" | "operating";
20227
20247
  includeDetails?: boolean;
20228
20248
  limit?: number;
20229
20249
  page?: number;
@@ -20481,6 +20501,7 @@ export interface operations {
20481
20501
  bookingChannels?: string;
20482
20502
  party?: "owners" | "manager";
20483
20503
  openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
20504
+ ledger?: "trust" | "operating";
20484
20505
  };
20485
20506
  header?: never;
20486
20507
  path?: never;
@@ -21072,6 +21093,7 @@ export interface operations {
21072
21093
  txnCode?: string;
21073
21094
  published?: boolean;
21074
21095
  status?: "active" | "inactive";
21096
+ ledger?: "trust" | "operating";
21075
21097
  startAt?: string;
21076
21098
  endAt?: string;
21077
21099
  search?: string;
@@ -21328,6 +21350,7 @@ export interface operations {
21328
21350
  txnCode?: string;
21329
21351
  published?: boolean;
21330
21352
  status?: "active" | "inactive";
21353
+ ledger?: "trust" | "operating";
21331
21354
  startAt?: string;
21332
21355
  endAt?: string;
21333
21356
  search?: string;
@@ -22190,6 +22213,7 @@ export interface operations {
22190
22213
  party?: "manager" | "owners";
22191
22214
  view?: "party" | "listing" | "month" | "quarter" | "year";
22192
22215
  listingIds?: string;
22216
+ ledger?: "trust" | "operating";
22193
22217
  };
22194
22218
  header?: never;
22195
22219
  path?: never;
@@ -22437,6 +22461,7 @@ export interface operations {
22437
22461
  party?: "manager" | "owners";
22438
22462
  view?: "party" | "listing" | "month" | "quarter" | "year";
22439
22463
  listingIds?: string;
22464
+ ledger?: "trust" | "operating";
22440
22465
  };
22441
22466
  header?: never;
22442
22467
  path?: never;
@@ -22786,6 +22811,7 @@ export interface operations {
22786
22811
  startDate: string;
22787
22812
  endDate: string;
22788
22813
  classification?: string;
22814
+ ledger?: "trust" | "operating";
22789
22815
  type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
22790
22816
  party?: "owners" | "manager";
22791
22817
  accountIds?: string;
@@ -22908,6 +22934,7 @@ export interface operations {
22908
22934
  startDate: string;
22909
22935
  endDate: string;
22910
22936
  classification?: string;
22937
+ ledger?: "trust" | "operating";
22911
22938
  type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
22912
22939
  party?: "owners" | "manager";
22913
22940
  accountIds?: string;
@@ -27894,6 +27921,8 @@ export interface operations {
27894
27921
  /** @description Value in cents (100 = 1€) */
27895
27922
  transfers: number;
27896
27923
  /** @description Value in cents (100 = 1€) */
27924
+ payouts?: number;
27925
+ /** @description Value in cents (100 = 1€) */
27897
27926
  balanceEnd: number;
27898
27927
  };
27899
27928
  payment: {
@@ -28077,6 +28106,12 @@ export interface operations {
28077
28106
  total: number;
28078
28107
  totalFormatted: string;
28079
28108
  }[];
28109
+ payouts?: {
28110
+ id: string;
28111
+ date: string;
28112
+ total: number;
28113
+ totalFormatted: string;
28114
+ }[];
28080
28115
  listing: {
28081
28116
  id: string;
28082
28117
  name: string;
@@ -28119,6 +28154,8 @@ export interface operations {
28119
28154
  /** @description Value in cents (100 = 1€) */
28120
28155
  transfers: number;
28121
28156
  /** @description Value in cents (100 = 1€) */
28157
+ payouts?: number;
28158
+ /** @description Value in cents (100 = 1€) */
28122
28159
  balanceEnd: number;
28123
28160
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
28124
28161
  currency: string;
@@ -28266,6 +28303,8 @@ export interface operations {
28266
28303
  /** @description Value in cents (100 = 1€) */
28267
28304
  transfers: number;
28268
28305
  /** @description Value in cents (100 = 1€) */
28306
+ payouts?: number;
28307
+ /** @description Value in cents (100 = 1€) */
28269
28308
  balanceEnd: number;
28270
28309
  };
28271
28310
  payment: {
@@ -28449,6 +28488,12 @@ export interface operations {
28449
28488
  total: number;
28450
28489
  totalFormatted: string;
28451
28490
  }[];
28491
+ payouts?: {
28492
+ id: string;
28493
+ date: string;
28494
+ total: number;
28495
+ totalFormatted: string;
28496
+ }[];
28452
28497
  listing: {
28453
28498
  id: string;
28454
28499
  name: string;
@@ -28863,6 +28908,8 @@ export interface operations {
28863
28908
  /** @description Value in cents (100 = 1€) */
28864
28909
  transfers: number;
28865
28910
  /** @description Value in cents (100 = 1€) */
28911
+ payouts?: number;
28912
+ /** @description Value in cents (100 = 1€) */
28866
28913
  balanceEnd: number;
28867
28914
  };
28868
28915
  payment: {
@@ -29046,6 +29093,12 @@ export interface operations {
29046
29093
  total: number;
29047
29094
  totalFormatted: string;
29048
29095
  }[];
29096
+ payouts?: {
29097
+ id: string;
29098
+ date: string;
29099
+ total: number;
29100
+ totalFormatted: string;
29101
+ }[];
29049
29102
  listing: {
29050
29103
  id: string;
29051
29104
  name: string;
@@ -31263,6 +31316,8 @@ export interface operations {
31263
31316
  /** @description Value in cents (100 = 1€) */
31264
31317
  transfers: number;
31265
31318
  /** @description Value in cents (100 = 1€) */
31319
+ payouts?: number;
31320
+ /** @description Value in cents (100 = 1€) */
31266
31321
  balanceEnd: number;
31267
31322
  /** @description Currency in ISO 4217 format, will be converted to lowercase */
31268
31323
  currency: string;
@@ -31392,6 +31447,8 @@ export interface operations {
31392
31447
  /** @description Value in cents (100 = 1€) */
31393
31448
  transfers: number;
31394
31449
  /** @description Value in cents (100 = 1€) */
31450
+ payouts?: number;
31451
+ /** @description Value in cents (100 = 1€) */
31395
31452
  balanceEnd: number;
31396
31453
  };
31397
31454
  payment: {
@@ -31575,6 +31632,12 @@ export interface operations {
31575
31632
  total: number;
31576
31633
  totalFormatted: string;
31577
31634
  }[];
31635
+ payouts?: {
31636
+ id: string;
31637
+ date: string;
31638
+ total: number;
31639
+ totalFormatted: string;
31640
+ }[];
31578
31641
  listing: {
31579
31642
  id: string;
31580
31643
  name: string;
@@ -31994,6 +32057,8 @@ export interface operations {
31994
32057
  /** @description Value in cents (100 = 1€) */
31995
32058
  transfers: number;
31996
32059
  /** @description Value in cents (100 = 1€) */
32060
+ payouts?: number;
32061
+ /** @description Value in cents (100 = 1€) */
31997
32062
  balanceEnd: number;
31998
32063
  };
31999
32064
  payment: {
@@ -32177,6 +32242,12 @@ export interface operations {
32177
32242
  total: number;
32178
32243
  totalFormatted: string;
32179
32244
  }[];
32245
+ payouts?: {
32246
+ id: string;
32247
+ date: string;
32248
+ total: number;
32249
+ totalFormatted: string;
32250
+ }[];
32180
32251
  listing: {
32181
32252
  id: string;
32182
32253
  name: string;
@@ -39091,6 +39162,144 @@ export interface operations {
39091
39162
  };
39092
39163
  };
39093
39164
  };
39165
+ getTransactionsPayoutsCsv: {
39166
+ parameters: {
39167
+ query?: {
39168
+ type?: "deposit" | "expense" | "transfer" | "payout";
39169
+ isOpeningBalance?: boolean;
39170
+ status?: "active" | "inactive";
39171
+ /** @description When true, include nested line items in each returned transaction. */
39172
+ includeLines?: boolean;
39173
+ accountId?: string;
39174
+ last4?: string;
39175
+ /** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
39176
+ isLocked?: boolean;
39177
+ /** @description Filter by whether the transaction has at least one active journal entry. */
39178
+ hasActiveJournalEntries?: boolean;
39179
+ /** @description connection id or 'null' */
39180
+ connectionId?: string;
39181
+ /** @description Amount in cents, also accepts ranges like 100...200 */
39182
+ amount?: string;
39183
+ /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
39184
+ paidAtRange?: string;
39185
+ /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
39186
+ dateRange?: string;
39187
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
39188
+ isDateRangeEndInclusive?: boolean;
39189
+ /** @description Comma-separated transaction unique refs. */
39190
+ uniqueRefs?: string;
39191
+ /** @description Comma-separated transaction short refs. */
39192
+ shortRefs?: string;
39193
+ /** @description Comma-separated transaction ids. */
39194
+ ids?: string;
39195
+ search?: string;
39196
+ recurringTemplateId?: string;
39197
+ paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
39198
+ /** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
39199
+ reconciled?: boolean;
39200
+ contactId?: string;
39201
+ /** @description Comma-separated listing ids. */
39202
+ listingIds?: string;
39203
+ };
39204
+ header?: never;
39205
+ path?: never;
39206
+ cookie?: never;
39207
+ };
39208
+ requestBody?: never;
39209
+ responses: {
39210
+ /** @description Successful response */
39211
+ 200: {
39212
+ headers: {
39213
+ [name: string]: unknown;
39214
+ };
39215
+ content: {
39216
+ "application/json": {
39217
+ url: string;
39218
+ };
39219
+ };
39220
+ };
39221
+ /** @description Bad request */
39222
+ 400: {
39223
+ headers: {
39224
+ [name: string]: unknown;
39225
+ };
39226
+ content: {
39227
+ "application/json": {
39228
+ code: string;
39229
+ message: string;
39230
+ issues?: {
39231
+ message: string;
39232
+ }[];
39233
+ context?: unknown;
39234
+ };
39235
+ };
39236
+ };
39237
+ /** @description Unauthorized */
39238
+ 401: {
39239
+ headers: {
39240
+ [name: string]: unknown;
39241
+ };
39242
+ content: {
39243
+ "application/json": {
39244
+ code: string;
39245
+ message: string;
39246
+ issues?: {
39247
+ message: string;
39248
+ }[];
39249
+ context?: unknown;
39250
+ };
39251
+ };
39252
+ };
39253
+ /** @description Forbidden */
39254
+ 403: {
39255
+ headers: {
39256
+ [name: string]: unknown;
39257
+ };
39258
+ content: {
39259
+ "application/json": {
39260
+ code: string;
39261
+ message: string;
39262
+ issues?: {
39263
+ message: string;
39264
+ }[];
39265
+ context?: unknown;
39266
+ };
39267
+ };
39268
+ };
39269
+ /** @description Not found */
39270
+ 404: {
39271
+ headers: {
39272
+ [name: string]: unknown;
39273
+ };
39274
+ content: {
39275
+ "application/json": {
39276
+ code: string;
39277
+ message: string;
39278
+ issues?: {
39279
+ message: string;
39280
+ }[];
39281
+ context?: unknown;
39282
+ };
39283
+ };
39284
+ };
39285
+ /** @description Internal server error */
39286
+ 500: {
39287
+ headers: {
39288
+ [name: string]: unknown;
39289
+ };
39290
+ content: {
39291
+ "application/json": {
39292
+ code: string;
39293
+ message: string;
39294
+ issues?: {
39295
+ message: string;
39296
+ }[];
39297
+ context?: unknown;
39298
+ };
39299
+ };
39300
+ };
39301
+ };
39302
+ };
39094
39303
  getTransactionsRecurringTemplates: {
39095
39304
  parameters: {
39096
39305
  query?: {