@vrplatform/api 1.3.1-stage.2069 → 1.3.1-stage.2071
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.
package/package.json
CHANGED
package/src/generated/v1.ts
CHANGED
|
@@ -2874,6 +2874,23 @@ export interface paths {
|
|
|
2874
2874
|
patch?: never;
|
|
2875
2875
|
trace?: never;
|
|
2876
2876
|
};
|
|
2877
|
+
"/transactions/payouts/csv": {
|
|
2878
|
+
parameters: {
|
|
2879
|
+
query?: never;
|
|
2880
|
+
header?: never;
|
|
2881
|
+
path?: never;
|
|
2882
|
+
cookie?: never;
|
|
2883
|
+
};
|
|
2884
|
+
/** @description Payout transactions CSV export */
|
|
2885
|
+
get: operations["getTransactionsPayoutsCsv"];
|
|
2886
|
+
put?: never;
|
|
2887
|
+
post?: never;
|
|
2888
|
+
delete?: never;
|
|
2889
|
+
options?: never;
|
|
2890
|
+
head?: never;
|
|
2891
|
+
patch?: never;
|
|
2892
|
+
trace?: never;
|
|
2893
|
+
};
|
|
2877
2894
|
"/transactions/recurring-templates": {
|
|
2878
2895
|
parameters: {
|
|
2879
2896
|
query?: never;
|
|
@@ -2952,7 +2969,7 @@ export interface paths {
|
|
|
2952
2969
|
path?: never;
|
|
2953
2970
|
cookie?: never;
|
|
2954
2971
|
};
|
|
2955
|
-
/** @description
|
|
2972
|
+
/** @description Legacy transfer transactions CSV export */
|
|
2956
2973
|
get: operations["getTransactionsTransfersCsv"];
|
|
2957
2974
|
put?: never;
|
|
2958
2975
|
post?: never;
|
|
@@ -19494,6 +19511,7 @@ export interface operations {
|
|
|
19494
19511
|
startDate?: string;
|
|
19495
19512
|
endDate?: string;
|
|
19496
19513
|
view?: "month" | "quarter" | "year";
|
|
19514
|
+
ledger?: "trust" | "operating";
|
|
19497
19515
|
};
|
|
19498
19516
|
header?: never;
|
|
19499
19517
|
path?: never;
|
|
@@ -19728,9 +19746,10 @@ export interface operations {
|
|
|
19728
19746
|
getBalanceSheetReportCsv: {
|
|
19729
19747
|
parameters: {
|
|
19730
19748
|
query?: {
|
|
19731
|
-
view?: "month" | "quarter" | "year";
|
|
19732
19749
|
startDate?: string;
|
|
19733
19750
|
endDate?: string;
|
|
19751
|
+
view?: "month" | "quarter" | "year";
|
|
19752
|
+
ledger?: "trust" | "operating";
|
|
19734
19753
|
};
|
|
19735
19754
|
header?: never;
|
|
19736
19755
|
path?: never;
|
|
@@ -20225,6 +20244,7 @@ export interface operations {
|
|
|
20225
20244
|
bookingChannels?: string;
|
|
20226
20245
|
party?: "owners" | "manager";
|
|
20227
20246
|
openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
|
|
20247
|
+
ledger?: "trust" | "operating";
|
|
20228
20248
|
includeDetails?: boolean;
|
|
20229
20249
|
limit?: number;
|
|
20230
20250
|
page?: number;
|
|
@@ -20482,6 +20502,7 @@ export interface operations {
|
|
|
20482
20502
|
bookingChannels?: string;
|
|
20483
20503
|
party?: "owners" | "manager";
|
|
20484
20504
|
openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
|
|
20505
|
+
ledger?: "trust" | "operating";
|
|
20485
20506
|
};
|
|
20486
20507
|
header?: never;
|
|
20487
20508
|
path?: never;
|
|
@@ -20615,6 +20636,7 @@ export interface operations {
|
|
|
20615
20636
|
netIncome: number;
|
|
20616
20637
|
adjustments: number;
|
|
20617
20638
|
transfers: number;
|
|
20639
|
+
payouts: number;
|
|
20618
20640
|
};
|
|
20619
20641
|
}[];
|
|
20620
20642
|
};
|
|
@@ -20839,6 +20861,7 @@ export interface operations {
|
|
|
20839
20861
|
netIncome: number;
|
|
20840
20862
|
adjustments: number;
|
|
20841
20863
|
transfers: number;
|
|
20864
|
+
payouts: number;
|
|
20842
20865
|
};
|
|
20843
20866
|
accounts: {
|
|
20844
20867
|
id: string;
|
|
@@ -21073,6 +21096,7 @@ export interface operations {
|
|
|
21073
21096
|
txnCode?: string;
|
|
21074
21097
|
published?: boolean;
|
|
21075
21098
|
status?: "active" | "inactive";
|
|
21099
|
+
ledger?: "trust" | "operating";
|
|
21076
21100
|
startAt?: string;
|
|
21077
21101
|
endAt?: string;
|
|
21078
21102
|
search?: string;
|
|
@@ -21329,6 +21353,7 @@ export interface operations {
|
|
|
21329
21353
|
txnCode?: string;
|
|
21330
21354
|
published?: boolean;
|
|
21331
21355
|
status?: "active" | "inactive";
|
|
21356
|
+
ledger?: "trust" | "operating";
|
|
21332
21357
|
startAt?: string;
|
|
21333
21358
|
endAt?: string;
|
|
21334
21359
|
search?: string;
|
|
@@ -21503,6 +21528,7 @@ export interface operations {
|
|
|
21503
21528
|
expenses: number;
|
|
21504
21529
|
reserve: number;
|
|
21505
21530
|
transfers: number;
|
|
21531
|
+
payouts: number;
|
|
21506
21532
|
netIncome: number;
|
|
21507
21533
|
currentBalance: number;
|
|
21508
21534
|
balanceEnd: number;
|
|
@@ -21853,6 +21879,7 @@ export interface operations {
|
|
|
21853
21879
|
expenses: number;
|
|
21854
21880
|
reserve: number;
|
|
21855
21881
|
transfers: number;
|
|
21882
|
+
payouts: number;
|
|
21856
21883
|
netIncome: number;
|
|
21857
21884
|
currentBalance: number;
|
|
21858
21885
|
balanceEnd: number;
|
|
@@ -22191,6 +22218,7 @@ export interface operations {
|
|
|
22191
22218
|
party?: "manager" | "owners";
|
|
22192
22219
|
view?: "party" | "listing" | "month" | "quarter" | "year";
|
|
22193
22220
|
listingIds?: string;
|
|
22221
|
+
ledger?: "trust" | "operating";
|
|
22194
22222
|
};
|
|
22195
22223
|
header?: never;
|
|
22196
22224
|
path?: never;
|
|
@@ -22438,6 +22466,7 @@ export interface operations {
|
|
|
22438
22466
|
party?: "manager" | "owners";
|
|
22439
22467
|
view?: "party" | "listing" | "month" | "quarter" | "year";
|
|
22440
22468
|
listingIds?: string;
|
|
22469
|
+
ledger?: "trust" | "operating";
|
|
22441
22470
|
};
|
|
22442
22471
|
header?: never;
|
|
22443
22472
|
path?: never;
|
|
@@ -22787,6 +22816,7 @@ export interface operations {
|
|
|
22787
22816
|
startDate: string;
|
|
22788
22817
|
endDate: string;
|
|
22789
22818
|
classification?: string;
|
|
22819
|
+
ledger?: "trust" | "operating";
|
|
22790
22820
|
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
22791
22821
|
party?: "owners" | "manager";
|
|
22792
22822
|
accountIds?: string;
|
|
@@ -22909,6 +22939,7 @@ export interface operations {
|
|
|
22909
22939
|
startDate: string;
|
|
22910
22940
|
endDate: string;
|
|
22911
22941
|
classification?: string;
|
|
22942
|
+
ledger?: "trust" | "operating";
|
|
22912
22943
|
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
22913
22944
|
party?: "owners" | "manager";
|
|
22914
22945
|
accountIds?: string;
|
|
@@ -27895,6 +27926,8 @@ export interface operations {
|
|
|
27895
27926
|
/** @description Value in cents (100 = 1€) */
|
|
27896
27927
|
transfers: number;
|
|
27897
27928
|
/** @description Value in cents (100 = 1€) */
|
|
27929
|
+
payouts?: number;
|
|
27930
|
+
/** @description Value in cents (100 = 1€) */
|
|
27898
27931
|
balanceEnd: number;
|
|
27899
27932
|
};
|
|
27900
27933
|
payment: {
|
|
@@ -28078,6 +28111,12 @@ export interface operations {
|
|
|
28078
28111
|
total: number;
|
|
28079
28112
|
totalFormatted: string;
|
|
28080
28113
|
}[];
|
|
28114
|
+
payouts?: {
|
|
28115
|
+
id: string;
|
|
28116
|
+
date: string;
|
|
28117
|
+
total: number;
|
|
28118
|
+
totalFormatted: string;
|
|
28119
|
+
}[];
|
|
28081
28120
|
listing: {
|
|
28082
28121
|
id: string;
|
|
28083
28122
|
name: string;
|
|
@@ -28120,6 +28159,8 @@ export interface operations {
|
|
|
28120
28159
|
/** @description Value in cents (100 = 1€) */
|
|
28121
28160
|
transfers: number;
|
|
28122
28161
|
/** @description Value in cents (100 = 1€) */
|
|
28162
|
+
payouts?: number;
|
|
28163
|
+
/** @description Value in cents (100 = 1€) */
|
|
28123
28164
|
balanceEnd: number;
|
|
28124
28165
|
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
28125
28166
|
currency: string;
|
|
@@ -28267,6 +28308,8 @@ export interface operations {
|
|
|
28267
28308
|
/** @description Value in cents (100 = 1€) */
|
|
28268
28309
|
transfers: number;
|
|
28269
28310
|
/** @description Value in cents (100 = 1€) */
|
|
28311
|
+
payouts?: number;
|
|
28312
|
+
/** @description Value in cents (100 = 1€) */
|
|
28270
28313
|
balanceEnd: number;
|
|
28271
28314
|
};
|
|
28272
28315
|
payment: {
|
|
@@ -28450,6 +28493,12 @@ export interface operations {
|
|
|
28450
28493
|
total: number;
|
|
28451
28494
|
totalFormatted: string;
|
|
28452
28495
|
}[];
|
|
28496
|
+
payouts?: {
|
|
28497
|
+
id: string;
|
|
28498
|
+
date: string;
|
|
28499
|
+
total: number;
|
|
28500
|
+
totalFormatted: string;
|
|
28501
|
+
}[];
|
|
28453
28502
|
listing: {
|
|
28454
28503
|
id: string;
|
|
28455
28504
|
name: string;
|
|
@@ -28864,6 +28913,8 @@ export interface operations {
|
|
|
28864
28913
|
/** @description Value in cents (100 = 1€) */
|
|
28865
28914
|
transfers: number;
|
|
28866
28915
|
/** @description Value in cents (100 = 1€) */
|
|
28916
|
+
payouts?: number;
|
|
28917
|
+
/** @description Value in cents (100 = 1€) */
|
|
28867
28918
|
balanceEnd: number;
|
|
28868
28919
|
};
|
|
28869
28920
|
payment: {
|
|
@@ -29047,6 +29098,12 @@ export interface operations {
|
|
|
29047
29098
|
total: number;
|
|
29048
29099
|
totalFormatted: string;
|
|
29049
29100
|
}[];
|
|
29101
|
+
payouts?: {
|
|
29102
|
+
id: string;
|
|
29103
|
+
date: string;
|
|
29104
|
+
total: number;
|
|
29105
|
+
totalFormatted: string;
|
|
29106
|
+
}[];
|
|
29050
29107
|
listing: {
|
|
29051
29108
|
id: string;
|
|
29052
29109
|
name: string;
|
|
@@ -31264,6 +31321,8 @@ export interface operations {
|
|
|
31264
31321
|
/** @description Value in cents (100 = 1€) */
|
|
31265
31322
|
transfers: number;
|
|
31266
31323
|
/** @description Value in cents (100 = 1€) */
|
|
31324
|
+
payouts?: number;
|
|
31325
|
+
/** @description Value in cents (100 = 1€) */
|
|
31267
31326
|
balanceEnd: number;
|
|
31268
31327
|
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
31269
31328
|
currency: string;
|
|
@@ -31393,6 +31452,8 @@ export interface operations {
|
|
|
31393
31452
|
/** @description Value in cents (100 = 1€) */
|
|
31394
31453
|
transfers: number;
|
|
31395
31454
|
/** @description Value in cents (100 = 1€) */
|
|
31455
|
+
payouts?: number;
|
|
31456
|
+
/** @description Value in cents (100 = 1€) */
|
|
31396
31457
|
balanceEnd: number;
|
|
31397
31458
|
};
|
|
31398
31459
|
payment: {
|
|
@@ -31576,6 +31637,12 @@ export interface operations {
|
|
|
31576
31637
|
total: number;
|
|
31577
31638
|
totalFormatted: string;
|
|
31578
31639
|
}[];
|
|
31640
|
+
payouts?: {
|
|
31641
|
+
id: string;
|
|
31642
|
+
date: string;
|
|
31643
|
+
total: number;
|
|
31644
|
+
totalFormatted: string;
|
|
31645
|
+
}[];
|
|
31579
31646
|
listing: {
|
|
31580
31647
|
id: string;
|
|
31581
31648
|
name: string;
|
|
@@ -31995,6 +32062,8 @@ export interface operations {
|
|
|
31995
32062
|
/** @description Value in cents (100 = 1€) */
|
|
31996
32063
|
transfers: number;
|
|
31997
32064
|
/** @description Value in cents (100 = 1€) */
|
|
32065
|
+
payouts?: number;
|
|
32066
|
+
/** @description Value in cents (100 = 1€) */
|
|
31998
32067
|
balanceEnd: number;
|
|
31999
32068
|
};
|
|
32000
32069
|
payment: {
|
|
@@ -32178,6 +32247,12 @@ export interface operations {
|
|
|
32178
32247
|
total: number;
|
|
32179
32248
|
totalFormatted: string;
|
|
32180
32249
|
}[];
|
|
32250
|
+
payouts?: {
|
|
32251
|
+
id: string;
|
|
32252
|
+
date: string;
|
|
32253
|
+
total: number;
|
|
32254
|
+
totalFormatted: string;
|
|
32255
|
+
}[];
|
|
32181
32256
|
listing: {
|
|
32182
32257
|
id: string;
|
|
32183
32258
|
name: string;
|
|
@@ -39092,6 +39167,144 @@ export interface operations {
|
|
|
39092
39167
|
};
|
|
39093
39168
|
};
|
|
39094
39169
|
};
|
|
39170
|
+
getTransactionsPayoutsCsv: {
|
|
39171
|
+
parameters: {
|
|
39172
|
+
query?: {
|
|
39173
|
+
type?: "deposit" | "expense" | "transfer" | "payout";
|
|
39174
|
+
isOpeningBalance?: boolean;
|
|
39175
|
+
status?: "active" | "inactive";
|
|
39176
|
+
/** @description When true, include nested line items in each returned transaction. */
|
|
39177
|
+
includeLines?: boolean;
|
|
39178
|
+
accountId?: string;
|
|
39179
|
+
last4?: string;
|
|
39180
|
+
/** @description Filter by lock state. True returns locked rows; false returns unlocked rows. */
|
|
39181
|
+
isLocked?: boolean;
|
|
39182
|
+
/** @description Filter by whether the transaction has at least one active journal entry. */
|
|
39183
|
+
hasActiveJournalEntries?: boolean;
|
|
39184
|
+
/** @description connection id or 'null' */
|
|
39185
|
+
connectionId?: string;
|
|
39186
|
+
/** @description Amount in cents, also accepts ranges like 100...200 */
|
|
39187
|
+
amount?: string;
|
|
39188
|
+
/** @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. */
|
|
39189
|
+
paidAtRange?: string;
|
|
39190
|
+
/** @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. */
|
|
39191
|
+
dateRange?: string;
|
|
39192
|
+
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
39193
|
+
isDateRangeEndInclusive?: boolean;
|
|
39194
|
+
/** @description Comma-separated transaction unique refs. */
|
|
39195
|
+
uniqueRefs?: string;
|
|
39196
|
+
/** @description Comma-separated transaction short refs. */
|
|
39197
|
+
shortRefs?: string;
|
|
39198
|
+
/** @description Comma-separated transaction ids. */
|
|
39199
|
+
ids?: string;
|
|
39200
|
+
search?: string;
|
|
39201
|
+
recurringTemplateId?: string;
|
|
39202
|
+
paidStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
39203
|
+
/** @description Filter by reconciled state. True returns reconciled rows; false returns unreconciled rows. */
|
|
39204
|
+
reconciled?: boolean;
|
|
39205
|
+
contactId?: string;
|
|
39206
|
+
/** @description Comma-separated listing ids. */
|
|
39207
|
+
listingIds?: string;
|
|
39208
|
+
};
|
|
39209
|
+
header?: never;
|
|
39210
|
+
path?: never;
|
|
39211
|
+
cookie?: never;
|
|
39212
|
+
};
|
|
39213
|
+
requestBody?: never;
|
|
39214
|
+
responses: {
|
|
39215
|
+
/** @description Successful response */
|
|
39216
|
+
200: {
|
|
39217
|
+
headers: {
|
|
39218
|
+
[name: string]: unknown;
|
|
39219
|
+
};
|
|
39220
|
+
content: {
|
|
39221
|
+
"application/json": {
|
|
39222
|
+
url: string;
|
|
39223
|
+
};
|
|
39224
|
+
};
|
|
39225
|
+
};
|
|
39226
|
+
/** @description Bad request */
|
|
39227
|
+
400: {
|
|
39228
|
+
headers: {
|
|
39229
|
+
[name: string]: unknown;
|
|
39230
|
+
};
|
|
39231
|
+
content: {
|
|
39232
|
+
"application/json": {
|
|
39233
|
+
code: string;
|
|
39234
|
+
message: string;
|
|
39235
|
+
issues?: {
|
|
39236
|
+
message: string;
|
|
39237
|
+
}[];
|
|
39238
|
+
context?: unknown;
|
|
39239
|
+
};
|
|
39240
|
+
};
|
|
39241
|
+
};
|
|
39242
|
+
/** @description Unauthorized */
|
|
39243
|
+
401: {
|
|
39244
|
+
headers: {
|
|
39245
|
+
[name: string]: unknown;
|
|
39246
|
+
};
|
|
39247
|
+
content: {
|
|
39248
|
+
"application/json": {
|
|
39249
|
+
code: string;
|
|
39250
|
+
message: string;
|
|
39251
|
+
issues?: {
|
|
39252
|
+
message: string;
|
|
39253
|
+
}[];
|
|
39254
|
+
context?: unknown;
|
|
39255
|
+
};
|
|
39256
|
+
};
|
|
39257
|
+
};
|
|
39258
|
+
/** @description Forbidden */
|
|
39259
|
+
403: {
|
|
39260
|
+
headers: {
|
|
39261
|
+
[name: string]: unknown;
|
|
39262
|
+
};
|
|
39263
|
+
content: {
|
|
39264
|
+
"application/json": {
|
|
39265
|
+
code: string;
|
|
39266
|
+
message: string;
|
|
39267
|
+
issues?: {
|
|
39268
|
+
message: string;
|
|
39269
|
+
}[];
|
|
39270
|
+
context?: unknown;
|
|
39271
|
+
};
|
|
39272
|
+
};
|
|
39273
|
+
};
|
|
39274
|
+
/** @description Not found */
|
|
39275
|
+
404: {
|
|
39276
|
+
headers: {
|
|
39277
|
+
[name: string]: unknown;
|
|
39278
|
+
};
|
|
39279
|
+
content: {
|
|
39280
|
+
"application/json": {
|
|
39281
|
+
code: string;
|
|
39282
|
+
message: string;
|
|
39283
|
+
issues?: {
|
|
39284
|
+
message: string;
|
|
39285
|
+
}[];
|
|
39286
|
+
context?: unknown;
|
|
39287
|
+
};
|
|
39288
|
+
};
|
|
39289
|
+
};
|
|
39290
|
+
/** @description Internal server error */
|
|
39291
|
+
500: {
|
|
39292
|
+
headers: {
|
|
39293
|
+
[name: string]: unknown;
|
|
39294
|
+
};
|
|
39295
|
+
content: {
|
|
39296
|
+
"application/json": {
|
|
39297
|
+
code: string;
|
|
39298
|
+
message: string;
|
|
39299
|
+
issues?: {
|
|
39300
|
+
message: string;
|
|
39301
|
+
}[];
|
|
39302
|
+
context?: unknown;
|
|
39303
|
+
};
|
|
39304
|
+
};
|
|
39305
|
+
};
|
|
39306
|
+
};
|
|
39307
|
+
};
|
|
39095
39308
|
getTransactionsRecurringTemplates: {
|
|
39096
39309
|
parameters: {
|
|
39097
39310
|
query?: {
|