@vrplatform/api 1.3.1-stage.2068 → 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
|
|
2971
|
+
/** @description Legacy transfer transactions CSV export */
|
|
2955
2972
|
get: operations["getTransactionsTransfersCsv"];
|
|
2956
2973
|
put?: never;
|
|
2957
2974
|
post?: never;
|
|
@@ -3034,6 +3051,7 @@ export interface operations {
|
|
|
3034
3051
|
status?: "active" | "inactive";
|
|
3035
3052
|
classification?: "asset" | "liability" | "revenue" | "expense";
|
|
3036
3053
|
categoryId?: string;
|
|
3054
|
+
bankingCategory?: "trust" | "operating" | "external";
|
|
3037
3055
|
reconciled?: boolean;
|
|
3038
3056
|
limit?: number;
|
|
3039
3057
|
page?: number;
|
|
@@ -3438,6 +3456,7 @@ export interface operations {
|
|
|
3438
3456
|
status?: "active" | "inactive";
|
|
3439
3457
|
classification?: "asset" | "liability" | "revenue" | "expense";
|
|
3440
3458
|
categoryId?: string;
|
|
3459
|
+
bankingCategory?: "trust" | "operating" | "external";
|
|
3441
3460
|
reconciled?: boolean;
|
|
3442
3461
|
};
|
|
3443
3462
|
header?: never;
|
|
@@ -19491,6 +19510,7 @@ export interface operations {
|
|
|
19491
19510
|
startDate?: string;
|
|
19492
19511
|
endDate?: string;
|
|
19493
19512
|
view?: "month" | "quarter" | "year";
|
|
19513
|
+
ledger?: "trust" | "operating";
|
|
19494
19514
|
};
|
|
19495
19515
|
header?: never;
|
|
19496
19516
|
path?: never;
|
|
@@ -19725,9 +19745,10 @@ export interface operations {
|
|
|
19725
19745
|
getBalanceSheetReportCsv: {
|
|
19726
19746
|
parameters: {
|
|
19727
19747
|
query?: {
|
|
19728
|
-
view?: "month" | "quarter" | "year";
|
|
19729
19748
|
startDate?: string;
|
|
19730
19749
|
endDate?: string;
|
|
19750
|
+
view?: "month" | "quarter" | "year";
|
|
19751
|
+
ledger?: "trust" | "operating";
|
|
19731
19752
|
};
|
|
19732
19753
|
header?: never;
|
|
19733
19754
|
path?: never;
|
|
@@ -20222,6 +20243,7 @@ export interface operations {
|
|
|
20222
20243
|
bookingChannels?: string;
|
|
20223
20244
|
party?: "owners" | "manager";
|
|
20224
20245
|
openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
|
|
20246
|
+
ledger?: "trust" | "operating";
|
|
20225
20247
|
includeDetails?: boolean;
|
|
20226
20248
|
limit?: number;
|
|
20227
20249
|
page?: number;
|
|
@@ -20479,6 +20501,7 @@ export interface operations {
|
|
|
20479
20501
|
bookingChannels?: string;
|
|
20480
20502
|
party?: "owners" | "manager";
|
|
20481
20503
|
openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance";
|
|
20504
|
+
ledger?: "trust" | "operating";
|
|
20482
20505
|
};
|
|
20483
20506
|
header?: never;
|
|
20484
20507
|
path?: never;
|
|
@@ -21070,6 +21093,7 @@ export interface operations {
|
|
|
21070
21093
|
txnCode?: string;
|
|
21071
21094
|
published?: boolean;
|
|
21072
21095
|
status?: "active" | "inactive";
|
|
21096
|
+
ledger?: "trust" | "operating";
|
|
21073
21097
|
startAt?: string;
|
|
21074
21098
|
endAt?: string;
|
|
21075
21099
|
search?: string;
|
|
@@ -21326,6 +21350,7 @@ export interface operations {
|
|
|
21326
21350
|
txnCode?: string;
|
|
21327
21351
|
published?: boolean;
|
|
21328
21352
|
status?: "active" | "inactive";
|
|
21353
|
+
ledger?: "trust" | "operating";
|
|
21329
21354
|
startAt?: string;
|
|
21330
21355
|
endAt?: string;
|
|
21331
21356
|
search?: string;
|
|
@@ -22188,6 +22213,7 @@ export interface operations {
|
|
|
22188
22213
|
party?: "manager" | "owners";
|
|
22189
22214
|
view?: "party" | "listing" | "month" | "quarter" | "year";
|
|
22190
22215
|
listingIds?: string;
|
|
22216
|
+
ledger?: "trust" | "operating";
|
|
22191
22217
|
};
|
|
22192
22218
|
header?: never;
|
|
22193
22219
|
path?: never;
|
|
@@ -22435,6 +22461,7 @@ export interface operations {
|
|
|
22435
22461
|
party?: "manager" | "owners";
|
|
22436
22462
|
view?: "party" | "listing" | "month" | "quarter" | "year";
|
|
22437
22463
|
listingIds?: string;
|
|
22464
|
+
ledger?: "trust" | "operating";
|
|
22438
22465
|
};
|
|
22439
22466
|
header?: never;
|
|
22440
22467
|
path?: never;
|
|
@@ -22784,6 +22811,7 @@ export interface operations {
|
|
|
22784
22811
|
startDate: string;
|
|
22785
22812
|
endDate: string;
|
|
22786
22813
|
classification?: string;
|
|
22814
|
+
ledger?: "trust" | "operating";
|
|
22787
22815
|
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
22788
22816
|
party?: "owners" | "manager";
|
|
22789
22817
|
accountIds?: string;
|
|
@@ -22906,6 +22934,7 @@ export interface operations {
|
|
|
22906
22934
|
startDate: string;
|
|
22907
22935
|
endDate: string;
|
|
22908
22936
|
classification?: string;
|
|
22937
|
+
ledger?: "trust" | "operating";
|
|
22909
22938
|
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
22910
22939
|
party?: "owners" | "manager";
|
|
22911
22940
|
accountIds?: string;
|
|
@@ -27892,6 +27921,8 @@ export interface operations {
|
|
|
27892
27921
|
/** @description Value in cents (100 = 1€) */
|
|
27893
27922
|
transfers: number;
|
|
27894
27923
|
/** @description Value in cents (100 = 1€) */
|
|
27924
|
+
payouts?: number;
|
|
27925
|
+
/** @description Value in cents (100 = 1€) */
|
|
27895
27926
|
balanceEnd: number;
|
|
27896
27927
|
};
|
|
27897
27928
|
payment: {
|
|
@@ -28075,6 +28106,12 @@ export interface operations {
|
|
|
28075
28106
|
total: number;
|
|
28076
28107
|
totalFormatted: string;
|
|
28077
28108
|
}[];
|
|
28109
|
+
payouts?: {
|
|
28110
|
+
id: string;
|
|
28111
|
+
date: string;
|
|
28112
|
+
total: number;
|
|
28113
|
+
totalFormatted: string;
|
|
28114
|
+
}[];
|
|
28078
28115
|
listing: {
|
|
28079
28116
|
id: string;
|
|
28080
28117
|
name: string;
|
|
@@ -28117,6 +28154,8 @@ export interface operations {
|
|
|
28117
28154
|
/** @description Value in cents (100 = 1€) */
|
|
28118
28155
|
transfers: number;
|
|
28119
28156
|
/** @description Value in cents (100 = 1€) */
|
|
28157
|
+
payouts?: number;
|
|
28158
|
+
/** @description Value in cents (100 = 1€) */
|
|
28120
28159
|
balanceEnd: number;
|
|
28121
28160
|
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
28122
28161
|
currency: string;
|
|
@@ -28264,6 +28303,8 @@ export interface operations {
|
|
|
28264
28303
|
/** @description Value in cents (100 = 1€) */
|
|
28265
28304
|
transfers: number;
|
|
28266
28305
|
/** @description Value in cents (100 = 1€) */
|
|
28306
|
+
payouts?: number;
|
|
28307
|
+
/** @description Value in cents (100 = 1€) */
|
|
28267
28308
|
balanceEnd: number;
|
|
28268
28309
|
};
|
|
28269
28310
|
payment: {
|
|
@@ -28447,6 +28488,12 @@ export interface operations {
|
|
|
28447
28488
|
total: number;
|
|
28448
28489
|
totalFormatted: string;
|
|
28449
28490
|
}[];
|
|
28491
|
+
payouts?: {
|
|
28492
|
+
id: string;
|
|
28493
|
+
date: string;
|
|
28494
|
+
total: number;
|
|
28495
|
+
totalFormatted: string;
|
|
28496
|
+
}[];
|
|
28450
28497
|
listing: {
|
|
28451
28498
|
id: string;
|
|
28452
28499
|
name: string;
|
|
@@ -28861,6 +28908,8 @@ export interface operations {
|
|
|
28861
28908
|
/** @description Value in cents (100 = 1€) */
|
|
28862
28909
|
transfers: number;
|
|
28863
28910
|
/** @description Value in cents (100 = 1€) */
|
|
28911
|
+
payouts?: number;
|
|
28912
|
+
/** @description Value in cents (100 = 1€) */
|
|
28864
28913
|
balanceEnd: number;
|
|
28865
28914
|
};
|
|
28866
28915
|
payment: {
|
|
@@ -29044,6 +29093,12 @@ export interface operations {
|
|
|
29044
29093
|
total: number;
|
|
29045
29094
|
totalFormatted: string;
|
|
29046
29095
|
}[];
|
|
29096
|
+
payouts?: {
|
|
29097
|
+
id: string;
|
|
29098
|
+
date: string;
|
|
29099
|
+
total: number;
|
|
29100
|
+
totalFormatted: string;
|
|
29101
|
+
}[];
|
|
29047
29102
|
listing: {
|
|
29048
29103
|
id: string;
|
|
29049
29104
|
name: string;
|
|
@@ -31261,6 +31316,8 @@ export interface operations {
|
|
|
31261
31316
|
/** @description Value in cents (100 = 1€) */
|
|
31262
31317
|
transfers: number;
|
|
31263
31318
|
/** @description Value in cents (100 = 1€) */
|
|
31319
|
+
payouts?: number;
|
|
31320
|
+
/** @description Value in cents (100 = 1€) */
|
|
31264
31321
|
balanceEnd: number;
|
|
31265
31322
|
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
31266
31323
|
currency: string;
|
|
@@ -31390,6 +31447,8 @@ export interface operations {
|
|
|
31390
31447
|
/** @description Value in cents (100 = 1€) */
|
|
31391
31448
|
transfers: number;
|
|
31392
31449
|
/** @description Value in cents (100 = 1€) */
|
|
31450
|
+
payouts?: number;
|
|
31451
|
+
/** @description Value in cents (100 = 1€) */
|
|
31393
31452
|
balanceEnd: number;
|
|
31394
31453
|
};
|
|
31395
31454
|
payment: {
|
|
@@ -31573,6 +31632,12 @@ export interface operations {
|
|
|
31573
31632
|
total: number;
|
|
31574
31633
|
totalFormatted: string;
|
|
31575
31634
|
}[];
|
|
31635
|
+
payouts?: {
|
|
31636
|
+
id: string;
|
|
31637
|
+
date: string;
|
|
31638
|
+
total: number;
|
|
31639
|
+
totalFormatted: string;
|
|
31640
|
+
}[];
|
|
31576
31641
|
listing: {
|
|
31577
31642
|
id: string;
|
|
31578
31643
|
name: string;
|
|
@@ -31992,6 +32057,8 @@ export interface operations {
|
|
|
31992
32057
|
/** @description Value in cents (100 = 1€) */
|
|
31993
32058
|
transfers: number;
|
|
31994
32059
|
/** @description Value in cents (100 = 1€) */
|
|
32060
|
+
payouts?: number;
|
|
32061
|
+
/** @description Value in cents (100 = 1€) */
|
|
31995
32062
|
balanceEnd: number;
|
|
31996
32063
|
};
|
|
31997
32064
|
payment: {
|
|
@@ -32175,6 +32242,12 @@ export interface operations {
|
|
|
32175
32242
|
total: number;
|
|
32176
32243
|
totalFormatted: string;
|
|
32177
32244
|
}[];
|
|
32245
|
+
payouts?: {
|
|
32246
|
+
id: string;
|
|
32247
|
+
date: string;
|
|
32248
|
+
total: number;
|
|
32249
|
+
totalFormatted: string;
|
|
32250
|
+
}[];
|
|
32178
32251
|
listing: {
|
|
32179
32252
|
id: string;
|
|
32180
32253
|
name: string;
|
|
@@ -39089,6 +39162,144 @@ export interface operations {
|
|
|
39089
39162
|
};
|
|
39090
39163
|
};
|
|
39091
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
|
+
};
|
|
39092
39303
|
getTransactionsRecurringTemplates: {
|
|
39093
39304
|
parameters: {
|
|
39094
39305
|
query?: {
|