@vrplatform/api 1.3.1-stage.4890 → 1.3.1-stage.4891
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/build/main/generated/v1.d.ts +613 -133
- package/build/main/generated/v1.js.map +1 -1
- package/build/module/generated/v1.d.ts +613 -133
- package/build/module/generated/v1.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/v1.ts +613 -133
|
@@ -179,7 +179,11 @@ export interface paths {
|
|
|
179
179
|
};
|
|
180
180
|
get?: never;
|
|
181
181
|
put?: never;
|
|
182
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* @description Initialize banking with an opening-balance transaction and feed checkpoint. Credit cards store a negative feed balance while the journal credits the liability.
|
|
184
|
+
*
|
|
185
|
+
* Required scope: bank-accounts:write
|
|
186
|
+
*/
|
|
183
187
|
post: operations["postAccountsByIdBankingInit"];
|
|
184
188
|
delete?: never;
|
|
185
189
|
options?: never;
|
|
@@ -196,7 +200,11 @@ export interface paths {
|
|
|
196
200
|
};
|
|
197
201
|
get?: never;
|
|
198
202
|
put?: never;
|
|
199
|
-
/**
|
|
203
|
+
/**
|
|
204
|
+
* @description Attach an external account connection to a bank account
|
|
205
|
+
*
|
|
206
|
+
* Required scope: bank-connections:manage
|
|
207
|
+
*/
|
|
200
208
|
post: operations["postAccountsByIdConnections"];
|
|
201
209
|
delete?: never;
|
|
202
210
|
options?: never;
|
|
@@ -214,7 +222,11 @@ export interface paths {
|
|
|
214
222
|
get?: never;
|
|
215
223
|
put?: never;
|
|
216
224
|
post?: never;
|
|
217
|
-
/**
|
|
225
|
+
/**
|
|
226
|
+
* @description Detach an external account connection from a bank account
|
|
227
|
+
*
|
|
228
|
+
* Required scope: bank-connections:manage
|
|
229
|
+
*/
|
|
218
230
|
delete: operations["deleteAccountsByIdConnectionsByAccountConnectionId"];
|
|
219
231
|
options?: never;
|
|
220
232
|
head?: never;
|
|
@@ -249,7 +261,11 @@ export interface paths {
|
|
|
249
261
|
path?: never;
|
|
250
262
|
cookie?: never;
|
|
251
263
|
};
|
|
252
|
-
/**
|
|
264
|
+
/**
|
|
265
|
+
* @description Get account reconciliation summary by date range
|
|
266
|
+
*
|
|
267
|
+
* Required scope: accounts:read
|
|
268
|
+
*/
|
|
253
269
|
get: operations["getAccountsByIdSummary"];
|
|
254
270
|
put?: never;
|
|
255
271
|
post?: never;
|
|
@@ -302,7 +318,11 @@ export interface paths {
|
|
|
302
318
|
path?: never;
|
|
303
319
|
cookie?: never;
|
|
304
320
|
};
|
|
305
|
-
/**
|
|
321
|
+
/**
|
|
322
|
+
* @description Get apps
|
|
323
|
+
*
|
|
324
|
+
* Required scope: integrations:read
|
|
325
|
+
*/
|
|
306
326
|
get: operations["getApps"];
|
|
307
327
|
put?: never;
|
|
308
328
|
post?: never;
|
|
@@ -319,7 +339,11 @@ export interface paths {
|
|
|
319
339
|
path?: never;
|
|
320
340
|
cookie?: never;
|
|
321
341
|
};
|
|
322
|
-
/**
|
|
342
|
+
/**
|
|
343
|
+
* @description Get app by ID
|
|
344
|
+
*
|
|
345
|
+
* Required scope: integrations:read
|
|
346
|
+
*/
|
|
323
347
|
get: operations["getApp"];
|
|
324
348
|
put?: never;
|
|
325
349
|
post?: never;
|
|
@@ -336,7 +360,11 @@ export interface paths {
|
|
|
336
360
|
path?: never;
|
|
337
361
|
cookie?: never;
|
|
338
362
|
};
|
|
339
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* @description List audit actions with optional filters. Use entityId/entityType to find rows related to a specific entity.
|
|
365
|
+
*
|
|
366
|
+
* Required scope: audit:read
|
|
367
|
+
*/
|
|
340
368
|
get: operations["getAuditActions"];
|
|
341
369
|
put?: never;
|
|
342
370
|
post?: never;
|
|
@@ -353,7 +381,11 @@ export interface paths {
|
|
|
353
381
|
path?: never;
|
|
354
382
|
cookie?: never;
|
|
355
383
|
};
|
|
356
|
-
/**
|
|
384
|
+
/**
|
|
385
|
+
* @description Retrieve an audit action and aggregated effect counts.
|
|
386
|
+
*
|
|
387
|
+
* Required scope: audit:read
|
|
388
|
+
*/
|
|
357
389
|
get: operations["getAuditActionsById"];
|
|
358
390
|
put?: never;
|
|
359
391
|
post?: never;
|
|
@@ -370,7 +402,11 @@ export interface paths {
|
|
|
370
402
|
path?: never;
|
|
371
403
|
cookie?: never;
|
|
372
404
|
};
|
|
373
|
-
/**
|
|
405
|
+
/**
|
|
406
|
+
* @description List audit effects with optional filters by action/entity/status/type.
|
|
407
|
+
*
|
|
408
|
+
* Required scope: audit:read
|
|
409
|
+
*/
|
|
374
410
|
get: operations["getAuditEffects"];
|
|
375
411
|
put?: never;
|
|
376
412
|
post?: never;
|
|
@@ -387,7 +423,11 @@ export interface paths {
|
|
|
387
423
|
path?: never;
|
|
388
424
|
cookie?: never;
|
|
389
425
|
};
|
|
390
|
-
/**
|
|
426
|
+
/**
|
|
427
|
+
* @description List journal delta audit rows with optional filters for action/effect/mutation/journal entry.
|
|
428
|
+
*
|
|
429
|
+
* Required scope: audit:read
|
|
430
|
+
*/
|
|
391
431
|
get: operations["getAuditJournalDeltas"];
|
|
392
432
|
put?: never;
|
|
393
433
|
post?: never;
|
|
@@ -404,7 +444,11 @@ export interface paths {
|
|
|
404
444
|
path?: never;
|
|
405
445
|
cookie?: never;
|
|
406
446
|
};
|
|
407
|
-
/**
|
|
447
|
+
/**
|
|
448
|
+
* @description List mutation audit rows with filters for action/effect/entity/op/outcome and date range.
|
|
449
|
+
*
|
|
450
|
+
* Required scope: audit:read
|
|
451
|
+
*/
|
|
408
452
|
get: operations["getAuditMutations"];
|
|
409
453
|
put?: never;
|
|
410
454
|
post?: never;
|
|
@@ -421,7 +465,11 @@ export interface paths {
|
|
|
421
465
|
path?: never;
|
|
422
466
|
cookie?: never;
|
|
423
467
|
};
|
|
424
|
-
/**
|
|
468
|
+
/**
|
|
469
|
+
* @description List a unified audit timeline for a root entity across actions/effects/attempts/mutations/journal deltas.
|
|
470
|
+
*
|
|
471
|
+
* Required scope: audit:read
|
|
472
|
+
*/
|
|
425
473
|
get: operations["getAuditTimeline"];
|
|
426
474
|
put?: never;
|
|
427
475
|
post?: never;
|
|
@@ -631,7 +679,11 @@ export interface paths {
|
|
|
631
679
|
path?: never;
|
|
632
680
|
cookie?: never;
|
|
633
681
|
};
|
|
634
|
-
/**
|
|
682
|
+
/**
|
|
683
|
+
* @description List booking channels available on the team
|
|
684
|
+
*
|
|
685
|
+
* Required scope: integrations:read
|
|
686
|
+
*/
|
|
635
687
|
get: operations["getBookingChannels"];
|
|
636
688
|
put?: never;
|
|
637
689
|
post?: never;
|
|
@@ -648,12 +700,24 @@ export interface paths {
|
|
|
648
700
|
path?: never;
|
|
649
701
|
cookie?: never;
|
|
650
702
|
};
|
|
651
|
-
/**
|
|
703
|
+
/**
|
|
704
|
+
* @description Retrieve calendar blocks from a listing
|
|
705
|
+
*
|
|
706
|
+
* Required scope: calendar:read
|
|
707
|
+
*/
|
|
652
708
|
get: operations["getCalendar"];
|
|
653
709
|
put?: never;
|
|
654
|
-
/**
|
|
710
|
+
/**
|
|
711
|
+
* @description Block calendar for a listing
|
|
712
|
+
*
|
|
713
|
+
* Required scope: calendar:write
|
|
714
|
+
*/
|
|
655
715
|
post: operations["blockCalendar"];
|
|
656
|
-
/**
|
|
716
|
+
/**
|
|
717
|
+
* @description Unblock calendar for a listing
|
|
718
|
+
*
|
|
719
|
+
* Required scope: calendar:delete
|
|
720
|
+
*/
|
|
657
721
|
delete: operations["unblockCalendar"];
|
|
658
722
|
options?: never;
|
|
659
723
|
head?: never;
|
|
@@ -667,10 +731,18 @@ export interface paths {
|
|
|
667
731
|
path?: never;
|
|
668
732
|
cookie?: never;
|
|
669
733
|
};
|
|
670
|
-
/**
|
|
734
|
+
/**
|
|
735
|
+
* @description List connections
|
|
736
|
+
*
|
|
737
|
+
* Required scope: integrations:read
|
|
738
|
+
*/
|
|
671
739
|
get: operations["getConnections"];
|
|
672
740
|
put?: never;
|
|
673
|
-
/**
|
|
741
|
+
/**
|
|
742
|
+
* @description Create a new connection
|
|
743
|
+
*
|
|
744
|
+
* Required scope: integrations:write
|
|
745
|
+
*/
|
|
674
746
|
post: operations["createConnection"];
|
|
675
747
|
delete?: never;
|
|
676
748
|
options?: never;
|
|
@@ -687,7 +759,11 @@ export interface paths {
|
|
|
687
759
|
};
|
|
688
760
|
get?: never;
|
|
689
761
|
put?: never;
|
|
690
|
-
/**
|
|
762
|
+
/**
|
|
763
|
+
* @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity.
|
|
764
|
+
*
|
|
765
|
+
* Required scope: integrations:write
|
|
766
|
+
*/
|
|
691
767
|
post: operations["connectAppConnection"];
|
|
692
768
|
delete?: never;
|
|
693
769
|
options?: never;
|
|
@@ -704,7 +780,11 @@ export interface paths {
|
|
|
704
780
|
};
|
|
705
781
|
get?: never;
|
|
706
782
|
put?: never;
|
|
707
|
-
/**
|
|
783
|
+
/**
|
|
784
|
+
* @description Trigger extract workflows for connections.
|
|
785
|
+
*
|
|
786
|
+
* Required scope: integrations:execute
|
|
787
|
+
*/
|
|
708
788
|
post: operations["extractConnections"];
|
|
709
789
|
delete?: never;
|
|
710
790
|
options?: never;
|
|
@@ -721,7 +801,11 @@ export interface paths {
|
|
|
721
801
|
};
|
|
722
802
|
get?: never;
|
|
723
803
|
put?: never;
|
|
724
|
-
/**
|
|
804
|
+
/**
|
|
805
|
+
* @description Get a redirect URL to connect an app through OAuth2.0. Defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Normalizes the legacy production /callback path to /callback/.
|
|
806
|
+
*
|
|
807
|
+
* Required scope: integrations:write
|
|
808
|
+
*/
|
|
725
809
|
post: operations["connectConnection"];
|
|
726
810
|
delete?: never;
|
|
727
811
|
options?: never;
|
|
@@ -738,7 +822,11 @@ export interface paths {
|
|
|
738
822
|
};
|
|
739
823
|
get?: never;
|
|
740
824
|
put?: never;
|
|
741
|
-
/**
|
|
825
|
+
/**
|
|
826
|
+
* @description Apply a PMS migration cutover
|
|
827
|
+
*
|
|
828
|
+
* Required scope: integrations:write
|
|
829
|
+
*/
|
|
742
830
|
post: operations["applyPmsConnectionCutover"];
|
|
743
831
|
delete?: never;
|
|
744
832
|
options?: never;
|
|
@@ -753,7 +841,11 @@ export interface paths {
|
|
|
753
841
|
path?: never;
|
|
754
842
|
cookie?: never;
|
|
755
843
|
};
|
|
756
|
-
/**
|
|
844
|
+
/**
|
|
845
|
+
* @description Retrieve PMS migration cutover target listing refs that need mapping, suggested source listings, and the source listing pool
|
|
846
|
+
*
|
|
847
|
+
* Required scope: integrations:read
|
|
848
|
+
*/
|
|
757
849
|
get: operations["getPmsConnectionCutoverListingMappings"];
|
|
758
850
|
put?: never;
|
|
759
851
|
post?: never;
|
|
@@ -772,7 +864,11 @@ export interface paths {
|
|
|
772
864
|
};
|
|
773
865
|
get?: never;
|
|
774
866
|
put?: never;
|
|
775
|
-
/**
|
|
867
|
+
/**
|
|
868
|
+
* @description Preview a PMS migration cutover
|
|
869
|
+
*
|
|
870
|
+
* Required scope: integrations:read
|
|
871
|
+
*/
|
|
776
872
|
post: operations["previewPmsConnectionCutover"];
|
|
777
873
|
delete?: never;
|
|
778
874
|
options?: never;
|
|
@@ -787,12 +883,24 @@ export interface paths {
|
|
|
787
883
|
path?: never;
|
|
788
884
|
cookie?: never;
|
|
789
885
|
};
|
|
790
|
-
/**
|
|
886
|
+
/**
|
|
887
|
+
* @description Get connection by ID
|
|
888
|
+
*
|
|
889
|
+
* Required scope: integrations:read
|
|
890
|
+
*/
|
|
791
891
|
get: operations["getConnection"];
|
|
792
|
-
/**
|
|
892
|
+
/**
|
|
893
|
+
* @description Update connection settings.
|
|
894
|
+
*
|
|
895
|
+
* Required scope: integrations:write
|
|
896
|
+
*/
|
|
793
897
|
put: operations["updateConnection"];
|
|
794
898
|
post?: never;
|
|
795
|
-
/**
|
|
899
|
+
/**
|
|
900
|
+
* @description Delete connection By ID
|
|
901
|
+
*
|
|
902
|
+
* Required scope: integrations:delete
|
|
903
|
+
*/
|
|
796
904
|
delete: operations["deleteConnection"];
|
|
797
905
|
options?: never;
|
|
798
906
|
head?: never;
|
|
@@ -808,7 +916,11 @@ export interface paths {
|
|
|
808
916
|
};
|
|
809
917
|
get?: never;
|
|
810
918
|
put?: never;
|
|
811
|
-
/**
|
|
919
|
+
/**
|
|
920
|
+
* @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity.
|
|
921
|
+
*
|
|
922
|
+
* Required scope: integrations:write
|
|
923
|
+
*/
|
|
812
924
|
post: operations["reconnectAppConnection"];
|
|
813
925
|
delete?: never;
|
|
814
926
|
options?: never;
|
|
@@ -825,7 +937,11 @@ export interface paths {
|
|
|
825
937
|
};
|
|
826
938
|
get?: never;
|
|
827
939
|
put?: never;
|
|
828
|
-
/**
|
|
940
|
+
/**
|
|
941
|
+
* @description Import a CSV file through a connection
|
|
942
|
+
*
|
|
943
|
+
* Required scope: integrations:import
|
|
944
|
+
*/
|
|
829
945
|
post: operations["csvImport"];
|
|
830
946
|
delete?: never;
|
|
831
947
|
options?: never;
|
|
@@ -842,7 +958,11 @@ export interface paths {
|
|
|
842
958
|
};
|
|
843
959
|
get?: never;
|
|
844
960
|
put?: never;
|
|
845
|
-
/**
|
|
961
|
+
/**
|
|
962
|
+
* @description Sync connection by uniqueRef and type
|
|
963
|
+
*
|
|
964
|
+
* Required scope: integrations:execute
|
|
965
|
+
*/
|
|
846
966
|
post: operations["syncConnection"];
|
|
847
967
|
delete?: never;
|
|
848
968
|
options?: never;
|
|
@@ -958,7 +1078,11 @@ export interface paths {
|
|
|
958
1078
|
};
|
|
959
1079
|
get?: never;
|
|
960
1080
|
put?: never;
|
|
961
|
-
/**
|
|
1081
|
+
/**
|
|
1082
|
+
* @description Send Owner Portal Invite to Contact By ID
|
|
1083
|
+
*
|
|
1084
|
+
* Required scope: contacts:write
|
|
1085
|
+
*/
|
|
962
1086
|
post: operations["postContactsByIdInvite"];
|
|
963
1087
|
delete?: never;
|
|
964
1088
|
options?: never;
|
|
@@ -975,7 +1099,11 @@ export interface paths {
|
|
|
975
1099
|
};
|
|
976
1100
|
get?: never;
|
|
977
1101
|
put?: never;
|
|
978
|
-
/**
|
|
1102
|
+
/**
|
|
1103
|
+
* @description Revoke Owner Portal Access for Contact By ID
|
|
1104
|
+
*
|
|
1105
|
+
* Required scope: contacts:write
|
|
1106
|
+
*/
|
|
979
1107
|
post: operations["postContactsByIdRevokeAccess"];
|
|
980
1108
|
delete?: never;
|
|
981
1109
|
options?: never;
|
|
@@ -990,10 +1118,18 @@ export interface paths {
|
|
|
990
1118
|
path?: never;
|
|
991
1119
|
cookie?: never;
|
|
992
1120
|
};
|
|
993
|
-
/**
|
|
1121
|
+
/**
|
|
1122
|
+
* @description List owner-viewer access for an owner contact
|
|
1123
|
+
*
|
|
1124
|
+
* Required scope: contacts:read
|
|
1125
|
+
*/
|
|
994
1126
|
get: operations["getContactsByIdViewers"];
|
|
995
1127
|
put?: never;
|
|
996
|
-
/**
|
|
1128
|
+
/**
|
|
1129
|
+
* @description Invite an owner viewer for an owner contact
|
|
1130
|
+
*
|
|
1131
|
+
* Required scope: contacts:write
|
|
1132
|
+
*/
|
|
997
1133
|
post: operations["postContactsByIdViewers"];
|
|
998
1134
|
delete?: never;
|
|
999
1135
|
options?: never;
|
|
@@ -1011,7 +1147,11 @@ export interface paths {
|
|
|
1011
1147
|
get?: never;
|
|
1012
1148
|
put?: never;
|
|
1013
1149
|
post?: never;
|
|
1014
|
-
/**
|
|
1150
|
+
/**
|
|
1151
|
+
* @description Remove an owner-viewer access row from an owner contact
|
|
1152
|
+
*
|
|
1153
|
+
* Required scope: contacts:write
|
|
1154
|
+
*/
|
|
1015
1155
|
delete: operations["deleteContactsByIdViewersByUserId"];
|
|
1016
1156
|
options?: never;
|
|
1017
1157
|
head?: never;
|
|
@@ -1027,7 +1167,11 @@ export interface paths {
|
|
|
1027
1167
|
};
|
|
1028
1168
|
get?: never;
|
|
1029
1169
|
put?: never;
|
|
1030
|
-
/**
|
|
1170
|
+
/**
|
|
1171
|
+
* @description Reinvite an existing owner viewer
|
|
1172
|
+
*
|
|
1173
|
+
* Required scope: contacts:write
|
|
1174
|
+
*/
|
|
1031
1175
|
post: operations["postContactsByIdViewersByUserIdReinvite"];
|
|
1032
1176
|
delete?: never;
|
|
1033
1177
|
options?: never;
|
|
@@ -1101,10 +1245,18 @@ export interface paths {
|
|
|
1101
1245
|
path?: never;
|
|
1102
1246
|
cookie?: never;
|
|
1103
1247
|
};
|
|
1104
|
-
/**
|
|
1248
|
+
/**
|
|
1249
|
+
* @description List supported GL files for the current team.
|
|
1250
|
+
*
|
|
1251
|
+
* Required scope: files:read
|
|
1252
|
+
*/
|
|
1105
1253
|
get: operations["getFiles"];
|
|
1106
1254
|
put?: never;
|
|
1107
|
-
/**
|
|
1255
|
+
/**
|
|
1256
|
+
* @description Upload a GL user file as multipart/form-data. Fields: file, optional filename, optional type (userUpload or historicalData or historicalOwnerStatement or ownerStatementExample or listingOwnerAssignment or listingFeeAssignment), optional startDate, optional endDate, and optional contactId. Type defaults to userUpload. The API derives team and user context from auth.
|
|
1257
|
+
*
|
|
1258
|
+
* Required scope: files:write
|
|
1259
|
+
*/
|
|
1108
1260
|
post: operations["postFiles"];
|
|
1109
1261
|
delete?: never;
|
|
1110
1262
|
options?: never;
|
|
@@ -1120,10 +1272,18 @@ export interface paths {
|
|
|
1120
1272
|
cookie?: never;
|
|
1121
1273
|
};
|
|
1122
1274
|
get?: never;
|
|
1123
|
-
/**
|
|
1275
|
+
/**
|
|
1276
|
+
* @description Update GL file metadata: filename, date range, and contact.
|
|
1277
|
+
*
|
|
1278
|
+
* Required scope: files:write
|
|
1279
|
+
*/
|
|
1124
1280
|
put: operations["putFilesById"];
|
|
1125
1281
|
post?: never;
|
|
1126
|
-
/**
|
|
1282
|
+
/**
|
|
1283
|
+
* @description Delete GL file metadata and its TEAM_STORAGE object.
|
|
1284
|
+
*
|
|
1285
|
+
* Required scope: files:delete
|
|
1286
|
+
*/
|
|
1127
1287
|
delete: operations["deleteFilesById"];
|
|
1128
1288
|
options?: never;
|
|
1129
1289
|
head?: never;
|
|
@@ -1137,7 +1297,11 @@ export interface paths {
|
|
|
1137
1297
|
path?: never;
|
|
1138
1298
|
cookie?: never;
|
|
1139
1299
|
};
|
|
1140
|
-
/**
|
|
1300
|
+
/**
|
|
1301
|
+
* @description Download a supported team file. Existing non-GL team files remain readable.
|
|
1302
|
+
*
|
|
1303
|
+
* Required scope: files:read
|
|
1304
|
+
*/
|
|
1141
1305
|
get: operations["getFilesByIdDownload"];
|
|
1142
1306
|
put?: never;
|
|
1143
1307
|
post?: never;
|
|
@@ -1154,7 +1318,11 @@ export interface paths {
|
|
|
1154
1318
|
path?: never;
|
|
1155
1319
|
cookie?: never;
|
|
1156
1320
|
};
|
|
1157
|
-
/**
|
|
1321
|
+
/**
|
|
1322
|
+
* @description List flows
|
|
1323
|
+
*
|
|
1324
|
+
* Required scope: integrations:read
|
|
1325
|
+
*/
|
|
1158
1326
|
get: operations["getFlows"];
|
|
1159
1327
|
put?: never;
|
|
1160
1328
|
post?: never;
|
|
@@ -1171,7 +1339,11 @@ export interface paths {
|
|
|
1171
1339
|
path?: never;
|
|
1172
1340
|
cookie?: never;
|
|
1173
1341
|
};
|
|
1174
|
-
/**
|
|
1342
|
+
/**
|
|
1343
|
+
* @description Get flow by ID
|
|
1344
|
+
*
|
|
1345
|
+
* Required scope: integrations:read
|
|
1346
|
+
*/
|
|
1175
1347
|
get: operations["getFlow"];
|
|
1176
1348
|
put?: never;
|
|
1177
1349
|
post?: never;
|
|
@@ -1188,9 +1360,17 @@ export interface paths {
|
|
|
1188
1360
|
path?: never;
|
|
1189
1361
|
cookie?: never;
|
|
1190
1362
|
};
|
|
1191
|
-
/**
|
|
1363
|
+
/**
|
|
1364
|
+
* @description Get flow configuration for a connection
|
|
1365
|
+
*
|
|
1366
|
+
* Required scope: integrations:read
|
|
1367
|
+
*/
|
|
1192
1368
|
get: operations["getFlowConnection"];
|
|
1193
|
-
/**
|
|
1369
|
+
/**
|
|
1370
|
+
* @description Update flow status for a connection
|
|
1371
|
+
*
|
|
1372
|
+
* Required scope: integrations:write
|
|
1373
|
+
*/
|
|
1194
1374
|
put: operations["setFlowStatus"];
|
|
1195
1375
|
post?: never;
|
|
1196
1376
|
delete?: never;
|
|
@@ -1206,10 +1386,18 @@ export interface paths {
|
|
|
1206
1386
|
path?: never;
|
|
1207
1387
|
cookie?: never;
|
|
1208
1388
|
};
|
|
1209
|
-
/**
|
|
1389
|
+
/**
|
|
1390
|
+
* @description List flow mappings for a key; optionally filter by leftId (source side id)
|
|
1391
|
+
*
|
|
1392
|
+
* Required scope: integrations:read
|
|
1393
|
+
*/
|
|
1210
1394
|
get: operations["getFlowMapping"];
|
|
1211
1395
|
put?: never;
|
|
1212
|
-
/**
|
|
1396
|
+
/**
|
|
1397
|
+
* @description Create, update or delete a flow mapping entry
|
|
1398
|
+
*
|
|
1399
|
+
* Required scope: integrations:write
|
|
1400
|
+
*/
|
|
1213
1401
|
post: operations["setFlowMapping"];
|
|
1214
1402
|
delete?: never;
|
|
1215
1403
|
options?: never;
|
|
@@ -1224,7 +1412,11 @@ export interface paths {
|
|
|
1224
1412
|
path?: never;
|
|
1225
1413
|
cookie?: never;
|
|
1226
1414
|
};
|
|
1227
|
-
/**
|
|
1415
|
+
/**
|
|
1416
|
+
* @description List available source entities for a flow mapping
|
|
1417
|
+
*
|
|
1418
|
+
* Required scope: integrations:read
|
|
1419
|
+
*/
|
|
1228
1420
|
get: operations["getFlowMappingSources"];
|
|
1229
1421
|
put?: never;
|
|
1230
1422
|
post?: never;
|
|
@@ -1241,7 +1433,11 @@ export interface paths {
|
|
|
1241
1433
|
path?: never;
|
|
1242
1434
|
cookie?: never;
|
|
1243
1435
|
};
|
|
1244
|
-
/**
|
|
1436
|
+
/**
|
|
1437
|
+
* @description List available destination entities for a flow mapping
|
|
1438
|
+
*
|
|
1439
|
+
* Required scope: integrations:read
|
|
1440
|
+
*/
|
|
1245
1441
|
get: operations["getFlowMappingDestinations"];
|
|
1246
1442
|
put?: never;
|
|
1247
1443
|
post?: never;
|
|
@@ -1260,7 +1456,11 @@ export interface paths {
|
|
|
1260
1456
|
};
|
|
1261
1457
|
get?: never;
|
|
1262
1458
|
put?: never;
|
|
1263
|
-
/**
|
|
1459
|
+
/**
|
|
1460
|
+
* @description Trigger execution of a flow for a connection
|
|
1461
|
+
*
|
|
1462
|
+
* Required scope: integrations:execute
|
|
1463
|
+
*/
|
|
1264
1464
|
post: operations["runFlow"];
|
|
1265
1465
|
delete?: never;
|
|
1266
1466
|
options?: never;
|
|
@@ -1275,10 +1475,18 @@ export interface paths {
|
|
|
1275
1475
|
path?: never;
|
|
1276
1476
|
cookie?: never;
|
|
1277
1477
|
};
|
|
1278
|
-
/**
|
|
1478
|
+
/**
|
|
1479
|
+
* @description Get a flow setting entry. Returns an empty object when the setting is not set.
|
|
1480
|
+
*
|
|
1481
|
+
* Required scope: integrations:read
|
|
1482
|
+
*/
|
|
1279
1483
|
get: operations["getFlowSetting"];
|
|
1280
1484
|
put?: never;
|
|
1281
|
-
/**
|
|
1485
|
+
/**
|
|
1486
|
+
* @description Create, update or delete a flow setting entry
|
|
1487
|
+
*
|
|
1488
|
+
* Required scope: integrations:write
|
|
1489
|
+
*/
|
|
1282
1490
|
post: operations["setFlowSetting"];
|
|
1283
1491
|
delete?: never;
|
|
1284
1492
|
options?: never;
|
|
@@ -1293,7 +1501,11 @@ export interface paths {
|
|
|
1293
1501
|
path?: never;
|
|
1294
1502
|
cookie?: never;
|
|
1295
1503
|
};
|
|
1296
|
-
/**
|
|
1504
|
+
/**
|
|
1505
|
+
* @description List available options for a flow setting
|
|
1506
|
+
*
|
|
1507
|
+
* Required scope: integrations:read
|
|
1508
|
+
*/
|
|
1297
1509
|
get: operations["getFlowSettingOptions"];
|
|
1298
1510
|
put?: never;
|
|
1299
1511
|
post?: never;
|
|
@@ -1312,7 +1524,11 @@ export interface paths {
|
|
|
1312
1524
|
};
|
|
1313
1525
|
get?: never;
|
|
1314
1526
|
put?: never;
|
|
1315
|
-
/**
|
|
1527
|
+
/**
|
|
1528
|
+
* @description Import historic general-ledger journal entries on the historical ledger; re-posting the same uniqueRef replaces that import
|
|
1529
|
+
*
|
|
1530
|
+
* Required scope: general-ledger:import
|
|
1531
|
+
*/
|
|
1316
1532
|
post: operations["postGeneralLedgerHistorical"];
|
|
1317
1533
|
delete?: never;
|
|
1318
1534
|
options?: never;
|
|
@@ -1327,9 +1543,17 @@ export interface paths {
|
|
|
1327
1543
|
path?: never;
|
|
1328
1544
|
cookie?: never;
|
|
1329
1545
|
};
|
|
1330
|
-
/**
|
|
1546
|
+
/**
|
|
1547
|
+
* @description Retrieve opening balance accounts payable summary by party
|
|
1548
|
+
*
|
|
1549
|
+
* Required scope: general-ledger:read
|
|
1550
|
+
*/
|
|
1331
1551
|
get: operations["getGeneralLedgerOpeningBalancesAccountsPayable"];
|
|
1332
|
-
/**
|
|
1552
|
+
/**
|
|
1553
|
+
* @description Update opening balance accounts payable by party. Replaces the accounts payable opening balance postings for the given party as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance.
|
|
1554
|
+
*
|
|
1555
|
+
* Required scope: general-ledger:write
|
|
1556
|
+
*/
|
|
1333
1557
|
put: operations["putGeneralLedgerOpeningBalancesAccountsPayable"];
|
|
1334
1558
|
post?: never;
|
|
1335
1559
|
delete?: never;
|
|
@@ -1345,9 +1569,17 @@ export interface paths {
|
|
|
1345
1569
|
path?: never;
|
|
1346
1570
|
cookie?: never;
|
|
1347
1571
|
};
|
|
1348
|
-
/**
|
|
1572
|
+
/**
|
|
1573
|
+
* @description Retrieve opening balance accounts receivable / deferred revenue summary
|
|
1574
|
+
*
|
|
1575
|
+
* Required scope: general-ledger:read
|
|
1576
|
+
*/
|
|
1349
1577
|
get: operations["getGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
|
|
1350
|
-
/**
|
|
1578
|
+
/**
|
|
1579
|
+
* @description Update opening balance accounts receivable / deferred revenue. Replaces the receivable and deferred revenue opening balance postings as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance.
|
|
1580
|
+
*
|
|
1581
|
+
* Required scope: general-ledger:write
|
|
1582
|
+
*/
|
|
1351
1583
|
put: operations["putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
|
|
1352
1584
|
post?: never;
|
|
1353
1585
|
delete?: never;
|
|
@@ -1363,9 +1595,17 @@ export interface paths {
|
|
|
1363
1595
|
path?: never;
|
|
1364
1596
|
cookie?: never;
|
|
1365
1597
|
};
|
|
1366
|
-
/**
|
|
1598
|
+
/**
|
|
1599
|
+
* @description Retrieve opening balance advanced deposits summary
|
|
1600
|
+
*
|
|
1601
|
+
* Required scope: general-ledger:read
|
|
1602
|
+
*/
|
|
1367
1603
|
get: operations["getGeneralLedgerOpeningBalancesAdvancedDeposits"];
|
|
1368
|
-
/**
|
|
1604
|
+
/**
|
|
1605
|
+
* @description Update opening balance advanced deposits. Replaces the advanced deposit opening balance postings for stays that were paid before the go-live date and returns the recalculated summary, including the submitted account selection. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance.
|
|
1606
|
+
*
|
|
1607
|
+
* Required scope: general-ledger:write
|
|
1608
|
+
*/
|
|
1369
1609
|
put: operations["putGeneralLedgerOpeningBalancesAdvancedDeposits"];
|
|
1370
1610
|
post?: never;
|
|
1371
1611
|
delete?: never;
|
|
@@ -1381,7 +1621,11 @@ export interface paths {
|
|
|
1381
1621
|
path?: never;
|
|
1382
1622
|
cookie?: never;
|
|
1383
1623
|
};
|
|
1384
|
-
/**
|
|
1624
|
+
/**
|
|
1625
|
+
* @description Retrieve synced payments and refunds that are candidates for advanced deposit opening balances
|
|
1626
|
+
*
|
|
1627
|
+
* Required scope: general-ledger:read
|
|
1628
|
+
*/
|
|
1385
1629
|
get: operations["getGeneralLedgerOpeningBalancesAdvancedDepositsSyncedPaymentsRefunds"];
|
|
1386
1630
|
put?: never;
|
|
1387
1631
|
post?: never;
|
|
@@ -1398,9 +1642,17 @@ export interface paths {
|
|
|
1398
1642
|
path?: never;
|
|
1399
1643
|
cookie?: never;
|
|
1400
1644
|
};
|
|
1401
|
-
/**
|
|
1645
|
+
/**
|
|
1646
|
+
* @description Retrieve opening balance tax payable summary
|
|
1647
|
+
*
|
|
1648
|
+
* Required scope: general-ledger:read
|
|
1649
|
+
*/
|
|
1402
1650
|
get: operations["getGeneralLedgerOpeningBalancesTaxPayable"];
|
|
1403
|
-
/**
|
|
1651
|
+
/**
|
|
1652
|
+
* @description Update opening balance tax payable. Replaces the tax payable opening balance postings as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance.
|
|
1653
|
+
*
|
|
1654
|
+
* Required scope: general-ledger:write
|
|
1655
|
+
*/
|
|
1404
1656
|
put: operations["putGeneralLedgerOpeningBalancesTaxPayable"];
|
|
1405
1657
|
post?: never;
|
|
1406
1658
|
delete?: never;
|
|
@@ -1416,9 +1668,17 @@ export interface paths {
|
|
|
1416
1668
|
path?: never;
|
|
1417
1669
|
cookie?: never;
|
|
1418
1670
|
};
|
|
1419
|
-
/**
|
|
1671
|
+
/**
|
|
1672
|
+
* @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.
|
|
1673
|
+
*
|
|
1674
|
+
* Required scope: general-ledger:read
|
|
1675
|
+
*/
|
|
1420
1676
|
get: operations["getGeneralLedgerOpeningTrialBalance"];
|
|
1421
|
-
/**
|
|
1677
|
+
/**
|
|
1678
|
+
* @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.
|
|
1679
|
+
*
|
|
1680
|
+
* Required scope: general-ledger:write
|
|
1681
|
+
*/
|
|
1422
1682
|
put: operations["putGeneralLedgerOpeningTrialBalance"];
|
|
1423
1683
|
post?: never;
|
|
1424
1684
|
delete?: never;
|
|
@@ -2023,7 +2283,11 @@ export interface paths {
|
|
|
2023
2283
|
path?: never;
|
|
2024
2284
|
cookie?: never;
|
|
2025
2285
|
};
|
|
2026
|
-
/**
|
|
2286
|
+
/**
|
|
2287
|
+
* @description Get opening balances for listings
|
|
2288
|
+
*
|
|
2289
|
+
* Required scope: general-ledger:read
|
|
2290
|
+
*/
|
|
2027
2291
|
get: operations["getListingsOpeningBalances"];
|
|
2028
2292
|
put?: never;
|
|
2029
2293
|
post?: never;
|
|
@@ -2040,7 +2304,11 @@ export interface paths {
|
|
|
2040
2304
|
path?: never;
|
|
2041
2305
|
cookie?: never;
|
|
2042
2306
|
};
|
|
2043
|
-
/**
|
|
2307
|
+
/**
|
|
2308
|
+
* @description Listing opening balance CSV import template
|
|
2309
|
+
*
|
|
2310
|
+
* Required scope: general-ledger:read
|
|
2311
|
+
*/
|
|
2044
2312
|
get: operations["getListingsOpeningBalancesCsvTemplate"];
|
|
2045
2313
|
put?: never;
|
|
2046
2314
|
post?: never;
|
|
@@ -2145,9 +2413,17 @@ export interface paths {
|
|
|
2145
2413
|
path?: never;
|
|
2146
2414
|
cookie?: never;
|
|
2147
2415
|
};
|
|
2148
|
-
/**
|
|
2416
|
+
/**
|
|
2417
|
+
* @description Get opening balance for listing
|
|
2418
|
+
*
|
|
2419
|
+
* Required scope: general-ledger:read
|
|
2420
|
+
*/
|
|
2149
2421
|
get: operations["getListingsByIdOpeningBalance"];
|
|
2150
|
-
/**
|
|
2422
|
+
/**
|
|
2423
|
+
* @description Update opening balance for listing
|
|
2424
|
+
*
|
|
2425
|
+
* Required scope: general-ledger:write
|
|
2426
|
+
*/
|
|
2151
2427
|
put: operations["putListingsByIdOpeningBalance"];
|
|
2152
2428
|
post?: never;
|
|
2153
2429
|
delete?: never;
|
|
@@ -2164,10 +2440,18 @@ export interface paths {
|
|
|
2164
2440
|
cookie?: never;
|
|
2165
2441
|
};
|
|
2166
2442
|
get?: never;
|
|
2167
|
-
/**
|
|
2443
|
+
/**
|
|
2444
|
+
* @description Set Listing Parent
|
|
2445
|
+
*
|
|
2446
|
+
* Required scope: listings:write
|
|
2447
|
+
*/
|
|
2168
2448
|
put: operations["putListingsByIdParent"];
|
|
2169
2449
|
post?: never;
|
|
2170
|
-
/**
|
|
2450
|
+
/**
|
|
2451
|
+
* @description Remove Listing Parent
|
|
2452
|
+
*
|
|
2453
|
+
* Required scope: listings:write
|
|
2454
|
+
*/
|
|
2171
2455
|
delete: operations["deleteListingsByIdParent"];
|
|
2172
2456
|
options?: never;
|
|
2173
2457
|
head?: never;
|
|
@@ -2966,7 +3250,11 @@ export interface paths {
|
|
|
2966
3250
|
};
|
|
2967
3251
|
get?: never;
|
|
2968
3252
|
put?: never;
|
|
2969
|
-
/**
|
|
3253
|
+
/**
|
|
3254
|
+
* @description Apply every required bank-account configuration for a Plaid connect session in one mutation, then create exactly one durable initial transaction sync. Connect decisions can reference an eligible existing GL bank account or create one using the normal account schema. Archive decisions make the external feed inactive. The earliest selected startDate controls history ingestion. Repeating a completed connectId returns the same sync. If eligibility changed after completion, a PLAID_CONNECT_CONFIGURATION_CHANGED conflict returns the refreshed screen model in context.result. See https://docs.vrplatform.app/guides/build/banking.
|
|
3255
|
+
*
|
|
3256
|
+
* Required scope: bank-connections:manage
|
|
3257
|
+
*/
|
|
2970
3258
|
post: operations["configurePlaidConnectSession"];
|
|
2971
3259
|
delete?: never;
|
|
2972
3260
|
options?: never;
|
|
@@ -3002,10 +3290,18 @@ export interface paths {
|
|
|
3002
3290
|
path?: never;
|
|
3003
3291
|
cookie?: never;
|
|
3004
3292
|
};
|
|
3005
|
-
/**
|
|
3293
|
+
/**
|
|
3294
|
+
* @description Recurring Fees
|
|
3295
|
+
*
|
|
3296
|
+
* Required scope: recurring-fees:read
|
|
3297
|
+
*/
|
|
3006
3298
|
get: operations["getRecurringFees"];
|
|
3007
3299
|
put?: never;
|
|
3008
|
-
/**
|
|
3300
|
+
/**
|
|
3301
|
+
* @description Create Recurring Fees
|
|
3302
|
+
*
|
|
3303
|
+
* Required scope: recurring-fees:write
|
|
3304
|
+
*/
|
|
3009
3305
|
post: operations["postRecurringFees"];
|
|
3010
3306
|
delete?: never;
|
|
3011
3307
|
options?: never;
|
|
@@ -3020,10 +3316,18 @@ export interface paths {
|
|
|
3020
3316
|
path?: never;
|
|
3021
3317
|
cookie?: never;
|
|
3022
3318
|
};
|
|
3023
|
-
/**
|
|
3319
|
+
/**
|
|
3320
|
+
* @description List recurring fee listing periods
|
|
3321
|
+
*
|
|
3322
|
+
* Required scope: recurring-fees:read
|
|
3323
|
+
*/
|
|
3024
3324
|
get: operations["getRecurringFeesListingPeriods"];
|
|
3025
3325
|
put?: never;
|
|
3026
|
-
/**
|
|
3326
|
+
/**
|
|
3327
|
+
* @description Add listing period to a recurring fee
|
|
3328
|
+
*
|
|
3329
|
+
* Required scope: recurring-fees:write
|
|
3330
|
+
*/
|
|
3027
3331
|
post: operations["postRecurringFeesListingPeriods"];
|
|
3028
3332
|
delete?: never;
|
|
3029
3333
|
options?: never;
|
|
@@ -3039,10 +3343,18 @@ export interface paths {
|
|
|
3039
3343
|
cookie?: never;
|
|
3040
3344
|
};
|
|
3041
3345
|
get?: never;
|
|
3042
|
-
/**
|
|
3346
|
+
/**
|
|
3347
|
+
* @description Update a listing period
|
|
3348
|
+
*
|
|
3349
|
+
* Required scope: recurring-fees:write
|
|
3350
|
+
*/
|
|
3043
3351
|
put: operations["putRecurringFeesListingPeriodsById"];
|
|
3044
3352
|
post?: never;
|
|
3045
|
-
/**
|
|
3353
|
+
/**
|
|
3354
|
+
* @description Delete listing period from a recurring fee
|
|
3355
|
+
*
|
|
3356
|
+
* Required scope: recurring-fees:delete
|
|
3357
|
+
*/
|
|
3046
3358
|
delete: operations["deleteRecurringFeesListingPeriodsById"];
|
|
3047
3359
|
options?: never;
|
|
3048
3360
|
head?: never;
|
|
@@ -3058,7 +3370,11 @@ export interface paths {
|
|
|
3058
3370
|
};
|
|
3059
3371
|
get?: never;
|
|
3060
3372
|
put?: never;
|
|
3061
|
-
/**
|
|
3373
|
+
/**
|
|
3374
|
+
* @description Preview Recurring Fees changes on a reservation
|
|
3375
|
+
*
|
|
3376
|
+
* Required scope: recurring-fees:read
|
|
3377
|
+
*/
|
|
3062
3378
|
post: operations["postRecurringFeesPreview"];
|
|
3063
3379
|
delete?: never;
|
|
3064
3380
|
options?: never;
|
|
@@ -3073,12 +3389,24 @@ export interface paths {
|
|
|
3073
3389
|
path?: never;
|
|
3074
3390
|
cookie?: never;
|
|
3075
3391
|
};
|
|
3076
|
-
/**
|
|
3392
|
+
/**
|
|
3393
|
+
* @description Get recurring fee by ID
|
|
3394
|
+
*
|
|
3395
|
+
* Required scope: recurring-fees:read
|
|
3396
|
+
*/
|
|
3077
3397
|
get: operations["getRecurringFeesById"];
|
|
3078
|
-
/**
|
|
3398
|
+
/**
|
|
3399
|
+
* @description Update Recurring Fees
|
|
3400
|
+
*
|
|
3401
|
+
* Required scope: recurring-fees:write
|
|
3402
|
+
*/
|
|
3079
3403
|
put: operations["putRecurringFeesById"];
|
|
3080
3404
|
post?: never;
|
|
3081
|
-
/**
|
|
3405
|
+
/**
|
|
3406
|
+
* @description Delete Recurring Fee By Id
|
|
3407
|
+
*
|
|
3408
|
+
* Required scope: recurring-fees:delete
|
|
3409
|
+
*/
|
|
3082
3410
|
delete: operations["deleteRecurringFeesById"];
|
|
3083
3411
|
options?: never;
|
|
3084
3412
|
head?: never;
|
|
@@ -3879,7 +4207,11 @@ export interface paths {
|
|
|
3879
4207
|
path?: never;
|
|
3880
4208
|
cookie?: never;
|
|
3881
4209
|
};
|
|
3882
|
-
/**
|
|
4210
|
+
/**
|
|
4211
|
+
* @description Reservation line mappings CSV export
|
|
4212
|
+
*
|
|
4213
|
+
* Required scope: reservation-mappings:read
|
|
4214
|
+
*/
|
|
3883
4215
|
get: operations["getReservationsLineMappingsCsv"];
|
|
3884
4216
|
put?: never;
|
|
3885
4217
|
post?: never;
|
|
@@ -3971,7 +4303,11 @@ export interface paths {
|
|
|
3971
4303
|
};
|
|
3972
4304
|
get?: never;
|
|
3973
4305
|
put?: never;
|
|
3974
|
-
/**
|
|
4306
|
+
/**
|
|
4307
|
+
* @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations. Pass onLocked=nextOpen to resolve and persist the earliest valid posting date, or provide generalLedgerPostingAt explicitly. The two options cannot be combined. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
|
|
4308
|
+
*
|
|
4309
|
+
* Required scope: reservations:write
|
|
4310
|
+
*/
|
|
3975
4311
|
post: operations["postReservationsByReservationIdAdjustments"];
|
|
3976
4312
|
delete?: never;
|
|
3977
4313
|
options?: never;
|
|
@@ -3987,10 +4323,18 @@ export interface paths {
|
|
|
3987
4323
|
cookie?: never;
|
|
3988
4324
|
};
|
|
3989
4325
|
get?: never;
|
|
3990
|
-
/**
|
|
4326
|
+
/**
|
|
4327
|
+
* @description Update a reservation adjustment line. Refreshes the reservation journal inline; the update is rejected when the adjustment posts into a books-closed month or its journal entries are attached to an owner statement. Move the generalLedgerPostingAt date after the locked range to adjust a locked reservation. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
|
|
4328
|
+
*
|
|
4329
|
+
* Required scope: reservations:write
|
|
4330
|
+
*/
|
|
3991
4331
|
put: operations["putReservationsByReservationIdAdjustmentsById"];
|
|
3992
4332
|
post?: never;
|
|
3993
|
-
/**
|
|
4333
|
+
/**
|
|
4334
|
+
* @description Delete a reservation adjustment line. Removes the adjustment and its journal entries and refreshes the reservation journal inline; deletion is rejected when the entries fall into a books-closed month or are attached to an owner statement. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
|
|
4335
|
+
*
|
|
4336
|
+
* Required scope: reservations:delete
|
|
4337
|
+
*/
|
|
3994
4338
|
delete: operations["deleteReservationsByReservationIdAdjustmentsById"];
|
|
3995
4339
|
options?: never;
|
|
3996
4340
|
head?: never;
|
|
@@ -4004,7 +4348,11 @@ export interface paths {
|
|
|
4004
4348
|
path?: never;
|
|
4005
4349
|
cookie?: never;
|
|
4006
4350
|
};
|
|
4007
|
-
/**
|
|
4351
|
+
/**
|
|
4352
|
+
* @description Download source JSON or the original imported source file for an entity.
|
|
4353
|
+
*
|
|
4354
|
+
* Required scope: sources:read
|
|
4355
|
+
*/
|
|
4008
4356
|
get: operations["downloadSource"];
|
|
4009
4357
|
put?: never;
|
|
4010
4358
|
post?: never;
|
|
@@ -4133,7 +4481,11 @@ export interface paths {
|
|
|
4133
4481
|
};
|
|
4134
4482
|
get?: never;
|
|
4135
4483
|
put?: never;
|
|
4136
|
-
/**
|
|
4484
|
+
/**
|
|
4485
|
+
* @description Import a historic owner statement with journal entries on the historical ledger; re-posting the same uniqueRef replaces the previous import
|
|
4486
|
+
*
|
|
4487
|
+
* Required scope: general-ledger:import
|
|
4488
|
+
*/
|
|
4137
4489
|
post: operations["postStatementsHistorical"];
|
|
4138
4490
|
delete?: never;
|
|
4139
4491
|
options?: never;
|
|
@@ -4155,7 +4507,11 @@ export interface paths {
|
|
|
4155
4507
|
*/
|
|
4156
4508
|
get: operations["getStatementsLayouts"];
|
|
4157
4509
|
put?: never;
|
|
4158
|
-
/**
|
|
4510
|
+
/**
|
|
4511
|
+
* @description Create Statement Layout
|
|
4512
|
+
*
|
|
4513
|
+
* Required scope: statement-layouts:write
|
|
4514
|
+
*/
|
|
4159
4515
|
post: operations["postStatementsLayouts"];
|
|
4160
4516
|
delete?: never;
|
|
4161
4517
|
options?: never;
|
|
@@ -4192,7 +4548,11 @@ export interface paths {
|
|
|
4192
4548
|
cookie?: never;
|
|
4193
4549
|
};
|
|
4194
4550
|
get?: never;
|
|
4195
|
-
/**
|
|
4551
|
+
/**
|
|
4552
|
+
* @description Update statement layout listing mapping
|
|
4553
|
+
*
|
|
4554
|
+
* Required scope: statement-layouts:write
|
|
4555
|
+
*/
|
|
4196
4556
|
put: operations["putStatementsLayoutsListingMappingsByListingId"];
|
|
4197
4557
|
post?: never;
|
|
4198
4558
|
delete?: never;
|
|
@@ -4214,10 +4574,18 @@ export interface paths {
|
|
|
4214
4574
|
* Required scope: statement-layouts:read
|
|
4215
4575
|
*/
|
|
4216
4576
|
get: operations["getStatementsLayoutsById"];
|
|
4217
|
-
/**
|
|
4577
|
+
/**
|
|
4578
|
+
* @description Update Statement Layout
|
|
4579
|
+
*
|
|
4580
|
+
* Required scope: statement-layouts:write
|
|
4581
|
+
*/
|
|
4218
4582
|
put: operations["putStatementsLayoutsById"];
|
|
4219
4583
|
post?: never;
|
|
4220
|
-
/**
|
|
4584
|
+
/**
|
|
4585
|
+
* @description Delete statement layout by ID
|
|
4586
|
+
*
|
|
4587
|
+
* Required scope: statement-layouts:delete
|
|
4588
|
+
*/
|
|
4221
4589
|
delete: operations["deleteStatementsLayoutsById"];
|
|
4222
4590
|
options?: never;
|
|
4223
4591
|
head?: never;
|
|
@@ -4232,7 +4600,11 @@ export interface paths {
|
|
|
4232
4600
|
cookie?: never;
|
|
4233
4601
|
};
|
|
4234
4602
|
get?: never;
|
|
4235
|
-
/**
|
|
4603
|
+
/**
|
|
4604
|
+
* @description Update an owner statement line description
|
|
4605
|
+
*
|
|
4606
|
+
* Required scope: statements:write
|
|
4607
|
+
*/
|
|
4236
4608
|
put: operations["putStatementsLinesByLineIdDescription"];
|
|
4237
4609
|
post?: never;
|
|
4238
4610
|
delete?: never;
|
|
@@ -4250,7 +4622,11 @@ export interface paths {
|
|
|
4250
4622
|
};
|
|
4251
4623
|
get?: never;
|
|
4252
4624
|
put?: never;
|
|
4253
|
-
/**
|
|
4625
|
+
/**
|
|
4626
|
+
* @description Pay the property manager out. Creates a payout transaction with a single manager-party line against either a bank account (bankAccountId) or an explicit ledger account (lineAccountId) - exactly one of the two must be provided - and posts the resulting journal entries on the payout date. Creation respects books-closed and statement locks and supports dryRun. See https://docs.vrplatform.app/guides/build/statements.
|
|
4627
|
+
*
|
|
4628
|
+
* Required scope: statements:pay
|
|
4629
|
+
*/
|
|
4254
4630
|
post: operations["postStatementsManagerPay"];
|
|
4255
4631
|
delete?: never;
|
|
4256
4632
|
options?: never;
|
|
@@ -4382,7 +4758,11 @@ export interface paths {
|
|
|
4382
4758
|
};
|
|
4383
4759
|
get?: never;
|
|
4384
4760
|
put?: never;
|
|
4385
|
-
/**
|
|
4761
|
+
/**
|
|
4762
|
+
* @description Refresh the templateJson of a statement to match the current layout configuration. Use this when a layout has been updated after a statement was published.
|
|
4763
|
+
*
|
|
4764
|
+
* Required scope: statements:write
|
|
4765
|
+
*/
|
|
4386
4766
|
post: operations["postStatementsByIdRefreshLayout"];
|
|
4387
4767
|
delete?: never;
|
|
4388
4768
|
options?: never;
|
|
@@ -4397,10 +4777,18 @@ export interface paths {
|
|
|
4397
4777
|
path?: never;
|
|
4398
4778
|
cookie?: never;
|
|
4399
4779
|
};
|
|
4400
|
-
/**
|
|
4780
|
+
/**
|
|
4781
|
+
* @description Get syncs
|
|
4782
|
+
*
|
|
4783
|
+
* Required scope: integrations:read
|
|
4784
|
+
*/
|
|
4401
4785
|
get: operations["getSyncs"];
|
|
4402
4786
|
put?: never;
|
|
4403
|
-
/**
|
|
4787
|
+
/**
|
|
4788
|
+
* @description Create a sync
|
|
4789
|
+
*
|
|
4790
|
+
* Required scope: integrations:execute
|
|
4791
|
+
*/
|
|
4404
4792
|
post: operations["createSync"];
|
|
4405
4793
|
delete?: never;
|
|
4406
4794
|
options?: never;
|
|
@@ -4417,7 +4805,11 @@ export interface paths {
|
|
|
4417
4805
|
};
|
|
4418
4806
|
get?: never;
|
|
4419
4807
|
put?: never;
|
|
4420
|
-
/**
|
|
4808
|
+
/**
|
|
4809
|
+
* @description Resolve canonical entity ID by source identity
|
|
4810
|
+
*
|
|
4811
|
+
* Required scope: integrations:read
|
|
4812
|
+
*/
|
|
4421
4813
|
post: operations["resolveSyncEntity"];
|
|
4422
4814
|
delete?: never;
|
|
4423
4815
|
options?: never;
|
|
@@ -4434,7 +4826,11 @@ export interface paths {
|
|
|
4434
4826
|
};
|
|
4435
4827
|
get?: never;
|
|
4436
4828
|
put?: never;
|
|
4437
|
-
/**
|
|
4829
|
+
/**
|
|
4830
|
+
* @description Create a sync subtask
|
|
4831
|
+
*
|
|
4832
|
+
* Required scope: integrations:execute
|
|
4833
|
+
*/
|
|
4438
4834
|
post: operations["createSyncSubtask"];
|
|
4439
4835
|
delete?: never;
|
|
4440
4836
|
options?: never;
|
|
@@ -4450,7 +4846,11 @@ export interface paths {
|
|
|
4450
4846
|
cookie?: never;
|
|
4451
4847
|
};
|
|
4452
4848
|
get?: never;
|
|
4453
|
-
/**
|
|
4849
|
+
/**
|
|
4850
|
+
* @description Update subtask by ID
|
|
4851
|
+
*
|
|
4852
|
+
* Required scope: integrations:execute
|
|
4853
|
+
*/
|
|
4454
4854
|
put: operations["updateSyncSubtask"];
|
|
4455
4855
|
post?: never;
|
|
4456
4856
|
delete?: never;
|
|
@@ -4466,9 +4866,17 @@ export interface paths {
|
|
|
4466
4866
|
path?: never;
|
|
4467
4867
|
cookie?: never;
|
|
4468
4868
|
};
|
|
4469
|
-
/**
|
|
4869
|
+
/**
|
|
4870
|
+
* @description Get sync by ID
|
|
4871
|
+
*
|
|
4872
|
+
* Required scope: integrations:read
|
|
4873
|
+
*/
|
|
4470
4874
|
get: operations["getSync"];
|
|
4471
|
-
/**
|
|
4875
|
+
/**
|
|
4876
|
+
* @description Update sync by ID
|
|
4877
|
+
*
|
|
4878
|
+
* Required scope: integrations:execute
|
|
4879
|
+
*/
|
|
4472
4880
|
put: operations["updateSync"];
|
|
4473
4881
|
post?: never;
|
|
4474
4882
|
delete?: never;
|
|
@@ -4486,7 +4894,11 @@ export interface paths {
|
|
|
4486
4894
|
};
|
|
4487
4895
|
get?: never;
|
|
4488
4896
|
put?: never;
|
|
4489
|
-
/**
|
|
4897
|
+
/**
|
|
4898
|
+
* @description Cancel sync by ID
|
|
4899
|
+
*
|
|
4900
|
+
* Required scope: integrations:execute
|
|
4901
|
+
*/
|
|
4490
4902
|
post: operations["cancelSync"];
|
|
4491
4903
|
delete?: never;
|
|
4492
4904
|
options?: never;
|
|
@@ -4501,7 +4913,11 @@ export interface paths {
|
|
|
4501
4913
|
path?: never;
|
|
4502
4914
|
cookie?: never;
|
|
4503
4915
|
};
|
|
4504
|
-
/**
|
|
4916
|
+
/**
|
|
4917
|
+
* @description Get sync changes
|
|
4918
|
+
*
|
|
4919
|
+
* Required scope: integrations:read
|
|
4920
|
+
*/
|
|
4505
4921
|
get: operations["getSyncChanges"];
|
|
4506
4922
|
put?: never;
|
|
4507
4923
|
post?: never;
|
|
@@ -4588,11 +5004,7 @@ export interface paths {
|
|
|
4588
5004
|
*/
|
|
4589
5005
|
put: operations["putTeam"];
|
|
4590
5006
|
post?: never;
|
|
4591
|
-
/**
|
|
4592
|
-
* @description Queue deletion of the current team selected by x-team-id. Requires confirm=true and an authenticated active VRPlatform member; API-key callers and ordinary tenant users cannot delete the current team.
|
|
4593
|
-
*
|
|
4594
|
-
* Required scope: teams:delete
|
|
4595
|
-
*/
|
|
5007
|
+
/** @description Queue deletion of the current team selected by x-team-id. Requires confirm=true and an authenticated active VRPlatform member; API-key callers and ordinary tenant users cannot delete the current team. */
|
|
4596
5008
|
delete: operations["deleteTeam"];
|
|
4597
5009
|
options?: never;
|
|
4598
5010
|
head?: never;
|
|
@@ -4691,7 +5103,11 @@ export interface paths {
|
|
|
4691
5103
|
path?: never;
|
|
4692
5104
|
cookie?: never;
|
|
4693
5105
|
};
|
|
4694
|
-
/**
|
|
5106
|
+
/**
|
|
5107
|
+
* @description List property-managers for the current team
|
|
5108
|
+
*
|
|
5109
|
+
* Required scope: team-members:read
|
|
5110
|
+
*/
|
|
4695
5111
|
get: operations["getTeamMembers"];
|
|
4696
5112
|
put?: never;
|
|
4697
5113
|
post?: never;
|
|
@@ -4710,7 +5126,11 @@ export interface paths {
|
|
|
4710
5126
|
};
|
|
4711
5127
|
get?: never;
|
|
4712
5128
|
put?: never;
|
|
4713
|
-
/**
|
|
5129
|
+
/**
|
|
5130
|
+
* @description Invite a property-manager member to the current team. Emails already used by owner accounts are rejected as bad requests.
|
|
5131
|
+
*
|
|
5132
|
+
* Required scope: team-members:manage
|
|
5133
|
+
*/
|
|
4714
5134
|
post: operations["postTeamMembersInvite"];
|
|
4715
5135
|
delete?: never;
|
|
4716
5136
|
options?: never;
|
|
@@ -4726,10 +5146,18 @@ export interface paths {
|
|
|
4726
5146
|
cookie?: never;
|
|
4727
5147
|
};
|
|
4728
5148
|
get?: never;
|
|
4729
|
-
/**
|
|
5149
|
+
/**
|
|
5150
|
+
* @description Update a property-manager member role for the current team
|
|
5151
|
+
*
|
|
5152
|
+
* Required scope: team-members:manage
|
|
5153
|
+
*/
|
|
4730
5154
|
put: operations["putTeamMembersByUserId"];
|
|
4731
5155
|
post?: never;
|
|
4732
|
-
/**
|
|
5156
|
+
/**
|
|
5157
|
+
* @description Remove a member from the current team
|
|
5158
|
+
*
|
|
5159
|
+
* Required scope: team-members:manage
|
|
5160
|
+
*/
|
|
4733
5161
|
delete: operations["deleteTeamMembersByUserId"];
|
|
4734
5162
|
options?: never;
|
|
4735
5163
|
head?: never;
|
|
@@ -4886,7 +5314,11 @@ export interface paths {
|
|
|
4886
5314
|
};
|
|
4887
5315
|
get?: never;
|
|
4888
5316
|
put?: never;
|
|
4889
|
-
/**
|
|
5317
|
+
/**
|
|
5318
|
+
* @description Upload an expense attachment as multipart/form-data. The returned staged attachment id can be passed in attachmentIds when creating or updating an expense transaction.
|
|
5319
|
+
*
|
|
5320
|
+
* Required scope: transactions:write
|
|
5321
|
+
*/
|
|
4890
5322
|
post: operations["postTransactionsAttachments"];
|
|
4891
5323
|
delete?: never;
|
|
4892
5324
|
options?: never;
|
|
@@ -4902,10 +5334,18 @@ export interface paths {
|
|
|
4902
5334
|
cookie?: never;
|
|
4903
5335
|
};
|
|
4904
5336
|
get?: never;
|
|
4905
|
-
/**
|
|
5337
|
+
/**
|
|
5338
|
+
* @description Update attachment visibility. isOwnerAccessible controls whether owners can see the file on owner statement details.
|
|
5339
|
+
*
|
|
5340
|
+
* Required scope: transactions:write
|
|
5341
|
+
*/
|
|
4906
5342
|
put: operations["putTransactionsAttachmentsById"];
|
|
4907
5343
|
post?: never;
|
|
4908
|
-
/**
|
|
5344
|
+
/**
|
|
5345
|
+
* @description Delete an expense attachment. This removes staged attachments and attachments already linked to expense transactions.
|
|
5346
|
+
*
|
|
5347
|
+
* Required scope: transactions:delete
|
|
5348
|
+
*/
|
|
4909
5349
|
delete: operations["deleteTransactionsAttachmentsById"];
|
|
4910
5350
|
options?: never;
|
|
4911
5351
|
head?: never;
|
|
@@ -4919,7 +5359,11 @@ export interface paths {
|
|
|
4919
5359
|
path?: never;
|
|
4920
5360
|
cookie?: never;
|
|
4921
5361
|
};
|
|
4922
|
-
/**
|
|
5362
|
+
/**
|
|
5363
|
+
* @description Download an expense attachment
|
|
5364
|
+
*
|
|
5365
|
+
* Required scope: transactions:read
|
|
5366
|
+
*/
|
|
4923
5367
|
get: operations["getTransactionsAttachmentsByIdDownload"];
|
|
4924
5368
|
put?: never;
|
|
4925
5369
|
post?: never;
|
|
@@ -4957,7 +5401,11 @@ export interface paths {
|
|
|
4957
5401
|
path?: never;
|
|
4958
5402
|
cookie?: never;
|
|
4959
5403
|
};
|
|
4960
|
-
/**
|
|
5404
|
+
/**
|
|
5405
|
+
* @description Deposit transactions grouped by last 4 digits
|
|
5406
|
+
*
|
|
5407
|
+
* Required scope: transactions:read
|
|
5408
|
+
*/
|
|
4961
5409
|
get: operations["getTransactionsByLast4"];
|
|
4962
5410
|
put?: never;
|
|
4963
5411
|
post?: never;
|
|
@@ -5058,10 +5506,18 @@ export interface paths {
|
|
|
5058
5506
|
path?: never;
|
|
5059
5507
|
cookie?: never;
|
|
5060
5508
|
};
|
|
5061
|
-
/**
|
|
5509
|
+
/**
|
|
5510
|
+
* @description Recurring Transaction Template List
|
|
5511
|
+
*
|
|
5512
|
+
* Required scope: transactions:read
|
|
5513
|
+
*/
|
|
5062
5514
|
get: operations["getTransactionsRecurringTemplates"];
|
|
5063
5515
|
put?: never;
|
|
5064
|
-
/**
|
|
5516
|
+
/**
|
|
5517
|
+
* @description Create a recurring transaction template
|
|
5518
|
+
*
|
|
5519
|
+
* Required scope: transactions:write
|
|
5520
|
+
*/
|
|
5065
5521
|
post: operations["postTransactionsRecurringTemplates"];
|
|
5066
5522
|
delete?: never;
|
|
5067
5523
|
options?: never;
|
|
@@ -5078,7 +5534,11 @@ export interface paths {
|
|
|
5078
5534
|
};
|
|
5079
5535
|
get?: never;
|
|
5080
5536
|
put?: never;
|
|
5081
|
-
/**
|
|
5537
|
+
/**
|
|
5538
|
+
* @description Preview a recurring transaction template pattern
|
|
5539
|
+
*
|
|
5540
|
+
* Required scope: transactions:write
|
|
5541
|
+
*/
|
|
5082
5542
|
post: operations["postTransactionsRecurringTemplatesPreview"];
|
|
5083
5543
|
delete?: never;
|
|
5084
5544
|
options?: never;
|
|
@@ -5093,12 +5553,24 @@ export interface paths {
|
|
|
5093
5553
|
path?: never;
|
|
5094
5554
|
cookie?: never;
|
|
5095
5555
|
};
|
|
5096
|
-
/**
|
|
5556
|
+
/**
|
|
5557
|
+
* @description Recurring Transaction Template
|
|
5558
|
+
*
|
|
5559
|
+
* Required scope: transactions:read
|
|
5560
|
+
*/
|
|
5097
5561
|
get: operations["getTransactionsRecurringTemplatesById"];
|
|
5098
|
-
/**
|
|
5562
|
+
/**
|
|
5563
|
+
* @description Update an recurring transaction template by ID
|
|
5564
|
+
*
|
|
5565
|
+
* Required scope: transactions:write
|
|
5566
|
+
*/
|
|
5099
5567
|
put: operations["putTransactionsRecurringTemplatesById"];
|
|
5100
5568
|
post?: never;
|
|
5101
|
-
/**
|
|
5569
|
+
/**
|
|
5570
|
+
* @description Delete an recurring transaction template by ID
|
|
5571
|
+
*
|
|
5572
|
+
* Required scope: transactions:delete
|
|
5573
|
+
*/
|
|
5102
5574
|
delete: operations["deleteTransactionsRecurringTemplatesById"];
|
|
5103
5575
|
options?: never;
|
|
5104
5576
|
head?: never;
|
|
@@ -5114,7 +5586,11 @@ export interface paths {
|
|
|
5114
5586
|
};
|
|
5115
5587
|
get?: never;
|
|
5116
5588
|
put?: never;
|
|
5117
|
-
/**
|
|
5589
|
+
/**
|
|
5590
|
+
* @description Create a recurring transaction instance
|
|
5591
|
+
*
|
|
5592
|
+
* Required scope: transactions:write
|
|
5593
|
+
*/
|
|
5118
5594
|
post: operations["postTransactionsRecurringTemplatesByIdRun"];
|
|
5119
5595
|
delete?: never;
|
|
5120
5596
|
options?: never;
|
|
@@ -5182,7 +5658,11 @@ export interface paths {
|
|
|
5182
5658
|
cookie?: never;
|
|
5183
5659
|
};
|
|
5184
5660
|
get?: never;
|
|
5185
|
-
/**
|
|
5661
|
+
/**
|
|
5662
|
+
* @description Update a transaction line by ID. Account, assignment, listing, and reservation changes can recompute a default or forced party. See https://docs.vrplatform.app/guides/build/transactions#decision-table.
|
|
5663
|
+
*
|
|
5664
|
+
* Required scope: transactions:write
|
|
5665
|
+
*/
|
|
5186
5666
|
put: operations["putTransactionsByTransactionIdLinesById"];
|
|
5187
5667
|
post?: never;
|
|
5188
5668
|
delete?: never;
|
|
@@ -10516,7 +10996,7 @@ export interface operations {
|
|
|
10516
10996
|
data: {
|
|
10517
10997
|
allowedEmbedParentOrigins: string[];
|
|
10518
10998
|
allowedIpCidrs: string[];
|
|
10519
|
-
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
10999
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:audit:v1" | "partner:banking:v1" | "partner:calendar:v1" | "partner:files:v1" | "partner:general-ledger:v1" | "partner:integrations:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:recurring-fees:v1" | "partner:reports:v1" | "partner:statement-layouts:v1" | "partner:statements:v1" | "partner:team-members:v1" | "partner:webhooks:v1")[];
|
|
10520
11000
|
/** Format: uuid */
|
|
10521
11001
|
id: string;
|
|
10522
11002
|
/**
|
|
@@ -10528,7 +11008,7 @@ export interface operations {
|
|
|
10528
11008
|
hint: string | null;
|
|
10529
11009
|
role: string | null;
|
|
10530
11010
|
scope: string | null;
|
|
10531
|
-
scopes: ("self:read" | "self:write" | "
|
|
11011
|
+
scopes: ("self:read" | "self:write" | "audit:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
10532
11012
|
}[];
|
|
10533
11013
|
pagination: {
|
|
10534
11014
|
/** @default 100 */
|
|
@@ -10784,7 +11264,7 @@ export interface operations {
|
|
|
10784
11264
|
/** @description Optional IPv4 or IPv6 addresses and CIDRs allowed to use this token. Individual addresses are normalized to /32 or /128. Omit or send an empty array for no IP restriction. */
|
|
10785
11265
|
allowedIpCidrs?: string[];
|
|
10786
11266
|
/** @description Optional capability restrictions for a partner-owned API token. Omit for unrestricted partner API access. Rejected for ordinary teams. */
|
|
10787
|
-
bundles?: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
11267
|
+
bundles?: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:audit:v1" | "partner:banking:v1" | "partner:calendar:v1" | "partner:files:v1" | "partner:general-ledger:v1" | "partner:integrations:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:recurring-fees:v1" | "partner:reports:v1" | "partner:statement-layouts:v1" | "partner:statements:v1" | "partner:team-members:v1" | "partner:webhooks:v1")[];
|
|
10788
11268
|
};
|
|
10789
11269
|
};
|
|
10790
11270
|
};
|
|
@@ -10798,7 +11278,7 @@ export interface operations {
|
|
|
10798
11278
|
"application/json": {
|
|
10799
11279
|
allowedEmbedParentOrigins: string[];
|
|
10800
11280
|
allowedIpCidrs: string[];
|
|
10801
|
-
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
11281
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:audit:v1" | "partner:banking:v1" | "partner:calendar:v1" | "partner:files:v1" | "partner:general-ledger:v1" | "partner:integrations:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:recurring-fees:v1" | "partner:reports:v1" | "partner:statement-layouts:v1" | "partner:statements:v1" | "partner:team-members:v1" | "partner:webhooks:v1")[];
|
|
10802
11282
|
/** Format: uuid */
|
|
10803
11283
|
id: string;
|
|
10804
11284
|
/**
|
|
@@ -10810,7 +11290,7 @@ export interface operations {
|
|
|
10810
11290
|
hint: string | null;
|
|
10811
11291
|
role: string | null;
|
|
10812
11292
|
scope: string | null;
|
|
10813
|
-
scopes: ("self:read" | "self:write" | "
|
|
11293
|
+
scopes: ("self:read" | "self:write" | "audit:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
10814
11294
|
apiToken: string;
|
|
10815
11295
|
};
|
|
10816
11296
|
};
|
|
@@ -11062,7 +11542,7 @@ export interface operations {
|
|
|
11062
11542
|
"application/json": {
|
|
11063
11543
|
allowedEmbedParentOrigins: string[];
|
|
11064
11544
|
allowedIpCidrs: string[];
|
|
11065
|
-
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:banking:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:reports:v1" | "partner:statements:v1" | "partner:webhooks:v1")[];
|
|
11545
|
+
bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1" | "partner:accounting-data:v1" | "partner:audit:v1" | "partner:banking:v1" | "partner:calendar:v1" | "partner:files:v1" | "partner:general-ledger:v1" | "partner:integrations:v1" | "partner:onboarding:v1" | "partner:provisioning:v1" | "partner:recurring-fees:v1" | "partner:reports:v1" | "partner:statement-layouts:v1" | "partner:statements:v1" | "partner:team-members:v1" | "partner:webhooks:v1")[];
|
|
11066
11546
|
/** Format: uuid */
|
|
11067
11547
|
id: string;
|
|
11068
11548
|
/**
|
|
@@ -11074,7 +11554,7 @@ export interface operations {
|
|
|
11074
11554
|
hint: string | null;
|
|
11075
11555
|
role: string | null;
|
|
11076
11556
|
scope: string | null;
|
|
11077
|
-
scopes: ("self:read" | "self:write" | "
|
|
11557
|
+
scopes: ("self:read" | "self:write" | "audit:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
11078
11558
|
apiToken: string;
|
|
11079
11559
|
};
|
|
11080
11560
|
};
|