@vrplatform/api 1.3.1-stage.4775 → 1.3.1-stage.4776
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 +2000 -2098
- package/build/main/generated/v1.js.map +1 -1
- package/build/module/generated/v1.d.ts +2000 -2098
- package/build/module/generated/v1.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/v1.ts +2000 -2098
|
@@ -3,6 +3,74 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
+
"/account-connections": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* @description List account connections for the current team
|
|
15
|
+
*
|
|
16
|
+
* Required scope: bank-accounts:read
|
|
17
|
+
*/
|
|
18
|
+
get: operations["getAccountConnections"];
|
|
19
|
+
put?: never;
|
|
20
|
+
post?: never;
|
|
21
|
+
delete?: never;
|
|
22
|
+
options?: never;
|
|
23
|
+
head?: never;
|
|
24
|
+
patch?: never;
|
|
25
|
+
trace?: never;
|
|
26
|
+
};
|
|
27
|
+
"/account-connections/batch": {
|
|
28
|
+
parameters: {
|
|
29
|
+
query?: never;
|
|
30
|
+
header?: never;
|
|
31
|
+
path?: never;
|
|
32
|
+
cookie?: never;
|
|
33
|
+
};
|
|
34
|
+
get?: never;
|
|
35
|
+
put?: never;
|
|
36
|
+
/**
|
|
37
|
+
* @description Create multiple account connections
|
|
38
|
+
*
|
|
39
|
+
* Required scope: bank-accounts:write
|
|
40
|
+
*/
|
|
41
|
+
post: operations["batchAccountConnections"];
|
|
42
|
+
delete?: never;
|
|
43
|
+
options?: never;
|
|
44
|
+
head?: never;
|
|
45
|
+
patch?: never;
|
|
46
|
+
trace?: never;
|
|
47
|
+
};
|
|
48
|
+
"/account-connections/{id}": {
|
|
49
|
+
parameters: {
|
|
50
|
+
query?: never;
|
|
51
|
+
header?: never;
|
|
52
|
+
path?: never;
|
|
53
|
+
cookie?: never;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* @description Get account connection by ID
|
|
57
|
+
*
|
|
58
|
+
* Required scope: bank-accounts:read
|
|
59
|
+
*/
|
|
60
|
+
get: operations["getAccountConnection"];
|
|
61
|
+
/**
|
|
62
|
+
* @description Update account connection by ID
|
|
63
|
+
*
|
|
64
|
+
* Required scope: bank-accounts:write
|
|
65
|
+
*/
|
|
66
|
+
put: operations["updateAccountConnection"];
|
|
67
|
+
post?: never;
|
|
68
|
+
delete?: never;
|
|
69
|
+
options?: never;
|
|
70
|
+
head?: never;
|
|
71
|
+
patch?: never;
|
|
72
|
+
trace?: never;
|
|
73
|
+
};
|
|
6
74
|
"/accounts": {
|
|
7
75
|
parameters: {
|
|
8
76
|
query?: never;
|
|
@@ -119,7 +187,7 @@ export interface paths {
|
|
|
119
187
|
patch?: never;
|
|
120
188
|
trace?: never;
|
|
121
189
|
};
|
|
122
|
-
"/accounts/{id}/
|
|
190
|
+
"/accounts/{id}/connections": {
|
|
123
191
|
parameters: {
|
|
124
192
|
query?: never;
|
|
125
193
|
header?: never;
|
|
@@ -128,15 +196,15 @@ export interface paths {
|
|
|
128
196
|
};
|
|
129
197
|
get?: never;
|
|
130
198
|
put?: never;
|
|
131
|
-
/** @description
|
|
132
|
-
post: operations["
|
|
199
|
+
/** @description Attach an external account connection to a bank account */
|
|
200
|
+
post: operations["postAccountsByIdConnections"];
|
|
133
201
|
delete?: never;
|
|
134
202
|
options?: never;
|
|
135
203
|
head?: never;
|
|
136
204
|
patch?: never;
|
|
137
205
|
trace?: never;
|
|
138
206
|
};
|
|
139
|
-
"/accounts/{id}/
|
|
207
|
+
"/accounts/{id}/connections/{accountConnectionId}": {
|
|
140
208
|
parameters: {
|
|
141
209
|
query?: never;
|
|
142
210
|
header?: never;
|
|
@@ -145,9 +213,9 @@ export interface paths {
|
|
|
145
213
|
};
|
|
146
214
|
get?: never;
|
|
147
215
|
put?: never;
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
delete
|
|
216
|
+
post?: never;
|
|
217
|
+
/** @description Detach an external account connection from a bank account */
|
|
218
|
+
delete: operations["deleteAccountsByIdConnectionsByAccountConnectionId"];
|
|
151
219
|
options?: never;
|
|
152
220
|
head?: never;
|
|
153
221
|
patch?: never;
|
|
@@ -363,74 +431,6 @@ export interface paths {
|
|
|
363
431
|
patch?: never;
|
|
364
432
|
trace?: never;
|
|
365
433
|
};
|
|
366
|
-
"/bank-accounts": {
|
|
367
|
-
parameters: {
|
|
368
|
-
query?: never;
|
|
369
|
-
header?: never;
|
|
370
|
-
path?: never;
|
|
371
|
-
cookie?: never;
|
|
372
|
-
};
|
|
373
|
-
/**
|
|
374
|
-
* @description List bank accounts for the current team
|
|
375
|
-
*
|
|
376
|
-
* Required scope: bank-accounts:read
|
|
377
|
-
*/
|
|
378
|
-
get: operations["getBankAccounts"];
|
|
379
|
-
put?: never;
|
|
380
|
-
post?: never;
|
|
381
|
-
delete?: never;
|
|
382
|
-
options?: never;
|
|
383
|
-
head?: never;
|
|
384
|
-
patch?: never;
|
|
385
|
-
trace?: never;
|
|
386
|
-
};
|
|
387
|
-
"/bank-accounts/batch": {
|
|
388
|
-
parameters: {
|
|
389
|
-
query?: never;
|
|
390
|
-
header?: never;
|
|
391
|
-
path?: never;
|
|
392
|
-
cookie?: never;
|
|
393
|
-
};
|
|
394
|
-
get?: never;
|
|
395
|
-
put?: never;
|
|
396
|
-
/**
|
|
397
|
-
* @description Create multiple bank accounts
|
|
398
|
-
*
|
|
399
|
-
* Required scope: bank-accounts:write
|
|
400
|
-
*/
|
|
401
|
-
post: operations["batchBankAccounts"];
|
|
402
|
-
delete?: never;
|
|
403
|
-
options?: never;
|
|
404
|
-
head?: never;
|
|
405
|
-
patch?: never;
|
|
406
|
-
trace?: never;
|
|
407
|
-
};
|
|
408
|
-
"/bank-accounts/{id}": {
|
|
409
|
-
parameters: {
|
|
410
|
-
query?: never;
|
|
411
|
-
header?: never;
|
|
412
|
-
path?: never;
|
|
413
|
-
cookie?: never;
|
|
414
|
-
};
|
|
415
|
-
/**
|
|
416
|
-
* @description Get bank account by ID
|
|
417
|
-
*
|
|
418
|
-
* Required scope: bank-accounts:read
|
|
419
|
-
*/
|
|
420
|
-
get: operations["getBankAccount"];
|
|
421
|
-
/**
|
|
422
|
-
* @description Update bank account by ID
|
|
423
|
-
*
|
|
424
|
-
* Required scope: bank-accounts:write
|
|
425
|
-
*/
|
|
426
|
-
put: operations["updateBankAccount"];
|
|
427
|
-
post?: never;
|
|
428
|
-
delete?: never;
|
|
429
|
-
options?: never;
|
|
430
|
-
head?: never;
|
|
431
|
-
patch?: never;
|
|
432
|
-
trace?: never;
|
|
433
|
-
};
|
|
434
434
|
"/bank-records": {
|
|
435
435
|
parameters: {
|
|
436
436
|
query?: never;
|
|
@@ -5288,19 +5288,14 @@ export interface components {
|
|
|
5288
5288
|
}
|
|
5289
5289
|
export type $defs = Record<string, never>;
|
|
5290
5290
|
export interface operations {
|
|
5291
|
-
|
|
5291
|
+
getAccountConnections: {
|
|
5292
5292
|
parameters: {
|
|
5293
5293
|
query?: {
|
|
5294
|
-
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
5295
|
-
search?: string;
|
|
5296
5294
|
status?: "active" | "inactive";
|
|
5297
|
-
|
|
5298
|
-
|
|
5299
|
-
|
|
5300
|
-
|
|
5301
|
-
limit?: number;
|
|
5302
|
-
page?: number;
|
|
5303
|
-
offset?: number;
|
|
5295
|
+
connectionId?: string;
|
|
5296
|
+
connectionAppId?: string;
|
|
5297
|
+
linked?: boolean;
|
|
5298
|
+
search?: string;
|
|
5304
5299
|
};
|
|
5305
5300
|
header?: never;
|
|
5306
5301
|
path?: never;
|
|
@@ -5316,119 +5311,44 @@ export interface operations {
|
|
|
5316
5311
|
content: {
|
|
5317
5312
|
"application/json": {
|
|
5318
5313
|
data: {
|
|
5319
|
-
|
|
5320
|
-
/** @enum {string} */
|
|
5321
|
-
status?: "active" | "inactive";
|
|
5322
|
-
/** @enum {string} */
|
|
5323
|
-
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
5324
|
-
uniqueRef?: string | null;
|
|
5314
|
+
/** Format: uuid */
|
|
5325
5315
|
id: string;
|
|
5326
|
-
|
|
5316
|
+
name?: string | null;
|
|
5317
|
+
type?: ("deposit" | "creditCard") | null;
|
|
5318
|
+
category?: ("trust" | "operating" | "external") | null;
|
|
5319
|
+
uniqueRef?: string | null;
|
|
5320
|
+
currency?: string | null;
|
|
5321
|
+
lastDigits?: string | null;
|
|
5322
|
+
persistentRef?: string | null;
|
|
5323
|
+
/** @enum {string} */
|
|
5324
|
+
status: "active" | "inactive";
|
|
5325
|
+
startDate?: string | null;
|
|
5326
|
+
account?: {
|
|
5327
5327
|
id: string;
|
|
5328
5328
|
name: string;
|
|
5329
5329
|
uniqueRef?: string | null;
|
|
5330
5330
|
/** @enum {string} */
|
|
5331
5331
|
status: "active" | "inactive";
|
|
5332
5332
|
} | null;
|
|
5333
|
-
|
|
5334
|
-
|
|
5333
|
+
connection?: {
|
|
5334
|
+
/** Format: uuid */
|
|
5335
5335
|
id: string;
|
|
5336
5336
|
name: string;
|
|
5337
|
-
|
|
5337
|
+
/** @enum {string} */
|
|
5338
|
+
status: "active" | "inactive";
|
|
5339
|
+
uniqueRef?: string | null;
|
|
5340
|
+
appId: string;
|
|
5341
|
+
icon?: string | null;
|
|
5338
5342
|
} | null;
|
|
5339
|
-
|
|
5340
|
-
/**
|
|
5341
|
-
|
|
5342
|
-
|
|
5343
|
-
|
|
5344
|
-
|
|
5345
|
-
|
|
5346
|
-
/** @constant */
|
|
5347
|
-
code: "bankAccountLast4OutOfSync";
|
|
5348
|
-
/** @constant */
|
|
5349
|
-
severity: "warning";
|
|
5350
|
-
context: {
|
|
5351
|
-
accountLast4?: string | null;
|
|
5352
|
-
bankAccountLast4: string;
|
|
5353
|
-
bankAccountIds: string[];
|
|
5354
|
-
};
|
|
5355
|
-
} | {
|
|
5356
|
-
/** @constant */
|
|
5357
|
-
code: "operatingBankAccountRequiresOpex";
|
|
5358
|
-
/** @constant */
|
|
5359
|
-
severity: "error";
|
|
5360
|
-
context: {
|
|
5361
|
-
/** @constant */
|
|
5362
|
-
bankingCategory: "operating";
|
|
5363
|
-
};
|
|
5364
|
-
})[];
|
|
5365
|
-
banking?: {
|
|
5366
|
-
category?: ("trust" | "operating" | "external") | null;
|
|
5367
|
-
type?: ("deposit" | "creditCard") | null;
|
|
5368
|
-
last4?: string | null;
|
|
5369
|
-
currency?: string | null;
|
|
5370
|
-
connections: {
|
|
5371
|
-
id: string;
|
|
5372
|
-
name: string;
|
|
5373
|
-
startDate?: string | null;
|
|
5374
|
-
connection?: {
|
|
5375
|
-
id: string;
|
|
5376
|
-
appId: string;
|
|
5377
|
-
name: string;
|
|
5378
|
-
/** @enum {string} */
|
|
5379
|
-
status: "active" | "inactive";
|
|
5380
|
-
isErrorState: boolean;
|
|
5381
|
-
icon?: string | null;
|
|
5382
|
-
} | null;
|
|
5383
|
-
status?: ("active" | "inactive") | null;
|
|
5384
|
-
currentSync?: {
|
|
5385
|
-
/** @enum {string} */
|
|
5386
|
-
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
5387
|
-
/**
|
|
5388
|
-
* Format: date-time
|
|
5389
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
5390
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
5391
|
-
*/
|
|
5392
|
-
createdAt: string;
|
|
5393
|
-
/**
|
|
5394
|
-
* Format: date-time
|
|
5395
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
5396
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
5397
|
-
*/
|
|
5398
|
-
updatedAt: string;
|
|
5399
|
-
message?: string | null;
|
|
5400
|
-
} | null;
|
|
5401
|
-
source?: {
|
|
5402
|
-
/** Format: uuid */
|
|
5403
|
-
id: string;
|
|
5404
|
-
type: string;
|
|
5405
|
-
status?: ("active" | "inactive") | null;
|
|
5406
|
-
appId?: string | null;
|
|
5407
|
-
appIcon?: string | null;
|
|
5408
|
-
} | null;
|
|
5409
|
-
}[];
|
|
5410
|
-
bankRecords: {
|
|
5411
|
-
reconciled: number;
|
|
5412
|
-
unreconciled: number;
|
|
5413
|
-
total: number;
|
|
5414
|
-
latestCreatedAt?: string | null;
|
|
5415
|
-
};
|
|
5416
|
-
balance?: {
|
|
5417
|
-
openingDate?: string | null;
|
|
5418
|
-
opening: number;
|
|
5419
|
-
ending: number;
|
|
5420
|
-
} | null;
|
|
5343
|
+
source?: {
|
|
5344
|
+
/** Format: uuid */
|
|
5345
|
+
id: string;
|
|
5346
|
+
type: string;
|
|
5347
|
+
status?: ("active" | "inactive") | null;
|
|
5348
|
+
appId?: string | null;
|
|
5349
|
+
appIcon?: string | null;
|
|
5421
5350
|
} | null;
|
|
5422
5351
|
}[];
|
|
5423
|
-
pagination: {
|
|
5424
|
-
/** @default 100 */
|
|
5425
|
-
limit: number;
|
|
5426
|
-
/** @default 1 */
|
|
5427
|
-
page: number;
|
|
5428
|
-
total: number;
|
|
5429
|
-
totalPage: number;
|
|
5430
|
-
nextPage?: number;
|
|
5431
|
-
};
|
|
5432
5352
|
};
|
|
5433
5353
|
};
|
|
5434
5354
|
};
|
|
@@ -5566,7 +5486,7 @@ export interface operations {
|
|
|
5566
5486
|
};
|
|
5567
5487
|
};
|
|
5568
5488
|
};
|
|
5569
|
-
|
|
5489
|
+
batchAccountConnections: {
|
|
5570
5490
|
parameters: {
|
|
5571
5491
|
query?: {
|
|
5572
5492
|
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
@@ -5579,21 +5499,24 @@ export interface operations {
|
|
|
5579
5499
|
requestBody?: {
|
|
5580
5500
|
content: {
|
|
5581
5501
|
"application/json": {
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
|
|
5586
|
-
|
|
5587
|
-
|
|
5588
|
-
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5593
|
-
last4?: string | null;
|
|
5502
|
+
/** Format: uuid */
|
|
5503
|
+
connectionId: string;
|
|
5504
|
+
data: {
|
|
5505
|
+
id?: string | null;
|
|
5506
|
+
/** @enum {string} */
|
|
5507
|
+
type: "deposit" | "creditCard";
|
|
5508
|
+
/** @enum {string} */
|
|
5509
|
+
category: "trust" | "operating" | "external";
|
|
5510
|
+
name: string;
|
|
5511
|
+
uniqueRef?: string | null;
|
|
5512
|
+
sourceId?: string | null;
|
|
5594
5513
|
currency?: string | null;
|
|
5595
|
-
|
|
5596
|
-
|
|
5514
|
+
lastDigits?: string | null;
|
|
5515
|
+
persistentRef?: string | null;
|
|
5516
|
+
status?: ("active" | "inactive") | null;
|
|
5517
|
+
accountId?: string | null;
|
|
5518
|
+
startDate?: string | null;
|
|
5519
|
+
}[];
|
|
5597
5520
|
};
|
|
5598
5521
|
};
|
|
5599
5522
|
};
|
|
@@ -5605,109 +5528,20 @@ export interface operations {
|
|
|
5605
5528
|
};
|
|
5606
5529
|
content: {
|
|
5607
5530
|
"application/json": {
|
|
5608
|
-
|
|
5609
|
-
|
|
5610
|
-
status?: "active" | "inactive";
|
|
5611
|
-
/** @enum {string} */
|
|
5612
|
-
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
5613
|
-
uniqueRef?: string | null;
|
|
5614
|
-
id: string;
|
|
5615
|
-
offsetAccount?: {
|
|
5531
|
+
data: {
|
|
5532
|
+
/** Format: uuid */
|
|
5616
5533
|
id: string;
|
|
5617
|
-
name: string;
|
|
5618
5534
|
uniqueRef?: string | null;
|
|
5535
|
+
sourceId?: string | null;
|
|
5536
|
+
}[];
|
|
5537
|
+
issues: {
|
|
5538
|
+
ref: string;
|
|
5539
|
+
sourceId?: string | null;
|
|
5540
|
+
message: string;
|
|
5619
5541
|
/** @enum {string} */
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
category?: {
|
|
5624
|
-
id: string;
|
|
5625
|
-
name: string;
|
|
5626
|
-
classification?: ("asset" | "liability" | "revenue" | "expense") | null;
|
|
5627
|
-
} | null;
|
|
5628
|
-
categoryLock: {
|
|
5629
|
-
/** @constant */
|
|
5630
|
-
status: "locked";
|
|
5631
|
-
/** @constant */
|
|
5632
|
-
reason: "immutable";
|
|
5633
|
-
};
|
|
5634
|
-
issues: ({
|
|
5635
|
-
/** @constant */
|
|
5636
|
-
code: "bankAccountLast4OutOfSync";
|
|
5637
|
-
/** @constant */
|
|
5638
|
-
severity: "warning";
|
|
5639
|
-
context: {
|
|
5640
|
-
accountLast4?: string | null;
|
|
5641
|
-
bankAccountLast4: string;
|
|
5642
|
-
bankAccountIds: string[];
|
|
5643
|
-
};
|
|
5644
|
-
} | {
|
|
5645
|
-
/** @constant */
|
|
5646
|
-
code: "operatingBankAccountRequiresOpex";
|
|
5647
|
-
/** @constant */
|
|
5648
|
-
severity: "error";
|
|
5649
|
-
context: {
|
|
5650
|
-
/** @constant */
|
|
5651
|
-
bankingCategory: "operating";
|
|
5652
|
-
};
|
|
5653
|
-
})[];
|
|
5654
|
-
banking?: {
|
|
5655
|
-
category?: ("trust" | "operating" | "external") | null;
|
|
5656
|
-
type?: ("deposit" | "creditCard") | null;
|
|
5657
|
-
last4?: string | null;
|
|
5658
|
-
currency?: string | null;
|
|
5659
|
-
connections: {
|
|
5660
|
-
id: string;
|
|
5661
|
-
name: string;
|
|
5662
|
-
startDate?: string | null;
|
|
5663
|
-
connection?: {
|
|
5664
|
-
id: string;
|
|
5665
|
-
appId: string;
|
|
5666
|
-
name: string;
|
|
5667
|
-
/** @enum {string} */
|
|
5668
|
-
status: "active" | "inactive";
|
|
5669
|
-
isErrorState: boolean;
|
|
5670
|
-
icon?: string | null;
|
|
5671
|
-
} | null;
|
|
5672
|
-
status?: ("active" | "inactive") | null;
|
|
5673
|
-
currentSync?: {
|
|
5674
|
-
/** @enum {string} */
|
|
5675
|
-
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
5676
|
-
/**
|
|
5677
|
-
* Format: date-time
|
|
5678
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
5679
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
5680
|
-
*/
|
|
5681
|
-
createdAt: string;
|
|
5682
|
-
/**
|
|
5683
|
-
* Format: date-time
|
|
5684
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
5685
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
5686
|
-
*/
|
|
5687
|
-
updatedAt: string;
|
|
5688
|
-
message?: string | null;
|
|
5689
|
-
} | null;
|
|
5690
|
-
source?: {
|
|
5691
|
-
/** Format: uuid */
|
|
5692
|
-
id: string;
|
|
5693
|
-
type: string;
|
|
5694
|
-
status?: ("active" | "inactive") | null;
|
|
5695
|
-
appId?: string | null;
|
|
5696
|
-
appIcon?: string | null;
|
|
5697
|
-
} | null;
|
|
5698
|
-
}[];
|
|
5699
|
-
bankRecords: {
|
|
5700
|
-
reconciled: number;
|
|
5701
|
-
unreconciled: number;
|
|
5702
|
-
total: number;
|
|
5703
|
-
latestCreatedAt?: string | null;
|
|
5704
|
-
};
|
|
5705
|
-
balance?: {
|
|
5706
|
-
openingDate?: string | null;
|
|
5707
|
-
opening: number;
|
|
5708
|
-
ending: number;
|
|
5709
|
-
} | null;
|
|
5710
|
-
} | null;
|
|
5542
|
+
code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR";
|
|
5543
|
+
context?: unknown;
|
|
5544
|
+
}[];
|
|
5711
5545
|
};
|
|
5712
5546
|
};
|
|
5713
5547
|
};
|
|
@@ -5845,11 +5679,13 @@ export interface operations {
|
|
|
5845
5679
|
};
|
|
5846
5680
|
};
|
|
5847
5681
|
};
|
|
5848
|
-
|
|
5682
|
+
getAccountConnection: {
|
|
5849
5683
|
parameters: {
|
|
5850
5684
|
query?: never;
|
|
5851
5685
|
header?: never;
|
|
5852
|
-
path
|
|
5686
|
+
path: {
|
|
5687
|
+
id: string;
|
|
5688
|
+
};
|
|
5853
5689
|
cookie?: never;
|
|
5854
5690
|
};
|
|
5855
5691
|
requestBody?: never;
|
|
@@ -5861,11 +5697,34 @@ export interface operations {
|
|
|
5861
5697
|
};
|
|
5862
5698
|
content: {
|
|
5863
5699
|
"application/json": {
|
|
5864
|
-
|
|
5700
|
+
/** Format: uuid */
|
|
5701
|
+
id: string;
|
|
5702
|
+
/** @enum {string} */
|
|
5703
|
+
type: "deposit" | "creditCard";
|
|
5704
|
+
/** @enum {string} */
|
|
5705
|
+
category: "trust" | "operating" | "external";
|
|
5706
|
+
name: string;
|
|
5707
|
+
uniqueRef?: string | null;
|
|
5708
|
+
currency?: string | null;
|
|
5709
|
+
lastDigits?: string | null;
|
|
5710
|
+
persistentRef?: string | null;
|
|
5711
|
+
status: ("active" | "inactive") | null;
|
|
5712
|
+
startDate?: string | null;
|
|
5713
|
+
account?: {
|
|
5865
5714
|
id: string;
|
|
5866
5715
|
name: string;
|
|
5867
|
-
|
|
5868
|
-
|
|
5716
|
+
uniqueRef?: string | null;
|
|
5717
|
+
/** @enum {string} */
|
|
5718
|
+
status: "active" | "inactive";
|
|
5719
|
+
} | null;
|
|
5720
|
+
source?: {
|
|
5721
|
+
/** Format: uuid */
|
|
5722
|
+
id: string;
|
|
5723
|
+
type: string;
|
|
5724
|
+
status?: ("active" | "inactive") | null;
|
|
5725
|
+
appId?: string | null;
|
|
5726
|
+
appIcon?: string | null;
|
|
5727
|
+
} | null;
|
|
5869
5728
|
};
|
|
5870
5729
|
};
|
|
5871
5730
|
};
|
|
@@ -6003,22 +5862,36 @@ export interface operations {
|
|
|
6003
5862
|
};
|
|
6004
5863
|
};
|
|
6005
5864
|
};
|
|
6006
|
-
|
|
5865
|
+
updateAccountConnection: {
|
|
6007
5866
|
parameters: {
|
|
6008
5867
|
query?: {
|
|
6009
|
-
|
|
6010
|
-
|
|
6011
|
-
status?: "active" | "inactive";
|
|
6012
|
-
classification?: "asset" | "liability" | "revenue" | "expense";
|
|
6013
|
-
categoryId?: string;
|
|
6014
|
-
bankingCategory?: "trust" | "operating" | "external";
|
|
6015
|
-
reconciled?: boolean;
|
|
5868
|
+
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
5869
|
+
dryRun?: boolean;
|
|
6016
5870
|
};
|
|
6017
5871
|
header?: never;
|
|
6018
|
-
path
|
|
5872
|
+
path: {
|
|
5873
|
+
id: string;
|
|
5874
|
+
};
|
|
6019
5875
|
cookie?: never;
|
|
6020
5876
|
};
|
|
6021
|
-
requestBody?:
|
|
5877
|
+
requestBody?: {
|
|
5878
|
+
content: {
|
|
5879
|
+
"application/json": {
|
|
5880
|
+
/** @enum {string} */
|
|
5881
|
+
type?: "deposit" | "creditCard";
|
|
5882
|
+
/** @enum {string} */
|
|
5883
|
+
category?: "trust" | "operating" | "external";
|
|
5884
|
+
name?: string;
|
|
5885
|
+
uniqueRef?: string | null;
|
|
5886
|
+
sourceId?: string | null;
|
|
5887
|
+
currency?: string | null;
|
|
5888
|
+
lastDigits?: string | null;
|
|
5889
|
+
status?: ("active" | "inactive") | null;
|
|
5890
|
+
accountId?: string | null;
|
|
5891
|
+
startDate?: string | null;
|
|
5892
|
+
};
|
|
5893
|
+
};
|
|
5894
|
+
};
|
|
6022
5895
|
responses: {
|
|
6023
5896
|
/** @description Successful response */
|
|
6024
5897
|
200: {
|
|
@@ -6027,7 +5900,34 @@ export interface operations {
|
|
|
6027
5900
|
};
|
|
6028
5901
|
content: {
|
|
6029
5902
|
"application/json": {
|
|
6030
|
-
|
|
5903
|
+
/** Format: uuid */
|
|
5904
|
+
id: string;
|
|
5905
|
+
/** @enum {string} */
|
|
5906
|
+
type: "deposit" | "creditCard";
|
|
5907
|
+
/** @enum {string} */
|
|
5908
|
+
category: "trust" | "operating" | "external";
|
|
5909
|
+
name: string;
|
|
5910
|
+
uniqueRef?: string | null;
|
|
5911
|
+
currency?: string | null;
|
|
5912
|
+
lastDigits?: string | null;
|
|
5913
|
+
persistentRef?: string | null;
|
|
5914
|
+
status: ("active" | "inactive") | null;
|
|
5915
|
+
startDate?: string | null;
|
|
5916
|
+
account?: {
|
|
5917
|
+
id: string;
|
|
5918
|
+
name: string;
|
|
5919
|
+
uniqueRef?: string | null;
|
|
5920
|
+
/** @enum {string} */
|
|
5921
|
+
status: "active" | "inactive";
|
|
5922
|
+
} | null;
|
|
5923
|
+
source?: {
|
|
5924
|
+
/** Format: uuid */
|
|
5925
|
+
id: string;
|
|
5926
|
+
type: string;
|
|
5927
|
+
status?: ("active" | "inactive") | null;
|
|
5928
|
+
appId?: string | null;
|
|
5929
|
+
appIcon?: string | null;
|
|
5930
|
+
} | null;
|
|
6031
5931
|
};
|
|
6032
5932
|
};
|
|
6033
5933
|
};
|
|
@@ -6165,13 +6065,22 @@ export interface operations {
|
|
|
6165
6065
|
};
|
|
6166
6066
|
};
|
|
6167
6067
|
};
|
|
6168
|
-
|
|
6068
|
+
getAccounts: {
|
|
6169
6069
|
parameters: {
|
|
6170
|
-
query?:
|
|
6171
|
-
|
|
6172
|
-
|
|
6173
|
-
|
|
6070
|
+
query?: {
|
|
6071
|
+
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
6072
|
+
search?: string;
|
|
6073
|
+
status?: "active" | "inactive";
|
|
6074
|
+
classification?: "asset" | "liability" | "revenue" | "expense";
|
|
6075
|
+
categoryId?: string;
|
|
6076
|
+
bankingCategory?: "trust" | "operating" | "external";
|
|
6077
|
+
reconciled?: boolean;
|
|
6078
|
+
limit?: number;
|
|
6079
|
+
page?: number;
|
|
6080
|
+
offset?: number;
|
|
6174
6081
|
};
|
|
6082
|
+
header?: never;
|
|
6083
|
+
path?: never;
|
|
6175
6084
|
cookie?: never;
|
|
6176
6085
|
};
|
|
6177
6086
|
requestBody?: never;
|
|
@@ -6183,109 +6092,120 @@ export interface operations {
|
|
|
6183
6092
|
};
|
|
6184
6093
|
content: {
|
|
6185
6094
|
"application/json": {
|
|
6186
|
-
|
|
6187
|
-
/** @enum {string} */
|
|
6188
|
-
status?: "active" | "inactive";
|
|
6189
|
-
/** @enum {string} */
|
|
6190
|
-
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
6191
|
-
uniqueRef?: string | null;
|
|
6192
|
-
id: string;
|
|
6193
|
-
offsetAccount?: {
|
|
6194
|
-
id: string;
|
|
6095
|
+
data: {
|
|
6195
6096
|
name: string;
|
|
6196
|
-
uniqueRef?: string | null;
|
|
6197
6097
|
/** @enum {string} */
|
|
6198
|
-
status
|
|
6199
|
-
|
|
6200
|
-
|
|
6201
|
-
|
|
6098
|
+
status?: "active" | "inactive";
|
|
6099
|
+
/** @enum {string} */
|
|
6100
|
+
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
6101
|
+
uniqueRef?: string | null;
|
|
6202
6102
|
id: string;
|
|
6203
|
-
|
|
6204
|
-
classification?: ("asset" | "liability" | "revenue" | "expense") | null;
|
|
6205
|
-
} | null;
|
|
6206
|
-
categoryLock: {
|
|
6207
|
-
/** @constant */
|
|
6208
|
-
status: "locked";
|
|
6209
|
-
/** @constant */
|
|
6210
|
-
reason: "immutable";
|
|
6211
|
-
};
|
|
6212
|
-
issues: ({
|
|
6213
|
-
/** @constant */
|
|
6214
|
-
code: "bankAccountLast4OutOfSync";
|
|
6215
|
-
/** @constant */
|
|
6216
|
-
severity: "warning";
|
|
6217
|
-
context: {
|
|
6218
|
-
accountLast4?: string | null;
|
|
6219
|
-
bankAccountLast4: string;
|
|
6220
|
-
bankAccountIds: string[];
|
|
6221
|
-
};
|
|
6222
|
-
} | {
|
|
6223
|
-
/** @constant */
|
|
6224
|
-
code: "operatingBankAccountRequiresOpex";
|
|
6225
|
-
/** @constant */
|
|
6226
|
-
severity: "error";
|
|
6227
|
-
context: {
|
|
6228
|
-
/** @constant */
|
|
6229
|
-
bankingCategory: "operating";
|
|
6230
|
-
};
|
|
6231
|
-
})[];
|
|
6232
|
-
banking?: {
|
|
6233
|
-
category?: ("trust" | "operating" | "external") | null;
|
|
6234
|
-
type?: ("deposit" | "creditCard") | null;
|
|
6235
|
-
last4?: string | null;
|
|
6236
|
-
currency?: string | null;
|
|
6237
|
-
connections: {
|
|
6103
|
+
offsetAccount?: {
|
|
6238
6104
|
id: string;
|
|
6239
6105
|
name: string;
|
|
6240
|
-
|
|
6241
|
-
|
|
6106
|
+
uniqueRef?: string | null;
|
|
6107
|
+
/** @enum {string} */
|
|
6108
|
+
status: "active" | "inactive";
|
|
6109
|
+
} | null;
|
|
6110
|
+
assignments: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution")[];
|
|
6111
|
+
category?: {
|
|
6112
|
+
id: string;
|
|
6113
|
+
name: string;
|
|
6114
|
+
classification?: ("asset" | "liability" | "revenue" | "expense") | null;
|
|
6115
|
+
} | null;
|
|
6116
|
+
categoryLock: {
|
|
6117
|
+
/** @constant */
|
|
6118
|
+
status: "locked";
|
|
6119
|
+
/** @constant */
|
|
6120
|
+
reason: "immutable";
|
|
6121
|
+
};
|
|
6122
|
+
issues: ({
|
|
6123
|
+
/** @constant */
|
|
6124
|
+
code: "accountConnectionLast4OutOfSync";
|
|
6125
|
+
/** @constant */
|
|
6126
|
+
severity: "warning";
|
|
6127
|
+
context: {
|
|
6128
|
+
accountLast4?: string | null;
|
|
6129
|
+
accountConnectionLast4: string;
|
|
6130
|
+
accountConnectionIds: string[];
|
|
6131
|
+
};
|
|
6132
|
+
} | {
|
|
6133
|
+
/** @constant */
|
|
6134
|
+
code: "operatingBankAccountRequiresOpex";
|
|
6135
|
+
/** @constant */
|
|
6136
|
+
severity: "error";
|
|
6137
|
+
context: {
|
|
6138
|
+
/** @constant */
|
|
6139
|
+
bankingCategory: "operating";
|
|
6140
|
+
};
|
|
6141
|
+
})[];
|
|
6142
|
+
banking?: {
|
|
6143
|
+
category?: ("trust" | "operating" | "external") | null;
|
|
6144
|
+
type?: ("deposit" | "creditCard") | null;
|
|
6145
|
+
last4?: string | null;
|
|
6146
|
+
currency?: string | null;
|
|
6147
|
+
connections: {
|
|
6242
6148
|
id: string;
|
|
6243
|
-
appId: string;
|
|
6244
6149
|
name: string;
|
|
6245
|
-
|
|
6246
|
-
|
|
6247
|
-
|
|
6248
|
-
|
|
6249
|
-
|
|
6250
|
-
|
|
6251
|
-
|
|
6252
|
-
|
|
6253
|
-
|
|
6254
|
-
|
|
6255
|
-
* Format: date-time
|
|
6256
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
6257
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
6258
|
-
*/
|
|
6259
|
-
createdAt: string;
|
|
6260
|
-
/**
|
|
6261
|
-
* Format: date-time
|
|
6262
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
6263
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
6264
|
-
*/
|
|
6265
|
-
updatedAt: string;
|
|
6266
|
-
message?: string | null;
|
|
6267
|
-
} | null;
|
|
6268
|
-
source?: {
|
|
6269
|
-
/** Format: uuid */
|
|
6270
|
-
id: string;
|
|
6271
|
-
type: string;
|
|
6150
|
+
startDate?: string | null;
|
|
6151
|
+
connection?: {
|
|
6152
|
+
id: string;
|
|
6153
|
+
appId: string;
|
|
6154
|
+
name: string;
|
|
6155
|
+
/** @enum {string} */
|
|
6156
|
+
status: "active" | "inactive";
|
|
6157
|
+
isErrorState: boolean;
|
|
6158
|
+
icon?: string | null;
|
|
6159
|
+
} | null;
|
|
6272
6160
|
status?: ("active" | "inactive") | null;
|
|
6273
|
-
|
|
6274
|
-
|
|
6161
|
+
currentSync?: {
|
|
6162
|
+
/** @enum {string} */
|
|
6163
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
6164
|
+
/**
|
|
6165
|
+
* Format: date-time
|
|
6166
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
6167
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
6168
|
+
*/
|
|
6169
|
+
createdAt: string;
|
|
6170
|
+
/**
|
|
6171
|
+
* Format: date-time
|
|
6172
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
6173
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
6174
|
+
*/
|
|
6175
|
+
updatedAt: string;
|
|
6176
|
+
message?: string | null;
|
|
6177
|
+
} | null;
|
|
6178
|
+
source?: {
|
|
6179
|
+
/** Format: uuid */
|
|
6180
|
+
id: string;
|
|
6181
|
+
type: string;
|
|
6182
|
+
status?: ("active" | "inactive") | null;
|
|
6183
|
+
appId?: string | null;
|
|
6184
|
+
appIcon?: string | null;
|
|
6185
|
+
} | null;
|
|
6186
|
+
}[];
|
|
6187
|
+
bankRecords: {
|
|
6188
|
+
reconciled: number;
|
|
6189
|
+
unreconciled: number;
|
|
6190
|
+
total: number;
|
|
6191
|
+
latestCreatedAt?: string | null;
|
|
6192
|
+
};
|
|
6193
|
+
balance?: {
|
|
6194
|
+
openingDate?: string | null;
|
|
6195
|
+
opening: number;
|
|
6196
|
+
ending: number;
|
|
6275
6197
|
} | null;
|
|
6276
|
-
}[];
|
|
6277
|
-
bankRecords: {
|
|
6278
|
-
reconciled: number;
|
|
6279
|
-
unreconciled: number;
|
|
6280
|
-
total: number;
|
|
6281
|
-
latestCreatedAt?: string | null;
|
|
6282
|
-
};
|
|
6283
|
-
balance?: {
|
|
6284
|
-
openingDate?: string | null;
|
|
6285
|
-
opening: number;
|
|
6286
|
-
ending: number;
|
|
6287
6198
|
} | null;
|
|
6288
|
-
}
|
|
6199
|
+
}[];
|
|
6200
|
+
pagination: {
|
|
6201
|
+
/** @default 100 */
|
|
6202
|
+
limit: number;
|
|
6203
|
+
/** @default 1 */
|
|
6204
|
+
page: number;
|
|
6205
|
+
total: number;
|
|
6206
|
+
totalPage: number;
|
|
6207
|
+
nextPage?: number;
|
|
6208
|
+
};
|
|
6289
6209
|
};
|
|
6290
6210
|
};
|
|
6291
6211
|
};
|
|
@@ -6423,26 +6343,24 @@ export interface operations {
|
|
|
6423
6343
|
};
|
|
6424
6344
|
};
|
|
6425
6345
|
};
|
|
6426
|
-
|
|
6346
|
+
postAccounts: {
|
|
6427
6347
|
parameters: {
|
|
6428
6348
|
query?: {
|
|
6429
6349
|
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
6430
6350
|
dryRun?: boolean;
|
|
6431
6351
|
};
|
|
6432
6352
|
header?: never;
|
|
6433
|
-
path
|
|
6434
|
-
id: string;
|
|
6435
|
-
};
|
|
6353
|
+
path?: never;
|
|
6436
6354
|
cookie?: never;
|
|
6437
6355
|
};
|
|
6438
6356
|
requestBody?: {
|
|
6439
6357
|
content: {
|
|
6440
6358
|
"application/json": {
|
|
6441
|
-
name
|
|
6359
|
+
name: string;
|
|
6442
6360
|
/** @enum {string} */
|
|
6443
6361
|
status?: "active" | "inactive";
|
|
6444
6362
|
/** @enum {string} */
|
|
6445
|
-
type
|
|
6363
|
+
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
6446
6364
|
assignments?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution")[] | null;
|
|
6447
6365
|
offsetAccountId?: string | null;
|
|
6448
6366
|
categoryId?: string;
|
|
@@ -6492,13 +6410,13 @@ export interface operations {
|
|
|
6492
6410
|
};
|
|
6493
6411
|
issues: ({
|
|
6494
6412
|
/** @constant */
|
|
6495
|
-
code: "
|
|
6413
|
+
code: "accountConnectionLast4OutOfSync";
|
|
6496
6414
|
/** @constant */
|
|
6497
6415
|
severity: "warning";
|
|
6498
6416
|
context: {
|
|
6499
6417
|
accountLast4?: string | null;
|
|
6500
|
-
|
|
6501
|
-
|
|
6418
|
+
accountConnectionLast4: string;
|
|
6419
|
+
accountConnectionIds: string[];
|
|
6502
6420
|
};
|
|
6503
6421
|
} | {
|
|
6504
6422
|
/** @constant */
|
|
@@ -6704,24 +6622,14 @@ export interface operations {
|
|
|
6704
6622
|
};
|
|
6705
6623
|
};
|
|
6706
6624
|
};
|
|
6707
|
-
|
|
6625
|
+
getAccountsCategories: {
|
|
6708
6626
|
parameters: {
|
|
6709
|
-
query?:
|
|
6710
|
-
onLocked?: "error" | "archive";
|
|
6711
|
-
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
6712
|
-
dryRun?: boolean;
|
|
6713
|
-
};
|
|
6627
|
+
query?: never;
|
|
6714
6628
|
header?: never;
|
|
6715
|
-
path
|
|
6716
|
-
id: string;
|
|
6717
|
-
};
|
|
6629
|
+
path?: never;
|
|
6718
6630
|
cookie?: never;
|
|
6719
6631
|
};
|
|
6720
|
-
requestBody?:
|
|
6721
|
-
content: {
|
|
6722
|
-
"application/json": Record<string, never>;
|
|
6723
|
-
};
|
|
6724
|
-
};
|
|
6632
|
+
requestBody?: never;
|
|
6725
6633
|
responses: {
|
|
6726
6634
|
/** @description Successful response */
|
|
6727
6635
|
200: {
|
|
@@ -6730,8 +6638,11 @@ export interface operations {
|
|
|
6730
6638
|
};
|
|
6731
6639
|
content: {
|
|
6732
6640
|
"application/json": {
|
|
6733
|
-
|
|
6734
|
-
|
|
6641
|
+
data: {
|
|
6642
|
+
id: string;
|
|
6643
|
+
name: string;
|
|
6644
|
+
classification?: ("asset" | "liability" | "revenue" | "expense") | null;
|
|
6645
|
+
}[];
|
|
6735
6646
|
};
|
|
6736
6647
|
};
|
|
6737
6648
|
};
|
|
@@ -6869,26 +6780,22 @@ export interface operations {
|
|
|
6869
6780
|
};
|
|
6870
6781
|
};
|
|
6871
6782
|
};
|
|
6872
|
-
|
|
6783
|
+
getAccountsCsv: {
|
|
6873
6784
|
parameters: {
|
|
6874
6785
|
query?: {
|
|
6875
|
-
|
|
6876
|
-
|
|
6786
|
+
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
6787
|
+
search?: string;
|
|
6788
|
+
status?: "active" | "inactive";
|
|
6789
|
+
classification?: "asset" | "liability" | "revenue" | "expense";
|
|
6790
|
+
categoryId?: string;
|
|
6791
|
+
bankingCategory?: "trust" | "operating" | "external";
|
|
6792
|
+
reconciled?: boolean;
|
|
6877
6793
|
};
|
|
6878
6794
|
header?: never;
|
|
6879
|
-
path
|
|
6880
|
-
id: string;
|
|
6881
|
-
};
|
|
6795
|
+
path?: never;
|
|
6882
6796
|
cookie?: never;
|
|
6883
6797
|
};
|
|
6884
|
-
requestBody?:
|
|
6885
|
-
content: {
|
|
6886
|
-
"application/json": {
|
|
6887
|
-
startingBalanceDate: string;
|
|
6888
|
-
startingBalanceAmount: number;
|
|
6889
|
-
};
|
|
6890
|
-
};
|
|
6891
|
-
};
|
|
6798
|
+
requestBody?: never;
|
|
6892
6799
|
responses: {
|
|
6893
6800
|
/** @description Successful response */
|
|
6894
6801
|
200: {
|
|
@@ -6897,347 +6804,7 @@ export interface operations {
|
|
|
6897
6804
|
};
|
|
6898
6805
|
content: {
|
|
6899
6806
|
"application/json": {
|
|
6900
|
-
|
|
6901
|
-
archivedRecords: number;
|
|
6902
|
-
unArchivedRecords: number;
|
|
6903
|
-
transaction: {
|
|
6904
|
-
description: string;
|
|
6905
|
-
/** @enum {string} */
|
|
6906
|
-
status: "active" | "inactive";
|
|
6907
|
-
uniqueRef?: string | null;
|
|
6908
|
-
isOpeningBalance: boolean;
|
|
6909
|
-
/** @enum {string} */
|
|
6910
|
-
type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
|
|
6911
|
-
date: string;
|
|
6912
|
-
lines: {
|
|
6913
|
-
uniqueRef?: string | null;
|
|
6914
|
-
description: string;
|
|
6915
|
-
/** @description System account purpose used to resolve or validate the posting account */
|
|
6916
|
-
assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
|
|
6917
|
-
/** @description Value in cents (100 = 1€) */
|
|
6918
|
-
amount: number;
|
|
6919
|
-
/** @description Persisted owner statement linked to a payout line */
|
|
6920
|
-
ownerStatementId?: string | null;
|
|
6921
|
-
matchReservationConfirmationCode?: string | null;
|
|
6922
|
-
matchReservationStripeGuestRef?: string | null;
|
|
6923
|
-
matchReservationProcessorBookingRef?: string | null;
|
|
6924
|
-
matchLineTypeClassification?: string | null;
|
|
6925
|
-
id: string;
|
|
6926
|
-
issues: {
|
|
6927
|
-
/** @constant */
|
|
6928
|
-
code: "unassignedAccount";
|
|
6929
|
-
/** @constant */
|
|
6930
|
-
severity: "error";
|
|
6931
|
-
context: {
|
|
6932
|
-
lineType: string;
|
|
6933
|
-
};
|
|
6934
|
-
}[];
|
|
6935
|
-
recurringTemplate?: {
|
|
6936
|
-
id: string;
|
|
6937
|
-
} | null;
|
|
6938
|
-
total: number;
|
|
6939
|
-
listing?: {
|
|
6940
|
-
/** Format: uuid */
|
|
6941
|
-
id: string;
|
|
6942
|
-
name: string;
|
|
6943
|
-
uniqueRef?: string | null;
|
|
6944
|
-
shortRef?: string | null;
|
|
6945
|
-
} | null;
|
|
6946
|
-
reservation?: {
|
|
6947
|
-
id: string;
|
|
6948
|
-
shortRef?: string | null;
|
|
6949
|
-
confirmationCode?: string | null;
|
|
6950
|
-
uniqueRef: string;
|
|
6951
|
-
/** @enum {string} */
|
|
6952
|
-
status: "booked" | "canceled" | "inactive";
|
|
6953
|
-
checkIn?: string | null;
|
|
6954
|
-
checkOut?: string | null;
|
|
6955
|
-
} | null;
|
|
6956
|
-
account?: {
|
|
6957
|
-
id: string;
|
|
6958
|
-
name: string;
|
|
6959
|
-
uniqueRef?: string | null;
|
|
6960
|
-
/** @enum {string} */
|
|
6961
|
-
status: "active" | "inactive";
|
|
6962
|
-
} | null;
|
|
6963
|
-
/**
|
|
6964
|
-
* @description Accounting attribution: owners affects owner-side balances and statements; manager affects manager-side accounting
|
|
6965
|
-
* @enum {string}
|
|
6966
|
-
*/
|
|
6967
|
-
party: "owners" | "manager";
|
|
6968
|
-
contact?: {
|
|
6969
|
-
/** Format: uuid */
|
|
6970
|
-
id: string;
|
|
6971
|
-
name?: string | null;
|
|
6972
|
-
firstName?: string | null;
|
|
6973
|
-
uniqueRef?: string | null;
|
|
6974
|
-
shortRef?: string | null;
|
|
6975
|
-
email?: string | null;
|
|
6976
|
-
/** @enum {string} */
|
|
6977
|
-
type: "owner" | "vendor";
|
|
6978
|
-
} | null;
|
|
6979
|
-
matchStatus?: string | null;
|
|
6980
|
-
appliedAmount?: {
|
|
6981
|
-
taxBehavior?: ("excluded" | "included") | null;
|
|
6982
|
-
taxRate?: {
|
|
6983
|
-
id: string;
|
|
6984
|
-
name: string;
|
|
6985
|
-
/**
|
|
6986
|
-
* @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
|
|
6987
|
-
* @example 100000
|
|
6988
|
-
*/
|
|
6989
|
-
basisPoints: number;
|
|
6990
|
-
} | null;
|
|
6991
|
-
} | null;
|
|
6992
|
-
markup?: {
|
|
6993
|
-
amount?: number | null;
|
|
6994
|
-
taxBehavior?: ("excluded" | "included") | null;
|
|
6995
|
-
taxRate?: {
|
|
6996
|
-
id: string;
|
|
6997
|
-
name: string;
|
|
6998
|
-
/**
|
|
6999
|
-
* @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
|
|
7000
|
-
* @example 100000
|
|
7001
|
-
*/
|
|
7002
|
-
basisPoints: number;
|
|
7003
|
-
} | null;
|
|
7004
|
-
} | null;
|
|
7005
|
-
lock?: {
|
|
7006
|
-
/**
|
|
7007
|
-
* @description Whether the represented entity or field can be mutated
|
|
7008
|
-
* @enum {string}
|
|
7009
|
-
*/
|
|
7010
|
-
status: "locked" | "unlocked";
|
|
7011
|
-
/** @description Present when books closing blocks the mutation */
|
|
7012
|
-
booksClosed?: {
|
|
7013
|
-
/** @description First open accounting date */
|
|
7014
|
-
date: string;
|
|
7015
|
-
} | null;
|
|
7016
|
-
/** @description Present when journal entries are attached to owner statements */
|
|
7017
|
-
ownerStatement?: {
|
|
7018
|
-
/** @description Owner statements that lock the represented data */
|
|
7019
|
-
ids: string[];
|
|
7020
|
-
} | null;
|
|
7021
|
-
reconciled?: {
|
|
7022
|
-
/** @description Bank records linked through reconciliation */
|
|
7023
|
-
bankRecordIds: string[];
|
|
7024
|
-
} | null;
|
|
7025
|
-
/** @description Listing statement-period conflicts for the represented data */
|
|
7026
|
-
statementPeriod?: {
|
|
7027
|
-
hits: {
|
|
7028
|
-
/** Format: uuid */
|
|
7029
|
-
listingId: string;
|
|
7030
|
-
/** @description Posting date blocked by the statement period */
|
|
7031
|
-
txnAt: string;
|
|
7032
|
-
/** @description First open date for this listing period */
|
|
7033
|
-
openFrom: string;
|
|
7034
|
-
}[];
|
|
7035
|
-
} | null;
|
|
7036
|
-
} | null;
|
|
7037
|
-
}[];
|
|
7038
|
-
/** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
7039
|
-
attachmentIds?: string[] | null;
|
|
7040
|
-
recurringTemplateId?: string | null;
|
|
7041
|
-
matchBankAccountLast4?: string | null;
|
|
7042
|
-
id: string;
|
|
7043
|
-
shortRef?: string | null;
|
|
7044
|
-
lock?: {
|
|
7045
|
-
/**
|
|
7046
|
-
* @description Whether the represented entity or field can be mutated
|
|
7047
|
-
* @enum {string}
|
|
7048
|
-
*/
|
|
7049
|
-
status: "locked" | "unlocked";
|
|
7050
|
-
/** @description Present when books closing blocks the mutation */
|
|
7051
|
-
booksClosed?: {
|
|
7052
|
-
/** @description First open accounting date */
|
|
7053
|
-
date: string;
|
|
7054
|
-
} | null;
|
|
7055
|
-
/** @description Present when journal entries are attached to owner statements */
|
|
7056
|
-
ownerStatement?: {
|
|
7057
|
-
/** @description Owner statements that lock the represented data */
|
|
7058
|
-
ids: string[];
|
|
7059
|
-
} | null;
|
|
7060
|
-
reconciled?: {
|
|
7061
|
-
/** @description Bank records linked through reconciliation */
|
|
7062
|
-
bankRecordIds: string[];
|
|
7063
|
-
} | null;
|
|
7064
|
-
/** @description Listing statement-period conflicts for the represented data */
|
|
7065
|
-
statementPeriod?: {
|
|
7066
|
-
hits: {
|
|
7067
|
-
/** Format: uuid */
|
|
7068
|
-
listingId: string;
|
|
7069
|
-
/** @description Posting date blocked by the statement period */
|
|
7070
|
-
txnAt: string;
|
|
7071
|
-
/** @description First open date for this listing period */
|
|
7072
|
-
openFrom: string;
|
|
7073
|
-
}[];
|
|
7074
|
-
} | null;
|
|
7075
|
-
} | null;
|
|
7076
|
-
issues: ({
|
|
7077
|
-
/** @constant */
|
|
7078
|
-
code: "line_unassignedAccount";
|
|
7079
|
-
/** @constant */
|
|
7080
|
-
severity: "error";
|
|
7081
|
-
context: Record<string, never>;
|
|
7082
|
-
} | {
|
|
7083
|
-
/** @constant */
|
|
7084
|
-
code: "bankAccountLast4Mismatch";
|
|
7085
|
-
/** @constant */
|
|
7086
|
-
severity: "warning";
|
|
7087
|
-
context: {
|
|
7088
|
-
accountLast4: string;
|
|
7089
|
-
transactionLast4: string;
|
|
7090
|
-
};
|
|
7091
|
-
})[];
|
|
7092
|
-
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
7093
|
-
currency: string;
|
|
7094
|
-
/** @description Value in cents (100 = 1€) */
|
|
7095
|
-
amount: number;
|
|
7096
|
-
recurringTemplate?: {
|
|
7097
|
-
id: string;
|
|
7098
|
-
} | null;
|
|
7099
|
-
attachments: {
|
|
7100
|
-
/** Format: uuid */
|
|
7101
|
-
id: string;
|
|
7102
|
-
transactionId: string | null;
|
|
7103
|
-
/**
|
|
7104
|
-
* Format: date-time
|
|
7105
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
7106
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
7107
|
-
*/
|
|
7108
|
-
createdAt: string;
|
|
7109
|
-
filename: string;
|
|
7110
|
-
extension?: string | null;
|
|
7111
|
-
contentType: string;
|
|
7112
|
-
byteSize: number;
|
|
7113
|
-
isOwnerAccessible: boolean;
|
|
7114
|
-
}[];
|
|
7115
|
-
account?: {
|
|
7116
|
-
id: string;
|
|
7117
|
-
name: string;
|
|
7118
|
-
uniqueRef?: string | null;
|
|
7119
|
-
/** @enum {string} */
|
|
7120
|
-
status: "active" | "inactive";
|
|
7121
|
-
} | null;
|
|
7122
|
-
payment: {
|
|
7123
|
-
/** @description Bank records reconciled to this transaction payment */
|
|
7124
|
-
bankRecordIds: string[];
|
|
7125
|
-
/**
|
|
7126
|
-
* @description Expense payment status
|
|
7127
|
-
* @enum {string}
|
|
7128
|
-
*/
|
|
7129
|
-
status: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
7130
|
-
lock?: {
|
|
7131
|
-
/**
|
|
7132
|
-
* @description Whether the represented entity or field can be mutated
|
|
7133
|
-
* @enum {string}
|
|
7134
|
-
*/
|
|
7135
|
-
status: "locked" | "unlocked";
|
|
7136
|
-
/** @description Present when books closing blocks the mutation */
|
|
7137
|
-
booksClosed?: {
|
|
7138
|
-
/** @description First open accounting date */
|
|
7139
|
-
date: string;
|
|
7140
|
-
} | null;
|
|
7141
|
-
/** @description Present when journal entries are attached to owner statements */
|
|
7142
|
-
ownerStatement?: {
|
|
7143
|
-
/** @description Owner statements that lock the represented data */
|
|
7144
|
-
ids: string[];
|
|
7145
|
-
} | null;
|
|
7146
|
-
reconciled?: {
|
|
7147
|
-
/** @description Bank records linked through reconciliation */
|
|
7148
|
-
bankRecordIds: string[];
|
|
7149
|
-
} | null;
|
|
7150
|
-
/** @description Listing statement-period conflicts for the represented data */
|
|
7151
|
-
statementPeriod?: {
|
|
7152
|
-
hits: {
|
|
7153
|
-
/** Format: uuid */
|
|
7154
|
-
listingId: string;
|
|
7155
|
-
/** @description Posting date blocked by the statement period */
|
|
7156
|
-
txnAt: string;
|
|
7157
|
-
/** @description First open date for this listing period */
|
|
7158
|
-
openFrom: string;
|
|
7159
|
-
}[];
|
|
7160
|
-
} | null;
|
|
7161
|
-
} | null;
|
|
7162
|
-
date?: string | null;
|
|
7163
|
-
};
|
|
7164
|
-
connection?: {
|
|
7165
|
-
/** Format: uuid */
|
|
7166
|
-
id: string;
|
|
7167
|
-
name: string;
|
|
7168
|
-
/** @enum {string} */
|
|
7169
|
-
status: "active" | "inactive";
|
|
7170
|
-
uniqueRef?: string | null;
|
|
7171
|
-
appId: string;
|
|
7172
|
-
} | null;
|
|
7173
|
-
contact?: {
|
|
7174
|
-
/** Format: uuid */
|
|
7175
|
-
id: string;
|
|
7176
|
-
name?: string | null;
|
|
7177
|
-
firstName?: string | null;
|
|
7178
|
-
uniqueRef?: string | null;
|
|
7179
|
-
shortRef?: string | null;
|
|
7180
|
-
email?: string | null;
|
|
7181
|
-
/** @enum {string} */
|
|
7182
|
-
type: "owner" | "vendor";
|
|
7183
|
-
} | null;
|
|
7184
|
-
source?: {
|
|
7185
|
-
/** Format: uuid */
|
|
7186
|
-
id: string;
|
|
7187
|
-
type: string;
|
|
7188
|
-
status?: ("active" | "inactive") | null;
|
|
7189
|
-
appId?: string | null;
|
|
7190
|
-
appIcon?: string | null;
|
|
7191
|
-
} | null;
|
|
7192
|
-
matchStatus?: string | null;
|
|
7193
|
-
matchedByBankRule: boolean;
|
|
7194
|
-
};
|
|
7195
|
-
bankRecord: {
|
|
7196
|
-
/** Format: uuid */
|
|
7197
|
-
id: string;
|
|
7198
|
-
uniqueRef?: string | null;
|
|
7199
|
-
date: string;
|
|
7200
|
-
/** @enum {string} */
|
|
7201
|
-
status: "active" | "inactive";
|
|
7202
|
-
description?: string | null;
|
|
7203
|
-
bankAccountId?: string | null;
|
|
7204
|
-
bankAccount?: {
|
|
7205
|
-
/** Format: uuid */
|
|
7206
|
-
id: string;
|
|
7207
|
-
name: string;
|
|
7208
|
-
connectionId?: string | null;
|
|
7209
|
-
} | null;
|
|
7210
|
-
accountId?: string | null;
|
|
7211
|
-
connectionId?: string | null;
|
|
7212
|
-
appId?: string | null;
|
|
7213
|
-
/** @enum {string} */
|
|
7214
|
-
type: "transaction" | "balance";
|
|
7215
|
-
lock: {
|
|
7216
|
-
/** @enum {string} */
|
|
7217
|
-
status: "locked" | "unlocked";
|
|
7218
|
-
delete: {
|
|
7219
|
-
/** @enum {string} */
|
|
7220
|
-
status: "locked" | "unlocked";
|
|
7221
|
-
reasons: ("notCsvSource" | "plaidSource" | "reconciled" | "balanceRecord" | "bankRuleMatched")[];
|
|
7222
|
-
};
|
|
7223
|
-
};
|
|
7224
|
-
/** @description Value in cents (100 = 1€) */
|
|
7225
|
-
amount: number;
|
|
7226
|
-
balance: {
|
|
7227
|
-
current: number;
|
|
7228
|
-
correction: number;
|
|
7229
|
-
};
|
|
7230
|
-
reconciliation: {
|
|
7231
|
-
status?: ("unpaid" | "underpaid" | "overpaid" | "paid") | null;
|
|
7232
|
-
transactions?: {
|
|
7233
|
-
id: string;
|
|
7234
|
-
date: string;
|
|
7235
|
-
description?: string | null;
|
|
7236
|
-
type: string;
|
|
7237
|
-
amount: number;
|
|
7238
|
-
}[] | null;
|
|
7239
|
-
};
|
|
7240
|
-
};
|
|
6807
|
+
url: string;
|
|
7241
6808
|
};
|
|
7242
6809
|
};
|
|
7243
6810
|
};
|
|
@@ -7375,7 +6942,7 @@ export interface operations {
|
|
|
7375
6942
|
};
|
|
7376
6943
|
};
|
|
7377
6944
|
};
|
|
7378
|
-
|
|
6945
|
+
getAccountsById: {
|
|
7379
6946
|
parameters: {
|
|
7380
6947
|
query?: never;
|
|
7381
6948
|
header?: never;
|
|
@@ -7384,20 +6951,7 @@ export interface operations {
|
|
|
7384
6951
|
};
|
|
7385
6952
|
cookie?: never;
|
|
7386
6953
|
};
|
|
7387
|
-
requestBody?:
|
|
7388
|
-
content: {
|
|
7389
|
-
"application/json": {
|
|
7390
|
-
/** Format: uuid */
|
|
7391
|
-
bankAccountId: string;
|
|
7392
|
-
startDate: string;
|
|
7393
|
-
/**
|
|
7394
|
-
* @default error
|
|
7395
|
-
* @enum {string}
|
|
7396
|
-
*/
|
|
7397
|
-
onConflict?: "error" | "replace" | "replace-and-detach-history";
|
|
7398
|
-
};
|
|
7399
|
-
};
|
|
7400
|
-
};
|
|
6954
|
+
requestBody?: never;
|
|
7401
6955
|
responses: {
|
|
7402
6956
|
/** @description Successful response */
|
|
7403
6957
|
200: {
|
|
@@ -7434,13 +6988,13 @@ export interface operations {
|
|
|
7434
6988
|
};
|
|
7435
6989
|
issues: ({
|
|
7436
6990
|
/** @constant */
|
|
7437
|
-
code: "
|
|
6991
|
+
code: "accountConnectionLast4OutOfSync";
|
|
7438
6992
|
/** @constant */
|
|
7439
6993
|
severity: "warning";
|
|
7440
6994
|
context: {
|
|
7441
6995
|
accountLast4?: string | null;
|
|
7442
|
-
|
|
7443
|
-
|
|
6996
|
+
accountConnectionLast4: string;
|
|
6997
|
+
accountConnectionIds: string[];
|
|
7444
6998
|
};
|
|
7445
6999
|
} | {
|
|
7446
7000
|
/** @constant */
|
|
@@ -7646,9 +7200,12 @@ export interface operations {
|
|
|
7646
7200
|
};
|
|
7647
7201
|
};
|
|
7648
7202
|
};
|
|
7649
|
-
|
|
7203
|
+
putAccountsById: {
|
|
7650
7204
|
parameters: {
|
|
7651
|
-
query?:
|
|
7205
|
+
query?: {
|
|
7206
|
+
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
7207
|
+
dryRun?: boolean;
|
|
7208
|
+
};
|
|
7652
7209
|
header?: never;
|
|
7653
7210
|
path: {
|
|
7654
7211
|
id: string;
|
|
@@ -7658,13 +7215,21 @@ export interface operations {
|
|
|
7658
7215
|
requestBody?: {
|
|
7659
7216
|
content: {
|
|
7660
7217
|
"application/json": {
|
|
7661
|
-
|
|
7662
|
-
|
|
7663
|
-
|
|
7664
|
-
|
|
7665
|
-
|
|
7666
|
-
|
|
7667
|
-
|
|
7218
|
+
name?: string;
|
|
7219
|
+
/** @enum {string} */
|
|
7220
|
+
status?: "active" | "inactive";
|
|
7221
|
+
/** @enum {string} */
|
|
7222
|
+
type?: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
7223
|
+
assignments?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution")[] | null;
|
|
7224
|
+
offsetAccountId?: string | null;
|
|
7225
|
+
categoryId?: string;
|
|
7226
|
+
banking?: {
|
|
7227
|
+
category?: ("trust" | "operating" | "external") | null;
|
|
7228
|
+
type?: ("deposit" | "creditCard") | null;
|
|
7229
|
+
last4?: string | null;
|
|
7230
|
+
currency?: string | null;
|
|
7231
|
+
} | null;
|
|
7232
|
+
uniqueRef?: string | null;
|
|
7668
7233
|
};
|
|
7669
7234
|
};
|
|
7670
7235
|
};
|
|
@@ -7704,13 +7269,13 @@ export interface operations {
|
|
|
7704
7269
|
};
|
|
7705
7270
|
issues: ({
|
|
7706
7271
|
/** @constant */
|
|
7707
|
-
code: "
|
|
7272
|
+
code: "accountConnectionLast4OutOfSync";
|
|
7708
7273
|
/** @constant */
|
|
7709
7274
|
severity: "warning";
|
|
7710
7275
|
context: {
|
|
7711
7276
|
accountLast4?: string | null;
|
|
7712
|
-
|
|
7713
|
-
|
|
7277
|
+
accountConnectionLast4: string;
|
|
7278
|
+
accountConnectionIds: string[];
|
|
7714
7279
|
};
|
|
7715
7280
|
} | {
|
|
7716
7281
|
/** @constant */
|
|
@@ -7916,9 +7481,13 @@ export interface operations {
|
|
|
7916
7481
|
};
|
|
7917
7482
|
};
|
|
7918
7483
|
};
|
|
7919
|
-
|
|
7484
|
+
deleteAccountsById: {
|
|
7920
7485
|
parameters: {
|
|
7921
|
-
query?:
|
|
7486
|
+
query?: {
|
|
7487
|
+
onLocked?: "error" | "archive";
|
|
7488
|
+
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
7489
|
+
dryRun?: boolean;
|
|
7490
|
+
};
|
|
7922
7491
|
header?: never;
|
|
7923
7492
|
path: {
|
|
7924
7493
|
id: string;
|
|
@@ -7938,7 +7507,8 @@ export interface operations {
|
|
|
7938
7507
|
};
|
|
7939
7508
|
content: {
|
|
7940
7509
|
"application/json": {
|
|
7941
|
-
|
|
7510
|
+
/** @enum {string} */
|
|
7511
|
+
status: "deleted" | "archived";
|
|
7942
7512
|
};
|
|
7943
7513
|
};
|
|
7944
7514
|
};
|
|
@@ -8076,11 +7646,11 @@ export interface operations {
|
|
|
8076
7646
|
};
|
|
8077
7647
|
};
|
|
8078
7648
|
};
|
|
8079
|
-
|
|
7649
|
+
postAccountsByIdBankingInit: {
|
|
8080
7650
|
parameters: {
|
|
8081
|
-
query
|
|
8082
|
-
/** @description
|
|
8083
|
-
|
|
7651
|
+
query?: {
|
|
7652
|
+
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
7653
|
+
dryRun?: boolean;
|
|
8084
7654
|
};
|
|
8085
7655
|
header?: never;
|
|
8086
7656
|
path: {
|
|
@@ -8088,7 +7658,14 @@ export interface operations {
|
|
|
8088
7658
|
};
|
|
8089
7659
|
cookie?: never;
|
|
8090
7660
|
};
|
|
8091
|
-
requestBody?:
|
|
7661
|
+
requestBody?: {
|
|
7662
|
+
content: {
|
|
7663
|
+
"application/json": {
|
|
7664
|
+
startingBalanceDate: string;
|
|
7665
|
+
startingBalanceAmount: number;
|
|
7666
|
+
};
|
|
7667
|
+
};
|
|
7668
|
+
};
|
|
8092
7669
|
responses: {
|
|
8093
7670
|
/** @description Successful response */
|
|
8094
7671
|
200: {
|
|
@@ -8097,208 +7674,346 @@ export interface operations {
|
|
|
8097
7674
|
};
|
|
8098
7675
|
content: {
|
|
8099
7676
|
"application/json": {
|
|
8100
|
-
|
|
8101
|
-
|
|
8102
|
-
|
|
7677
|
+
id: string;
|
|
7678
|
+
archivedRecords: number;
|
|
7679
|
+
unArchivedRecords: number;
|
|
7680
|
+
transaction: {
|
|
7681
|
+
description: string;
|
|
7682
|
+
/** @enum {string} */
|
|
7683
|
+
status: "active" | "inactive";
|
|
7684
|
+
uniqueRef?: string | null;
|
|
7685
|
+
isOpeningBalance: boolean;
|
|
7686
|
+
/** @enum {string} */
|
|
7687
|
+
type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
|
|
7688
|
+
date: string;
|
|
7689
|
+
lines: {
|
|
7690
|
+
uniqueRef?: string | null;
|
|
7691
|
+
description: string;
|
|
7692
|
+
/** @description System account purpose used to resolve or validate the posting account */
|
|
7693
|
+
assignment?: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution") | null;
|
|
7694
|
+
/** @description Value in cents (100 = 1€) */
|
|
7695
|
+
amount: number;
|
|
7696
|
+
/** @description Persisted owner statement linked to a payout line */
|
|
7697
|
+
ownerStatementId?: string | null;
|
|
7698
|
+
matchReservationConfirmationCode?: string | null;
|
|
7699
|
+
matchReservationStripeGuestRef?: string | null;
|
|
7700
|
+
matchReservationProcessorBookingRef?: string | null;
|
|
7701
|
+
matchLineTypeClassification?: string | null;
|
|
8103
7702
|
id: string;
|
|
8104
|
-
|
|
7703
|
+
issues: {
|
|
7704
|
+
/** @constant */
|
|
7705
|
+
code: "unassignedAccount";
|
|
7706
|
+
/** @constant */
|
|
7707
|
+
severity: "error";
|
|
7708
|
+
context: {
|
|
7709
|
+
lineType: string;
|
|
7710
|
+
};
|
|
7711
|
+
}[];
|
|
7712
|
+
recurringTemplate?: {
|
|
7713
|
+
id: string;
|
|
7714
|
+
} | null;
|
|
7715
|
+
total: number;
|
|
7716
|
+
listing?: {
|
|
7717
|
+
/** Format: uuid */
|
|
7718
|
+
id: string;
|
|
7719
|
+
name: string;
|
|
7720
|
+
uniqueRef?: string | null;
|
|
7721
|
+
shortRef?: string | null;
|
|
7722
|
+
} | null;
|
|
7723
|
+
reservation?: {
|
|
7724
|
+
id: string;
|
|
7725
|
+
shortRef?: string | null;
|
|
7726
|
+
confirmationCode?: string | null;
|
|
7727
|
+
uniqueRef: string;
|
|
7728
|
+
/** @enum {string} */
|
|
7729
|
+
status: "booked" | "canceled" | "inactive";
|
|
7730
|
+
checkIn?: string | null;
|
|
7731
|
+
checkOut?: string | null;
|
|
7732
|
+
} | null;
|
|
7733
|
+
account?: {
|
|
7734
|
+
id: string;
|
|
7735
|
+
name: string;
|
|
7736
|
+
uniqueRef?: string | null;
|
|
7737
|
+
/** @enum {string} */
|
|
7738
|
+
status: "active" | "inactive";
|
|
7739
|
+
} | null;
|
|
7740
|
+
/**
|
|
7741
|
+
* @description Accounting attribution: owners affects owner-side balances and statements; manager affects manager-side accounting
|
|
7742
|
+
* @enum {string}
|
|
7743
|
+
*/
|
|
7744
|
+
party: "owners" | "manager";
|
|
7745
|
+
contact?: {
|
|
7746
|
+
/** Format: uuid */
|
|
7747
|
+
id: string;
|
|
7748
|
+
name?: string | null;
|
|
7749
|
+
firstName?: string | null;
|
|
7750
|
+
uniqueRef?: string | null;
|
|
7751
|
+
shortRef?: string | null;
|
|
7752
|
+
email?: string | null;
|
|
7753
|
+
/** @enum {string} */
|
|
7754
|
+
type: "owner" | "vendor";
|
|
7755
|
+
} | null;
|
|
7756
|
+
matchStatus?: string | null;
|
|
7757
|
+
appliedAmount?: {
|
|
7758
|
+
taxBehavior?: ("excluded" | "included") | null;
|
|
7759
|
+
taxRate?: {
|
|
7760
|
+
id: string;
|
|
7761
|
+
name: string;
|
|
7762
|
+
/**
|
|
7763
|
+
* @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
|
|
7764
|
+
* @example 100000
|
|
7765
|
+
*/
|
|
7766
|
+
basisPoints: number;
|
|
7767
|
+
} | null;
|
|
7768
|
+
} | null;
|
|
7769
|
+
markup?: {
|
|
7770
|
+
amount?: number | null;
|
|
7771
|
+
taxBehavior?: ("excluded" | "included") | null;
|
|
7772
|
+
taxRate?: {
|
|
7773
|
+
id: string;
|
|
7774
|
+
name: string;
|
|
7775
|
+
/**
|
|
7776
|
+
* @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%)
|
|
7777
|
+
* @example 100000
|
|
7778
|
+
*/
|
|
7779
|
+
basisPoints: number;
|
|
7780
|
+
} | null;
|
|
7781
|
+
} | null;
|
|
7782
|
+
lock?: {
|
|
7783
|
+
/**
|
|
7784
|
+
* @description Whether the represented entity or field can be mutated
|
|
7785
|
+
* @enum {string}
|
|
7786
|
+
*/
|
|
7787
|
+
status: "locked" | "unlocked";
|
|
7788
|
+
/** @description Present when books closing blocks the mutation */
|
|
7789
|
+
booksClosed?: {
|
|
7790
|
+
/** @description First open accounting date */
|
|
7791
|
+
date: string;
|
|
7792
|
+
} | null;
|
|
7793
|
+
/** @description Present when journal entries are attached to owner statements */
|
|
7794
|
+
ownerStatement?: {
|
|
7795
|
+
/** @description Owner statements that lock the represented data */
|
|
7796
|
+
ids: string[];
|
|
7797
|
+
} | null;
|
|
7798
|
+
reconciled?: {
|
|
7799
|
+
/** @description Bank records linked through reconciliation */
|
|
7800
|
+
bankRecordIds: string[];
|
|
7801
|
+
} | null;
|
|
7802
|
+
/** @description Listing statement-period conflicts for the represented data */
|
|
7803
|
+
statementPeriod?: {
|
|
7804
|
+
hits: {
|
|
7805
|
+
/** Format: uuid */
|
|
7806
|
+
listingId: string;
|
|
7807
|
+
/** @description Posting date blocked by the statement period */
|
|
7808
|
+
txnAt: string;
|
|
7809
|
+
/** @description First open date for this listing period */
|
|
7810
|
+
openFrom: string;
|
|
7811
|
+
}[];
|
|
7812
|
+
} | null;
|
|
7813
|
+
} | null;
|
|
8105
7814
|
}[];
|
|
8106
|
-
transactions
|
|
7815
|
+
/** @description Expense attachment IDs returned by POST /transactions/attachments. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
7816
|
+
attachmentIds?: string[] | null;
|
|
7817
|
+
recurringTemplateId?: string | null;
|
|
7818
|
+
matchBankAccountLast4?: string | null;
|
|
7819
|
+
id: string;
|
|
7820
|
+
shortRef?: string | null;
|
|
7821
|
+
lock?: {
|
|
7822
|
+
/**
|
|
7823
|
+
* @description Whether the represented entity or field can be mutated
|
|
7824
|
+
* @enum {string}
|
|
7825
|
+
*/
|
|
7826
|
+
status: "locked" | "unlocked";
|
|
7827
|
+
/** @description Present when books closing blocks the mutation */
|
|
7828
|
+
booksClosed?: {
|
|
7829
|
+
/** @description First open accounting date */
|
|
7830
|
+
date: string;
|
|
7831
|
+
} | null;
|
|
7832
|
+
/** @description Present when journal entries are attached to owner statements */
|
|
7833
|
+
ownerStatement?: {
|
|
7834
|
+
/** @description Owner statements that lock the represented data */
|
|
7835
|
+
ids: string[];
|
|
7836
|
+
} | null;
|
|
7837
|
+
reconciled?: {
|
|
7838
|
+
/** @description Bank records linked through reconciliation */
|
|
7839
|
+
bankRecordIds: string[];
|
|
7840
|
+
} | null;
|
|
7841
|
+
/** @description Listing statement-period conflicts for the represented data */
|
|
7842
|
+
statementPeriod?: {
|
|
7843
|
+
hits: {
|
|
7844
|
+
/** Format: uuid */
|
|
7845
|
+
listingId: string;
|
|
7846
|
+
/** @description Posting date blocked by the statement period */
|
|
7847
|
+
txnAt: string;
|
|
7848
|
+
/** @description First open date for this listing period */
|
|
7849
|
+
openFrom: string;
|
|
7850
|
+
}[];
|
|
7851
|
+
} | null;
|
|
7852
|
+
} | null;
|
|
7853
|
+
issues: ({
|
|
7854
|
+
/** @constant */
|
|
7855
|
+
code: "line_unassignedAccount";
|
|
7856
|
+
/** @constant */
|
|
7857
|
+
severity: "error";
|
|
7858
|
+
context: Record<string, never>;
|
|
7859
|
+
} | {
|
|
7860
|
+
/** @constant */
|
|
7861
|
+
code: "bankAccountLast4Mismatch";
|
|
7862
|
+
/** @constant */
|
|
7863
|
+
severity: "warning";
|
|
7864
|
+
context: {
|
|
7865
|
+
accountLast4: string;
|
|
7866
|
+
transactionLast4: string;
|
|
7867
|
+
};
|
|
7868
|
+
})[];
|
|
7869
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
7870
|
+
currency: string;
|
|
7871
|
+
/** @description Value in cents (100 = 1€) */
|
|
7872
|
+
amount: number;
|
|
7873
|
+
recurringTemplate?: {
|
|
7874
|
+
id: string;
|
|
7875
|
+
} | null;
|
|
7876
|
+
attachments: {
|
|
8107
7877
|
/** Format: uuid */
|
|
8108
7878
|
id: string;
|
|
8109
|
-
|
|
7879
|
+
transactionId: string | null;
|
|
7880
|
+
/**
|
|
7881
|
+
* Format: date-time
|
|
7882
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
7883
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
7884
|
+
*/
|
|
7885
|
+
createdAt: string;
|
|
7886
|
+
filename: string;
|
|
7887
|
+
extension?: string | null;
|
|
7888
|
+
contentType: string;
|
|
7889
|
+
byteSize: number;
|
|
7890
|
+
isOwnerAccessible: boolean;
|
|
8110
7891
|
}[];
|
|
7892
|
+
account?: {
|
|
7893
|
+
id: string;
|
|
7894
|
+
name: string;
|
|
7895
|
+
uniqueRef?: string | null;
|
|
7896
|
+
/** @enum {string} */
|
|
7897
|
+
status: "active" | "inactive";
|
|
7898
|
+
} | null;
|
|
7899
|
+
payment: {
|
|
7900
|
+
/** @description Bank records reconciled to this transaction payment */
|
|
7901
|
+
bankRecordIds: string[];
|
|
7902
|
+
/**
|
|
7903
|
+
* @description Expense payment status
|
|
7904
|
+
* @enum {string}
|
|
7905
|
+
*/
|
|
7906
|
+
status: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
7907
|
+
lock?: {
|
|
7908
|
+
/**
|
|
7909
|
+
* @description Whether the represented entity or field can be mutated
|
|
7910
|
+
* @enum {string}
|
|
7911
|
+
*/
|
|
7912
|
+
status: "locked" | "unlocked";
|
|
7913
|
+
/** @description Present when books closing blocks the mutation */
|
|
7914
|
+
booksClosed?: {
|
|
7915
|
+
/** @description First open accounting date */
|
|
7916
|
+
date: string;
|
|
7917
|
+
} | null;
|
|
7918
|
+
/** @description Present when journal entries are attached to owner statements */
|
|
7919
|
+
ownerStatement?: {
|
|
7920
|
+
/** @description Owner statements that lock the represented data */
|
|
7921
|
+
ids: string[];
|
|
7922
|
+
} | null;
|
|
7923
|
+
reconciled?: {
|
|
7924
|
+
/** @description Bank records linked through reconciliation */
|
|
7925
|
+
bankRecordIds: string[];
|
|
7926
|
+
} | null;
|
|
7927
|
+
/** @description Listing statement-period conflicts for the represented data */
|
|
7928
|
+
statementPeriod?: {
|
|
7929
|
+
hits: {
|
|
7930
|
+
/** Format: uuid */
|
|
7931
|
+
listingId: string;
|
|
7932
|
+
/** @description Posting date blocked by the statement period */
|
|
7933
|
+
txnAt: string;
|
|
7934
|
+
/** @description First open date for this listing period */
|
|
7935
|
+
openFrom: string;
|
|
7936
|
+
}[];
|
|
7937
|
+
} | null;
|
|
7938
|
+
} | null;
|
|
7939
|
+
date?: string | null;
|
|
7940
|
+
};
|
|
7941
|
+
connection?: {
|
|
7942
|
+
/** Format: uuid */
|
|
7943
|
+
id: string;
|
|
7944
|
+
name: string;
|
|
7945
|
+
/** @enum {string} */
|
|
7946
|
+
status: "active" | "inactive";
|
|
7947
|
+
uniqueRef?: string | null;
|
|
7948
|
+
appId: string;
|
|
7949
|
+
} | null;
|
|
7950
|
+
contact?: {
|
|
7951
|
+
/** Format: uuid */
|
|
7952
|
+
id: string;
|
|
7953
|
+
name?: string | null;
|
|
7954
|
+
firstName?: string | null;
|
|
7955
|
+
uniqueRef?: string | null;
|
|
7956
|
+
shortRef?: string | null;
|
|
7957
|
+
email?: string | null;
|
|
7958
|
+
/** @enum {string} */
|
|
7959
|
+
type: "owner" | "vendor";
|
|
7960
|
+
} | null;
|
|
7961
|
+
source?: {
|
|
7962
|
+
/** Format: uuid */
|
|
7963
|
+
id: string;
|
|
7964
|
+
type: string;
|
|
7965
|
+
status?: ("active" | "inactive") | null;
|
|
7966
|
+
appId?: string | null;
|
|
7967
|
+
appIcon?: string | null;
|
|
7968
|
+
} | null;
|
|
7969
|
+
matchStatus?: string | null;
|
|
7970
|
+
matchedByBankRule: boolean;
|
|
8111
7971
|
};
|
|
8112
|
-
|
|
8113
|
-
bankAccountBalance: number;
|
|
8114
|
-
bookBalance: number;
|
|
8115
|
-
unclearedTransactionsBalance: number;
|
|
8116
|
-
unmatchedTransactionsBalance: number;
|
|
8117
|
-
unmatchedBankRecordsBalance: number;
|
|
8118
|
-
adjustedBankAccountBalance: number;
|
|
8119
|
-
difference: number;
|
|
8120
|
-
};
|
|
8121
|
-
};
|
|
8122
|
-
};
|
|
8123
|
-
};
|
|
8124
|
-
/** @description Bad request */
|
|
8125
|
-
400: {
|
|
8126
|
-
headers: {
|
|
8127
|
-
[name: string]: unknown;
|
|
8128
|
-
};
|
|
8129
|
-
content: {
|
|
8130
|
-
"application/json": {
|
|
8131
|
-
code: string;
|
|
8132
|
-
message: string;
|
|
8133
|
-
links?: {
|
|
8134
|
-
docs: string;
|
|
8135
|
-
schema: string;
|
|
8136
|
-
};
|
|
8137
|
-
issues?: {
|
|
8138
|
-
message: string;
|
|
8139
|
-
path?: (string | number)[];
|
|
8140
|
-
schema?: string;
|
|
8141
|
-
}[];
|
|
8142
|
-
context?: unknown;
|
|
8143
|
-
};
|
|
8144
|
-
};
|
|
8145
|
-
};
|
|
8146
|
-
/** @description Unauthorized */
|
|
8147
|
-
401: {
|
|
8148
|
-
headers: {
|
|
8149
|
-
[name: string]: unknown;
|
|
8150
|
-
};
|
|
8151
|
-
content: {
|
|
8152
|
-
"application/json": {
|
|
8153
|
-
code: string;
|
|
8154
|
-
message: string;
|
|
8155
|
-
links?: {
|
|
8156
|
-
docs: string;
|
|
8157
|
-
schema: string;
|
|
8158
|
-
};
|
|
8159
|
-
issues?: {
|
|
8160
|
-
message: string;
|
|
8161
|
-
path?: (string | number)[];
|
|
8162
|
-
schema?: string;
|
|
8163
|
-
}[];
|
|
8164
|
-
context?: unknown;
|
|
8165
|
-
};
|
|
8166
|
-
};
|
|
8167
|
-
};
|
|
8168
|
-
/** @description Forbidden */
|
|
8169
|
-
403: {
|
|
8170
|
-
headers: {
|
|
8171
|
-
[name: string]: unknown;
|
|
8172
|
-
};
|
|
8173
|
-
content: {
|
|
8174
|
-
"application/json": {
|
|
8175
|
-
code: string;
|
|
8176
|
-
message: string;
|
|
8177
|
-
links?: {
|
|
8178
|
-
docs: string;
|
|
8179
|
-
schema: string;
|
|
8180
|
-
};
|
|
8181
|
-
issues?: {
|
|
8182
|
-
message: string;
|
|
8183
|
-
path?: (string | number)[];
|
|
8184
|
-
schema?: string;
|
|
8185
|
-
}[];
|
|
8186
|
-
context?: unknown;
|
|
8187
|
-
};
|
|
8188
|
-
};
|
|
8189
|
-
};
|
|
8190
|
-
/** @description Not found */
|
|
8191
|
-
404: {
|
|
8192
|
-
headers: {
|
|
8193
|
-
[name: string]: unknown;
|
|
8194
|
-
};
|
|
8195
|
-
content: {
|
|
8196
|
-
"application/json": {
|
|
8197
|
-
code: string;
|
|
8198
|
-
message: string;
|
|
8199
|
-
links?: {
|
|
8200
|
-
docs: string;
|
|
8201
|
-
schema: string;
|
|
8202
|
-
};
|
|
8203
|
-
issues?: {
|
|
8204
|
-
message: string;
|
|
8205
|
-
path?: (string | number)[];
|
|
8206
|
-
schema?: string;
|
|
8207
|
-
}[];
|
|
8208
|
-
context?: unknown;
|
|
8209
|
-
};
|
|
8210
|
-
};
|
|
8211
|
-
};
|
|
8212
|
-
/** @description Internal server error */
|
|
8213
|
-
500: {
|
|
8214
|
-
headers: {
|
|
8215
|
-
[name: string]: unknown;
|
|
8216
|
-
};
|
|
8217
|
-
content: {
|
|
8218
|
-
"application/json": {
|
|
8219
|
-
code: string;
|
|
8220
|
-
message: string;
|
|
8221
|
-
links?: {
|
|
8222
|
-
docs: string;
|
|
8223
|
-
schema: string;
|
|
8224
|
-
};
|
|
8225
|
-
issues?: {
|
|
8226
|
-
message: string;
|
|
8227
|
-
path?: (string | number)[];
|
|
8228
|
-
schema?: string;
|
|
8229
|
-
}[];
|
|
8230
|
-
context?: unknown;
|
|
8231
|
-
};
|
|
8232
|
-
};
|
|
8233
|
-
};
|
|
8234
|
-
/** @description Service unavailable */
|
|
8235
|
-
503: {
|
|
8236
|
-
headers: {
|
|
8237
|
-
[name: string]: unknown;
|
|
8238
|
-
};
|
|
8239
|
-
content: {
|
|
8240
|
-
"application/json": {
|
|
8241
|
-
code: string;
|
|
8242
|
-
message: string;
|
|
8243
|
-
links?: {
|
|
8244
|
-
docs: string;
|
|
8245
|
-
schema: string;
|
|
8246
|
-
};
|
|
8247
|
-
issues?: {
|
|
8248
|
-
message: string;
|
|
8249
|
-
path?: (string | number)[];
|
|
8250
|
-
schema?: string;
|
|
8251
|
-
}[];
|
|
8252
|
-
context?: unknown;
|
|
8253
|
-
};
|
|
8254
|
-
};
|
|
8255
|
-
};
|
|
8256
|
-
};
|
|
8257
|
-
};
|
|
8258
|
-
getApiTokens: {
|
|
8259
|
-
parameters: {
|
|
8260
|
-
query?: {
|
|
8261
|
-
limit?: number;
|
|
8262
|
-
page?: number;
|
|
8263
|
-
offset?: number;
|
|
8264
|
-
};
|
|
8265
|
-
header?: never;
|
|
8266
|
-
path?: never;
|
|
8267
|
-
cookie?: never;
|
|
8268
|
-
};
|
|
8269
|
-
requestBody?: never;
|
|
8270
|
-
responses: {
|
|
8271
|
-
/** @description Successful response */
|
|
8272
|
-
200: {
|
|
8273
|
-
headers: {
|
|
8274
|
-
[name: string]: unknown;
|
|
8275
|
-
};
|
|
8276
|
-
content: {
|
|
8277
|
-
"application/json": {
|
|
8278
|
-
data: {
|
|
8279
|
-
allowedIpCidrs: string[];
|
|
8280
|
-
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")[];
|
|
7972
|
+
bankRecord: {
|
|
8281
7973
|
/** Format: uuid */
|
|
8282
7974
|
id: string;
|
|
8283
|
-
|
|
8284
|
-
|
|
8285
|
-
|
|
8286
|
-
|
|
8287
|
-
|
|
8288
|
-
|
|
8289
|
-
|
|
8290
|
-
|
|
8291
|
-
|
|
8292
|
-
|
|
8293
|
-
|
|
8294
|
-
|
|
8295
|
-
|
|
8296
|
-
|
|
8297
|
-
|
|
8298
|
-
|
|
8299
|
-
|
|
8300
|
-
|
|
8301
|
-
|
|
7975
|
+
uniqueRef?: string | null;
|
|
7976
|
+
date: string;
|
|
7977
|
+
/** @enum {string} */
|
|
7978
|
+
status: "active" | "inactive";
|
|
7979
|
+
description?: string | null;
|
|
7980
|
+
accountConnectionId?: string | null;
|
|
7981
|
+
accountConnection?: {
|
|
7982
|
+
/** Format: uuid */
|
|
7983
|
+
id: string;
|
|
7984
|
+
name: string;
|
|
7985
|
+
connectionId?: string | null;
|
|
7986
|
+
} | null;
|
|
7987
|
+
accountId?: string | null;
|
|
7988
|
+
connectionId?: string | null;
|
|
7989
|
+
appId?: string | null;
|
|
7990
|
+
/** @enum {string} */
|
|
7991
|
+
type: "transaction" | "balance";
|
|
7992
|
+
lock: {
|
|
7993
|
+
/** @enum {string} */
|
|
7994
|
+
status: "locked" | "unlocked";
|
|
7995
|
+
delete: {
|
|
7996
|
+
/** @enum {string} */
|
|
7997
|
+
status: "locked" | "unlocked";
|
|
7998
|
+
reasons: ("notCsvSource" | "plaidSource" | "reconciled" | "balanceRecord" | "bankRuleMatched")[];
|
|
7999
|
+
};
|
|
8000
|
+
};
|
|
8001
|
+
/** @description Value in cents (100 = 1€) */
|
|
8002
|
+
amount: number;
|
|
8003
|
+
balance: {
|
|
8004
|
+
current: number;
|
|
8005
|
+
correction: number;
|
|
8006
|
+
};
|
|
8007
|
+
reconciliation: {
|
|
8008
|
+
status?: ("unpaid" | "underpaid" | "overpaid" | "paid") | null;
|
|
8009
|
+
transactions?: {
|
|
8010
|
+
id: string;
|
|
8011
|
+
date: string;
|
|
8012
|
+
description?: string | null;
|
|
8013
|
+
type: string;
|
|
8014
|
+
amount: number;
|
|
8015
|
+
}[] | null;
|
|
8016
|
+
};
|
|
8302
8017
|
};
|
|
8303
8018
|
};
|
|
8304
8019
|
};
|
|
@@ -8437,20 +8152,26 @@ export interface operations {
|
|
|
8437
8152
|
};
|
|
8438
8153
|
};
|
|
8439
8154
|
};
|
|
8440
|
-
|
|
8155
|
+
postAccountsByIdConnections: {
|
|
8441
8156
|
parameters: {
|
|
8442
8157
|
query?: never;
|
|
8443
8158
|
header?: never;
|
|
8444
|
-
path
|
|
8159
|
+
path: {
|
|
8160
|
+
id: string;
|
|
8161
|
+
};
|
|
8445
8162
|
cookie?: never;
|
|
8446
8163
|
};
|
|
8447
8164
|
requestBody?: {
|
|
8448
8165
|
content: {
|
|
8449
8166
|
"application/json": {
|
|
8450
|
-
/**
|
|
8451
|
-
|
|
8452
|
-
|
|
8453
|
-
|
|
8167
|
+
/** Format: uuid */
|
|
8168
|
+
accountConnectionId: string;
|
|
8169
|
+
startDate: string;
|
|
8170
|
+
/**
|
|
8171
|
+
* @default error
|
|
8172
|
+
* @enum {string}
|
|
8173
|
+
*/
|
|
8174
|
+
onConflict?: "error" | "replace" | "replace-and-detach-history";
|
|
8454
8175
|
};
|
|
8455
8176
|
};
|
|
8456
8177
|
};
|
|
@@ -8462,21 +8183,109 @@ export interface operations {
|
|
|
8462
8183
|
};
|
|
8463
8184
|
content: {
|
|
8464
8185
|
"application/json": {
|
|
8465
|
-
|
|
8466
|
-
|
|
8467
|
-
|
|
8186
|
+
name: string;
|
|
8187
|
+
/** @enum {string} */
|
|
8188
|
+
status?: "active" | "inactive";
|
|
8189
|
+
/** @enum {string} */
|
|
8190
|
+
type: "ledger" | "bank" | "recurringFee" | "nonPosting";
|
|
8191
|
+
uniqueRef?: string | null;
|
|
8468
8192
|
id: string;
|
|
8469
|
-
|
|
8470
|
-
|
|
8471
|
-
|
|
8472
|
-
|
|
8473
|
-
|
|
8474
|
-
|
|
8475
|
-
|
|
8476
|
-
|
|
8477
|
-
|
|
8478
|
-
|
|
8479
|
-
|
|
8193
|
+
offsetAccount?: {
|
|
8194
|
+
id: string;
|
|
8195
|
+
name: string;
|
|
8196
|
+
uniqueRef?: string | null;
|
|
8197
|
+
/** @enum {string} */
|
|
8198
|
+
status: "active" | "inactive";
|
|
8199
|
+
} | null;
|
|
8200
|
+
assignments: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution")[];
|
|
8201
|
+
category?: {
|
|
8202
|
+
id: string;
|
|
8203
|
+
name: string;
|
|
8204
|
+
classification?: ("asset" | "liability" | "revenue" | "expense") | null;
|
|
8205
|
+
} | null;
|
|
8206
|
+
categoryLock: {
|
|
8207
|
+
/** @constant */
|
|
8208
|
+
status: "locked";
|
|
8209
|
+
/** @constant */
|
|
8210
|
+
reason: "immutable";
|
|
8211
|
+
};
|
|
8212
|
+
issues: ({
|
|
8213
|
+
/** @constant */
|
|
8214
|
+
code: "accountConnectionLast4OutOfSync";
|
|
8215
|
+
/** @constant */
|
|
8216
|
+
severity: "warning";
|
|
8217
|
+
context: {
|
|
8218
|
+
accountLast4?: string | null;
|
|
8219
|
+
accountConnectionLast4: string;
|
|
8220
|
+
accountConnectionIds: string[];
|
|
8221
|
+
};
|
|
8222
|
+
} | {
|
|
8223
|
+
/** @constant */
|
|
8224
|
+
code: "operatingBankAccountRequiresOpex";
|
|
8225
|
+
/** @constant */
|
|
8226
|
+
severity: "error";
|
|
8227
|
+
context: {
|
|
8228
|
+
/** @constant */
|
|
8229
|
+
bankingCategory: "operating";
|
|
8230
|
+
};
|
|
8231
|
+
})[];
|
|
8232
|
+
banking?: {
|
|
8233
|
+
category?: ("trust" | "operating" | "external") | null;
|
|
8234
|
+
type?: ("deposit" | "creditCard") | null;
|
|
8235
|
+
last4?: string | null;
|
|
8236
|
+
currency?: string | null;
|
|
8237
|
+
connections: {
|
|
8238
|
+
id: string;
|
|
8239
|
+
name: string;
|
|
8240
|
+
startDate?: string | null;
|
|
8241
|
+
connection?: {
|
|
8242
|
+
id: string;
|
|
8243
|
+
appId: string;
|
|
8244
|
+
name: string;
|
|
8245
|
+
/** @enum {string} */
|
|
8246
|
+
status: "active" | "inactive";
|
|
8247
|
+
isErrorState: boolean;
|
|
8248
|
+
icon?: string | null;
|
|
8249
|
+
} | null;
|
|
8250
|
+
status?: ("active" | "inactive") | null;
|
|
8251
|
+
currentSync?: {
|
|
8252
|
+
/** @enum {string} */
|
|
8253
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
8254
|
+
/**
|
|
8255
|
+
* Format: date-time
|
|
8256
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
8257
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
8258
|
+
*/
|
|
8259
|
+
createdAt: string;
|
|
8260
|
+
/**
|
|
8261
|
+
* Format: date-time
|
|
8262
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
8263
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
8264
|
+
*/
|
|
8265
|
+
updatedAt: string;
|
|
8266
|
+
message?: string | null;
|
|
8267
|
+
} | null;
|
|
8268
|
+
source?: {
|
|
8269
|
+
/** Format: uuid */
|
|
8270
|
+
id: string;
|
|
8271
|
+
type: string;
|
|
8272
|
+
status?: ("active" | "inactive") | null;
|
|
8273
|
+
appId?: string | null;
|
|
8274
|
+
appIcon?: string | null;
|
|
8275
|
+
} | null;
|
|
8276
|
+
}[];
|
|
8277
|
+
bankRecords: {
|
|
8278
|
+
reconciled: number;
|
|
8279
|
+
unreconciled: number;
|
|
8280
|
+
total: number;
|
|
8281
|
+
latestCreatedAt?: string | null;
|
|
8282
|
+
};
|
|
8283
|
+
balance?: {
|
|
8284
|
+
openingDate?: string | null;
|
|
8285
|
+
opening: number;
|
|
8286
|
+
ending: number;
|
|
8287
|
+
} | null;
|
|
8288
|
+
} | null;
|
|
8480
8289
|
};
|
|
8481
8290
|
};
|
|
8482
8291
|
};
|
|
@@ -8614,186 +8423,23 @@ export interface operations {
|
|
|
8614
8423
|
};
|
|
8615
8424
|
};
|
|
8616
8425
|
};
|
|
8617
|
-
|
|
8426
|
+
deleteAccountsByIdConnectionsByAccountConnectionId: {
|
|
8618
8427
|
parameters: {
|
|
8619
|
-
query?:
|
|
8428
|
+
query?: {
|
|
8429
|
+
mode?: "preserve-history" | "detach-history";
|
|
8430
|
+
};
|
|
8620
8431
|
header?: never;
|
|
8621
8432
|
path: {
|
|
8622
8433
|
id: string;
|
|
8434
|
+
accountConnectionId: string;
|
|
8623
8435
|
};
|
|
8624
8436
|
cookie?: never;
|
|
8625
8437
|
};
|
|
8626
|
-
requestBody?:
|
|
8627
|
-
|
|
8628
|
-
|
|
8629
|
-
200: {
|
|
8630
|
-
headers: {
|
|
8631
|
-
[name: string]: unknown;
|
|
8632
|
-
};
|
|
8633
|
-
content: {
|
|
8634
|
-
"application/json": {
|
|
8635
|
-
allowedIpCidrs: string[];
|
|
8636
|
-
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")[];
|
|
8637
|
-
/** Format: uuid */
|
|
8638
|
-
id: string;
|
|
8639
|
-
/**
|
|
8640
|
-
* Format: date-time
|
|
8641
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
8642
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
8643
|
-
*/
|
|
8644
|
-
createdAt: string;
|
|
8645
|
-
hint: string | null;
|
|
8646
|
-
role: string | null;
|
|
8647
|
-
scope: string | null;
|
|
8648
|
-
scopes: ("self:read" | "self:write" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "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" | "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" | "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")[];
|
|
8649
|
-
apiToken: string;
|
|
8650
|
-
};
|
|
8651
|
-
};
|
|
8652
|
-
};
|
|
8653
|
-
/** @description Bad request */
|
|
8654
|
-
400: {
|
|
8655
|
-
headers: {
|
|
8656
|
-
[name: string]: unknown;
|
|
8657
|
-
};
|
|
8658
|
-
content: {
|
|
8659
|
-
"application/json": {
|
|
8660
|
-
code: string;
|
|
8661
|
-
message: string;
|
|
8662
|
-
links?: {
|
|
8663
|
-
docs: string;
|
|
8664
|
-
schema: string;
|
|
8665
|
-
};
|
|
8666
|
-
issues?: {
|
|
8667
|
-
message: string;
|
|
8668
|
-
path?: (string | number)[];
|
|
8669
|
-
schema?: string;
|
|
8670
|
-
}[];
|
|
8671
|
-
context?: unknown;
|
|
8672
|
-
};
|
|
8673
|
-
};
|
|
8674
|
-
};
|
|
8675
|
-
/** @description Unauthorized */
|
|
8676
|
-
401: {
|
|
8677
|
-
headers: {
|
|
8678
|
-
[name: string]: unknown;
|
|
8679
|
-
};
|
|
8680
|
-
content: {
|
|
8681
|
-
"application/json": {
|
|
8682
|
-
code: string;
|
|
8683
|
-
message: string;
|
|
8684
|
-
links?: {
|
|
8685
|
-
docs: string;
|
|
8686
|
-
schema: string;
|
|
8687
|
-
};
|
|
8688
|
-
issues?: {
|
|
8689
|
-
message: string;
|
|
8690
|
-
path?: (string | number)[];
|
|
8691
|
-
schema?: string;
|
|
8692
|
-
}[];
|
|
8693
|
-
context?: unknown;
|
|
8694
|
-
};
|
|
8695
|
-
};
|
|
8696
|
-
};
|
|
8697
|
-
/** @description Forbidden */
|
|
8698
|
-
403: {
|
|
8699
|
-
headers: {
|
|
8700
|
-
[name: string]: unknown;
|
|
8701
|
-
};
|
|
8702
|
-
content: {
|
|
8703
|
-
"application/json": {
|
|
8704
|
-
code: string;
|
|
8705
|
-
message: string;
|
|
8706
|
-
links?: {
|
|
8707
|
-
docs: string;
|
|
8708
|
-
schema: string;
|
|
8709
|
-
};
|
|
8710
|
-
issues?: {
|
|
8711
|
-
message: string;
|
|
8712
|
-
path?: (string | number)[];
|
|
8713
|
-
schema?: string;
|
|
8714
|
-
}[];
|
|
8715
|
-
context?: unknown;
|
|
8716
|
-
};
|
|
8717
|
-
};
|
|
8718
|
-
};
|
|
8719
|
-
/** @description Not found */
|
|
8720
|
-
404: {
|
|
8721
|
-
headers: {
|
|
8722
|
-
[name: string]: unknown;
|
|
8723
|
-
};
|
|
8724
|
-
content: {
|
|
8725
|
-
"application/json": {
|
|
8726
|
-
code: string;
|
|
8727
|
-
message: string;
|
|
8728
|
-
links?: {
|
|
8729
|
-
docs: string;
|
|
8730
|
-
schema: string;
|
|
8731
|
-
};
|
|
8732
|
-
issues?: {
|
|
8733
|
-
message: string;
|
|
8734
|
-
path?: (string | number)[];
|
|
8735
|
-
schema?: string;
|
|
8736
|
-
}[];
|
|
8737
|
-
context?: unknown;
|
|
8738
|
-
};
|
|
8739
|
-
};
|
|
8740
|
-
};
|
|
8741
|
-
/** @description Internal server error */
|
|
8742
|
-
500: {
|
|
8743
|
-
headers: {
|
|
8744
|
-
[name: string]: unknown;
|
|
8745
|
-
};
|
|
8746
|
-
content: {
|
|
8747
|
-
"application/json": {
|
|
8748
|
-
code: string;
|
|
8749
|
-
message: string;
|
|
8750
|
-
links?: {
|
|
8751
|
-
docs: string;
|
|
8752
|
-
schema: string;
|
|
8753
|
-
};
|
|
8754
|
-
issues?: {
|
|
8755
|
-
message: string;
|
|
8756
|
-
path?: (string | number)[];
|
|
8757
|
-
schema?: string;
|
|
8758
|
-
}[];
|
|
8759
|
-
context?: unknown;
|
|
8760
|
-
};
|
|
8761
|
-
};
|
|
8762
|
-
};
|
|
8763
|
-
/** @description Service unavailable */
|
|
8764
|
-
503: {
|
|
8765
|
-
headers: {
|
|
8766
|
-
[name: string]: unknown;
|
|
8767
|
-
};
|
|
8768
|
-
content: {
|
|
8769
|
-
"application/json": {
|
|
8770
|
-
code: string;
|
|
8771
|
-
message: string;
|
|
8772
|
-
links?: {
|
|
8773
|
-
docs: string;
|
|
8774
|
-
schema: string;
|
|
8775
|
-
};
|
|
8776
|
-
issues?: {
|
|
8777
|
-
message: string;
|
|
8778
|
-
path?: (string | number)[];
|
|
8779
|
-
schema?: string;
|
|
8780
|
-
}[];
|
|
8781
|
-
context?: unknown;
|
|
8782
|
-
};
|
|
8783
|
-
};
|
|
8784
|
-
};
|
|
8785
|
-
};
|
|
8786
|
-
};
|
|
8787
|
-
deleteApiTokensById: {
|
|
8788
|
-
parameters: {
|
|
8789
|
-
query?: never;
|
|
8790
|
-
header?: never;
|
|
8791
|
-
path: {
|
|
8792
|
-
id: string;
|
|
8438
|
+
requestBody?: {
|
|
8439
|
+
content: {
|
|
8440
|
+
"application/json": Record<string, never>;
|
|
8793
8441
|
};
|
|
8794
|
-
cookie?: never;
|
|
8795
8442
|
};
|
|
8796
|
-
requestBody?: never;
|
|
8797
8443
|
responses: {
|
|
8798
8444
|
/** @description Successful response */
|
|
8799
8445
|
200: {
|
|
@@ -8912,120 +8558,60 @@ export interface operations {
|
|
|
8912
8558
|
};
|
|
8913
8559
|
issues?: {
|
|
8914
8560
|
message: string;
|
|
8915
|
-
path?: (string | number)[];
|
|
8916
|
-
schema?: string;
|
|
8917
|
-
}[];
|
|
8918
|
-
context?: unknown;
|
|
8919
|
-
};
|
|
8920
|
-
};
|
|
8921
|
-
};
|
|
8922
|
-
/** @description Service unavailable */
|
|
8923
|
-
503: {
|
|
8924
|
-
headers: {
|
|
8925
|
-
[name: string]: unknown;
|
|
8926
|
-
};
|
|
8927
|
-
content: {
|
|
8928
|
-
"application/json": {
|
|
8929
|
-
code: string;
|
|
8930
|
-
message: string;
|
|
8931
|
-
links?: {
|
|
8932
|
-
docs: string;
|
|
8933
|
-
schema: string;
|
|
8934
|
-
};
|
|
8935
|
-
issues?: {
|
|
8936
|
-
message: string;
|
|
8937
|
-
path?: (string | number)[];
|
|
8938
|
-
schema?: string;
|
|
8939
|
-
}[];
|
|
8940
|
-
context?: unknown;
|
|
8941
|
-
};
|
|
8942
|
-
};
|
|
8943
|
-
};
|
|
8944
|
-
};
|
|
8945
|
-
};
|
|
8946
|
-
getApps: {
|
|
8947
|
-
parameters: {
|
|
8948
|
-
query?: {
|
|
8949
|
-
search?: string;
|
|
8950
|
-
category?: string;
|
|
8951
|
-
type?: string;
|
|
8952
|
-
/** @description Filter by whether an app has a connection for the current team */
|
|
8953
|
-
hasConnection?: boolean;
|
|
8954
|
-
limit?: number;
|
|
8955
|
-
page?: number;
|
|
8956
|
-
offset?: number;
|
|
8957
|
-
};
|
|
8958
|
-
header?: never;
|
|
8959
|
-
path?: never;
|
|
8960
|
-
cookie?: never;
|
|
8961
|
-
};
|
|
8962
|
-
requestBody?: never;
|
|
8963
|
-
responses: {
|
|
8964
|
-
/** @description Successful response */
|
|
8965
|
-
200: {
|
|
8966
|
-
headers: {
|
|
8967
|
-
[name: string]: unknown;
|
|
8968
|
-
};
|
|
8969
|
-
content: {
|
|
8970
|
-
"application/json": {
|
|
8971
|
-
data: {
|
|
8972
|
-
id: string;
|
|
8973
|
-
name: string;
|
|
8974
|
-
icon?: string;
|
|
8975
|
-
type: string;
|
|
8976
|
-
category: string;
|
|
8977
|
-
description?: string | null;
|
|
8978
|
-
extension?: {
|
|
8979
|
-
url: string;
|
|
8980
|
-
};
|
|
8981
|
-
flows: {
|
|
8982
|
-
/** Format: uuid */
|
|
8983
|
-
id: string;
|
|
8984
|
-
name: string;
|
|
8985
|
-
/** @enum {string} */
|
|
8986
|
-
type: "push" | "pull";
|
|
8987
|
-
left: string;
|
|
8988
|
-
right: string;
|
|
8989
|
-
}[];
|
|
8990
|
-
extractors: {
|
|
8991
|
-
name: string;
|
|
8992
|
-
/** @constant */
|
|
8993
|
-
sync: "full";
|
|
8994
|
-
visible?: boolean;
|
|
8995
|
-
isDateRangeFetchable?: boolean;
|
|
8996
|
-
/** @enum {string} */
|
|
8997
|
-
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
8998
|
-
params?: {
|
|
8999
|
-
/** @constant */
|
|
9000
|
-
type: "object";
|
|
9001
|
-
properties?: {
|
|
9002
|
-
uniqueRef?: {
|
|
9003
|
-
/** @constant */
|
|
9004
|
-
type: "string";
|
|
9005
|
-
};
|
|
9006
|
-
};
|
|
9007
|
-
/** @constant */
|
|
9008
|
-
additionalProperties: false;
|
|
9009
|
-
};
|
|
9010
|
-
urlExample?: string;
|
|
9011
|
-
allowConfirmationCode?: boolean;
|
|
9012
|
-
}[];
|
|
9013
|
-
importers: {
|
|
9014
|
-
docsLink?: string;
|
|
9015
|
-
uniqueRef: string;
|
|
9016
|
-
description: string;
|
|
9017
|
-
types?: string[];
|
|
9018
|
-
}[];
|
|
9019
|
-
}[];
|
|
9020
|
-
pagination: {
|
|
9021
|
-
/** @default 100 */
|
|
9022
|
-
limit: number;
|
|
9023
|
-
/** @default 1 */
|
|
9024
|
-
page: number;
|
|
9025
|
-
total: number;
|
|
9026
|
-
totalPage: number;
|
|
9027
|
-
nextPage?: number;
|
|
8561
|
+
path?: (string | number)[];
|
|
8562
|
+
schema?: string;
|
|
8563
|
+
}[];
|
|
8564
|
+
context?: unknown;
|
|
8565
|
+
};
|
|
8566
|
+
};
|
|
8567
|
+
};
|
|
8568
|
+
/** @description Service unavailable */
|
|
8569
|
+
503: {
|
|
8570
|
+
headers: {
|
|
8571
|
+
[name: string]: unknown;
|
|
8572
|
+
};
|
|
8573
|
+
content: {
|
|
8574
|
+
"application/json": {
|
|
8575
|
+
code: string;
|
|
8576
|
+
message: string;
|
|
8577
|
+
links?: {
|
|
8578
|
+
docs: string;
|
|
8579
|
+
schema: string;
|
|
9028
8580
|
};
|
|
8581
|
+
issues?: {
|
|
8582
|
+
message: string;
|
|
8583
|
+
path?: (string | number)[];
|
|
8584
|
+
schema?: string;
|
|
8585
|
+
}[];
|
|
8586
|
+
context?: unknown;
|
|
8587
|
+
};
|
|
8588
|
+
};
|
|
8589
|
+
};
|
|
8590
|
+
};
|
|
8591
|
+
};
|
|
8592
|
+
postAccountsByIdRecalculateBalances: {
|
|
8593
|
+
parameters: {
|
|
8594
|
+
query?: never;
|
|
8595
|
+
header?: never;
|
|
8596
|
+
path: {
|
|
8597
|
+
id: string;
|
|
8598
|
+
};
|
|
8599
|
+
cookie?: never;
|
|
8600
|
+
};
|
|
8601
|
+
requestBody?: {
|
|
8602
|
+
content: {
|
|
8603
|
+
"application/json": Record<string, never>;
|
|
8604
|
+
};
|
|
8605
|
+
};
|
|
8606
|
+
responses: {
|
|
8607
|
+
/** @description Successful response */
|
|
8608
|
+
200: {
|
|
8609
|
+
headers: {
|
|
8610
|
+
[name: string]: unknown;
|
|
8611
|
+
};
|
|
8612
|
+
content: {
|
|
8613
|
+
"application/json": {
|
|
8614
|
+
success: boolean;
|
|
9029
8615
|
};
|
|
9030
8616
|
};
|
|
9031
8617
|
};
|
|
@@ -9163,9 +8749,12 @@ export interface operations {
|
|
|
9163
8749
|
};
|
|
9164
8750
|
};
|
|
9165
8751
|
};
|
|
9166
|
-
|
|
8752
|
+
getAccountsByIdSummary: {
|
|
9167
8753
|
parameters: {
|
|
9168
|
-
query
|
|
8754
|
+
query: {
|
|
8755
|
+
/** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
|
|
8756
|
+
dateRange: string;
|
|
8757
|
+
};
|
|
9169
8758
|
header?: never;
|
|
9170
8759
|
path: {
|
|
9171
8760
|
id: string;
|
|
@@ -9181,53 +8770,27 @@ export interface operations {
|
|
|
9181
8770
|
};
|
|
9182
8771
|
content: {
|
|
9183
8772
|
"application/json": {
|
|
9184
|
-
|
|
9185
|
-
|
|
9186
|
-
|
|
9187
|
-
|
|
9188
|
-
|
|
9189
|
-
|
|
9190
|
-
|
|
9191
|
-
|
|
8773
|
+
unmatched: {
|
|
8774
|
+
bankRecords: {
|
|
8775
|
+
/** Format: uuid */
|
|
8776
|
+
id: string;
|
|
8777
|
+
centTotal: number;
|
|
8778
|
+
}[];
|
|
8779
|
+
transactions: {
|
|
8780
|
+
/** Format: uuid */
|
|
8781
|
+
id: string;
|
|
8782
|
+
centTotal: number;
|
|
8783
|
+
}[];
|
|
8784
|
+
};
|
|
8785
|
+
totals: {
|
|
8786
|
+
bankAccountBalance: number;
|
|
8787
|
+
bookBalance: number;
|
|
8788
|
+
unclearedTransactionsBalance: number;
|
|
8789
|
+
unmatchedTransactionsBalance: number;
|
|
8790
|
+
unmatchedBankRecordsBalance: number;
|
|
8791
|
+
adjustedBankAccountBalance: number;
|
|
8792
|
+
difference: number;
|
|
9192
8793
|
};
|
|
9193
|
-
flows: {
|
|
9194
|
-
/** Format: uuid */
|
|
9195
|
-
id: string;
|
|
9196
|
-
name: string;
|
|
9197
|
-
/** @enum {string} */
|
|
9198
|
-
type: "push" | "pull";
|
|
9199
|
-
left: string;
|
|
9200
|
-
right: string;
|
|
9201
|
-
}[];
|
|
9202
|
-
extractors: {
|
|
9203
|
-
name: string;
|
|
9204
|
-
/** @constant */
|
|
9205
|
-
sync: "full";
|
|
9206
|
-
visible?: boolean;
|
|
9207
|
-
isDateRangeFetchable?: boolean;
|
|
9208
|
-
/** @enum {string} */
|
|
9209
|
-
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
9210
|
-
params?: {
|
|
9211
|
-
/** @constant */
|
|
9212
|
-
type: "object";
|
|
9213
|
-
properties?: {
|
|
9214
|
-
uniqueRef?: {
|
|
9215
|
-
/** @constant */
|
|
9216
|
-
type: "string";
|
|
9217
|
-
};
|
|
9218
|
-
};
|
|
9219
|
-
/** @constant */
|
|
9220
|
-
additionalProperties: false;
|
|
9221
|
-
};
|
|
9222
|
-
urlExample?: string;
|
|
9223
|
-
allowConfirmationCode?: boolean;
|
|
9224
|
-
}[];
|
|
9225
|
-
importers: {
|
|
9226
|
-
docsLink?: string;
|
|
9227
|
-
uniqueRef: string;
|
|
9228
|
-
description: string;
|
|
9229
|
-
types?: string[];
|
|
9230
|
-
}[];
|
|
9231
8794
|
};
|
|
9232
8795
|
};
|
|
9233
8796
|
};
|
|
@@ -9365,18 +8928,12 @@ export interface operations {
|
|
|
9365
8928
|
};
|
|
9366
8929
|
};
|
|
9367
8930
|
};
|
|
9368
|
-
|
|
8931
|
+
getApiTokens: {
|
|
9369
8932
|
parameters: {
|
|
9370
8933
|
query?: {
|
|
9371
8934
|
limit?: number;
|
|
9372
|
-
offset?: number;
|
|
9373
|
-
startDate?: string;
|
|
9374
|
-
endDate?: string;
|
|
9375
|
-
actionType?: string;
|
|
9376
|
-
entityId?: string;
|
|
9377
|
-
entityType?: "account" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
9378
|
-
includeIfNoEffects?: boolean;
|
|
9379
8935
|
page?: number;
|
|
8936
|
+
offset?: number;
|
|
9380
8937
|
};
|
|
9381
8938
|
header?: never;
|
|
9382
8939
|
path?: never;
|
|
@@ -9392,42 +8949,20 @@ export interface operations {
|
|
|
9392
8949
|
content: {
|
|
9393
8950
|
"application/json": {
|
|
9394
8951
|
data: {
|
|
8952
|
+
allowedIpCidrs: string[];
|
|
8953
|
+
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")[];
|
|
9395
8954
|
/** Format: uuid */
|
|
9396
8955
|
id: string;
|
|
9397
|
-
/** Format: uuid */
|
|
9398
|
-
tenantId: string;
|
|
9399
|
-
actionType: string;
|
|
9400
|
-
rootEntityType: string | null;
|
|
9401
|
-
rootEntityId: string | null;
|
|
9402
|
-
message: string | null;
|
|
9403
|
-
payload: unknown;
|
|
9404
|
-
userId: string | null;
|
|
9405
|
-
actor: {
|
|
9406
|
-
id: string | null;
|
|
9407
|
-
type: string;
|
|
9408
|
-
name: string | null;
|
|
9409
|
-
email: string | null;
|
|
9410
|
-
};
|
|
9411
8956
|
/**
|
|
9412
8957
|
* Format: date-time
|
|
9413
8958
|
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
9414
8959
|
* @example 2024-01-15T12:30:00.000+00:00
|
|
9415
8960
|
*/
|
|
9416
8961
|
createdAt: string;
|
|
9417
|
-
|
|
9418
|
-
|
|
9419
|
-
|
|
9420
|
-
|
|
9421
|
-
parentActionId: string | null;
|
|
9422
|
-
effectCounts: {
|
|
9423
|
-
total: number;
|
|
9424
|
-
pending: number;
|
|
9425
|
-
claimed: number;
|
|
9426
|
-
running: number;
|
|
9427
|
-
completed: number;
|
|
9428
|
-
failed: number;
|
|
9429
|
-
deadLetter: number;
|
|
9430
|
-
};
|
|
8962
|
+
hint: string | null;
|
|
8963
|
+
role: string | null;
|
|
8964
|
+
scope: string | null;
|
|
8965
|
+
scopes: ("self:read" | "self:write" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "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" | "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" | "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")[];
|
|
9431
8966
|
}[];
|
|
9432
8967
|
pagination: {
|
|
9433
8968
|
/** @default 100 */
|
|
@@ -9575,16 +9110,23 @@ export interface operations {
|
|
|
9575
9110
|
};
|
|
9576
9111
|
};
|
|
9577
9112
|
};
|
|
9578
|
-
|
|
9113
|
+
postApiTokens: {
|
|
9579
9114
|
parameters: {
|
|
9580
9115
|
query?: never;
|
|
9581
9116
|
header?: never;
|
|
9582
|
-
path
|
|
9583
|
-
id: string;
|
|
9584
|
-
};
|
|
9117
|
+
path?: never;
|
|
9585
9118
|
cookie?: never;
|
|
9586
9119
|
};
|
|
9587
|
-
requestBody?:
|
|
9120
|
+
requestBody?: {
|
|
9121
|
+
content: {
|
|
9122
|
+
"application/json": {
|
|
9123
|
+
/** @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. */
|
|
9124
|
+
allowedIpCidrs?: string[];
|
|
9125
|
+
/** @description Optional capability restrictions for a partner-owned API token. Omit for unrestricted partner API access. Rejected for ordinary teams. */
|
|
9126
|
+
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")[];
|
|
9127
|
+
};
|
|
9128
|
+
};
|
|
9129
|
+
};
|
|
9588
9130
|
responses: {
|
|
9589
9131
|
/** @description Successful response */
|
|
9590
9132
|
200: {
|
|
@@ -9593,42 +9135,21 @@ export interface operations {
|
|
|
9593
9135
|
};
|
|
9594
9136
|
content: {
|
|
9595
9137
|
"application/json": {
|
|
9138
|
+
allowedIpCidrs: string[];
|
|
9139
|
+
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")[];
|
|
9596
9140
|
/** Format: uuid */
|
|
9597
9141
|
id: string;
|
|
9598
|
-
/** Format: uuid */
|
|
9599
|
-
tenantId: string;
|
|
9600
|
-
actionType: string;
|
|
9601
|
-
rootEntityType: string | null;
|
|
9602
|
-
rootEntityId: string | null;
|
|
9603
|
-
message: string | null;
|
|
9604
|
-
payload: unknown;
|
|
9605
|
-
userId: string | null;
|
|
9606
|
-
actor: {
|
|
9607
|
-
id: string | null;
|
|
9608
|
-
type: string;
|
|
9609
|
-
name: string | null;
|
|
9610
|
-
email: string | null;
|
|
9611
|
-
};
|
|
9612
9142
|
/**
|
|
9613
9143
|
* Format: date-time
|
|
9614
9144
|
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
9615
9145
|
* @example 2024-01-15T12:30:00.000+00:00
|
|
9616
9146
|
*/
|
|
9617
9147
|
createdAt: string;
|
|
9618
|
-
|
|
9619
|
-
|
|
9620
|
-
|
|
9621
|
-
|
|
9622
|
-
|
|
9623
|
-
effectCounts: {
|
|
9624
|
-
total: number;
|
|
9625
|
-
pending: number;
|
|
9626
|
-
claimed: number;
|
|
9627
|
-
running: number;
|
|
9628
|
-
completed: number;
|
|
9629
|
-
failed: number;
|
|
9630
|
-
deadLetter: number;
|
|
9631
|
-
};
|
|
9148
|
+
hint: string | null;
|
|
9149
|
+
role: string | null;
|
|
9150
|
+
scope: string | null;
|
|
9151
|
+
scopes: ("self:read" | "self:write" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "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" | "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" | "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")[];
|
|
9152
|
+
apiToken: string;
|
|
9632
9153
|
};
|
|
9633
9154
|
};
|
|
9634
9155
|
};
|
|
@@ -9766,20 +9287,13 @@ export interface operations {
|
|
|
9766
9287
|
};
|
|
9767
9288
|
};
|
|
9768
9289
|
};
|
|
9769
|
-
|
|
9290
|
+
getApiTokensById: {
|
|
9770
9291
|
parameters: {
|
|
9771
|
-
query?:
|
|
9772
|
-
limit?: number;
|
|
9773
|
-
offset?: number;
|
|
9774
|
-
actionId?: string;
|
|
9775
|
-
entityId?: string;
|
|
9776
|
-
entityType?: "account" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
9777
|
-
status?: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
|
|
9778
|
-
effectType?: "BANK_ACCOUNT_CREATED_TRACK" | "CALENDAR_UNBLOCK_ACTION" | "CREATE_RECURRING_TRANSACTION_INSTANCE" | "JOURNAL_ENTRY_SET_ACTIVE" | "JOURNAL_ENTRY_SET_INACTIVE" | "LINK_JOURNAL_TO_OWNERSHIP_PERIOD" | "RECALCULATE_BANK_RECORD_BALANCES" | "REFRESH_RESERVATION_JOURNAL" | "DELETE_TRANSACTION_ATTACHMENT_BLOB" | "MAP_DEPOSIT_TRANSACTIONS_BY_LAST4" | "REFRESH_TRANSACTION_JOURNAL" | "SEND_STATEMENT_NOTIFICATIONS" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "TENANT_HYPERLINE_SYNC" | "TENANT_INIT" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
|
|
9779
|
-
page?: number;
|
|
9780
|
-
};
|
|
9292
|
+
query?: never;
|
|
9781
9293
|
header?: never;
|
|
9782
|
-
path
|
|
9294
|
+
path: {
|
|
9295
|
+
id: string;
|
|
9296
|
+
};
|
|
9783
9297
|
cookie?: never;
|
|
9784
9298
|
};
|
|
9785
9299
|
requestBody?: never;
|
|
@@ -9791,196 +9305,180 @@ export interface operations {
|
|
|
9791
9305
|
};
|
|
9792
9306
|
content: {
|
|
9793
9307
|
"application/json": {
|
|
9794
|
-
|
|
9795
|
-
|
|
9796
|
-
|
|
9797
|
-
|
|
9798
|
-
|
|
9799
|
-
|
|
9800
|
-
|
|
9801
|
-
|
|
9802
|
-
|
|
9803
|
-
|
|
9804
|
-
|
|
9805
|
-
|
|
9806
|
-
|
|
9807
|
-
|
|
9808
|
-
|
|
9809
|
-
|
|
9810
|
-
|
|
9811
|
-
|
|
9812
|
-
|
|
9813
|
-
|
|
9814
|
-
|
|
9815
|
-
|
|
9816
|
-
|
|
9817
|
-
|
|
9818
|
-
|
|
9819
|
-
|
|
9820
|
-
|
|
9821
|
-
|
|
9822
|
-
|
|
9823
|
-
|
|
9824
|
-
|
|
9825
|
-
|
|
9826
|
-
|
|
9827
|
-
|
|
9828
|
-
|
|
9829
|
-
|
|
9830
|
-
|
|
9831
|
-
|
|
9832
|
-
|
|
9833
|
-
|
|
9834
|
-
|
|
9835
|
-
|
|
9836
|
-
|
|
9837
|
-
|
|
9838
|
-
|
|
9839
|
-
|
|
9840
|
-
|
|
9841
|
-
|
|
9842
|
-
|
|
9843
|
-
|
|
9844
|
-
|
|
9845
|
-
|
|
9846
|
-
|
|
9847
|
-
|
|
9848
|
-
|
|
9849
|
-
|
|
9850
|
-
|
|
9851
|
-
|
|
9852
|
-
|
|
9853
|
-
|
|
9854
|
-
|
|
9855
|
-
|
|
9856
|
-
|
|
9857
|
-
|
|
9858
|
-
|
|
9859
|
-
|
|
9860
|
-
|
|
9861
|
-
|
|
9862
|
-
|
|
9863
|
-
|
|
9864
|
-
|
|
9865
|
-
|
|
9866
|
-
|
|
9867
|
-
|
|
9868
|
-
|
|
9869
|
-
|
|
9870
|
-
|
|
9871
|
-
|
|
9872
|
-
|
|
9873
|
-
|
|
9874
|
-
|
|
9875
|
-
|
|
9876
|
-
|
|
9877
|
-
|
|
9878
|
-
|
|
9879
|
-
|
|
9880
|
-
|
|
9881
|
-
|
|
9882
|
-
|
|
9883
|
-
|
|
9884
|
-
|
|
9885
|
-
|
|
9886
|
-
|
|
9887
|
-
|
|
9888
|
-
|
|
9889
|
-
|
|
9890
|
-
|
|
9891
|
-
|
|
9892
|
-
|
|
9893
|
-
|
|
9894
|
-
|
|
9895
|
-
date: string;
|
|
9896
|
-
description: string;
|
|
9897
|
-
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
9898
|
-
currency: string;
|
|
9899
|
-
/** @enum {string} */
|
|
9900
|
-
type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
|
|
9901
|
-
isOpeningBalance: boolean;
|
|
9902
|
-
contact?: {
|
|
9903
|
-
/** Format: uuid */
|
|
9904
|
-
id: string;
|
|
9905
|
-
name?: string | null;
|
|
9906
|
-
firstName?: string | null;
|
|
9907
|
-
uniqueRef?: string | null;
|
|
9908
|
-
shortRef?: string | null;
|
|
9909
|
-
email?: string | null;
|
|
9910
|
-
/** @enum {string} */
|
|
9911
|
-
type: "owner" | "vendor";
|
|
9912
|
-
} | null;
|
|
9913
|
-
connection?: {
|
|
9914
|
-
/** Format: uuid */
|
|
9915
|
-
id: string;
|
|
9916
|
-
name: string;
|
|
9917
|
-
/** @enum {string} */
|
|
9918
|
-
status: "active" | "inactive";
|
|
9919
|
-
uniqueRef?: string | null;
|
|
9920
|
-
appId: string;
|
|
9921
|
-
} | null;
|
|
9922
|
-
uniqueRef?: string | null;
|
|
9923
|
-
shortRef?: string | null;
|
|
9924
|
-
recurringTemplate?: {
|
|
9925
|
-
id: string;
|
|
9926
|
-
} | null;
|
|
9927
|
-
};
|
|
9928
|
-
} | {
|
|
9929
|
-
/** @constant */
|
|
9930
|
-
type: "other";
|
|
9931
|
-
data: {
|
|
9932
|
-
/** Format: uuid */
|
|
9933
|
-
id: string;
|
|
9934
|
-
type: string;
|
|
9935
|
-
name: string | null;
|
|
9936
|
-
};
|
|
9937
|
-
}) | null;
|
|
9938
|
-
/** @enum {string} */
|
|
9939
|
-
status: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
|
|
9940
|
-
priority: number;
|
|
9941
|
-
retryCount: number;
|
|
9942
|
-
maxRetries: number;
|
|
9943
|
-
sequence: number;
|
|
9944
|
-
claimedAt: string | null;
|
|
9945
|
-
claimedBy: string | null;
|
|
9946
|
-
completedAt: string | null;
|
|
9947
|
-
lastAttemptAt: string | null;
|
|
9948
|
-
lastError: string | null;
|
|
9949
|
-
latestAttempt: {
|
|
9950
|
-
/** Format: uuid */
|
|
9951
|
-
id: string;
|
|
9952
|
-
/** @enum {string} */
|
|
9953
|
-
status: "running" | "completed" | "failed" | "skipped_locked";
|
|
9954
|
-
attemptNum: number;
|
|
9955
|
-
/**
|
|
9956
|
-
* Format: date-time
|
|
9957
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
9958
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
9959
|
-
*/
|
|
9960
|
-
startedAt: string;
|
|
9961
|
-
finishedAt: string | null;
|
|
9962
|
-
workerId: string | null;
|
|
9963
|
-
resultCode: string | null;
|
|
9964
|
-
resultCategory: string | null;
|
|
9965
|
-
retryable: boolean | null;
|
|
9966
|
-
errorMessage: string | null;
|
|
9967
|
-
} | null;
|
|
9968
|
-
/**
|
|
9969
|
-
* Format: date-time
|
|
9970
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
9971
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
9972
|
-
*/
|
|
9973
|
-
createdAt: string;
|
|
9308
|
+
allowedIpCidrs: string[];
|
|
9309
|
+
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")[];
|
|
9310
|
+
/** Format: uuid */
|
|
9311
|
+
id: string;
|
|
9312
|
+
/**
|
|
9313
|
+
* Format: date-time
|
|
9314
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
9315
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
9316
|
+
*/
|
|
9317
|
+
createdAt: string;
|
|
9318
|
+
hint: string | null;
|
|
9319
|
+
role: string | null;
|
|
9320
|
+
scope: string | null;
|
|
9321
|
+
scopes: ("self:read" | "self:write" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "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" | "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" | "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")[];
|
|
9322
|
+
apiToken: string;
|
|
9323
|
+
};
|
|
9324
|
+
};
|
|
9325
|
+
};
|
|
9326
|
+
/** @description Bad request */
|
|
9327
|
+
400: {
|
|
9328
|
+
headers: {
|
|
9329
|
+
[name: string]: unknown;
|
|
9330
|
+
};
|
|
9331
|
+
content: {
|
|
9332
|
+
"application/json": {
|
|
9333
|
+
code: string;
|
|
9334
|
+
message: string;
|
|
9335
|
+
links?: {
|
|
9336
|
+
docs: string;
|
|
9337
|
+
schema: string;
|
|
9338
|
+
};
|
|
9339
|
+
issues?: {
|
|
9340
|
+
message: string;
|
|
9341
|
+
path?: (string | number)[];
|
|
9342
|
+
schema?: string;
|
|
9343
|
+
}[];
|
|
9344
|
+
context?: unknown;
|
|
9345
|
+
};
|
|
9346
|
+
};
|
|
9347
|
+
};
|
|
9348
|
+
/** @description Unauthorized */
|
|
9349
|
+
401: {
|
|
9350
|
+
headers: {
|
|
9351
|
+
[name: string]: unknown;
|
|
9352
|
+
};
|
|
9353
|
+
content: {
|
|
9354
|
+
"application/json": {
|
|
9355
|
+
code: string;
|
|
9356
|
+
message: string;
|
|
9357
|
+
links?: {
|
|
9358
|
+
docs: string;
|
|
9359
|
+
schema: string;
|
|
9360
|
+
};
|
|
9361
|
+
issues?: {
|
|
9362
|
+
message: string;
|
|
9363
|
+
path?: (string | number)[];
|
|
9364
|
+
schema?: string;
|
|
9365
|
+
}[];
|
|
9366
|
+
context?: unknown;
|
|
9367
|
+
};
|
|
9368
|
+
};
|
|
9369
|
+
};
|
|
9370
|
+
/** @description Forbidden */
|
|
9371
|
+
403: {
|
|
9372
|
+
headers: {
|
|
9373
|
+
[name: string]: unknown;
|
|
9374
|
+
};
|
|
9375
|
+
content: {
|
|
9376
|
+
"application/json": {
|
|
9377
|
+
code: string;
|
|
9378
|
+
message: string;
|
|
9379
|
+
links?: {
|
|
9380
|
+
docs: string;
|
|
9381
|
+
schema: string;
|
|
9382
|
+
};
|
|
9383
|
+
issues?: {
|
|
9384
|
+
message: string;
|
|
9385
|
+
path?: (string | number)[];
|
|
9386
|
+
schema?: string;
|
|
9387
|
+
}[];
|
|
9388
|
+
context?: unknown;
|
|
9389
|
+
};
|
|
9390
|
+
};
|
|
9391
|
+
};
|
|
9392
|
+
/** @description Not found */
|
|
9393
|
+
404: {
|
|
9394
|
+
headers: {
|
|
9395
|
+
[name: string]: unknown;
|
|
9396
|
+
};
|
|
9397
|
+
content: {
|
|
9398
|
+
"application/json": {
|
|
9399
|
+
code: string;
|
|
9400
|
+
message: string;
|
|
9401
|
+
links?: {
|
|
9402
|
+
docs: string;
|
|
9403
|
+
schema: string;
|
|
9404
|
+
};
|
|
9405
|
+
issues?: {
|
|
9406
|
+
message: string;
|
|
9407
|
+
path?: (string | number)[];
|
|
9408
|
+
schema?: string;
|
|
9974
9409
|
}[];
|
|
9975
|
-
|
|
9976
|
-
|
|
9977
|
-
|
|
9978
|
-
|
|
9979
|
-
|
|
9980
|
-
|
|
9981
|
-
|
|
9982
|
-
|
|
9410
|
+
context?: unknown;
|
|
9411
|
+
};
|
|
9412
|
+
};
|
|
9413
|
+
};
|
|
9414
|
+
/** @description Internal server error */
|
|
9415
|
+
500: {
|
|
9416
|
+
headers: {
|
|
9417
|
+
[name: string]: unknown;
|
|
9418
|
+
};
|
|
9419
|
+
content: {
|
|
9420
|
+
"application/json": {
|
|
9421
|
+
code: string;
|
|
9422
|
+
message: string;
|
|
9423
|
+
links?: {
|
|
9424
|
+
docs: string;
|
|
9425
|
+
schema: string;
|
|
9983
9426
|
};
|
|
9427
|
+
issues?: {
|
|
9428
|
+
message: string;
|
|
9429
|
+
path?: (string | number)[];
|
|
9430
|
+
schema?: string;
|
|
9431
|
+
}[];
|
|
9432
|
+
context?: unknown;
|
|
9433
|
+
};
|
|
9434
|
+
};
|
|
9435
|
+
};
|
|
9436
|
+
/** @description Service unavailable */
|
|
9437
|
+
503: {
|
|
9438
|
+
headers: {
|
|
9439
|
+
[name: string]: unknown;
|
|
9440
|
+
};
|
|
9441
|
+
content: {
|
|
9442
|
+
"application/json": {
|
|
9443
|
+
code: string;
|
|
9444
|
+
message: string;
|
|
9445
|
+
links?: {
|
|
9446
|
+
docs: string;
|
|
9447
|
+
schema: string;
|
|
9448
|
+
};
|
|
9449
|
+
issues?: {
|
|
9450
|
+
message: string;
|
|
9451
|
+
path?: (string | number)[];
|
|
9452
|
+
schema?: string;
|
|
9453
|
+
}[];
|
|
9454
|
+
context?: unknown;
|
|
9455
|
+
};
|
|
9456
|
+
};
|
|
9457
|
+
};
|
|
9458
|
+
};
|
|
9459
|
+
};
|
|
9460
|
+
deleteApiTokensById: {
|
|
9461
|
+
parameters: {
|
|
9462
|
+
query?: never;
|
|
9463
|
+
header?: never;
|
|
9464
|
+
path: {
|
|
9465
|
+
id: string;
|
|
9466
|
+
};
|
|
9467
|
+
cookie?: never;
|
|
9468
|
+
};
|
|
9469
|
+
requestBody?: never;
|
|
9470
|
+
responses: {
|
|
9471
|
+
/** @description Successful response */
|
|
9472
|
+
200: {
|
|
9473
|
+
headers: {
|
|
9474
|
+
[name: string]: unknown;
|
|
9475
|
+
};
|
|
9476
|
+
content: {
|
|
9477
|
+
"application/json": {
|
|
9478
|
+
/** Format: uuid */
|
|
9479
|
+
id: string;
|
|
9480
|
+
/** @constant */
|
|
9481
|
+
status: "deleted";
|
|
9984
9482
|
};
|
|
9985
9483
|
};
|
|
9986
9484
|
};
|
|
@@ -10118,21 +9616,17 @@ export interface operations {
|
|
|
10118
9616
|
};
|
|
10119
9617
|
};
|
|
10120
9618
|
};
|
|
10121
|
-
|
|
9619
|
+
getApps: {
|
|
10122
9620
|
parameters: {
|
|
10123
9621
|
query?: {
|
|
9622
|
+
search?: string;
|
|
9623
|
+
category?: string;
|
|
9624
|
+
type?: string;
|
|
9625
|
+
/** @description Filter by whether an app has a connection for the current team */
|
|
9626
|
+
hasConnection?: boolean;
|
|
10124
9627
|
limit?: number;
|
|
10125
|
-
offset?: number;
|
|
10126
|
-
actionId?: string;
|
|
10127
|
-
effectId?: string;
|
|
10128
|
-
mutationId?: string;
|
|
10129
|
-
journalEntryId?: string;
|
|
10130
|
-
operation?: "insert" | "update" | "delete";
|
|
10131
|
-
rootEntityType?: string;
|
|
10132
|
-
rootEntityId?: string;
|
|
10133
|
-
startAt?: string;
|
|
10134
|
-
endAt?: string;
|
|
10135
9628
|
page?: number;
|
|
9629
|
+
offset?: number;
|
|
10136
9630
|
};
|
|
10137
9631
|
header?: never;
|
|
10138
9632
|
path?: never;
|
|
@@ -10148,43 +9642,53 @@ export interface operations {
|
|
|
10148
9642
|
content: {
|
|
10149
9643
|
"application/json": {
|
|
10150
9644
|
data: {
|
|
10151
|
-
/** Format: uuid */
|
|
10152
9645
|
id: string;
|
|
10153
|
-
|
|
10154
|
-
|
|
10155
|
-
|
|
10156
|
-
|
|
10157
|
-
|
|
10158
|
-
|
|
10159
|
-
|
|
10160
|
-
|
|
10161
|
-
|
|
10162
|
-
|
|
10163
|
-
|
|
10164
|
-
|
|
10165
|
-
|
|
10166
|
-
|
|
10167
|
-
|
|
10168
|
-
|
|
10169
|
-
|
|
10170
|
-
|
|
10171
|
-
|
|
10172
|
-
|
|
10173
|
-
|
|
10174
|
-
|
|
10175
|
-
|
|
10176
|
-
|
|
10177
|
-
|
|
10178
|
-
|
|
10179
|
-
|
|
10180
|
-
|
|
10181
|
-
|
|
10182
|
-
|
|
10183
|
-
|
|
10184
|
-
|
|
10185
|
-
|
|
10186
|
-
|
|
10187
|
-
|
|
9646
|
+
name: string;
|
|
9647
|
+
icon?: string;
|
|
9648
|
+
type: string;
|
|
9649
|
+
category: string;
|
|
9650
|
+
description?: string | null;
|
|
9651
|
+
extension?: {
|
|
9652
|
+
url: string;
|
|
9653
|
+
};
|
|
9654
|
+
flows: {
|
|
9655
|
+
/** Format: uuid */
|
|
9656
|
+
id: string;
|
|
9657
|
+
name: string;
|
|
9658
|
+
/** @enum {string} */
|
|
9659
|
+
type: "push" | "pull";
|
|
9660
|
+
left: string;
|
|
9661
|
+
right: string;
|
|
9662
|
+
}[];
|
|
9663
|
+
extractors: {
|
|
9664
|
+
name: string;
|
|
9665
|
+
/** @constant */
|
|
9666
|
+
sync: "full";
|
|
9667
|
+
visible?: boolean;
|
|
9668
|
+
isDateRangeFetchable?: boolean;
|
|
9669
|
+
/** @enum {string} */
|
|
9670
|
+
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
9671
|
+
params?: {
|
|
9672
|
+
/** @constant */
|
|
9673
|
+
type: "object";
|
|
9674
|
+
properties?: {
|
|
9675
|
+
uniqueRef?: {
|
|
9676
|
+
/** @constant */
|
|
9677
|
+
type: "string";
|
|
9678
|
+
};
|
|
9679
|
+
};
|
|
9680
|
+
/** @constant */
|
|
9681
|
+
additionalProperties: false;
|
|
9682
|
+
};
|
|
9683
|
+
urlExample?: string;
|
|
9684
|
+
allowConfirmationCode?: boolean;
|
|
9685
|
+
}[];
|
|
9686
|
+
importers: {
|
|
9687
|
+
docsLink?: string;
|
|
9688
|
+
uniqueRef: string;
|
|
9689
|
+
description: string;
|
|
9690
|
+
types?: string[];
|
|
9691
|
+
}[];
|
|
10188
9692
|
}[];
|
|
10189
9693
|
pagination: {
|
|
10190
9694
|
/** @default 100 */
|
|
@@ -10332,23 +9836,13 @@ export interface operations {
|
|
|
10332
9836
|
};
|
|
10333
9837
|
};
|
|
10334
9838
|
};
|
|
10335
|
-
|
|
9839
|
+
getApp: {
|
|
10336
9840
|
parameters: {
|
|
10337
|
-
query?:
|
|
10338
|
-
limit?: number;
|
|
10339
|
-
offset?: number;
|
|
10340
|
-
actionId?: string;
|
|
10341
|
-
effectId?: string;
|
|
10342
|
-
entityType?: string;
|
|
10343
|
-
entityId?: string;
|
|
10344
|
-
op?: string;
|
|
10345
|
-
outcome?: string;
|
|
10346
|
-
startAt?: string;
|
|
10347
|
-
endAt?: string;
|
|
10348
|
-
page?: number;
|
|
10349
|
-
};
|
|
9841
|
+
query?: never;
|
|
10350
9842
|
header?: never;
|
|
10351
|
-
path
|
|
9843
|
+
path: {
|
|
9844
|
+
id: string;
|
|
9845
|
+
};
|
|
10352
9846
|
cookie?: never;
|
|
10353
9847
|
};
|
|
10354
9848
|
requestBody?: never;
|
|
@@ -10360,64 +9854,53 @@ export interface operations {
|
|
|
10360
9854
|
};
|
|
10361
9855
|
content: {
|
|
10362
9856
|
"application/json": {
|
|
10363
|
-
|
|
9857
|
+
id: string;
|
|
9858
|
+
name: string;
|
|
9859
|
+
icon?: string;
|
|
9860
|
+
type: string;
|
|
9861
|
+
category: string;
|
|
9862
|
+
description?: string | null;
|
|
9863
|
+
extension?: {
|
|
9864
|
+
url: string;
|
|
9865
|
+
};
|
|
9866
|
+
flows: {
|
|
10364
9867
|
/** Format: uuid */
|
|
10365
9868
|
id: string;
|
|
10366
|
-
|
|
10367
|
-
|
|
10368
|
-
|
|
10369
|
-
|
|
10370
|
-
|
|
10371
|
-
|
|
10372
|
-
|
|
10373
|
-
|
|
10374
|
-
|
|
10375
|
-
|
|
10376
|
-
|
|
10377
|
-
|
|
10378
|
-
|
|
10379
|
-
|
|
10380
|
-
|
|
10381
|
-
|
|
10382
|
-
|
|
10383
|
-
|
|
10384
|
-
|
|
10385
|
-
|
|
10386
|
-
|
|
10387
|
-
|
|
10388
|
-
};
|
|
10389
|
-
/**
|
|
10390
|
-
* Format: date-time
|
|
10391
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10392
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
10393
|
-
*/
|
|
10394
|
-
createdAt: string;
|
|
10395
|
-
action: {
|
|
10396
|
-
/** Format: uuid */
|
|
10397
|
-
id: string;
|
|
10398
|
-
actionType: string;
|
|
10399
|
-
source: string | null;
|
|
10400
|
-
apiVersion: string;
|
|
10401
|
-
requestId: string | null;
|
|
10402
|
-
traceId: string | null;
|
|
10403
|
-
parentActionId: string | null;
|
|
10404
|
-
actor: {
|
|
10405
|
-
id: string | null;
|
|
10406
|
-
type: string;
|
|
10407
|
-
name: string | null;
|
|
10408
|
-
email: string | null;
|
|
9869
|
+
name: string;
|
|
9870
|
+
/** @enum {string} */
|
|
9871
|
+
type: "push" | "pull";
|
|
9872
|
+
left: string;
|
|
9873
|
+
right: string;
|
|
9874
|
+
}[];
|
|
9875
|
+
extractors: {
|
|
9876
|
+
name: string;
|
|
9877
|
+
/** @constant */
|
|
9878
|
+
sync: "full";
|
|
9879
|
+
visible?: boolean;
|
|
9880
|
+
isDateRangeFetchable?: boolean;
|
|
9881
|
+
/** @enum {string} */
|
|
9882
|
+
dateRangeMethod?: "checkIn/checkOut" | "bookedAt" | "creationDate";
|
|
9883
|
+
params?: {
|
|
9884
|
+
/** @constant */
|
|
9885
|
+
type: "object";
|
|
9886
|
+
properties?: {
|
|
9887
|
+
uniqueRef?: {
|
|
9888
|
+
/** @constant */
|
|
9889
|
+
type: "string";
|
|
9890
|
+
};
|
|
10409
9891
|
};
|
|
9892
|
+
/** @constant */
|
|
9893
|
+
additionalProperties: false;
|
|
10410
9894
|
};
|
|
9895
|
+
urlExample?: string;
|
|
9896
|
+
allowConfirmationCode?: boolean;
|
|
9897
|
+
}[];
|
|
9898
|
+
importers: {
|
|
9899
|
+
docsLink?: string;
|
|
9900
|
+
uniqueRef: string;
|
|
9901
|
+
description: string;
|
|
9902
|
+
types?: string[];
|
|
10411
9903
|
}[];
|
|
10412
|
-
pagination: {
|
|
10413
|
-
/** @default 100 */
|
|
10414
|
-
limit: number;
|
|
10415
|
-
/** @default 1 */
|
|
10416
|
-
page: number;
|
|
10417
|
-
total: number;
|
|
10418
|
-
totalPage: number;
|
|
10419
|
-
nextPage?: number;
|
|
10420
|
-
};
|
|
10421
9904
|
};
|
|
10422
9905
|
};
|
|
10423
9906
|
};
|
|
@@ -10555,22 +10038,18 @@ export interface operations {
|
|
|
10555
10038
|
};
|
|
10556
10039
|
};
|
|
10557
10040
|
};
|
|
10558
|
-
|
|
10041
|
+
getAuditActions: {
|
|
10559
10042
|
parameters: {
|
|
10560
|
-
query
|
|
10561
|
-
rootEntityType: string;
|
|
10562
|
-
rootEntityId: string;
|
|
10563
|
-
/** @description Timeline item type filter. Accepts repeated `types=value` query params or one comma-separated string. */
|
|
10564
|
-
types?: ("action" | "effect" | "effect_attempt" | "mutation" | "journal_delta")[];
|
|
10565
|
-
/** @description Temporal boundary string parsed by the API. Prefer `YYYY-MM-DD` for day-granularity filters or an ISO 8601 timestamp for exact time bounds. */
|
|
10566
|
-
from?: string;
|
|
10567
|
-
/** @description Temporal boundary string parsed by the API. Prefer `YYYY-MM-DD` for day-granularity filters or an ISO 8601 timestamp for exact time bounds. */
|
|
10568
|
-
to?: string;
|
|
10569
|
-
/** @description When true, include diff payloads in audit timeline journal delta entries. */
|
|
10570
|
-
includeDiff?: boolean;
|
|
10043
|
+
query?: {
|
|
10571
10044
|
limit?: number;
|
|
10572
|
-
|
|
10573
|
-
|
|
10045
|
+
offset?: number;
|
|
10046
|
+
startDate?: string;
|
|
10047
|
+
endDate?: string;
|
|
10048
|
+
actionType?: string;
|
|
10049
|
+
entityId?: string;
|
|
10050
|
+
entityType?: "account" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
10051
|
+
includeIfNoEffects?: boolean;
|
|
10052
|
+
page?: number;
|
|
10574
10053
|
};
|
|
10575
10054
|
header?: never;
|
|
10576
10055
|
path?: never;
|
|
@@ -10585,180 +10064,243 @@ export interface operations {
|
|
|
10585
10064
|
};
|
|
10586
10065
|
content: {
|
|
10587
10066
|
"application/json": {
|
|
10588
|
-
data:
|
|
10589
|
-
/** @constant */
|
|
10590
|
-
type: "action";
|
|
10591
|
-
/** Format: uuid */
|
|
10592
|
-
id: string;
|
|
10593
|
-
/**
|
|
10594
|
-
* Format: date-time
|
|
10595
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10596
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
10597
|
-
*/
|
|
10598
|
-
timestamp: string;
|
|
10599
|
-
actionId: string | null;
|
|
10600
|
-
effectId: string | null;
|
|
10601
|
-
mutationId: string | null;
|
|
10602
|
-
rootEntityType: string | null;
|
|
10603
|
-
rootEntityId: string | null;
|
|
10604
|
-
data: {
|
|
10605
|
-
actionType: string;
|
|
10606
|
-
message: string | null;
|
|
10607
|
-
payload: unknown | null;
|
|
10608
|
-
source: string | null;
|
|
10609
|
-
apiVersion: string;
|
|
10610
|
-
requestId: string | null;
|
|
10611
|
-
traceId: string | null;
|
|
10612
|
-
parentActionId: string | null;
|
|
10613
|
-
actor: {
|
|
10614
|
-
id: string | null;
|
|
10615
|
-
type: string;
|
|
10616
|
-
name: string | null;
|
|
10617
|
-
email: string | null;
|
|
10618
|
-
};
|
|
10619
|
-
};
|
|
10620
|
-
} | {
|
|
10621
|
-
/** @constant */
|
|
10622
|
-
type: "effect";
|
|
10623
|
-
/** Format: uuid */
|
|
10624
|
-
id: string;
|
|
10625
|
-
/**
|
|
10626
|
-
* Format: date-time
|
|
10627
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10628
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
10629
|
-
*/
|
|
10630
|
-
timestamp: string;
|
|
10631
|
-
actionId: string | null;
|
|
10632
|
-
effectId: string | null;
|
|
10633
|
-
mutationId: string | null;
|
|
10634
|
-
rootEntityType: string | null;
|
|
10635
|
-
rootEntityId: string | null;
|
|
10636
|
-
data: {
|
|
10637
|
-
effectType: string;
|
|
10638
|
-
status: string;
|
|
10639
|
-
payload: unknown;
|
|
10640
|
-
entityType: string | null;
|
|
10641
|
-
entityId: string | null;
|
|
10642
|
-
priority: number;
|
|
10643
|
-
retryCount: number;
|
|
10644
|
-
maxRetries: number;
|
|
10645
|
-
claimedAt: string | null;
|
|
10646
|
-
claimedBy: string | null;
|
|
10647
|
-
completedAt: string | null;
|
|
10648
|
-
lastAttemptAt: string | null;
|
|
10649
|
-
lastError: string | null;
|
|
10650
|
-
};
|
|
10651
|
-
} | {
|
|
10652
|
-
/** @constant */
|
|
10653
|
-
type: "effect_attempt";
|
|
10067
|
+
data: {
|
|
10654
10068
|
/** Format: uuid */
|
|
10655
10069
|
id: string;
|
|
10656
|
-
/**
|
|
10657
|
-
* Format: date-time
|
|
10658
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10659
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
10660
|
-
*/
|
|
10661
|
-
timestamp: string;
|
|
10662
|
-
actionId: string | null;
|
|
10663
|
-
effectId: string | null;
|
|
10664
|
-
mutationId: string | null;
|
|
10665
|
-
rootEntityType: string | null;
|
|
10666
|
-
rootEntityId: string | null;
|
|
10667
|
-
data: {
|
|
10668
|
-
/** @enum {string} */
|
|
10669
|
-
status: "running" | "completed" | "failed" | "skipped_locked";
|
|
10670
|
-
attemptNum: number;
|
|
10671
|
-
/**
|
|
10672
|
-
* Format: date-time
|
|
10673
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10674
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
10675
|
-
*/
|
|
10676
|
-
startedAt: string;
|
|
10677
|
-
finishedAt: string | null;
|
|
10678
|
-
workerId: string | null;
|
|
10679
|
-
resultCode: string | null;
|
|
10680
|
-
resultCategory: string | null;
|
|
10681
|
-
retryable: boolean | null;
|
|
10682
|
-
errorMessage: string | null;
|
|
10683
|
-
};
|
|
10684
|
-
} | {
|
|
10685
|
-
/** @constant */
|
|
10686
|
-
type: "mutation";
|
|
10687
10070
|
/** Format: uuid */
|
|
10688
|
-
|
|
10689
|
-
|
|
10690
|
-
* Format: date-time
|
|
10691
|
-
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10692
|
-
* @example 2024-01-15T12:30:00.000+00:00
|
|
10693
|
-
*/
|
|
10694
|
-
timestamp: string;
|
|
10695
|
-
actionId: string | null;
|
|
10696
|
-
effectId: string | null;
|
|
10697
|
-
mutationId: string | null;
|
|
10071
|
+
tenantId: string;
|
|
10072
|
+
actionType: string;
|
|
10698
10073
|
rootEntityType: string | null;
|
|
10699
10074
|
rootEntityId: string | null;
|
|
10700
|
-
|
|
10701
|
-
|
|
10702
|
-
|
|
10703
|
-
|
|
10704
|
-
|
|
10705
|
-
|
|
10706
|
-
|
|
10707
|
-
|
|
10708
|
-
changedKeys: string[];
|
|
10709
|
-
reasonCode: string;
|
|
10710
|
-
outcome: string;
|
|
10711
|
-
context: {
|
|
10712
|
-
[key: string]: unknown;
|
|
10713
|
-
} | null;
|
|
10714
|
-
} & {
|
|
10715
|
-
[key: string]: unknown;
|
|
10716
|
-
};
|
|
10075
|
+
message: string | null;
|
|
10076
|
+
payload: unknown;
|
|
10077
|
+
userId: string | null;
|
|
10078
|
+
actor: {
|
|
10079
|
+
id: string | null;
|
|
10080
|
+
type: string;
|
|
10081
|
+
name: string | null;
|
|
10082
|
+
email: string | null;
|
|
10717
10083
|
};
|
|
10718
|
-
} | {
|
|
10719
|
-
/** @constant */
|
|
10720
|
-
type: "journal_delta";
|
|
10721
|
-
/** Format: uuid */
|
|
10722
|
-
id: string;
|
|
10723
10084
|
/**
|
|
10724
10085
|
* Format: date-time
|
|
10725
10086
|
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10726
10087
|
* @example 2024-01-15T12:30:00.000+00:00
|
|
10727
10088
|
*/
|
|
10728
|
-
|
|
10729
|
-
|
|
10730
|
-
|
|
10731
|
-
|
|
10732
|
-
|
|
10733
|
-
|
|
10734
|
-
|
|
10735
|
-
|
|
10736
|
-
|
|
10737
|
-
|
|
10738
|
-
|
|
10739
|
-
|
|
10740
|
-
|
|
10741
|
-
|
|
10742
|
-
accountIdBefore: string | null;
|
|
10743
|
-
accountIdAfter: string | null;
|
|
10744
|
-
centTotalBefore: number | null;
|
|
10745
|
-
centTotalAfter: number | null;
|
|
10746
|
-
txnAtBefore: string | null;
|
|
10747
|
-
txnAtAfter: string | null;
|
|
10748
|
-
statusBefore: string | null;
|
|
10749
|
-
statusAfter: string | null;
|
|
10750
|
-
partyBefore: string | null;
|
|
10751
|
-
partyAfter: string | null;
|
|
10752
|
-
listingOwnershipPeriodIdBefore: string | null;
|
|
10753
|
-
listingOwnershipPeriodIdAfter: string | null;
|
|
10754
|
-
attachedToOwnerStatementIdBefore: string | null;
|
|
10755
|
-
attachedToOwnerStatementIdAfter: string | null;
|
|
10089
|
+
createdAt: string;
|
|
10090
|
+
source: string | null;
|
|
10091
|
+
apiVersion: string;
|
|
10092
|
+
requestId: string | null;
|
|
10093
|
+
traceId: string | null;
|
|
10094
|
+
parentActionId: string | null;
|
|
10095
|
+
effectCounts: {
|
|
10096
|
+
total: number;
|
|
10097
|
+
pending: number;
|
|
10098
|
+
claimed: number;
|
|
10099
|
+
running: number;
|
|
10100
|
+
completed: number;
|
|
10101
|
+
failed: number;
|
|
10102
|
+
deadLetter: number;
|
|
10756
10103
|
};
|
|
10757
|
-
}
|
|
10758
|
-
|
|
10104
|
+
}[];
|
|
10105
|
+
pagination: {
|
|
10106
|
+
/** @default 100 */
|
|
10759
10107
|
limit: number;
|
|
10760
|
-
|
|
10761
|
-
|
|
10108
|
+
/** @default 1 */
|
|
10109
|
+
page: number;
|
|
10110
|
+
total: number;
|
|
10111
|
+
totalPage: number;
|
|
10112
|
+
nextPage?: number;
|
|
10113
|
+
};
|
|
10114
|
+
};
|
|
10115
|
+
};
|
|
10116
|
+
};
|
|
10117
|
+
/** @description Bad request */
|
|
10118
|
+
400: {
|
|
10119
|
+
headers: {
|
|
10120
|
+
[name: string]: unknown;
|
|
10121
|
+
};
|
|
10122
|
+
content: {
|
|
10123
|
+
"application/json": {
|
|
10124
|
+
code: string;
|
|
10125
|
+
message: string;
|
|
10126
|
+
links?: {
|
|
10127
|
+
docs: string;
|
|
10128
|
+
schema: string;
|
|
10129
|
+
};
|
|
10130
|
+
issues?: {
|
|
10131
|
+
message: string;
|
|
10132
|
+
path?: (string | number)[];
|
|
10133
|
+
schema?: string;
|
|
10134
|
+
}[];
|
|
10135
|
+
context?: unknown;
|
|
10136
|
+
};
|
|
10137
|
+
};
|
|
10138
|
+
};
|
|
10139
|
+
/** @description Unauthorized */
|
|
10140
|
+
401: {
|
|
10141
|
+
headers: {
|
|
10142
|
+
[name: string]: unknown;
|
|
10143
|
+
};
|
|
10144
|
+
content: {
|
|
10145
|
+
"application/json": {
|
|
10146
|
+
code: string;
|
|
10147
|
+
message: string;
|
|
10148
|
+
links?: {
|
|
10149
|
+
docs: string;
|
|
10150
|
+
schema: string;
|
|
10151
|
+
};
|
|
10152
|
+
issues?: {
|
|
10153
|
+
message: string;
|
|
10154
|
+
path?: (string | number)[];
|
|
10155
|
+
schema?: string;
|
|
10156
|
+
}[];
|
|
10157
|
+
context?: unknown;
|
|
10158
|
+
};
|
|
10159
|
+
};
|
|
10160
|
+
};
|
|
10161
|
+
/** @description Forbidden */
|
|
10162
|
+
403: {
|
|
10163
|
+
headers: {
|
|
10164
|
+
[name: string]: unknown;
|
|
10165
|
+
};
|
|
10166
|
+
content: {
|
|
10167
|
+
"application/json": {
|
|
10168
|
+
code: string;
|
|
10169
|
+
message: string;
|
|
10170
|
+
links?: {
|
|
10171
|
+
docs: string;
|
|
10172
|
+
schema: string;
|
|
10173
|
+
};
|
|
10174
|
+
issues?: {
|
|
10175
|
+
message: string;
|
|
10176
|
+
path?: (string | number)[];
|
|
10177
|
+
schema?: string;
|
|
10178
|
+
}[];
|
|
10179
|
+
context?: unknown;
|
|
10180
|
+
};
|
|
10181
|
+
};
|
|
10182
|
+
};
|
|
10183
|
+
/** @description Not found */
|
|
10184
|
+
404: {
|
|
10185
|
+
headers: {
|
|
10186
|
+
[name: string]: unknown;
|
|
10187
|
+
};
|
|
10188
|
+
content: {
|
|
10189
|
+
"application/json": {
|
|
10190
|
+
code: string;
|
|
10191
|
+
message: string;
|
|
10192
|
+
links?: {
|
|
10193
|
+
docs: string;
|
|
10194
|
+
schema: string;
|
|
10195
|
+
};
|
|
10196
|
+
issues?: {
|
|
10197
|
+
message: string;
|
|
10198
|
+
path?: (string | number)[];
|
|
10199
|
+
schema?: string;
|
|
10200
|
+
}[];
|
|
10201
|
+
context?: unknown;
|
|
10202
|
+
};
|
|
10203
|
+
};
|
|
10204
|
+
};
|
|
10205
|
+
/** @description Internal server error */
|
|
10206
|
+
500: {
|
|
10207
|
+
headers: {
|
|
10208
|
+
[name: string]: unknown;
|
|
10209
|
+
};
|
|
10210
|
+
content: {
|
|
10211
|
+
"application/json": {
|
|
10212
|
+
code: string;
|
|
10213
|
+
message: string;
|
|
10214
|
+
links?: {
|
|
10215
|
+
docs: string;
|
|
10216
|
+
schema: string;
|
|
10217
|
+
};
|
|
10218
|
+
issues?: {
|
|
10219
|
+
message: string;
|
|
10220
|
+
path?: (string | number)[];
|
|
10221
|
+
schema?: string;
|
|
10222
|
+
}[];
|
|
10223
|
+
context?: unknown;
|
|
10224
|
+
};
|
|
10225
|
+
};
|
|
10226
|
+
};
|
|
10227
|
+
/** @description Service unavailable */
|
|
10228
|
+
503: {
|
|
10229
|
+
headers: {
|
|
10230
|
+
[name: string]: unknown;
|
|
10231
|
+
};
|
|
10232
|
+
content: {
|
|
10233
|
+
"application/json": {
|
|
10234
|
+
code: string;
|
|
10235
|
+
message: string;
|
|
10236
|
+
links?: {
|
|
10237
|
+
docs: string;
|
|
10238
|
+
schema: string;
|
|
10239
|
+
};
|
|
10240
|
+
issues?: {
|
|
10241
|
+
message: string;
|
|
10242
|
+
path?: (string | number)[];
|
|
10243
|
+
schema?: string;
|
|
10244
|
+
}[];
|
|
10245
|
+
context?: unknown;
|
|
10246
|
+
};
|
|
10247
|
+
};
|
|
10248
|
+
};
|
|
10249
|
+
};
|
|
10250
|
+
};
|
|
10251
|
+
getAuditActionsById: {
|
|
10252
|
+
parameters: {
|
|
10253
|
+
query?: never;
|
|
10254
|
+
header?: never;
|
|
10255
|
+
path: {
|
|
10256
|
+
id: string;
|
|
10257
|
+
};
|
|
10258
|
+
cookie?: never;
|
|
10259
|
+
};
|
|
10260
|
+
requestBody?: never;
|
|
10261
|
+
responses: {
|
|
10262
|
+
/** @description Successful response */
|
|
10263
|
+
200: {
|
|
10264
|
+
headers: {
|
|
10265
|
+
[name: string]: unknown;
|
|
10266
|
+
};
|
|
10267
|
+
content: {
|
|
10268
|
+
"application/json": {
|
|
10269
|
+
/** Format: uuid */
|
|
10270
|
+
id: string;
|
|
10271
|
+
/** Format: uuid */
|
|
10272
|
+
tenantId: string;
|
|
10273
|
+
actionType: string;
|
|
10274
|
+
rootEntityType: string | null;
|
|
10275
|
+
rootEntityId: string | null;
|
|
10276
|
+
message: string | null;
|
|
10277
|
+
payload: unknown;
|
|
10278
|
+
userId: string | null;
|
|
10279
|
+
actor: {
|
|
10280
|
+
id: string | null;
|
|
10281
|
+
type: string;
|
|
10282
|
+
name: string | null;
|
|
10283
|
+
email: string | null;
|
|
10284
|
+
};
|
|
10285
|
+
/**
|
|
10286
|
+
* Format: date-time
|
|
10287
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10288
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
10289
|
+
*/
|
|
10290
|
+
createdAt: string;
|
|
10291
|
+
source: string | null;
|
|
10292
|
+
apiVersion: string;
|
|
10293
|
+
requestId: string | null;
|
|
10294
|
+
traceId: string | null;
|
|
10295
|
+
parentActionId: string | null;
|
|
10296
|
+
effectCounts: {
|
|
10297
|
+
total: number;
|
|
10298
|
+
pending: number;
|
|
10299
|
+
claimed: number;
|
|
10300
|
+
running: number;
|
|
10301
|
+
completed: number;
|
|
10302
|
+
failed: number;
|
|
10303
|
+
deadLetter: number;
|
|
10762
10304
|
};
|
|
10763
10305
|
};
|
|
10764
10306
|
};
|
|
@@ -10897,12 +10439,17 @@ export interface operations {
|
|
|
10897
10439
|
};
|
|
10898
10440
|
};
|
|
10899
10441
|
};
|
|
10900
|
-
|
|
10442
|
+
getAuditEffects: {
|
|
10901
10443
|
parameters: {
|
|
10902
10444
|
query?: {
|
|
10903
|
-
|
|
10904
|
-
|
|
10905
|
-
|
|
10445
|
+
limit?: number;
|
|
10446
|
+
offset?: number;
|
|
10447
|
+
actionId?: string;
|
|
10448
|
+
entityId?: string;
|
|
10449
|
+
entityType?: "account" | "journalEntry" | "listingOwnershipPeriod" | "ownerStatement" | "recurringTransactionTemplate" | "reservation" | "tenant" | "transaction" | "transactionAttachment";
|
|
10450
|
+
status?: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
|
|
10451
|
+
effectType?: "BANK_ACCOUNT_CREATED_TRACK" | "CALENDAR_UNBLOCK_ACTION" | "CREATE_RECURRING_TRANSACTION_INSTANCE" | "JOURNAL_ENTRY_SET_ACTIVE" | "JOURNAL_ENTRY_SET_INACTIVE" | "LINK_JOURNAL_TO_OWNERSHIP_PERIOD" | "RECALCULATE_BANK_RECORD_BALANCES" | "REFRESH_RESERVATION_JOURNAL" | "DELETE_TRANSACTION_ATTACHMENT_BLOB" | "MAP_DEPOSIT_TRANSACTIONS_BY_LAST4" | "REFRESH_TRANSACTION_JOURNAL" | "SEND_STATEMENT_NOTIFICATIONS" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "TENANT_HYPERLINE_SYNC" | "TENANT_INIT" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
|
|
10452
|
+
page?: number;
|
|
10906
10453
|
};
|
|
10907
10454
|
header?: never;
|
|
10908
10455
|
path?: never;
|
|
@@ -10920,41 +10467,193 @@ export interface operations {
|
|
|
10920
10467
|
data: {
|
|
10921
10468
|
/** Format: uuid */
|
|
10922
10469
|
id: string;
|
|
10923
|
-
|
|
10924
|
-
type?: ("deposit" | "creditCard") | null;
|
|
10925
|
-
category?: ("trust" | "operating" | "external") | null;
|
|
10926
|
-
uniqueRef?: string | null;
|
|
10927
|
-
currency?: string | null;
|
|
10928
|
-
lastDigits?: string | null;
|
|
10929
|
-
/** @enum {string} */
|
|
10930
|
-
status: "active" | "inactive";
|
|
10931
|
-
startDate?: string | null;
|
|
10932
|
-
account?: {
|
|
10933
|
-
id: string;
|
|
10934
|
-
name: string;
|
|
10935
|
-
uniqueRef?: string | null;
|
|
10936
|
-
/** @enum {string} */
|
|
10937
|
-
status: "active" | "inactive";
|
|
10938
|
-
} | null;
|
|
10939
|
-
connection?: {
|
|
10470
|
+
action: {
|
|
10940
10471
|
/** Format: uuid */
|
|
10941
10472
|
id: string;
|
|
10942
|
-
|
|
10943
|
-
|
|
10944
|
-
|
|
10945
|
-
|
|
10946
|
-
|
|
10947
|
-
|
|
10948
|
-
|
|
10949
|
-
|
|
10473
|
+
actionType: string;
|
|
10474
|
+
source: string | null;
|
|
10475
|
+
apiVersion: string;
|
|
10476
|
+
requestId: string | null;
|
|
10477
|
+
traceId: string | null;
|
|
10478
|
+
parentActionId: string | null;
|
|
10479
|
+
actor: {
|
|
10480
|
+
id: string | null;
|
|
10481
|
+
type: string;
|
|
10482
|
+
name: string | null;
|
|
10483
|
+
email: string | null;
|
|
10484
|
+
};
|
|
10485
|
+
};
|
|
10486
|
+
rootEntityType: string | null;
|
|
10487
|
+
rootEntityId: string | null;
|
|
10488
|
+
/** @enum {string} */
|
|
10489
|
+
effectType: "BANK_ACCOUNT_CREATED_TRACK" | "CALENDAR_UNBLOCK_ACTION" | "CREATE_RECURRING_TRANSACTION_INSTANCE" | "JOURNAL_ENTRY_SET_ACTIVE" | "JOURNAL_ENTRY_SET_INACTIVE" | "LINK_JOURNAL_TO_OWNERSHIP_PERIOD" | "RECALCULATE_BANK_RECORD_BALANCES" | "REFRESH_RESERVATION_JOURNAL" | "DELETE_TRANSACTION_ATTACHMENT_BLOB" | "MAP_DEPOSIT_TRANSACTIONS_BY_LAST4" | "REFRESH_TRANSACTION_JOURNAL" | "SEND_STATEMENT_NOTIFICATIONS" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "TENANT_HYPERLINE_SYNC" | "TENANT_INIT" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
|
|
10490
|
+
payload: unknown;
|
|
10491
|
+
entity: ({
|
|
10492
|
+
/** @constant */
|
|
10493
|
+
type: "reservation";
|
|
10494
|
+
data: {
|
|
10495
|
+
id: string;
|
|
10496
|
+
confirmationCode?: string | null;
|
|
10497
|
+
uniqueRef: string;
|
|
10498
|
+
/** @enum {string} */
|
|
10499
|
+
status: "booked" | "canceled" | "inactive";
|
|
10500
|
+
checkIn?: string | null;
|
|
10501
|
+
checkOut?: string | null;
|
|
10502
|
+
};
|
|
10503
|
+
} | {
|
|
10504
|
+
/** @constant */
|
|
10505
|
+
type: "transaction";
|
|
10506
|
+
data: {
|
|
10507
|
+
id: string;
|
|
10508
|
+
/** @enum {string} */
|
|
10509
|
+
status: "active" | "inactive";
|
|
10510
|
+
/** @description Value in cents (100 = 1€) */
|
|
10511
|
+
amount: number;
|
|
10512
|
+
account?: {
|
|
10513
|
+
id: string;
|
|
10514
|
+
name: string;
|
|
10515
|
+
uniqueRef?: string | null;
|
|
10516
|
+
/** @enum {string} */
|
|
10517
|
+
status: "active" | "inactive";
|
|
10518
|
+
} | null;
|
|
10519
|
+
date: string;
|
|
10520
|
+
description: string;
|
|
10521
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
10522
|
+
currency: string;
|
|
10523
|
+
/** @enum {string} */
|
|
10524
|
+
type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
|
|
10525
|
+
isOpeningBalance: boolean;
|
|
10526
|
+
contact?: {
|
|
10527
|
+
/** Format: uuid */
|
|
10528
|
+
id: string;
|
|
10529
|
+
name?: string | null;
|
|
10530
|
+
firstName?: string | null;
|
|
10531
|
+
uniqueRef?: string | null;
|
|
10532
|
+
shortRef?: string | null;
|
|
10533
|
+
email?: string | null;
|
|
10534
|
+
/** @enum {string} */
|
|
10535
|
+
type: "owner" | "vendor";
|
|
10536
|
+
} | null;
|
|
10537
|
+
connection?: {
|
|
10538
|
+
/** Format: uuid */
|
|
10539
|
+
id: string;
|
|
10540
|
+
name: string;
|
|
10541
|
+
/** @enum {string} */
|
|
10542
|
+
status: "active" | "inactive";
|
|
10543
|
+
uniqueRef?: string | null;
|
|
10544
|
+
appId: string;
|
|
10545
|
+
} | null;
|
|
10546
|
+
uniqueRef?: string | null;
|
|
10547
|
+
shortRef?: string | null;
|
|
10548
|
+
recurringTemplate?: {
|
|
10549
|
+
id: string;
|
|
10550
|
+
} | null;
|
|
10551
|
+
};
|
|
10552
|
+
} | {
|
|
10553
|
+
/** @constant */
|
|
10554
|
+
type: "recurringTransactionTemplate";
|
|
10555
|
+
data: {
|
|
10556
|
+
id: string;
|
|
10557
|
+
/** @enum {string} */
|
|
10558
|
+
status: "active" | "inactive";
|
|
10559
|
+
/** @description Value in cents (100 = 1€) */
|
|
10560
|
+
amount: number;
|
|
10561
|
+
account?: {
|
|
10562
|
+
id: string;
|
|
10563
|
+
name: string;
|
|
10564
|
+
uniqueRef?: string | null;
|
|
10565
|
+
/** @enum {string} */
|
|
10566
|
+
status: "active" | "inactive";
|
|
10567
|
+
} | null;
|
|
10568
|
+
date: string;
|
|
10569
|
+
description: string;
|
|
10570
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
10571
|
+
currency: string;
|
|
10572
|
+
/** @enum {string} */
|
|
10573
|
+
type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
|
|
10574
|
+
isOpeningBalance: boolean;
|
|
10575
|
+
contact?: {
|
|
10576
|
+
/** Format: uuid */
|
|
10577
|
+
id: string;
|
|
10578
|
+
name?: string | null;
|
|
10579
|
+
firstName?: string | null;
|
|
10580
|
+
uniqueRef?: string | null;
|
|
10581
|
+
shortRef?: string | null;
|
|
10582
|
+
email?: string | null;
|
|
10583
|
+
/** @enum {string} */
|
|
10584
|
+
type: "owner" | "vendor";
|
|
10585
|
+
} | null;
|
|
10586
|
+
connection?: {
|
|
10587
|
+
/** Format: uuid */
|
|
10588
|
+
id: string;
|
|
10589
|
+
name: string;
|
|
10590
|
+
/** @enum {string} */
|
|
10591
|
+
status: "active" | "inactive";
|
|
10592
|
+
uniqueRef?: string | null;
|
|
10593
|
+
appId: string;
|
|
10594
|
+
} | null;
|
|
10595
|
+
uniqueRef?: string | null;
|
|
10596
|
+
shortRef?: string | null;
|
|
10597
|
+
recurringTemplate?: {
|
|
10598
|
+
id: string;
|
|
10599
|
+
} | null;
|
|
10600
|
+
};
|
|
10601
|
+
} | {
|
|
10602
|
+
/** @constant */
|
|
10603
|
+
type: "other";
|
|
10604
|
+
data: {
|
|
10605
|
+
/** Format: uuid */
|
|
10606
|
+
id: string;
|
|
10607
|
+
type: string;
|
|
10608
|
+
name: string | null;
|
|
10609
|
+
};
|
|
10610
|
+
}) | null;
|
|
10611
|
+
/** @enum {string} */
|
|
10612
|
+
status: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
|
|
10613
|
+
priority: number;
|
|
10614
|
+
retryCount: number;
|
|
10615
|
+
maxRetries: number;
|
|
10616
|
+
sequence: number;
|
|
10617
|
+
claimedAt: string | null;
|
|
10618
|
+
claimedBy: string | null;
|
|
10619
|
+
completedAt: string | null;
|
|
10620
|
+
lastAttemptAt: string | null;
|
|
10621
|
+
lastError: string | null;
|
|
10622
|
+
latestAttempt: {
|
|
10950
10623
|
/** Format: uuid */
|
|
10951
10624
|
id: string;
|
|
10952
|
-
|
|
10953
|
-
status
|
|
10954
|
-
|
|
10955
|
-
|
|
10625
|
+
/** @enum {string} */
|
|
10626
|
+
status: "running" | "completed" | "failed" | "skipped_locked";
|
|
10627
|
+
attemptNum: number;
|
|
10628
|
+
/**
|
|
10629
|
+
* Format: date-time
|
|
10630
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10631
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
10632
|
+
*/
|
|
10633
|
+
startedAt: string;
|
|
10634
|
+
finishedAt: string | null;
|
|
10635
|
+
workerId: string | null;
|
|
10636
|
+
resultCode: string | null;
|
|
10637
|
+
resultCategory: string | null;
|
|
10638
|
+
retryable: boolean | null;
|
|
10639
|
+
errorMessage: string | null;
|
|
10956
10640
|
} | null;
|
|
10641
|
+
/**
|
|
10642
|
+
* Format: date-time
|
|
10643
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10644
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
10645
|
+
*/
|
|
10646
|
+
createdAt: string;
|
|
10957
10647
|
}[];
|
|
10648
|
+
pagination: {
|
|
10649
|
+
/** @default 100 */
|
|
10650
|
+
limit: number;
|
|
10651
|
+
/** @default 1 */
|
|
10652
|
+
page: number;
|
|
10653
|
+
total: number;
|
|
10654
|
+
totalPage: number;
|
|
10655
|
+
nextPage?: number;
|
|
10656
|
+
};
|
|
10958
10657
|
};
|
|
10959
10658
|
};
|
|
10960
10659
|
};
|
|
@@ -11092,39 +10791,27 @@ export interface operations {
|
|
|
11092
10791
|
};
|
|
11093
10792
|
};
|
|
11094
10793
|
};
|
|
11095
|
-
|
|
10794
|
+
getAuditJournalDeltas: {
|
|
11096
10795
|
parameters: {
|
|
11097
10796
|
query?: {
|
|
11098
|
-
|
|
11099
|
-
|
|
10797
|
+
limit?: number;
|
|
10798
|
+
offset?: number;
|
|
10799
|
+
actionId?: string;
|
|
10800
|
+
effectId?: string;
|
|
10801
|
+
mutationId?: string;
|
|
10802
|
+
journalEntryId?: string;
|
|
10803
|
+
operation?: "insert" | "update" | "delete";
|
|
10804
|
+
rootEntityType?: string;
|
|
10805
|
+
rootEntityId?: string;
|
|
10806
|
+
startAt?: string;
|
|
10807
|
+
endAt?: string;
|
|
10808
|
+
page?: number;
|
|
11100
10809
|
};
|
|
11101
10810
|
header?: never;
|
|
11102
10811
|
path?: never;
|
|
11103
10812
|
cookie?: never;
|
|
11104
10813
|
};
|
|
11105
|
-
requestBody?:
|
|
11106
|
-
content: {
|
|
11107
|
-
"application/json": {
|
|
11108
|
-
/** Format: uuid */
|
|
11109
|
-
connectionId: string;
|
|
11110
|
-
data: {
|
|
11111
|
-
id?: string | null;
|
|
11112
|
-
/** @enum {string} */
|
|
11113
|
-
type: "deposit" | "creditCard";
|
|
11114
|
-
/** @enum {string} */
|
|
11115
|
-
category: "trust" | "operating" | "external";
|
|
11116
|
-
name: string;
|
|
11117
|
-
uniqueRef?: string | null;
|
|
11118
|
-
sourceId?: string | null;
|
|
11119
|
-
currency?: string | null;
|
|
11120
|
-
lastDigits?: string | null;
|
|
11121
|
-
status?: ("active" | "inactive") | null;
|
|
11122
|
-
accountId?: string | null;
|
|
11123
|
-
startDate?: string | null;
|
|
11124
|
-
}[];
|
|
11125
|
-
};
|
|
11126
|
-
};
|
|
11127
|
-
};
|
|
10814
|
+
requestBody?: never;
|
|
11128
10815
|
responses: {
|
|
11129
10816
|
/** @description Successful response */
|
|
11130
10817
|
200: {
|
|
@@ -11136,17 +10823,51 @@ export interface operations {
|
|
|
11136
10823
|
data: {
|
|
11137
10824
|
/** Format: uuid */
|
|
11138
10825
|
id: string;
|
|
11139
|
-
|
|
11140
|
-
|
|
11141
|
-
|
|
11142
|
-
|
|
11143
|
-
|
|
11144
|
-
|
|
11145
|
-
|
|
10826
|
+
/** Format: uuid */
|
|
10827
|
+
tenantId: string;
|
|
10828
|
+
/** Format: uuid */
|
|
10829
|
+
journalEntryId: string;
|
|
10830
|
+
/** Format: uuid */
|
|
10831
|
+
actionId: string;
|
|
10832
|
+
effectId: string | null;
|
|
10833
|
+
mutationId: string | null;
|
|
10834
|
+
rootEntityType: string | null;
|
|
10835
|
+
rootEntityId: string | null;
|
|
11146
10836
|
/** @enum {string} */
|
|
11147
|
-
|
|
11148
|
-
|
|
10837
|
+
operation: "insert" | "update" | "delete";
|
|
10838
|
+
/**
|
|
10839
|
+
* Format: date-time
|
|
10840
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
10841
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
10842
|
+
*/
|
|
10843
|
+
changedAt: string;
|
|
10844
|
+
apiVersion: string;
|
|
10845
|
+
changedFields: string[];
|
|
10846
|
+
diffJson: unknown | null;
|
|
10847
|
+
accountIdBefore: string | null;
|
|
10848
|
+
accountIdAfter: string | null;
|
|
10849
|
+
centTotalBefore: number | null;
|
|
10850
|
+
centTotalAfter: number | null;
|
|
10851
|
+
txnAtBefore: string | null;
|
|
10852
|
+
txnAtAfter: string | null;
|
|
10853
|
+
statusBefore: string | null;
|
|
10854
|
+
statusAfter: string | null;
|
|
10855
|
+
partyBefore: string | null;
|
|
10856
|
+
partyAfter: string | null;
|
|
10857
|
+
listingOwnershipPeriodIdBefore: string | null;
|
|
10858
|
+
listingOwnershipPeriodIdAfter: string | null;
|
|
10859
|
+
attachedToOwnerStatementIdBefore: string | null;
|
|
10860
|
+
attachedToOwnerStatementIdAfter: string | null;
|
|
11149
10861
|
}[];
|
|
10862
|
+
pagination: {
|
|
10863
|
+
/** @default 100 */
|
|
10864
|
+
limit: number;
|
|
10865
|
+
/** @default 1 */
|
|
10866
|
+
page: number;
|
|
10867
|
+
total: number;
|
|
10868
|
+
totalPage: number;
|
|
10869
|
+
nextPage?: number;
|
|
10870
|
+
};
|
|
11150
10871
|
};
|
|
11151
10872
|
};
|
|
11152
10873
|
};
|
|
@@ -11284,13 +11005,23 @@ export interface operations {
|
|
|
11284
11005
|
};
|
|
11285
11006
|
};
|
|
11286
11007
|
};
|
|
11287
|
-
|
|
11008
|
+
getAuditMutations: {
|
|
11288
11009
|
parameters: {
|
|
11289
|
-
query?:
|
|
11290
|
-
|
|
11291
|
-
|
|
11292
|
-
|
|
11010
|
+
query?: {
|
|
11011
|
+
limit?: number;
|
|
11012
|
+
offset?: number;
|
|
11013
|
+
actionId?: string;
|
|
11014
|
+
effectId?: string;
|
|
11015
|
+
entityType?: string;
|
|
11016
|
+
entityId?: string;
|
|
11017
|
+
op?: string;
|
|
11018
|
+
outcome?: string;
|
|
11019
|
+
startAt?: string;
|
|
11020
|
+
endAt?: string;
|
|
11021
|
+
page?: number;
|
|
11293
11022
|
};
|
|
11023
|
+
header?: never;
|
|
11024
|
+
path?: never;
|
|
11294
11025
|
cookie?: never;
|
|
11295
11026
|
};
|
|
11296
11027
|
requestBody?: never;
|
|
@@ -11302,33 +11033,64 @@ export interface operations {
|
|
|
11302
11033
|
};
|
|
11303
11034
|
content: {
|
|
11304
11035
|
"application/json": {
|
|
11305
|
-
|
|
11306
|
-
id: string;
|
|
11307
|
-
/** @enum {string} */
|
|
11308
|
-
type: "deposit" | "creditCard";
|
|
11309
|
-
/** @enum {string} */
|
|
11310
|
-
category: "trust" | "operating" | "external";
|
|
11311
|
-
name: string;
|
|
11312
|
-
uniqueRef?: string | null;
|
|
11313
|
-
currency?: string | null;
|
|
11314
|
-
lastDigits?: string | null;
|
|
11315
|
-
status: ("active" | "inactive") | null;
|
|
11316
|
-
startDate?: string | null;
|
|
11317
|
-
account?: {
|
|
11318
|
-
id: string;
|
|
11319
|
-
name: string;
|
|
11320
|
-
uniqueRef?: string | null;
|
|
11321
|
-
/** @enum {string} */
|
|
11322
|
-
status: "active" | "inactive";
|
|
11323
|
-
} | null;
|
|
11324
|
-
source?: {
|
|
11036
|
+
data: {
|
|
11325
11037
|
/** Format: uuid */
|
|
11326
11038
|
id: string;
|
|
11327
|
-
|
|
11328
|
-
|
|
11329
|
-
|
|
11330
|
-
|
|
11331
|
-
|
|
11039
|
+
/** Format: uuid */
|
|
11040
|
+
tenantId: string;
|
|
11041
|
+
/** Format: uuid */
|
|
11042
|
+
actionId: string;
|
|
11043
|
+
effectId: string | null;
|
|
11044
|
+
op: string;
|
|
11045
|
+
rootEntityType: string | null;
|
|
11046
|
+
rootEntityId: string | null;
|
|
11047
|
+
subjectType: string;
|
|
11048
|
+
/** Format: uuid */
|
|
11049
|
+
subjectId: string;
|
|
11050
|
+
outcome: string | null;
|
|
11051
|
+
changeRecord: {
|
|
11052
|
+
summary: string;
|
|
11053
|
+
changedKeys: string[];
|
|
11054
|
+
reasonCode: string;
|
|
11055
|
+
outcome: string;
|
|
11056
|
+
context: {
|
|
11057
|
+
[key: string]: unknown;
|
|
11058
|
+
} | null;
|
|
11059
|
+
} & {
|
|
11060
|
+
[key: string]: unknown;
|
|
11061
|
+
};
|
|
11062
|
+
/**
|
|
11063
|
+
* Format: date-time
|
|
11064
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11065
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11066
|
+
*/
|
|
11067
|
+
createdAt: string;
|
|
11068
|
+
action: {
|
|
11069
|
+
/** Format: uuid */
|
|
11070
|
+
id: string;
|
|
11071
|
+
actionType: string;
|
|
11072
|
+
source: string | null;
|
|
11073
|
+
apiVersion: string;
|
|
11074
|
+
requestId: string | null;
|
|
11075
|
+
traceId: string | null;
|
|
11076
|
+
parentActionId: string | null;
|
|
11077
|
+
actor: {
|
|
11078
|
+
id: string | null;
|
|
11079
|
+
type: string;
|
|
11080
|
+
name: string | null;
|
|
11081
|
+
email: string | null;
|
|
11082
|
+
};
|
|
11083
|
+
};
|
|
11084
|
+
}[];
|
|
11085
|
+
pagination: {
|
|
11086
|
+
/** @default 100 */
|
|
11087
|
+
limit: number;
|
|
11088
|
+
/** @default 1 */
|
|
11089
|
+
page: number;
|
|
11090
|
+
total: number;
|
|
11091
|
+
totalPage: number;
|
|
11092
|
+
nextPage?: number;
|
|
11093
|
+
};
|
|
11332
11094
|
};
|
|
11333
11095
|
};
|
|
11334
11096
|
};
|
|
@@ -11466,36 +11228,28 @@ export interface operations {
|
|
|
11466
11228
|
};
|
|
11467
11229
|
};
|
|
11468
11230
|
};
|
|
11469
|
-
|
|
11231
|
+
getAuditTimeline: {
|
|
11470
11232
|
parameters: {
|
|
11471
|
-
query
|
|
11472
|
-
|
|
11473
|
-
|
|
11233
|
+
query: {
|
|
11234
|
+
rootEntityType: string;
|
|
11235
|
+
rootEntityId: string;
|
|
11236
|
+
/** @description Timeline item type filter. Accepts repeated `types=value` query params or one comma-separated string. */
|
|
11237
|
+
types?: ("action" | "effect" | "effect_attempt" | "mutation" | "journal_delta")[];
|
|
11238
|
+
/** @description Temporal boundary string parsed by the API. Prefer `YYYY-MM-DD` for day-granularity filters or an ISO 8601 timestamp for exact time bounds. */
|
|
11239
|
+
from?: string;
|
|
11240
|
+
/** @description Temporal boundary string parsed by the API. Prefer `YYYY-MM-DD` for day-granularity filters or an ISO 8601 timestamp for exact time bounds. */
|
|
11241
|
+
to?: string;
|
|
11242
|
+
/** @description When true, include diff payloads in audit timeline journal delta entries. */
|
|
11243
|
+
includeDiff?: boolean;
|
|
11244
|
+
limit?: number;
|
|
11245
|
+
/** @description Opaque pagination cursor returned by a previous response. Pass it back unchanged. */
|
|
11246
|
+
cursor?: string;
|
|
11474
11247
|
};
|
|
11475
11248
|
header?: never;
|
|
11476
|
-
path
|
|
11477
|
-
id: string;
|
|
11478
|
-
};
|
|
11249
|
+
path?: never;
|
|
11479
11250
|
cookie?: never;
|
|
11480
11251
|
};
|
|
11481
|
-
requestBody?:
|
|
11482
|
-
content: {
|
|
11483
|
-
"application/json": {
|
|
11484
|
-
/** @enum {string} */
|
|
11485
|
-
type?: "deposit" | "creditCard";
|
|
11486
|
-
/** @enum {string} */
|
|
11487
|
-
category?: "trust" | "operating" | "external";
|
|
11488
|
-
name?: string;
|
|
11489
|
-
uniqueRef?: string | null;
|
|
11490
|
-
sourceId?: string | null;
|
|
11491
|
-
currency?: string | null;
|
|
11492
|
-
lastDigits?: string | null;
|
|
11493
|
-
status?: ("active" | "inactive") | null;
|
|
11494
|
-
accountId?: string | null;
|
|
11495
|
-
startDate?: string | null;
|
|
11496
|
-
};
|
|
11497
|
-
};
|
|
11498
|
-
};
|
|
11252
|
+
requestBody?: never;
|
|
11499
11253
|
responses: {
|
|
11500
11254
|
/** @description Successful response */
|
|
11501
11255
|
200: {
|
|
@@ -11504,33 +11258,181 @@ export interface operations {
|
|
|
11504
11258
|
};
|
|
11505
11259
|
content: {
|
|
11506
11260
|
"application/json": {
|
|
11507
|
-
|
|
11508
|
-
|
|
11509
|
-
|
|
11510
|
-
|
|
11511
|
-
/** @enum {string} */
|
|
11512
|
-
category: "trust" | "operating" | "external";
|
|
11513
|
-
name: string;
|
|
11514
|
-
uniqueRef?: string | null;
|
|
11515
|
-
currency?: string | null;
|
|
11516
|
-
lastDigits?: string | null;
|
|
11517
|
-
status: ("active" | "inactive") | null;
|
|
11518
|
-
startDate?: string | null;
|
|
11519
|
-
account?: {
|
|
11261
|
+
data: ({
|
|
11262
|
+
/** @constant */
|
|
11263
|
+
type: "action";
|
|
11264
|
+
/** Format: uuid */
|
|
11520
11265
|
id: string;
|
|
11521
|
-
|
|
11522
|
-
|
|
11523
|
-
|
|
11524
|
-
|
|
11525
|
-
|
|
11526
|
-
|
|
11266
|
+
/**
|
|
11267
|
+
* Format: date-time
|
|
11268
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11269
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11270
|
+
*/
|
|
11271
|
+
timestamp: string;
|
|
11272
|
+
actionId: string | null;
|
|
11273
|
+
effectId: string | null;
|
|
11274
|
+
mutationId: string | null;
|
|
11275
|
+
rootEntityType: string | null;
|
|
11276
|
+
rootEntityId: string | null;
|
|
11277
|
+
data: {
|
|
11278
|
+
actionType: string;
|
|
11279
|
+
message: string | null;
|
|
11280
|
+
payload: unknown | null;
|
|
11281
|
+
source: string | null;
|
|
11282
|
+
apiVersion: string;
|
|
11283
|
+
requestId: string | null;
|
|
11284
|
+
traceId: string | null;
|
|
11285
|
+
parentActionId: string | null;
|
|
11286
|
+
actor: {
|
|
11287
|
+
id: string | null;
|
|
11288
|
+
type: string;
|
|
11289
|
+
name: string | null;
|
|
11290
|
+
email: string | null;
|
|
11291
|
+
};
|
|
11292
|
+
};
|
|
11293
|
+
} | {
|
|
11294
|
+
/** @constant */
|
|
11295
|
+
type: "effect";
|
|
11527
11296
|
/** Format: uuid */
|
|
11528
11297
|
id: string;
|
|
11529
|
-
|
|
11530
|
-
|
|
11531
|
-
|
|
11532
|
-
|
|
11533
|
-
|
|
11298
|
+
/**
|
|
11299
|
+
* Format: date-time
|
|
11300
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11301
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11302
|
+
*/
|
|
11303
|
+
timestamp: string;
|
|
11304
|
+
actionId: string | null;
|
|
11305
|
+
effectId: string | null;
|
|
11306
|
+
mutationId: string | null;
|
|
11307
|
+
rootEntityType: string | null;
|
|
11308
|
+
rootEntityId: string | null;
|
|
11309
|
+
data: {
|
|
11310
|
+
effectType: string;
|
|
11311
|
+
status: string;
|
|
11312
|
+
payload: unknown;
|
|
11313
|
+
entityType: string | null;
|
|
11314
|
+
entityId: string | null;
|
|
11315
|
+
priority: number;
|
|
11316
|
+
retryCount: number;
|
|
11317
|
+
maxRetries: number;
|
|
11318
|
+
claimedAt: string | null;
|
|
11319
|
+
claimedBy: string | null;
|
|
11320
|
+
completedAt: string | null;
|
|
11321
|
+
lastAttemptAt: string | null;
|
|
11322
|
+
lastError: string | null;
|
|
11323
|
+
};
|
|
11324
|
+
} | {
|
|
11325
|
+
/** @constant */
|
|
11326
|
+
type: "effect_attempt";
|
|
11327
|
+
/** Format: uuid */
|
|
11328
|
+
id: string;
|
|
11329
|
+
/**
|
|
11330
|
+
* Format: date-time
|
|
11331
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11332
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11333
|
+
*/
|
|
11334
|
+
timestamp: string;
|
|
11335
|
+
actionId: string | null;
|
|
11336
|
+
effectId: string | null;
|
|
11337
|
+
mutationId: string | null;
|
|
11338
|
+
rootEntityType: string | null;
|
|
11339
|
+
rootEntityId: string | null;
|
|
11340
|
+
data: {
|
|
11341
|
+
/** @enum {string} */
|
|
11342
|
+
status: "running" | "completed" | "failed" | "skipped_locked";
|
|
11343
|
+
attemptNum: number;
|
|
11344
|
+
/**
|
|
11345
|
+
* Format: date-time
|
|
11346
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11347
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11348
|
+
*/
|
|
11349
|
+
startedAt: string;
|
|
11350
|
+
finishedAt: string | null;
|
|
11351
|
+
workerId: string | null;
|
|
11352
|
+
resultCode: string | null;
|
|
11353
|
+
resultCategory: string | null;
|
|
11354
|
+
retryable: boolean | null;
|
|
11355
|
+
errorMessage: string | null;
|
|
11356
|
+
};
|
|
11357
|
+
} | {
|
|
11358
|
+
/** @constant */
|
|
11359
|
+
type: "mutation";
|
|
11360
|
+
/** Format: uuid */
|
|
11361
|
+
id: string;
|
|
11362
|
+
/**
|
|
11363
|
+
* Format: date-time
|
|
11364
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11365
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11366
|
+
*/
|
|
11367
|
+
timestamp: string;
|
|
11368
|
+
actionId: string | null;
|
|
11369
|
+
effectId: string | null;
|
|
11370
|
+
mutationId: string | null;
|
|
11371
|
+
rootEntityType: string | null;
|
|
11372
|
+
rootEntityId: string | null;
|
|
11373
|
+
data: {
|
|
11374
|
+
op: string;
|
|
11375
|
+
subjectType: string;
|
|
11376
|
+
/** Format: uuid */
|
|
11377
|
+
subjectId: string;
|
|
11378
|
+
outcome: string | null;
|
|
11379
|
+
changeRecord: {
|
|
11380
|
+
summary: string;
|
|
11381
|
+
changedKeys: string[];
|
|
11382
|
+
reasonCode: string;
|
|
11383
|
+
outcome: string;
|
|
11384
|
+
context: {
|
|
11385
|
+
[key: string]: unknown;
|
|
11386
|
+
} | null;
|
|
11387
|
+
} & {
|
|
11388
|
+
[key: string]: unknown;
|
|
11389
|
+
};
|
|
11390
|
+
};
|
|
11391
|
+
} | {
|
|
11392
|
+
/** @constant */
|
|
11393
|
+
type: "journal_delta";
|
|
11394
|
+
/** Format: uuid */
|
|
11395
|
+
id: string;
|
|
11396
|
+
/**
|
|
11397
|
+
* Format: date-time
|
|
11398
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11399
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11400
|
+
*/
|
|
11401
|
+
timestamp: string;
|
|
11402
|
+
actionId: string | null;
|
|
11403
|
+
effectId: string | null;
|
|
11404
|
+
mutationId: string | null;
|
|
11405
|
+
rootEntityType: string | null;
|
|
11406
|
+
rootEntityId: string | null;
|
|
11407
|
+
data: {
|
|
11408
|
+
/** Format: uuid */
|
|
11409
|
+
journalEntryId: string;
|
|
11410
|
+
/** @enum {string} */
|
|
11411
|
+
operation: "insert" | "update" | "delete";
|
|
11412
|
+
changedFields: string[];
|
|
11413
|
+
diffJson: unknown | null;
|
|
11414
|
+
apiVersion: string;
|
|
11415
|
+
accountIdBefore: string | null;
|
|
11416
|
+
accountIdAfter: string | null;
|
|
11417
|
+
centTotalBefore: number | null;
|
|
11418
|
+
centTotalAfter: number | null;
|
|
11419
|
+
txnAtBefore: string | null;
|
|
11420
|
+
txnAtAfter: string | null;
|
|
11421
|
+
statusBefore: string | null;
|
|
11422
|
+
statusAfter: string | null;
|
|
11423
|
+
partyBefore: string | null;
|
|
11424
|
+
partyAfter: string | null;
|
|
11425
|
+
listingOwnershipPeriodIdBefore: string | null;
|
|
11426
|
+
listingOwnershipPeriodIdAfter: string | null;
|
|
11427
|
+
attachedToOwnerStatementIdBefore: string | null;
|
|
11428
|
+
attachedToOwnerStatementIdAfter: string | null;
|
|
11429
|
+
};
|
|
11430
|
+
})[];
|
|
11431
|
+
page: {
|
|
11432
|
+
limit: number;
|
|
11433
|
+
hasMore: boolean;
|
|
11434
|
+
nextCursor: string | null;
|
|
11435
|
+
};
|
|
11534
11436
|
};
|
|
11535
11437
|
};
|
|
11536
11438
|
};
|
|
@@ -11681,7 +11583,7 @@ export interface operations {
|
|
|
11681
11583
|
dateRange?: string;
|
|
11682
11584
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
11683
11585
|
isDateRangeEndInclusive?: boolean;
|
|
11684
|
-
|
|
11586
|
+
accountConnectionId?: string;
|
|
11685
11587
|
accountId?: string;
|
|
11686
11588
|
uniqueRefs?: string;
|
|
11687
11589
|
reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
@@ -11719,8 +11621,8 @@ export interface operations {
|
|
|
11719
11621
|
/** @enum {string} */
|
|
11720
11622
|
status: "active" | "inactive";
|
|
11721
11623
|
description?: string | null;
|
|
11722
|
-
|
|
11723
|
-
|
|
11624
|
+
accountConnectionId?: string | null;
|
|
11625
|
+
accountConnection?: {
|
|
11724
11626
|
/** Format: uuid */
|
|
11725
11627
|
id: string;
|
|
11726
11628
|
name: string;
|
|
@@ -11826,7 +11728,7 @@ export interface operations {
|
|
|
11826
11728
|
date: string;
|
|
11827
11729
|
description: string;
|
|
11828
11730
|
amount: number;
|
|
11829
|
-
|
|
11731
|
+
accountConnectionId?: string | null;
|
|
11830
11732
|
accountId?: string | null;
|
|
11831
11733
|
};
|
|
11832
11734
|
transaction: {
|
|
@@ -12077,7 +11979,7 @@ export interface operations {
|
|
|
12077
11979
|
}[] | null;
|
|
12078
11980
|
};
|
|
12079
11981
|
id?: string | null;
|
|
12080
|
-
|
|
11982
|
+
accountConnectionRef?: string | null;
|
|
12081
11983
|
sourceId?: string | null;
|
|
12082
11984
|
}[];
|
|
12083
11985
|
};
|
|
@@ -12255,7 +12157,7 @@ export interface operations {
|
|
|
12255
12157
|
dateRange?: string;
|
|
12256
12158
|
/** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
|
|
12257
12159
|
isDateRangeEndInclusive?: boolean;
|
|
12258
|
-
|
|
12160
|
+
accountConnectionId?: string;
|
|
12259
12161
|
accountId?: string;
|
|
12260
12162
|
uniqueRefs?: string;
|
|
12261
12163
|
reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
@@ -12449,8 +12351,8 @@ export interface operations {
|
|
|
12449
12351
|
/** @enum {string} */
|
|
12450
12352
|
status: "active" | "inactive";
|
|
12451
12353
|
description?: string | null;
|
|
12452
|
-
|
|
12453
|
-
|
|
12354
|
+
accountConnectionId?: string | null;
|
|
12355
|
+
accountConnection?: {
|
|
12454
12356
|
/** Format: uuid */
|
|
12455
12357
|
id: string;
|
|
12456
12358
|
name: string;
|
|
@@ -12556,7 +12458,7 @@ export interface operations {
|
|
|
12556
12458
|
date: string;
|
|
12557
12459
|
description: string;
|
|
12558
12460
|
amount: number;
|
|
12559
|
-
|
|
12461
|
+
accountConnectionId?: string | null;
|
|
12560
12462
|
accountId?: string | null;
|
|
12561
12463
|
};
|
|
12562
12464
|
transaction: {
|
|
@@ -13753,7 +13655,7 @@ export interface operations {
|
|
|
13753
13655
|
date: string;
|
|
13754
13656
|
description: string;
|
|
13755
13657
|
amount: number;
|
|
13756
|
-
|
|
13658
|
+
accountConnectionId?: string | null;
|
|
13757
13659
|
accountId?: string | null;
|
|
13758
13660
|
};
|
|
13759
13661
|
transaction: {
|
|
@@ -14736,7 +14638,7 @@ export interface operations {
|
|
|
14736
14638
|
date: string;
|
|
14737
14639
|
description: string;
|
|
14738
14640
|
amount: number;
|
|
14739
|
-
|
|
14641
|
+
accountConnectionId?: string | null;
|
|
14740
14642
|
accountId?: string | null;
|
|
14741
14643
|
};
|
|
14742
14644
|
transaction: {
|
|
@@ -65567,7 +65469,7 @@ export interface operations {
|
|
|
65567
65469
|
downloadSource: {
|
|
65568
65470
|
parameters: {
|
|
65569
65471
|
query: {
|
|
65570
|
-
type: "source" | "payment" | "deposit" | "expense" | "payout" | "transfer" | "transaction" | "reservation" | "bankRecord" | "
|
|
65472
|
+
type: "source" | "payment" | "deposit" | "expense" | "payout" | "transfer" | "transaction" | "reservation" | "bankRecord" | "accountConnection" | "listing" | "listingConnection" | "owner" | "ownerStatement";
|
|
65571
65473
|
};
|
|
65572
65474
|
header?: never;
|
|
65573
65475
|
path: {
|
|
@@ -76602,7 +76504,7 @@ export interface operations {
|
|
|
76602
76504
|
content: {
|
|
76603
76505
|
"application/json": {
|
|
76604
76506
|
/** @enum {string} */
|
|
76605
|
-
entityType: "reservation" | "listing" | "transaction" | "payment" | "
|
|
76507
|
+
entityType: "reservation" | "listing" | "transaction" | "payment" | "accountConnection" | "bankRecord" | "contact";
|
|
76606
76508
|
/** Format: uuid */
|
|
76607
76509
|
connectionId?: string;
|
|
76608
76510
|
/** Format: uuid */
|