@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
package/src/generated/v1.ts
CHANGED
|
@@ -180,7 +180,11 @@ export interface paths {
|
|
|
180
180
|
};
|
|
181
181
|
get?: never;
|
|
182
182
|
put?: never;
|
|
183
|
-
/**
|
|
183
|
+
/**
|
|
184
|
+
* @description Initialize banking with an opening-balance transaction and feed checkpoint. Credit cards store a negative feed balance while the journal credits the liability.
|
|
185
|
+
*
|
|
186
|
+
* Required scope: bank-accounts:write
|
|
187
|
+
*/
|
|
184
188
|
post: operations["postAccountsByIdBankingInit"];
|
|
185
189
|
delete?: never;
|
|
186
190
|
options?: never;
|
|
@@ -197,7 +201,11 @@ export interface paths {
|
|
|
197
201
|
};
|
|
198
202
|
get?: never;
|
|
199
203
|
put?: never;
|
|
200
|
-
/**
|
|
204
|
+
/**
|
|
205
|
+
* @description Attach an external account connection to a bank account
|
|
206
|
+
*
|
|
207
|
+
* Required scope: bank-connections:manage
|
|
208
|
+
*/
|
|
201
209
|
post: operations["postAccountsByIdConnections"];
|
|
202
210
|
delete?: never;
|
|
203
211
|
options?: never;
|
|
@@ -215,7 +223,11 @@ export interface paths {
|
|
|
215
223
|
get?: never;
|
|
216
224
|
put?: never;
|
|
217
225
|
post?: never;
|
|
218
|
-
/**
|
|
226
|
+
/**
|
|
227
|
+
* @description Detach an external account connection from a bank account
|
|
228
|
+
*
|
|
229
|
+
* Required scope: bank-connections:manage
|
|
230
|
+
*/
|
|
219
231
|
delete: operations["deleteAccountsByIdConnectionsByAccountConnectionId"];
|
|
220
232
|
options?: never;
|
|
221
233
|
head?: never;
|
|
@@ -250,7 +262,11 @@ export interface paths {
|
|
|
250
262
|
path?: never;
|
|
251
263
|
cookie?: never;
|
|
252
264
|
};
|
|
253
|
-
/**
|
|
265
|
+
/**
|
|
266
|
+
* @description Get account reconciliation summary by date range
|
|
267
|
+
*
|
|
268
|
+
* Required scope: accounts:read
|
|
269
|
+
*/
|
|
254
270
|
get: operations["getAccountsByIdSummary"];
|
|
255
271
|
put?: never;
|
|
256
272
|
post?: never;
|
|
@@ -303,7 +319,11 @@ export interface paths {
|
|
|
303
319
|
path?: never;
|
|
304
320
|
cookie?: never;
|
|
305
321
|
};
|
|
306
|
-
/**
|
|
322
|
+
/**
|
|
323
|
+
* @description Get apps
|
|
324
|
+
*
|
|
325
|
+
* Required scope: integrations:read
|
|
326
|
+
*/
|
|
307
327
|
get: operations["getApps"];
|
|
308
328
|
put?: never;
|
|
309
329
|
post?: never;
|
|
@@ -320,7 +340,11 @@ export interface paths {
|
|
|
320
340
|
path?: never;
|
|
321
341
|
cookie?: never;
|
|
322
342
|
};
|
|
323
|
-
/**
|
|
343
|
+
/**
|
|
344
|
+
* @description Get app by ID
|
|
345
|
+
*
|
|
346
|
+
* Required scope: integrations:read
|
|
347
|
+
*/
|
|
324
348
|
get: operations["getApp"];
|
|
325
349
|
put?: never;
|
|
326
350
|
post?: never;
|
|
@@ -337,7 +361,11 @@ export interface paths {
|
|
|
337
361
|
path?: never;
|
|
338
362
|
cookie?: never;
|
|
339
363
|
};
|
|
340
|
-
/**
|
|
364
|
+
/**
|
|
365
|
+
* @description List audit actions with optional filters. Use entityId/entityType to find rows related to a specific entity.
|
|
366
|
+
*
|
|
367
|
+
* Required scope: audit:read
|
|
368
|
+
*/
|
|
341
369
|
get: operations["getAuditActions"];
|
|
342
370
|
put?: never;
|
|
343
371
|
post?: never;
|
|
@@ -354,7 +382,11 @@ export interface paths {
|
|
|
354
382
|
path?: never;
|
|
355
383
|
cookie?: never;
|
|
356
384
|
};
|
|
357
|
-
/**
|
|
385
|
+
/**
|
|
386
|
+
* @description Retrieve an audit action and aggregated effect counts.
|
|
387
|
+
*
|
|
388
|
+
* Required scope: audit:read
|
|
389
|
+
*/
|
|
358
390
|
get: operations["getAuditActionsById"];
|
|
359
391
|
put?: never;
|
|
360
392
|
post?: never;
|
|
@@ -371,7 +403,11 @@ export interface paths {
|
|
|
371
403
|
path?: never;
|
|
372
404
|
cookie?: never;
|
|
373
405
|
};
|
|
374
|
-
/**
|
|
406
|
+
/**
|
|
407
|
+
* @description List audit effects with optional filters by action/entity/status/type.
|
|
408
|
+
*
|
|
409
|
+
* Required scope: audit:read
|
|
410
|
+
*/
|
|
375
411
|
get: operations["getAuditEffects"];
|
|
376
412
|
put?: never;
|
|
377
413
|
post?: never;
|
|
@@ -388,7 +424,11 @@ export interface paths {
|
|
|
388
424
|
path?: never;
|
|
389
425
|
cookie?: never;
|
|
390
426
|
};
|
|
391
|
-
/**
|
|
427
|
+
/**
|
|
428
|
+
* @description List journal delta audit rows with optional filters for action/effect/mutation/journal entry.
|
|
429
|
+
*
|
|
430
|
+
* Required scope: audit:read
|
|
431
|
+
*/
|
|
392
432
|
get: operations["getAuditJournalDeltas"];
|
|
393
433
|
put?: never;
|
|
394
434
|
post?: never;
|
|
@@ -405,7 +445,11 @@ export interface paths {
|
|
|
405
445
|
path?: never;
|
|
406
446
|
cookie?: never;
|
|
407
447
|
};
|
|
408
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* @description List mutation audit rows with filters for action/effect/entity/op/outcome and date range.
|
|
450
|
+
*
|
|
451
|
+
* Required scope: audit:read
|
|
452
|
+
*/
|
|
409
453
|
get: operations["getAuditMutations"];
|
|
410
454
|
put?: never;
|
|
411
455
|
post?: never;
|
|
@@ -422,7 +466,11 @@ export interface paths {
|
|
|
422
466
|
path?: never;
|
|
423
467
|
cookie?: never;
|
|
424
468
|
};
|
|
425
|
-
/**
|
|
469
|
+
/**
|
|
470
|
+
* @description List a unified audit timeline for a root entity across actions/effects/attempts/mutations/journal deltas.
|
|
471
|
+
*
|
|
472
|
+
* Required scope: audit:read
|
|
473
|
+
*/
|
|
426
474
|
get: operations["getAuditTimeline"];
|
|
427
475
|
put?: never;
|
|
428
476
|
post?: never;
|
|
@@ -632,7 +680,11 @@ export interface paths {
|
|
|
632
680
|
path?: never;
|
|
633
681
|
cookie?: never;
|
|
634
682
|
};
|
|
635
|
-
/**
|
|
683
|
+
/**
|
|
684
|
+
* @description List booking channels available on the team
|
|
685
|
+
*
|
|
686
|
+
* Required scope: integrations:read
|
|
687
|
+
*/
|
|
636
688
|
get: operations["getBookingChannels"];
|
|
637
689
|
put?: never;
|
|
638
690
|
post?: never;
|
|
@@ -649,12 +701,24 @@ export interface paths {
|
|
|
649
701
|
path?: never;
|
|
650
702
|
cookie?: never;
|
|
651
703
|
};
|
|
652
|
-
/**
|
|
704
|
+
/**
|
|
705
|
+
* @description Retrieve calendar blocks from a listing
|
|
706
|
+
*
|
|
707
|
+
* Required scope: calendar:read
|
|
708
|
+
*/
|
|
653
709
|
get: operations["getCalendar"];
|
|
654
710
|
put?: never;
|
|
655
|
-
/**
|
|
711
|
+
/**
|
|
712
|
+
* @description Block calendar for a listing
|
|
713
|
+
*
|
|
714
|
+
* Required scope: calendar:write
|
|
715
|
+
*/
|
|
656
716
|
post: operations["blockCalendar"];
|
|
657
|
-
/**
|
|
717
|
+
/**
|
|
718
|
+
* @description Unblock calendar for a listing
|
|
719
|
+
*
|
|
720
|
+
* Required scope: calendar:delete
|
|
721
|
+
*/
|
|
658
722
|
delete: operations["unblockCalendar"];
|
|
659
723
|
options?: never;
|
|
660
724
|
head?: never;
|
|
@@ -668,10 +732,18 @@ export interface paths {
|
|
|
668
732
|
path?: never;
|
|
669
733
|
cookie?: never;
|
|
670
734
|
};
|
|
671
|
-
/**
|
|
735
|
+
/**
|
|
736
|
+
* @description List connections
|
|
737
|
+
*
|
|
738
|
+
* Required scope: integrations:read
|
|
739
|
+
*/
|
|
672
740
|
get: operations["getConnections"];
|
|
673
741
|
put?: never;
|
|
674
|
-
/**
|
|
742
|
+
/**
|
|
743
|
+
* @description Create a new connection
|
|
744
|
+
*
|
|
745
|
+
* Required scope: integrations:write
|
|
746
|
+
*/
|
|
675
747
|
post: operations["createConnection"];
|
|
676
748
|
delete?: never;
|
|
677
749
|
options?: never;
|
|
@@ -688,7 +760,11 @@ export interface paths {
|
|
|
688
760
|
};
|
|
689
761
|
get?: never;
|
|
690
762
|
put?: never;
|
|
691
|
-
/**
|
|
763
|
+
/**
|
|
764
|
+
* @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.
|
|
765
|
+
*
|
|
766
|
+
* Required scope: integrations:write
|
|
767
|
+
*/
|
|
692
768
|
post: operations["connectAppConnection"];
|
|
693
769
|
delete?: never;
|
|
694
770
|
options?: never;
|
|
@@ -705,7 +781,11 @@ export interface paths {
|
|
|
705
781
|
};
|
|
706
782
|
get?: never;
|
|
707
783
|
put?: never;
|
|
708
|
-
/**
|
|
784
|
+
/**
|
|
785
|
+
* @description Trigger extract workflows for connections.
|
|
786
|
+
*
|
|
787
|
+
* Required scope: integrations:execute
|
|
788
|
+
*/
|
|
709
789
|
post: operations["extractConnections"];
|
|
710
790
|
delete?: never;
|
|
711
791
|
options?: never;
|
|
@@ -722,7 +802,11 @@ export interface paths {
|
|
|
722
802
|
};
|
|
723
803
|
get?: never;
|
|
724
804
|
put?: never;
|
|
725
|
-
/**
|
|
805
|
+
/**
|
|
806
|
+
* @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/.
|
|
807
|
+
*
|
|
808
|
+
* Required scope: integrations:write
|
|
809
|
+
*/
|
|
726
810
|
post: operations["connectConnection"];
|
|
727
811
|
delete?: never;
|
|
728
812
|
options?: never;
|
|
@@ -739,7 +823,11 @@ export interface paths {
|
|
|
739
823
|
};
|
|
740
824
|
get?: never;
|
|
741
825
|
put?: never;
|
|
742
|
-
/**
|
|
826
|
+
/**
|
|
827
|
+
* @description Apply a PMS migration cutover
|
|
828
|
+
*
|
|
829
|
+
* Required scope: integrations:write
|
|
830
|
+
*/
|
|
743
831
|
post: operations["applyPmsConnectionCutover"];
|
|
744
832
|
delete?: never;
|
|
745
833
|
options?: never;
|
|
@@ -754,7 +842,11 @@ export interface paths {
|
|
|
754
842
|
path?: never;
|
|
755
843
|
cookie?: never;
|
|
756
844
|
};
|
|
757
|
-
/**
|
|
845
|
+
/**
|
|
846
|
+
* @description Retrieve PMS migration cutover target listing refs that need mapping, suggested source listings, and the source listing pool
|
|
847
|
+
*
|
|
848
|
+
* Required scope: integrations:read
|
|
849
|
+
*/
|
|
758
850
|
get: operations["getPmsConnectionCutoverListingMappings"];
|
|
759
851
|
put?: never;
|
|
760
852
|
post?: never;
|
|
@@ -773,7 +865,11 @@ export interface paths {
|
|
|
773
865
|
};
|
|
774
866
|
get?: never;
|
|
775
867
|
put?: never;
|
|
776
|
-
/**
|
|
868
|
+
/**
|
|
869
|
+
* @description Preview a PMS migration cutover
|
|
870
|
+
*
|
|
871
|
+
* Required scope: integrations:read
|
|
872
|
+
*/
|
|
777
873
|
post: operations["previewPmsConnectionCutover"];
|
|
778
874
|
delete?: never;
|
|
779
875
|
options?: never;
|
|
@@ -788,12 +884,24 @@ export interface paths {
|
|
|
788
884
|
path?: never;
|
|
789
885
|
cookie?: never;
|
|
790
886
|
};
|
|
791
|
-
/**
|
|
887
|
+
/**
|
|
888
|
+
* @description Get connection by ID
|
|
889
|
+
*
|
|
890
|
+
* Required scope: integrations:read
|
|
891
|
+
*/
|
|
792
892
|
get: operations["getConnection"];
|
|
793
|
-
/**
|
|
893
|
+
/**
|
|
894
|
+
* @description Update connection settings.
|
|
895
|
+
*
|
|
896
|
+
* Required scope: integrations:write
|
|
897
|
+
*/
|
|
794
898
|
put: operations["updateConnection"];
|
|
795
899
|
post?: never;
|
|
796
|
-
/**
|
|
900
|
+
/**
|
|
901
|
+
* @description Delete connection By ID
|
|
902
|
+
*
|
|
903
|
+
* Required scope: integrations:delete
|
|
904
|
+
*/
|
|
797
905
|
delete: operations["deleteConnection"];
|
|
798
906
|
options?: never;
|
|
799
907
|
head?: never;
|
|
@@ -809,7 +917,11 @@ export interface paths {
|
|
|
809
917
|
};
|
|
810
918
|
get?: never;
|
|
811
919
|
put?: never;
|
|
812
|
-
/**
|
|
920
|
+
/**
|
|
921
|
+
* @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.
|
|
922
|
+
*
|
|
923
|
+
* Required scope: integrations:write
|
|
924
|
+
*/
|
|
813
925
|
post: operations["reconnectAppConnection"];
|
|
814
926
|
delete?: never;
|
|
815
927
|
options?: never;
|
|
@@ -826,7 +938,11 @@ export interface paths {
|
|
|
826
938
|
};
|
|
827
939
|
get?: never;
|
|
828
940
|
put?: never;
|
|
829
|
-
/**
|
|
941
|
+
/**
|
|
942
|
+
* @description Import a CSV file through a connection
|
|
943
|
+
*
|
|
944
|
+
* Required scope: integrations:import
|
|
945
|
+
*/
|
|
830
946
|
post: operations["csvImport"];
|
|
831
947
|
delete?: never;
|
|
832
948
|
options?: never;
|
|
@@ -843,7 +959,11 @@ export interface paths {
|
|
|
843
959
|
};
|
|
844
960
|
get?: never;
|
|
845
961
|
put?: never;
|
|
846
|
-
/**
|
|
962
|
+
/**
|
|
963
|
+
* @description Sync connection by uniqueRef and type
|
|
964
|
+
*
|
|
965
|
+
* Required scope: integrations:execute
|
|
966
|
+
*/
|
|
847
967
|
post: operations["syncConnection"];
|
|
848
968
|
delete?: never;
|
|
849
969
|
options?: never;
|
|
@@ -959,7 +1079,11 @@ export interface paths {
|
|
|
959
1079
|
};
|
|
960
1080
|
get?: never;
|
|
961
1081
|
put?: never;
|
|
962
|
-
/**
|
|
1082
|
+
/**
|
|
1083
|
+
* @description Send Owner Portal Invite to Contact By ID
|
|
1084
|
+
*
|
|
1085
|
+
* Required scope: contacts:write
|
|
1086
|
+
*/
|
|
963
1087
|
post: operations["postContactsByIdInvite"];
|
|
964
1088
|
delete?: never;
|
|
965
1089
|
options?: never;
|
|
@@ -976,7 +1100,11 @@ export interface paths {
|
|
|
976
1100
|
};
|
|
977
1101
|
get?: never;
|
|
978
1102
|
put?: never;
|
|
979
|
-
/**
|
|
1103
|
+
/**
|
|
1104
|
+
* @description Revoke Owner Portal Access for Contact By ID
|
|
1105
|
+
*
|
|
1106
|
+
* Required scope: contacts:write
|
|
1107
|
+
*/
|
|
980
1108
|
post: operations["postContactsByIdRevokeAccess"];
|
|
981
1109
|
delete?: never;
|
|
982
1110
|
options?: never;
|
|
@@ -991,10 +1119,18 @@ export interface paths {
|
|
|
991
1119
|
path?: never;
|
|
992
1120
|
cookie?: never;
|
|
993
1121
|
};
|
|
994
|
-
/**
|
|
1122
|
+
/**
|
|
1123
|
+
* @description List owner-viewer access for an owner contact
|
|
1124
|
+
*
|
|
1125
|
+
* Required scope: contacts:read
|
|
1126
|
+
*/
|
|
995
1127
|
get: operations["getContactsByIdViewers"];
|
|
996
1128
|
put?: never;
|
|
997
|
-
/**
|
|
1129
|
+
/**
|
|
1130
|
+
* @description Invite an owner viewer for an owner contact
|
|
1131
|
+
*
|
|
1132
|
+
* Required scope: contacts:write
|
|
1133
|
+
*/
|
|
998
1134
|
post: operations["postContactsByIdViewers"];
|
|
999
1135
|
delete?: never;
|
|
1000
1136
|
options?: never;
|
|
@@ -1012,7 +1148,11 @@ export interface paths {
|
|
|
1012
1148
|
get?: never;
|
|
1013
1149
|
put?: never;
|
|
1014
1150
|
post?: never;
|
|
1015
|
-
/**
|
|
1151
|
+
/**
|
|
1152
|
+
* @description Remove an owner-viewer access row from an owner contact
|
|
1153
|
+
*
|
|
1154
|
+
* Required scope: contacts:write
|
|
1155
|
+
*/
|
|
1016
1156
|
delete: operations["deleteContactsByIdViewersByUserId"];
|
|
1017
1157
|
options?: never;
|
|
1018
1158
|
head?: never;
|
|
@@ -1028,7 +1168,11 @@ export interface paths {
|
|
|
1028
1168
|
};
|
|
1029
1169
|
get?: never;
|
|
1030
1170
|
put?: never;
|
|
1031
|
-
/**
|
|
1171
|
+
/**
|
|
1172
|
+
* @description Reinvite an existing owner viewer
|
|
1173
|
+
*
|
|
1174
|
+
* Required scope: contacts:write
|
|
1175
|
+
*/
|
|
1032
1176
|
post: operations["postContactsByIdViewersByUserIdReinvite"];
|
|
1033
1177
|
delete?: never;
|
|
1034
1178
|
options?: never;
|
|
@@ -1102,10 +1246,18 @@ export interface paths {
|
|
|
1102
1246
|
path?: never;
|
|
1103
1247
|
cookie?: never;
|
|
1104
1248
|
};
|
|
1105
|
-
/**
|
|
1249
|
+
/**
|
|
1250
|
+
* @description List supported GL files for the current team.
|
|
1251
|
+
*
|
|
1252
|
+
* Required scope: files:read
|
|
1253
|
+
*/
|
|
1106
1254
|
get: operations["getFiles"];
|
|
1107
1255
|
put?: never;
|
|
1108
|
-
/**
|
|
1256
|
+
/**
|
|
1257
|
+
* @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.
|
|
1258
|
+
*
|
|
1259
|
+
* Required scope: files:write
|
|
1260
|
+
*/
|
|
1109
1261
|
post: operations["postFiles"];
|
|
1110
1262
|
delete?: never;
|
|
1111
1263
|
options?: never;
|
|
@@ -1121,10 +1273,18 @@ export interface paths {
|
|
|
1121
1273
|
cookie?: never;
|
|
1122
1274
|
};
|
|
1123
1275
|
get?: never;
|
|
1124
|
-
/**
|
|
1276
|
+
/**
|
|
1277
|
+
* @description Update GL file metadata: filename, date range, and contact.
|
|
1278
|
+
*
|
|
1279
|
+
* Required scope: files:write
|
|
1280
|
+
*/
|
|
1125
1281
|
put: operations["putFilesById"];
|
|
1126
1282
|
post?: never;
|
|
1127
|
-
/**
|
|
1283
|
+
/**
|
|
1284
|
+
* @description Delete GL file metadata and its TEAM_STORAGE object.
|
|
1285
|
+
*
|
|
1286
|
+
* Required scope: files:delete
|
|
1287
|
+
*/
|
|
1128
1288
|
delete: operations["deleteFilesById"];
|
|
1129
1289
|
options?: never;
|
|
1130
1290
|
head?: never;
|
|
@@ -1138,7 +1298,11 @@ export interface paths {
|
|
|
1138
1298
|
path?: never;
|
|
1139
1299
|
cookie?: never;
|
|
1140
1300
|
};
|
|
1141
|
-
/**
|
|
1301
|
+
/**
|
|
1302
|
+
* @description Download a supported team file. Existing non-GL team files remain readable.
|
|
1303
|
+
*
|
|
1304
|
+
* Required scope: files:read
|
|
1305
|
+
*/
|
|
1142
1306
|
get: operations["getFilesByIdDownload"];
|
|
1143
1307
|
put?: never;
|
|
1144
1308
|
post?: never;
|
|
@@ -1155,7 +1319,11 @@ export interface paths {
|
|
|
1155
1319
|
path?: never;
|
|
1156
1320
|
cookie?: never;
|
|
1157
1321
|
};
|
|
1158
|
-
/**
|
|
1322
|
+
/**
|
|
1323
|
+
* @description List flows
|
|
1324
|
+
*
|
|
1325
|
+
* Required scope: integrations:read
|
|
1326
|
+
*/
|
|
1159
1327
|
get: operations["getFlows"];
|
|
1160
1328
|
put?: never;
|
|
1161
1329
|
post?: never;
|
|
@@ -1172,7 +1340,11 @@ export interface paths {
|
|
|
1172
1340
|
path?: never;
|
|
1173
1341
|
cookie?: never;
|
|
1174
1342
|
};
|
|
1175
|
-
/**
|
|
1343
|
+
/**
|
|
1344
|
+
* @description Get flow by ID
|
|
1345
|
+
*
|
|
1346
|
+
* Required scope: integrations:read
|
|
1347
|
+
*/
|
|
1176
1348
|
get: operations["getFlow"];
|
|
1177
1349
|
put?: never;
|
|
1178
1350
|
post?: never;
|
|
@@ -1189,9 +1361,17 @@ export interface paths {
|
|
|
1189
1361
|
path?: never;
|
|
1190
1362
|
cookie?: never;
|
|
1191
1363
|
};
|
|
1192
|
-
/**
|
|
1364
|
+
/**
|
|
1365
|
+
* @description Get flow configuration for a connection
|
|
1366
|
+
*
|
|
1367
|
+
* Required scope: integrations:read
|
|
1368
|
+
*/
|
|
1193
1369
|
get: operations["getFlowConnection"];
|
|
1194
|
-
/**
|
|
1370
|
+
/**
|
|
1371
|
+
* @description Update flow status for a connection
|
|
1372
|
+
*
|
|
1373
|
+
* Required scope: integrations:write
|
|
1374
|
+
*/
|
|
1195
1375
|
put: operations["setFlowStatus"];
|
|
1196
1376
|
post?: never;
|
|
1197
1377
|
delete?: never;
|
|
@@ -1207,10 +1387,18 @@ export interface paths {
|
|
|
1207
1387
|
path?: never;
|
|
1208
1388
|
cookie?: never;
|
|
1209
1389
|
};
|
|
1210
|
-
/**
|
|
1390
|
+
/**
|
|
1391
|
+
* @description List flow mappings for a key; optionally filter by leftId (source side id)
|
|
1392
|
+
*
|
|
1393
|
+
* Required scope: integrations:read
|
|
1394
|
+
*/
|
|
1211
1395
|
get: operations["getFlowMapping"];
|
|
1212
1396
|
put?: never;
|
|
1213
|
-
/**
|
|
1397
|
+
/**
|
|
1398
|
+
* @description Create, update or delete a flow mapping entry
|
|
1399
|
+
*
|
|
1400
|
+
* Required scope: integrations:write
|
|
1401
|
+
*/
|
|
1214
1402
|
post: operations["setFlowMapping"];
|
|
1215
1403
|
delete?: never;
|
|
1216
1404
|
options?: never;
|
|
@@ -1225,7 +1413,11 @@ export interface paths {
|
|
|
1225
1413
|
path?: never;
|
|
1226
1414
|
cookie?: never;
|
|
1227
1415
|
};
|
|
1228
|
-
/**
|
|
1416
|
+
/**
|
|
1417
|
+
* @description List available source entities for a flow mapping
|
|
1418
|
+
*
|
|
1419
|
+
* Required scope: integrations:read
|
|
1420
|
+
*/
|
|
1229
1421
|
get: operations["getFlowMappingSources"];
|
|
1230
1422
|
put?: never;
|
|
1231
1423
|
post?: never;
|
|
@@ -1242,7 +1434,11 @@ export interface paths {
|
|
|
1242
1434
|
path?: never;
|
|
1243
1435
|
cookie?: never;
|
|
1244
1436
|
};
|
|
1245
|
-
/**
|
|
1437
|
+
/**
|
|
1438
|
+
* @description List available destination entities for a flow mapping
|
|
1439
|
+
*
|
|
1440
|
+
* Required scope: integrations:read
|
|
1441
|
+
*/
|
|
1246
1442
|
get: operations["getFlowMappingDestinations"];
|
|
1247
1443
|
put?: never;
|
|
1248
1444
|
post?: never;
|
|
@@ -1261,7 +1457,11 @@ export interface paths {
|
|
|
1261
1457
|
};
|
|
1262
1458
|
get?: never;
|
|
1263
1459
|
put?: never;
|
|
1264
|
-
/**
|
|
1460
|
+
/**
|
|
1461
|
+
* @description Trigger execution of a flow for a connection
|
|
1462
|
+
*
|
|
1463
|
+
* Required scope: integrations:execute
|
|
1464
|
+
*/
|
|
1265
1465
|
post: operations["runFlow"];
|
|
1266
1466
|
delete?: never;
|
|
1267
1467
|
options?: never;
|
|
@@ -1276,10 +1476,18 @@ export interface paths {
|
|
|
1276
1476
|
path?: never;
|
|
1277
1477
|
cookie?: never;
|
|
1278
1478
|
};
|
|
1279
|
-
/**
|
|
1479
|
+
/**
|
|
1480
|
+
* @description Get a flow setting entry. Returns an empty object when the setting is not set.
|
|
1481
|
+
*
|
|
1482
|
+
* Required scope: integrations:read
|
|
1483
|
+
*/
|
|
1280
1484
|
get: operations["getFlowSetting"];
|
|
1281
1485
|
put?: never;
|
|
1282
|
-
/**
|
|
1486
|
+
/**
|
|
1487
|
+
* @description Create, update or delete a flow setting entry
|
|
1488
|
+
*
|
|
1489
|
+
* Required scope: integrations:write
|
|
1490
|
+
*/
|
|
1283
1491
|
post: operations["setFlowSetting"];
|
|
1284
1492
|
delete?: never;
|
|
1285
1493
|
options?: never;
|
|
@@ -1294,7 +1502,11 @@ export interface paths {
|
|
|
1294
1502
|
path?: never;
|
|
1295
1503
|
cookie?: never;
|
|
1296
1504
|
};
|
|
1297
|
-
/**
|
|
1505
|
+
/**
|
|
1506
|
+
* @description List available options for a flow setting
|
|
1507
|
+
*
|
|
1508
|
+
* Required scope: integrations:read
|
|
1509
|
+
*/
|
|
1298
1510
|
get: operations["getFlowSettingOptions"];
|
|
1299
1511
|
put?: never;
|
|
1300
1512
|
post?: never;
|
|
@@ -1313,7 +1525,11 @@ export interface paths {
|
|
|
1313
1525
|
};
|
|
1314
1526
|
get?: never;
|
|
1315
1527
|
put?: never;
|
|
1316
|
-
/**
|
|
1528
|
+
/**
|
|
1529
|
+
* @description Import historic general-ledger journal entries on the historical ledger; re-posting the same uniqueRef replaces that import
|
|
1530
|
+
*
|
|
1531
|
+
* Required scope: general-ledger:import
|
|
1532
|
+
*/
|
|
1317
1533
|
post: operations["postGeneralLedgerHistorical"];
|
|
1318
1534
|
delete?: never;
|
|
1319
1535
|
options?: never;
|
|
@@ -1328,9 +1544,17 @@ export interface paths {
|
|
|
1328
1544
|
path?: never;
|
|
1329
1545
|
cookie?: never;
|
|
1330
1546
|
};
|
|
1331
|
-
/**
|
|
1547
|
+
/**
|
|
1548
|
+
* @description Retrieve opening balance accounts payable summary by party
|
|
1549
|
+
*
|
|
1550
|
+
* Required scope: general-ledger:read
|
|
1551
|
+
*/
|
|
1332
1552
|
get: operations["getGeneralLedgerOpeningBalancesAccountsPayable"];
|
|
1333
|
-
/**
|
|
1553
|
+
/**
|
|
1554
|
+
* @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.
|
|
1555
|
+
*
|
|
1556
|
+
* Required scope: general-ledger:write
|
|
1557
|
+
*/
|
|
1334
1558
|
put: operations["putGeneralLedgerOpeningBalancesAccountsPayable"];
|
|
1335
1559
|
post?: never;
|
|
1336
1560
|
delete?: never;
|
|
@@ -1346,9 +1570,17 @@ export interface paths {
|
|
|
1346
1570
|
path?: never;
|
|
1347
1571
|
cookie?: never;
|
|
1348
1572
|
};
|
|
1349
|
-
/**
|
|
1573
|
+
/**
|
|
1574
|
+
* @description Retrieve opening balance accounts receivable / deferred revenue summary
|
|
1575
|
+
*
|
|
1576
|
+
* Required scope: general-ledger:read
|
|
1577
|
+
*/
|
|
1350
1578
|
get: operations["getGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
|
|
1351
|
-
/**
|
|
1579
|
+
/**
|
|
1580
|
+
* @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.
|
|
1581
|
+
*
|
|
1582
|
+
* Required scope: general-ledger:write
|
|
1583
|
+
*/
|
|
1352
1584
|
put: operations["putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
|
|
1353
1585
|
post?: never;
|
|
1354
1586
|
delete?: never;
|
|
@@ -1364,9 +1596,17 @@ export interface paths {
|
|
|
1364
1596
|
path?: never;
|
|
1365
1597
|
cookie?: never;
|
|
1366
1598
|
};
|
|
1367
|
-
/**
|
|
1599
|
+
/**
|
|
1600
|
+
* @description Retrieve opening balance advanced deposits summary
|
|
1601
|
+
*
|
|
1602
|
+
* Required scope: general-ledger:read
|
|
1603
|
+
*/
|
|
1368
1604
|
get: operations["getGeneralLedgerOpeningBalancesAdvancedDeposits"];
|
|
1369
|
-
/**
|
|
1605
|
+
/**
|
|
1606
|
+
* @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.
|
|
1607
|
+
*
|
|
1608
|
+
* Required scope: general-ledger:write
|
|
1609
|
+
*/
|
|
1370
1610
|
put: operations["putGeneralLedgerOpeningBalancesAdvancedDeposits"];
|
|
1371
1611
|
post?: never;
|
|
1372
1612
|
delete?: never;
|
|
@@ -1382,7 +1622,11 @@ export interface paths {
|
|
|
1382
1622
|
path?: never;
|
|
1383
1623
|
cookie?: never;
|
|
1384
1624
|
};
|
|
1385
|
-
/**
|
|
1625
|
+
/**
|
|
1626
|
+
* @description Retrieve synced payments and refunds that are candidates for advanced deposit opening balances
|
|
1627
|
+
*
|
|
1628
|
+
* Required scope: general-ledger:read
|
|
1629
|
+
*/
|
|
1386
1630
|
get: operations["getGeneralLedgerOpeningBalancesAdvancedDepositsSyncedPaymentsRefunds"];
|
|
1387
1631
|
put?: never;
|
|
1388
1632
|
post?: never;
|
|
@@ -1399,9 +1643,17 @@ export interface paths {
|
|
|
1399
1643
|
path?: never;
|
|
1400
1644
|
cookie?: never;
|
|
1401
1645
|
};
|
|
1402
|
-
/**
|
|
1646
|
+
/**
|
|
1647
|
+
* @description Retrieve opening balance tax payable summary
|
|
1648
|
+
*
|
|
1649
|
+
* Required scope: general-ledger:read
|
|
1650
|
+
*/
|
|
1403
1651
|
get: operations["getGeneralLedgerOpeningBalancesTaxPayable"];
|
|
1404
|
-
/**
|
|
1652
|
+
/**
|
|
1653
|
+
* @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.
|
|
1654
|
+
*
|
|
1655
|
+
* Required scope: general-ledger:write
|
|
1656
|
+
*/
|
|
1405
1657
|
put: operations["putGeneralLedgerOpeningBalancesTaxPayable"];
|
|
1406
1658
|
post?: never;
|
|
1407
1659
|
delete?: never;
|
|
@@ -1417,9 +1669,17 @@ export interface paths {
|
|
|
1417
1669
|
path?: never;
|
|
1418
1670
|
cookie?: never;
|
|
1419
1671
|
};
|
|
1420
|
-
/**
|
|
1672
|
+
/**
|
|
1673
|
+
* @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.
|
|
1674
|
+
*
|
|
1675
|
+
* Required scope: general-ledger:read
|
|
1676
|
+
*/
|
|
1421
1677
|
get: operations["getGeneralLedgerOpeningTrialBalance"];
|
|
1422
|
-
/**
|
|
1678
|
+
/**
|
|
1679
|
+
* @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.
|
|
1680
|
+
*
|
|
1681
|
+
* Required scope: general-ledger:write
|
|
1682
|
+
*/
|
|
1423
1683
|
put: operations["putGeneralLedgerOpeningTrialBalance"];
|
|
1424
1684
|
post?: never;
|
|
1425
1685
|
delete?: never;
|
|
@@ -2024,7 +2284,11 @@ export interface paths {
|
|
|
2024
2284
|
path?: never;
|
|
2025
2285
|
cookie?: never;
|
|
2026
2286
|
};
|
|
2027
|
-
/**
|
|
2287
|
+
/**
|
|
2288
|
+
* @description Get opening balances for listings
|
|
2289
|
+
*
|
|
2290
|
+
* Required scope: general-ledger:read
|
|
2291
|
+
*/
|
|
2028
2292
|
get: operations["getListingsOpeningBalances"];
|
|
2029
2293
|
put?: never;
|
|
2030
2294
|
post?: never;
|
|
@@ -2041,7 +2305,11 @@ export interface paths {
|
|
|
2041
2305
|
path?: never;
|
|
2042
2306
|
cookie?: never;
|
|
2043
2307
|
};
|
|
2044
|
-
/**
|
|
2308
|
+
/**
|
|
2309
|
+
* @description Listing opening balance CSV import template
|
|
2310
|
+
*
|
|
2311
|
+
* Required scope: general-ledger:read
|
|
2312
|
+
*/
|
|
2045
2313
|
get: operations["getListingsOpeningBalancesCsvTemplate"];
|
|
2046
2314
|
put?: never;
|
|
2047
2315
|
post?: never;
|
|
@@ -2146,9 +2414,17 @@ export interface paths {
|
|
|
2146
2414
|
path?: never;
|
|
2147
2415
|
cookie?: never;
|
|
2148
2416
|
};
|
|
2149
|
-
/**
|
|
2417
|
+
/**
|
|
2418
|
+
* @description Get opening balance for listing
|
|
2419
|
+
*
|
|
2420
|
+
* Required scope: general-ledger:read
|
|
2421
|
+
*/
|
|
2150
2422
|
get: operations["getListingsByIdOpeningBalance"];
|
|
2151
|
-
/**
|
|
2423
|
+
/**
|
|
2424
|
+
* @description Update opening balance for listing
|
|
2425
|
+
*
|
|
2426
|
+
* Required scope: general-ledger:write
|
|
2427
|
+
*/
|
|
2152
2428
|
put: operations["putListingsByIdOpeningBalance"];
|
|
2153
2429
|
post?: never;
|
|
2154
2430
|
delete?: never;
|
|
@@ -2165,10 +2441,18 @@ export interface paths {
|
|
|
2165
2441
|
cookie?: never;
|
|
2166
2442
|
};
|
|
2167
2443
|
get?: never;
|
|
2168
|
-
/**
|
|
2444
|
+
/**
|
|
2445
|
+
* @description Set Listing Parent
|
|
2446
|
+
*
|
|
2447
|
+
* Required scope: listings:write
|
|
2448
|
+
*/
|
|
2169
2449
|
put: operations["putListingsByIdParent"];
|
|
2170
2450
|
post?: never;
|
|
2171
|
-
/**
|
|
2451
|
+
/**
|
|
2452
|
+
* @description Remove Listing Parent
|
|
2453
|
+
*
|
|
2454
|
+
* Required scope: listings:write
|
|
2455
|
+
*/
|
|
2172
2456
|
delete: operations["deleteListingsByIdParent"];
|
|
2173
2457
|
options?: never;
|
|
2174
2458
|
head?: never;
|
|
@@ -2967,7 +3251,11 @@ export interface paths {
|
|
|
2967
3251
|
};
|
|
2968
3252
|
get?: never;
|
|
2969
3253
|
put?: never;
|
|
2970
|
-
/**
|
|
3254
|
+
/**
|
|
3255
|
+
* @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.
|
|
3256
|
+
*
|
|
3257
|
+
* Required scope: bank-connections:manage
|
|
3258
|
+
*/
|
|
2971
3259
|
post: operations["configurePlaidConnectSession"];
|
|
2972
3260
|
delete?: never;
|
|
2973
3261
|
options?: never;
|
|
@@ -3003,10 +3291,18 @@ export interface paths {
|
|
|
3003
3291
|
path?: never;
|
|
3004
3292
|
cookie?: never;
|
|
3005
3293
|
};
|
|
3006
|
-
/**
|
|
3294
|
+
/**
|
|
3295
|
+
* @description Recurring Fees
|
|
3296
|
+
*
|
|
3297
|
+
* Required scope: recurring-fees:read
|
|
3298
|
+
*/
|
|
3007
3299
|
get: operations["getRecurringFees"];
|
|
3008
3300
|
put?: never;
|
|
3009
|
-
/**
|
|
3301
|
+
/**
|
|
3302
|
+
* @description Create Recurring Fees
|
|
3303
|
+
*
|
|
3304
|
+
* Required scope: recurring-fees:write
|
|
3305
|
+
*/
|
|
3010
3306
|
post: operations["postRecurringFees"];
|
|
3011
3307
|
delete?: never;
|
|
3012
3308
|
options?: never;
|
|
@@ -3021,10 +3317,18 @@ export interface paths {
|
|
|
3021
3317
|
path?: never;
|
|
3022
3318
|
cookie?: never;
|
|
3023
3319
|
};
|
|
3024
|
-
/**
|
|
3320
|
+
/**
|
|
3321
|
+
* @description List recurring fee listing periods
|
|
3322
|
+
*
|
|
3323
|
+
* Required scope: recurring-fees:read
|
|
3324
|
+
*/
|
|
3025
3325
|
get: operations["getRecurringFeesListingPeriods"];
|
|
3026
3326
|
put?: never;
|
|
3027
|
-
/**
|
|
3327
|
+
/**
|
|
3328
|
+
* @description Add listing period to a recurring fee
|
|
3329
|
+
*
|
|
3330
|
+
* Required scope: recurring-fees:write
|
|
3331
|
+
*/
|
|
3028
3332
|
post: operations["postRecurringFeesListingPeriods"];
|
|
3029
3333
|
delete?: never;
|
|
3030
3334
|
options?: never;
|
|
@@ -3040,10 +3344,18 @@ export interface paths {
|
|
|
3040
3344
|
cookie?: never;
|
|
3041
3345
|
};
|
|
3042
3346
|
get?: never;
|
|
3043
|
-
/**
|
|
3347
|
+
/**
|
|
3348
|
+
* @description Update a listing period
|
|
3349
|
+
*
|
|
3350
|
+
* Required scope: recurring-fees:write
|
|
3351
|
+
*/
|
|
3044
3352
|
put: operations["putRecurringFeesListingPeriodsById"];
|
|
3045
3353
|
post?: never;
|
|
3046
|
-
/**
|
|
3354
|
+
/**
|
|
3355
|
+
* @description Delete listing period from a recurring fee
|
|
3356
|
+
*
|
|
3357
|
+
* Required scope: recurring-fees:delete
|
|
3358
|
+
*/
|
|
3047
3359
|
delete: operations["deleteRecurringFeesListingPeriodsById"];
|
|
3048
3360
|
options?: never;
|
|
3049
3361
|
head?: never;
|
|
@@ -3059,7 +3371,11 @@ export interface paths {
|
|
|
3059
3371
|
};
|
|
3060
3372
|
get?: never;
|
|
3061
3373
|
put?: never;
|
|
3062
|
-
/**
|
|
3374
|
+
/**
|
|
3375
|
+
* @description Preview Recurring Fees changes on a reservation
|
|
3376
|
+
*
|
|
3377
|
+
* Required scope: recurring-fees:read
|
|
3378
|
+
*/
|
|
3063
3379
|
post: operations["postRecurringFeesPreview"];
|
|
3064
3380
|
delete?: never;
|
|
3065
3381
|
options?: never;
|
|
@@ -3074,12 +3390,24 @@ export interface paths {
|
|
|
3074
3390
|
path?: never;
|
|
3075
3391
|
cookie?: never;
|
|
3076
3392
|
};
|
|
3077
|
-
/**
|
|
3393
|
+
/**
|
|
3394
|
+
* @description Get recurring fee by ID
|
|
3395
|
+
*
|
|
3396
|
+
* Required scope: recurring-fees:read
|
|
3397
|
+
*/
|
|
3078
3398
|
get: operations["getRecurringFeesById"];
|
|
3079
|
-
/**
|
|
3399
|
+
/**
|
|
3400
|
+
* @description Update Recurring Fees
|
|
3401
|
+
*
|
|
3402
|
+
* Required scope: recurring-fees:write
|
|
3403
|
+
*/
|
|
3080
3404
|
put: operations["putRecurringFeesById"];
|
|
3081
3405
|
post?: never;
|
|
3082
|
-
/**
|
|
3406
|
+
/**
|
|
3407
|
+
* @description Delete Recurring Fee By Id
|
|
3408
|
+
*
|
|
3409
|
+
* Required scope: recurring-fees:delete
|
|
3410
|
+
*/
|
|
3083
3411
|
delete: operations["deleteRecurringFeesById"];
|
|
3084
3412
|
options?: never;
|
|
3085
3413
|
head?: never;
|
|
@@ -3880,7 +4208,11 @@ export interface paths {
|
|
|
3880
4208
|
path?: never;
|
|
3881
4209
|
cookie?: never;
|
|
3882
4210
|
};
|
|
3883
|
-
/**
|
|
4211
|
+
/**
|
|
4212
|
+
* @description Reservation line mappings CSV export
|
|
4213
|
+
*
|
|
4214
|
+
* Required scope: reservation-mappings:read
|
|
4215
|
+
*/
|
|
3884
4216
|
get: operations["getReservationsLineMappingsCsv"];
|
|
3885
4217
|
put?: never;
|
|
3886
4218
|
post?: never;
|
|
@@ -3972,7 +4304,11 @@ export interface paths {
|
|
|
3972
4304
|
};
|
|
3973
4305
|
get?: never;
|
|
3974
4306
|
put?: never;
|
|
3975
|
-
/**
|
|
4307
|
+
/**
|
|
4308
|
+
* @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.
|
|
4309
|
+
*
|
|
4310
|
+
* Required scope: reservations:write
|
|
4311
|
+
*/
|
|
3976
4312
|
post: operations["postReservationsByReservationIdAdjustments"];
|
|
3977
4313
|
delete?: never;
|
|
3978
4314
|
options?: never;
|
|
@@ -3988,10 +4324,18 @@ export interface paths {
|
|
|
3988
4324
|
cookie?: never;
|
|
3989
4325
|
};
|
|
3990
4326
|
get?: never;
|
|
3991
|
-
/**
|
|
4327
|
+
/**
|
|
4328
|
+
* @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.
|
|
4329
|
+
*
|
|
4330
|
+
* Required scope: reservations:write
|
|
4331
|
+
*/
|
|
3992
4332
|
put: operations["putReservationsByReservationIdAdjustmentsById"];
|
|
3993
4333
|
post?: never;
|
|
3994
|
-
/**
|
|
4334
|
+
/**
|
|
4335
|
+
* @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.
|
|
4336
|
+
*
|
|
4337
|
+
* Required scope: reservations:delete
|
|
4338
|
+
*/
|
|
3995
4339
|
delete: operations["deleteReservationsByReservationIdAdjustmentsById"];
|
|
3996
4340
|
options?: never;
|
|
3997
4341
|
head?: never;
|
|
@@ -4005,7 +4349,11 @@ export interface paths {
|
|
|
4005
4349
|
path?: never;
|
|
4006
4350
|
cookie?: never;
|
|
4007
4351
|
};
|
|
4008
|
-
/**
|
|
4352
|
+
/**
|
|
4353
|
+
* @description Download source JSON or the original imported source file for an entity.
|
|
4354
|
+
*
|
|
4355
|
+
* Required scope: sources:read
|
|
4356
|
+
*/
|
|
4009
4357
|
get: operations["downloadSource"];
|
|
4010
4358
|
put?: never;
|
|
4011
4359
|
post?: never;
|
|
@@ -4134,7 +4482,11 @@ export interface paths {
|
|
|
4134
4482
|
};
|
|
4135
4483
|
get?: never;
|
|
4136
4484
|
put?: never;
|
|
4137
|
-
/**
|
|
4485
|
+
/**
|
|
4486
|
+
* @description Import a historic owner statement with journal entries on the historical ledger; re-posting the same uniqueRef replaces the previous import
|
|
4487
|
+
*
|
|
4488
|
+
* Required scope: general-ledger:import
|
|
4489
|
+
*/
|
|
4138
4490
|
post: operations["postStatementsHistorical"];
|
|
4139
4491
|
delete?: never;
|
|
4140
4492
|
options?: never;
|
|
@@ -4156,7 +4508,11 @@ export interface paths {
|
|
|
4156
4508
|
*/
|
|
4157
4509
|
get: operations["getStatementsLayouts"];
|
|
4158
4510
|
put?: never;
|
|
4159
|
-
/**
|
|
4511
|
+
/**
|
|
4512
|
+
* @description Create Statement Layout
|
|
4513
|
+
*
|
|
4514
|
+
* Required scope: statement-layouts:write
|
|
4515
|
+
*/
|
|
4160
4516
|
post: operations["postStatementsLayouts"];
|
|
4161
4517
|
delete?: never;
|
|
4162
4518
|
options?: never;
|
|
@@ -4193,7 +4549,11 @@ export interface paths {
|
|
|
4193
4549
|
cookie?: never;
|
|
4194
4550
|
};
|
|
4195
4551
|
get?: never;
|
|
4196
|
-
/**
|
|
4552
|
+
/**
|
|
4553
|
+
* @description Update statement layout listing mapping
|
|
4554
|
+
*
|
|
4555
|
+
* Required scope: statement-layouts:write
|
|
4556
|
+
*/
|
|
4197
4557
|
put: operations["putStatementsLayoutsListingMappingsByListingId"];
|
|
4198
4558
|
post?: never;
|
|
4199
4559
|
delete?: never;
|
|
@@ -4215,10 +4575,18 @@ export interface paths {
|
|
|
4215
4575
|
* Required scope: statement-layouts:read
|
|
4216
4576
|
*/
|
|
4217
4577
|
get: operations["getStatementsLayoutsById"];
|
|
4218
|
-
/**
|
|
4578
|
+
/**
|
|
4579
|
+
* @description Update Statement Layout
|
|
4580
|
+
*
|
|
4581
|
+
* Required scope: statement-layouts:write
|
|
4582
|
+
*/
|
|
4219
4583
|
put: operations["putStatementsLayoutsById"];
|
|
4220
4584
|
post?: never;
|
|
4221
|
-
/**
|
|
4585
|
+
/**
|
|
4586
|
+
* @description Delete statement layout by ID
|
|
4587
|
+
*
|
|
4588
|
+
* Required scope: statement-layouts:delete
|
|
4589
|
+
*/
|
|
4222
4590
|
delete: operations["deleteStatementsLayoutsById"];
|
|
4223
4591
|
options?: never;
|
|
4224
4592
|
head?: never;
|
|
@@ -4233,7 +4601,11 @@ export interface paths {
|
|
|
4233
4601
|
cookie?: never;
|
|
4234
4602
|
};
|
|
4235
4603
|
get?: never;
|
|
4236
|
-
/**
|
|
4604
|
+
/**
|
|
4605
|
+
* @description Update an owner statement line description
|
|
4606
|
+
*
|
|
4607
|
+
* Required scope: statements:write
|
|
4608
|
+
*/
|
|
4237
4609
|
put: operations["putStatementsLinesByLineIdDescription"];
|
|
4238
4610
|
post?: never;
|
|
4239
4611
|
delete?: never;
|
|
@@ -4251,7 +4623,11 @@ export interface paths {
|
|
|
4251
4623
|
};
|
|
4252
4624
|
get?: never;
|
|
4253
4625
|
put?: never;
|
|
4254
|
-
/**
|
|
4626
|
+
/**
|
|
4627
|
+
* @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.
|
|
4628
|
+
*
|
|
4629
|
+
* Required scope: statements:pay
|
|
4630
|
+
*/
|
|
4255
4631
|
post: operations["postStatementsManagerPay"];
|
|
4256
4632
|
delete?: never;
|
|
4257
4633
|
options?: never;
|
|
@@ -4383,7 +4759,11 @@ export interface paths {
|
|
|
4383
4759
|
};
|
|
4384
4760
|
get?: never;
|
|
4385
4761
|
put?: never;
|
|
4386
|
-
/**
|
|
4762
|
+
/**
|
|
4763
|
+
* @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.
|
|
4764
|
+
*
|
|
4765
|
+
* Required scope: statements:write
|
|
4766
|
+
*/
|
|
4387
4767
|
post: operations["postStatementsByIdRefreshLayout"];
|
|
4388
4768
|
delete?: never;
|
|
4389
4769
|
options?: never;
|
|
@@ -4398,10 +4778,18 @@ export interface paths {
|
|
|
4398
4778
|
path?: never;
|
|
4399
4779
|
cookie?: never;
|
|
4400
4780
|
};
|
|
4401
|
-
/**
|
|
4781
|
+
/**
|
|
4782
|
+
* @description Get syncs
|
|
4783
|
+
*
|
|
4784
|
+
* Required scope: integrations:read
|
|
4785
|
+
*/
|
|
4402
4786
|
get: operations["getSyncs"];
|
|
4403
4787
|
put?: never;
|
|
4404
|
-
/**
|
|
4788
|
+
/**
|
|
4789
|
+
* @description Create a sync
|
|
4790
|
+
*
|
|
4791
|
+
* Required scope: integrations:execute
|
|
4792
|
+
*/
|
|
4405
4793
|
post: operations["createSync"];
|
|
4406
4794
|
delete?: never;
|
|
4407
4795
|
options?: never;
|
|
@@ -4418,7 +4806,11 @@ export interface paths {
|
|
|
4418
4806
|
};
|
|
4419
4807
|
get?: never;
|
|
4420
4808
|
put?: never;
|
|
4421
|
-
/**
|
|
4809
|
+
/**
|
|
4810
|
+
* @description Resolve canonical entity ID by source identity
|
|
4811
|
+
*
|
|
4812
|
+
* Required scope: integrations:read
|
|
4813
|
+
*/
|
|
4422
4814
|
post: operations["resolveSyncEntity"];
|
|
4423
4815
|
delete?: never;
|
|
4424
4816
|
options?: never;
|
|
@@ -4435,7 +4827,11 @@ export interface paths {
|
|
|
4435
4827
|
};
|
|
4436
4828
|
get?: never;
|
|
4437
4829
|
put?: never;
|
|
4438
|
-
/**
|
|
4830
|
+
/**
|
|
4831
|
+
* @description Create a sync subtask
|
|
4832
|
+
*
|
|
4833
|
+
* Required scope: integrations:execute
|
|
4834
|
+
*/
|
|
4439
4835
|
post: operations["createSyncSubtask"];
|
|
4440
4836
|
delete?: never;
|
|
4441
4837
|
options?: never;
|
|
@@ -4451,7 +4847,11 @@ export interface paths {
|
|
|
4451
4847
|
cookie?: never;
|
|
4452
4848
|
};
|
|
4453
4849
|
get?: never;
|
|
4454
|
-
/**
|
|
4850
|
+
/**
|
|
4851
|
+
* @description Update subtask by ID
|
|
4852
|
+
*
|
|
4853
|
+
* Required scope: integrations:execute
|
|
4854
|
+
*/
|
|
4455
4855
|
put: operations["updateSyncSubtask"];
|
|
4456
4856
|
post?: never;
|
|
4457
4857
|
delete?: never;
|
|
@@ -4467,9 +4867,17 @@ export interface paths {
|
|
|
4467
4867
|
path?: never;
|
|
4468
4868
|
cookie?: never;
|
|
4469
4869
|
};
|
|
4470
|
-
/**
|
|
4870
|
+
/**
|
|
4871
|
+
* @description Get sync by ID
|
|
4872
|
+
*
|
|
4873
|
+
* Required scope: integrations:read
|
|
4874
|
+
*/
|
|
4471
4875
|
get: operations["getSync"];
|
|
4472
|
-
/**
|
|
4876
|
+
/**
|
|
4877
|
+
* @description Update sync by ID
|
|
4878
|
+
*
|
|
4879
|
+
* Required scope: integrations:execute
|
|
4880
|
+
*/
|
|
4473
4881
|
put: operations["updateSync"];
|
|
4474
4882
|
post?: never;
|
|
4475
4883
|
delete?: never;
|
|
@@ -4487,7 +4895,11 @@ export interface paths {
|
|
|
4487
4895
|
};
|
|
4488
4896
|
get?: never;
|
|
4489
4897
|
put?: never;
|
|
4490
|
-
/**
|
|
4898
|
+
/**
|
|
4899
|
+
* @description Cancel sync by ID
|
|
4900
|
+
*
|
|
4901
|
+
* Required scope: integrations:execute
|
|
4902
|
+
*/
|
|
4491
4903
|
post: operations["cancelSync"];
|
|
4492
4904
|
delete?: never;
|
|
4493
4905
|
options?: never;
|
|
@@ -4502,7 +4914,11 @@ export interface paths {
|
|
|
4502
4914
|
path?: never;
|
|
4503
4915
|
cookie?: never;
|
|
4504
4916
|
};
|
|
4505
|
-
/**
|
|
4917
|
+
/**
|
|
4918
|
+
* @description Get sync changes
|
|
4919
|
+
*
|
|
4920
|
+
* Required scope: integrations:read
|
|
4921
|
+
*/
|
|
4506
4922
|
get: operations["getSyncChanges"];
|
|
4507
4923
|
put?: never;
|
|
4508
4924
|
post?: never;
|
|
@@ -4589,11 +5005,7 @@ export interface paths {
|
|
|
4589
5005
|
*/
|
|
4590
5006
|
put: operations["putTeam"];
|
|
4591
5007
|
post?: never;
|
|
4592
|
-
/**
|
|
4593
|
-
* @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.
|
|
4594
|
-
*
|
|
4595
|
-
* Required scope: teams:delete
|
|
4596
|
-
*/
|
|
5008
|
+
/** @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. */
|
|
4597
5009
|
delete: operations["deleteTeam"];
|
|
4598
5010
|
options?: never;
|
|
4599
5011
|
head?: never;
|
|
@@ -4692,7 +5104,11 @@ export interface paths {
|
|
|
4692
5104
|
path?: never;
|
|
4693
5105
|
cookie?: never;
|
|
4694
5106
|
};
|
|
4695
|
-
/**
|
|
5107
|
+
/**
|
|
5108
|
+
* @description List property-managers for the current team
|
|
5109
|
+
*
|
|
5110
|
+
* Required scope: team-members:read
|
|
5111
|
+
*/
|
|
4696
5112
|
get: operations["getTeamMembers"];
|
|
4697
5113
|
put?: never;
|
|
4698
5114
|
post?: never;
|
|
@@ -4711,7 +5127,11 @@ export interface paths {
|
|
|
4711
5127
|
};
|
|
4712
5128
|
get?: never;
|
|
4713
5129
|
put?: never;
|
|
4714
|
-
/**
|
|
5130
|
+
/**
|
|
5131
|
+
* @description Invite a property-manager member to the current team. Emails already used by owner accounts are rejected as bad requests.
|
|
5132
|
+
*
|
|
5133
|
+
* Required scope: team-members:manage
|
|
5134
|
+
*/
|
|
4715
5135
|
post: operations["postTeamMembersInvite"];
|
|
4716
5136
|
delete?: never;
|
|
4717
5137
|
options?: never;
|
|
@@ -4727,10 +5147,18 @@ export interface paths {
|
|
|
4727
5147
|
cookie?: never;
|
|
4728
5148
|
};
|
|
4729
5149
|
get?: never;
|
|
4730
|
-
/**
|
|
5150
|
+
/**
|
|
5151
|
+
* @description Update a property-manager member role for the current team
|
|
5152
|
+
*
|
|
5153
|
+
* Required scope: team-members:manage
|
|
5154
|
+
*/
|
|
4731
5155
|
put: operations["putTeamMembersByUserId"];
|
|
4732
5156
|
post?: never;
|
|
4733
|
-
/**
|
|
5157
|
+
/**
|
|
5158
|
+
* @description Remove a member from the current team
|
|
5159
|
+
*
|
|
5160
|
+
* Required scope: team-members:manage
|
|
5161
|
+
*/
|
|
4734
5162
|
delete: operations["deleteTeamMembersByUserId"];
|
|
4735
5163
|
options?: never;
|
|
4736
5164
|
head?: never;
|
|
@@ -4887,7 +5315,11 @@ export interface paths {
|
|
|
4887
5315
|
};
|
|
4888
5316
|
get?: never;
|
|
4889
5317
|
put?: never;
|
|
4890
|
-
/**
|
|
5318
|
+
/**
|
|
5319
|
+
* @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.
|
|
5320
|
+
*
|
|
5321
|
+
* Required scope: transactions:write
|
|
5322
|
+
*/
|
|
4891
5323
|
post: operations["postTransactionsAttachments"];
|
|
4892
5324
|
delete?: never;
|
|
4893
5325
|
options?: never;
|
|
@@ -4903,10 +5335,18 @@ export interface paths {
|
|
|
4903
5335
|
cookie?: never;
|
|
4904
5336
|
};
|
|
4905
5337
|
get?: never;
|
|
4906
|
-
/**
|
|
5338
|
+
/**
|
|
5339
|
+
* @description Update attachment visibility. isOwnerAccessible controls whether owners can see the file on owner statement details.
|
|
5340
|
+
*
|
|
5341
|
+
* Required scope: transactions:write
|
|
5342
|
+
*/
|
|
4907
5343
|
put: operations["putTransactionsAttachmentsById"];
|
|
4908
5344
|
post?: never;
|
|
4909
|
-
/**
|
|
5345
|
+
/**
|
|
5346
|
+
* @description Delete an expense attachment. This removes staged attachments and attachments already linked to expense transactions.
|
|
5347
|
+
*
|
|
5348
|
+
* Required scope: transactions:delete
|
|
5349
|
+
*/
|
|
4910
5350
|
delete: operations["deleteTransactionsAttachmentsById"];
|
|
4911
5351
|
options?: never;
|
|
4912
5352
|
head?: never;
|
|
@@ -4920,7 +5360,11 @@ export interface paths {
|
|
|
4920
5360
|
path?: never;
|
|
4921
5361
|
cookie?: never;
|
|
4922
5362
|
};
|
|
4923
|
-
/**
|
|
5363
|
+
/**
|
|
5364
|
+
* @description Download an expense attachment
|
|
5365
|
+
*
|
|
5366
|
+
* Required scope: transactions:read
|
|
5367
|
+
*/
|
|
4924
5368
|
get: operations["getTransactionsAttachmentsByIdDownload"];
|
|
4925
5369
|
put?: never;
|
|
4926
5370
|
post?: never;
|
|
@@ -4958,7 +5402,11 @@ export interface paths {
|
|
|
4958
5402
|
path?: never;
|
|
4959
5403
|
cookie?: never;
|
|
4960
5404
|
};
|
|
4961
|
-
/**
|
|
5405
|
+
/**
|
|
5406
|
+
* @description Deposit transactions grouped by last 4 digits
|
|
5407
|
+
*
|
|
5408
|
+
* Required scope: transactions:read
|
|
5409
|
+
*/
|
|
4962
5410
|
get: operations["getTransactionsByLast4"];
|
|
4963
5411
|
put?: never;
|
|
4964
5412
|
post?: never;
|
|
@@ -5059,10 +5507,18 @@ export interface paths {
|
|
|
5059
5507
|
path?: never;
|
|
5060
5508
|
cookie?: never;
|
|
5061
5509
|
};
|
|
5062
|
-
/**
|
|
5510
|
+
/**
|
|
5511
|
+
* @description Recurring Transaction Template List
|
|
5512
|
+
*
|
|
5513
|
+
* Required scope: transactions:read
|
|
5514
|
+
*/
|
|
5063
5515
|
get: operations["getTransactionsRecurringTemplates"];
|
|
5064
5516
|
put?: never;
|
|
5065
|
-
/**
|
|
5517
|
+
/**
|
|
5518
|
+
* @description Create a recurring transaction template
|
|
5519
|
+
*
|
|
5520
|
+
* Required scope: transactions:write
|
|
5521
|
+
*/
|
|
5066
5522
|
post: operations["postTransactionsRecurringTemplates"];
|
|
5067
5523
|
delete?: never;
|
|
5068
5524
|
options?: never;
|
|
@@ -5079,7 +5535,11 @@ export interface paths {
|
|
|
5079
5535
|
};
|
|
5080
5536
|
get?: never;
|
|
5081
5537
|
put?: never;
|
|
5082
|
-
/**
|
|
5538
|
+
/**
|
|
5539
|
+
* @description Preview a recurring transaction template pattern
|
|
5540
|
+
*
|
|
5541
|
+
* Required scope: transactions:write
|
|
5542
|
+
*/
|
|
5083
5543
|
post: operations["postTransactionsRecurringTemplatesPreview"];
|
|
5084
5544
|
delete?: never;
|
|
5085
5545
|
options?: never;
|
|
@@ -5094,12 +5554,24 @@ export interface paths {
|
|
|
5094
5554
|
path?: never;
|
|
5095
5555
|
cookie?: never;
|
|
5096
5556
|
};
|
|
5097
|
-
/**
|
|
5557
|
+
/**
|
|
5558
|
+
* @description Recurring Transaction Template
|
|
5559
|
+
*
|
|
5560
|
+
* Required scope: transactions:read
|
|
5561
|
+
*/
|
|
5098
5562
|
get: operations["getTransactionsRecurringTemplatesById"];
|
|
5099
|
-
/**
|
|
5563
|
+
/**
|
|
5564
|
+
* @description Update an recurring transaction template by ID
|
|
5565
|
+
*
|
|
5566
|
+
* Required scope: transactions:write
|
|
5567
|
+
*/
|
|
5100
5568
|
put: operations["putTransactionsRecurringTemplatesById"];
|
|
5101
5569
|
post?: never;
|
|
5102
|
-
/**
|
|
5570
|
+
/**
|
|
5571
|
+
* @description Delete an recurring transaction template by ID
|
|
5572
|
+
*
|
|
5573
|
+
* Required scope: transactions:delete
|
|
5574
|
+
*/
|
|
5103
5575
|
delete: operations["deleteTransactionsRecurringTemplatesById"];
|
|
5104
5576
|
options?: never;
|
|
5105
5577
|
head?: never;
|
|
@@ -5115,7 +5587,11 @@ export interface paths {
|
|
|
5115
5587
|
};
|
|
5116
5588
|
get?: never;
|
|
5117
5589
|
put?: never;
|
|
5118
|
-
/**
|
|
5590
|
+
/**
|
|
5591
|
+
* @description Create a recurring transaction instance
|
|
5592
|
+
*
|
|
5593
|
+
* Required scope: transactions:write
|
|
5594
|
+
*/
|
|
5119
5595
|
post: operations["postTransactionsRecurringTemplatesByIdRun"];
|
|
5120
5596
|
delete?: never;
|
|
5121
5597
|
options?: never;
|
|
@@ -5183,7 +5659,11 @@ export interface paths {
|
|
|
5183
5659
|
cookie?: never;
|
|
5184
5660
|
};
|
|
5185
5661
|
get?: never;
|
|
5186
|
-
/**
|
|
5662
|
+
/**
|
|
5663
|
+
* @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.
|
|
5664
|
+
*
|
|
5665
|
+
* Required scope: transactions:write
|
|
5666
|
+
*/
|
|
5187
5667
|
put: operations["putTransactionsByTransactionIdLinesById"];
|
|
5188
5668
|
post?: never;
|
|
5189
5669
|
delete?: never;
|
|
@@ -10517,7 +10997,7 @@ export interface operations {
|
|
|
10517
10997
|
data: {
|
|
10518
10998
|
allowedEmbedParentOrigins: string[];
|
|
10519
10999
|
allowedIpCidrs: string[];
|
|
10520
|
-
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")[];
|
|
11000
|
+
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")[];
|
|
10521
11001
|
/** Format: uuid */
|
|
10522
11002
|
id: string;
|
|
10523
11003
|
/**
|
|
@@ -10529,7 +11009,7 @@ export interface operations {
|
|
|
10529
11009
|
hint: string | null;
|
|
10530
11010
|
role: string | null;
|
|
10531
11011
|
scope: string | null;
|
|
10532
|
-
scopes: ("self:read" | "self:write" | "
|
|
11012
|
+
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")[];
|
|
10533
11013
|
}[];
|
|
10534
11014
|
pagination: {
|
|
10535
11015
|
/** @default 100 */
|
|
@@ -10785,7 +11265,7 @@ export interface operations {
|
|
|
10785
11265
|
/** @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. */
|
|
10786
11266
|
allowedIpCidrs?: string[];
|
|
10787
11267
|
/** @description Optional capability restrictions for a partner-owned API token. Omit for unrestricted partner API access. Rejected for ordinary teams. */
|
|
10788
|
-
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")[];
|
|
11268
|
+
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")[];
|
|
10789
11269
|
};
|
|
10790
11270
|
};
|
|
10791
11271
|
};
|
|
@@ -10799,7 +11279,7 @@ export interface operations {
|
|
|
10799
11279
|
"application/json": {
|
|
10800
11280
|
allowedEmbedParentOrigins: string[];
|
|
10801
11281
|
allowedIpCidrs: string[];
|
|
10802
|
-
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")[];
|
|
11282
|
+
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")[];
|
|
10803
11283
|
/** Format: uuid */
|
|
10804
11284
|
id: string;
|
|
10805
11285
|
/**
|
|
@@ -10811,7 +11291,7 @@ export interface operations {
|
|
|
10811
11291
|
hint: string | null;
|
|
10812
11292
|
role: string | null;
|
|
10813
11293
|
scope: string | null;
|
|
10814
|
-
scopes: ("self:read" | "self:write" | "
|
|
11294
|
+
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")[];
|
|
10815
11295
|
apiToken: string;
|
|
10816
11296
|
};
|
|
10817
11297
|
};
|
|
@@ -11063,7 +11543,7 @@ export interface operations {
|
|
|
11063
11543
|
"application/json": {
|
|
11064
11544
|
allowedEmbedParentOrigins: string[];
|
|
11065
11545
|
allowedIpCidrs: string[];
|
|
11066
|
-
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")[];
|
|
11546
|
+
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")[];
|
|
11067
11547
|
/** Format: uuid */
|
|
11068
11548
|
id: string;
|
|
11069
11549
|
/**
|
|
@@ -11075,7 +11555,7 @@ export interface operations {
|
|
|
11075
11555
|
hint: string | null;
|
|
11076
11556
|
role: string | null;
|
|
11077
11557
|
scope: string | null;
|
|
11078
|
-
scopes: ("self:read" | "self:write" | "
|
|
11558
|
+
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")[];
|
|
11079
11559
|
apiToken: string;
|
|
11080
11560
|
};
|
|
11081
11561
|
};
|