@vrplatform/api 1.3.1-stage.5160 → 1.3.1-stage.5173
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 +60 -312
- package/build/main/generated/v1.js.map +1 -1
- package/build/module/generated/v1.d.ts +60 -312
- package/build/module/generated/v1.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/v1.ts +60 -312
package/package.json
CHANGED
package/src/generated/v1.ts
CHANGED
|
@@ -4800,7 +4800,7 @@ export interface paths {
|
|
|
4800
4800
|
get?: never;
|
|
4801
4801
|
put?: never;
|
|
4802
4802
|
/**
|
|
4803
|
-
* @description
|
|
4803
|
+
* @description Execute owner statement payouts with one explicit selection per ownership member. Every selection books a payout transaction against its bank account. `provider: "ramp"` additionally dispatches an ACH payment funded through the Ramp account connection of the selected bank account; `provider: null` never dispatches, even when the bank account is Ramp-backed. Each statement validates and executes atomically and independently, so one blocked statement never rolls back earlier results. Raw bank details are never accepted here; owner ACH methods are managed through `POST /contacts/{id}/payment-methods/ach`.
|
|
4804
4804
|
*
|
|
4805
4805
|
* Required scope: statements:pay
|
|
4806
4806
|
*/
|
|
@@ -4821,7 +4821,7 @@ export interface paths {
|
|
|
4821
4821
|
get?: never;
|
|
4822
4822
|
put?: never;
|
|
4823
4823
|
/**
|
|
4824
|
-
* @description Preview
|
|
4824
|
+
* @description Preview owner statement payout plans without creating transactions. Returns authoritative per-owner allocations after server rounding, default bank accounts, ACH payment-method readiness, and typed blockers for the submitted owner selections. `POST /statements/pay` revalidates the same rules; the preview is advisory.
|
|
4825
4825
|
*
|
|
4826
4826
|
* Required scope: statements:read
|
|
4827
4827
|
*/
|
|
@@ -4926,27 +4926,6 @@ export interface paths {
|
|
|
4926
4926
|
patch?: never;
|
|
4927
4927
|
trace?: never;
|
|
4928
4928
|
};
|
|
4929
|
-
"/statements/{id}/pay": {
|
|
4930
|
-
parameters: {
|
|
4931
|
-
query?: never;
|
|
4932
|
-
header?: never;
|
|
4933
|
-
path?: never;
|
|
4934
|
-
cookie?: never;
|
|
4935
|
-
};
|
|
4936
|
-
get?: never;
|
|
4937
|
-
put?: never;
|
|
4938
|
-
/**
|
|
4939
|
-
* @description Create owner payout transactions and optionally dispatch them through Ramp. The response includes every payout transaction ID and the durable Ramp sync ID.
|
|
4940
|
-
*
|
|
4941
|
-
* Required scope: statements:pay
|
|
4942
|
-
*/
|
|
4943
|
-
post: operations["postStatementsByIdPay"];
|
|
4944
|
-
delete?: never;
|
|
4945
|
-
options?: never;
|
|
4946
|
-
head?: never;
|
|
4947
|
-
patch?: never;
|
|
4948
|
-
trace?: never;
|
|
4949
|
-
};
|
|
4950
4929
|
"/statements/{id}/refresh-layout": {
|
|
4951
4930
|
parameters: {
|
|
4952
4931
|
query?: never;
|
|
@@ -55398,6 +55377,7 @@ export interface operations {
|
|
|
55398
55377
|
hasPms: boolean;
|
|
55399
55378
|
activePmsConnectionId: string | null;
|
|
55400
55379
|
hasOwnerBlockingConnection: boolean;
|
|
55380
|
+
hasAchConnection: boolean;
|
|
55401
55381
|
hasDeposit: boolean;
|
|
55402
55382
|
depositTransactionId: string | null;
|
|
55403
55383
|
hasListingNeedsReview: boolean;
|
|
@@ -103427,18 +103407,27 @@ export interface operations {
|
|
|
103427
103407
|
requestBody?: {
|
|
103428
103408
|
content: {
|
|
103429
103409
|
"application/json": {
|
|
103430
|
-
/** @
|
|
103431
|
-
|
|
103432
|
-
|
|
103410
|
+
/** @description Payout date for every statement. */
|
|
103411
|
+
date?: string | null;
|
|
103412
|
+
statements: {
|
|
103433
103413
|
/** Format: uuid */
|
|
103434
103414
|
statementId: string;
|
|
103435
|
-
/**
|
|
103436
|
-
|
|
103415
|
+
/** @description Signed override total for an additional partial payment or owner receipt. Omit to pay the full net income, which requires the statement to have no prior payout. */
|
|
103416
|
+
amount?: number | null;
|
|
103437
103417
|
idempotencyKey?: string;
|
|
103418
|
+
/** @description Exactly one selection per ownership member. Missing or invalid selections fail; the API never substitutes a payment method. */
|
|
103419
|
+
payouts: {
|
|
103420
|
+
/** Format: uuid */
|
|
103421
|
+
contactId: string;
|
|
103422
|
+
/** @description The only ACH trigger. `null` records the payout without dispatching, even when the bank account is Ramp-backed. */
|
|
103423
|
+
provider: "ramp" | null;
|
|
103424
|
+
/**
|
|
103425
|
+
* Format: uuid
|
|
103426
|
+
* @description GL bank account the payout is booked against. For `provider: "ramp"` it must be ACH-capable; its Ramp account connection is used as the funding account.
|
|
103427
|
+
*/
|
|
103428
|
+
bankAccountId: string;
|
|
103429
|
+
}[];
|
|
103438
103430
|
}[];
|
|
103439
|
-
date?: string | null;
|
|
103440
|
-
amount?: number | null;
|
|
103441
|
-
bankAccountId?: string | null;
|
|
103442
103431
|
};
|
|
103443
103432
|
};
|
|
103444
103433
|
};
|
|
@@ -103453,10 +103442,21 @@ export interface operations {
|
|
|
103453
103442
|
results: {
|
|
103454
103443
|
/** Format: uuid */
|
|
103455
103444
|
statementId: string;
|
|
103456
|
-
/**
|
|
103457
|
-
|
|
103458
|
-
|
|
103459
|
-
|
|
103445
|
+
/**
|
|
103446
|
+
* @description `requested` dispatched at least one Ramp ACH payment, `recorded` booked payout transactions only, `skipped` rejected the complete statement.
|
|
103447
|
+
* @enum {string}
|
|
103448
|
+
*/
|
|
103449
|
+
status: "requested" | "recorded" | "skipped";
|
|
103450
|
+
payouts: {
|
|
103451
|
+
/** Format: uuid */
|
|
103452
|
+
contactId: string;
|
|
103453
|
+
provider: "ramp" | null;
|
|
103454
|
+
/** @description Value in cents (100 = 1€) */
|
|
103455
|
+
amount: number;
|
|
103456
|
+
/** Format: uuid */
|
|
103457
|
+
transactionId: string;
|
|
103458
|
+
syncId: string | null;
|
|
103459
|
+
}[];
|
|
103460
103460
|
message: string | null;
|
|
103461
103461
|
}[];
|
|
103462
103462
|
};
|
|
@@ -103699,11 +103699,25 @@ export interface operations {
|
|
|
103699
103699
|
requestBody?: {
|
|
103700
103700
|
content: {
|
|
103701
103701
|
"application/json": {
|
|
103702
|
-
|
|
103703
|
-
|
|
103704
|
-
|
|
103705
|
-
|
|
103706
|
-
|
|
103702
|
+
date?: string | null;
|
|
103703
|
+
statements: {
|
|
103704
|
+
/** Format: uuid */
|
|
103705
|
+
statementId: string;
|
|
103706
|
+
/** @description Signed override total. Omit to preview the full net income payout. */
|
|
103707
|
+
amount?: number | null;
|
|
103708
|
+
/** @description Owner selections to validate. Omit to receive server-computed defaults per owner. */
|
|
103709
|
+
payouts?: {
|
|
103710
|
+
/** Format: uuid */
|
|
103711
|
+
contactId: string;
|
|
103712
|
+
/** @description The only ACH trigger. `null` records the payout without dispatching, even when the bank account is Ramp-backed. */
|
|
103713
|
+
provider: "ramp" | null;
|
|
103714
|
+
/**
|
|
103715
|
+
* Format: uuid
|
|
103716
|
+
* @description GL bank account the payout is booked against. For `provider: "ramp"` it must be ACH-capable; its Ramp account connection is used as the funding account.
|
|
103717
|
+
*/
|
|
103718
|
+
bankAccountId: string;
|
|
103719
|
+
}[];
|
|
103720
|
+
}[];
|
|
103707
103721
|
};
|
|
103708
103722
|
};
|
|
103709
103723
|
};
|
|
@@ -103720,9 +103734,13 @@ export interface operations {
|
|
|
103720
103734
|
statementId: string;
|
|
103721
103735
|
ready: boolean;
|
|
103722
103736
|
connectionId: string | null;
|
|
103723
|
-
|
|
103737
|
+
/** @description Signed effective payout total: the explicit amount override, or the statement net income. */
|
|
103738
|
+
amount: number;
|
|
103724
103739
|
owners: {
|
|
103725
103740
|
contactId: string | null;
|
|
103741
|
+
/** @description Authoritative owner allocation after server rounding. */
|
|
103742
|
+
amount: number;
|
|
103743
|
+
defaultBankAccountId: string | null;
|
|
103726
103744
|
paymentMethod: {
|
|
103727
103745
|
/** @constant */
|
|
103728
103746
|
provider: "ramp";
|
|
@@ -103735,7 +103753,7 @@ export interface operations {
|
|
|
103735
103753
|
}[];
|
|
103736
103754
|
issues: {
|
|
103737
103755
|
/** @enum {string} */
|
|
103738
|
-
code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "
|
|
103756
|
+
code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable";
|
|
103739
103757
|
message: string;
|
|
103740
103758
|
/** Format: uuid */
|
|
103741
103759
|
contactId?: string;
|
|
@@ -108112,276 +108130,6 @@ export interface operations {
|
|
|
108112
108130
|
};
|
|
108113
108131
|
};
|
|
108114
108132
|
};
|
|
108115
|
-
postStatementsByIdPay: {
|
|
108116
|
-
parameters: {
|
|
108117
|
-
query?: {
|
|
108118
|
-
/** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
|
|
108119
|
-
dryRun?: boolean;
|
|
108120
|
-
};
|
|
108121
|
-
header?: never;
|
|
108122
|
-
path: {
|
|
108123
|
-
id: string;
|
|
108124
|
-
};
|
|
108125
|
-
cookie?: never;
|
|
108126
|
-
};
|
|
108127
|
-
requestBody?: {
|
|
108128
|
-
content: {
|
|
108129
|
-
"application/json": {
|
|
108130
|
-
provider: "ramp" | null;
|
|
108131
|
-
date?: string | null;
|
|
108132
|
-
amount?: number | null;
|
|
108133
|
-
bankAccountId?: string | null;
|
|
108134
|
-
fundingAccountId?: string | null;
|
|
108135
|
-
idempotencyKey?: string;
|
|
108136
|
-
};
|
|
108137
|
-
};
|
|
108138
|
-
};
|
|
108139
|
-
responses: {
|
|
108140
|
-
/** @description Successful response */
|
|
108141
|
-
200: {
|
|
108142
|
-
headers: {
|
|
108143
|
-
[name: string]: unknown;
|
|
108144
|
-
};
|
|
108145
|
-
content: {
|
|
108146
|
-
"application/json": {
|
|
108147
|
-
payouts: {
|
|
108148
|
-
/** Format: uuid */
|
|
108149
|
-
id: string;
|
|
108150
|
-
uniqueRef?: string | null;
|
|
108151
|
-
sourceId?: string | null;
|
|
108152
|
-
}[];
|
|
108153
|
-
transactionIds: string[];
|
|
108154
|
-
syncId: string | null;
|
|
108155
|
-
};
|
|
108156
|
-
};
|
|
108157
|
-
};
|
|
108158
|
-
/** @description Bad request */
|
|
108159
|
-
400: {
|
|
108160
|
-
headers: {
|
|
108161
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108162
|
-
"Retry-After"?: number;
|
|
108163
|
-
[name: string]: unknown;
|
|
108164
|
-
};
|
|
108165
|
-
content: {
|
|
108166
|
-
"application/json": {
|
|
108167
|
-
code: string;
|
|
108168
|
-
message: string;
|
|
108169
|
-
links?: {
|
|
108170
|
-
docs: string;
|
|
108171
|
-
schema: string;
|
|
108172
|
-
};
|
|
108173
|
-
issues?: {
|
|
108174
|
-
message: string;
|
|
108175
|
-
path?: (string | number)[];
|
|
108176
|
-
schema?: string;
|
|
108177
|
-
}[];
|
|
108178
|
-
retryable?: boolean;
|
|
108179
|
-
context?: unknown;
|
|
108180
|
-
};
|
|
108181
|
-
};
|
|
108182
|
-
};
|
|
108183
|
-
/** @description Unauthorized */
|
|
108184
|
-
401: {
|
|
108185
|
-
headers: {
|
|
108186
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108187
|
-
"Retry-After"?: number;
|
|
108188
|
-
[name: string]: unknown;
|
|
108189
|
-
};
|
|
108190
|
-
content: {
|
|
108191
|
-
"application/json": {
|
|
108192
|
-
code: string;
|
|
108193
|
-
message: string;
|
|
108194
|
-
links?: {
|
|
108195
|
-
docs: string;
|
|
108196
|
-
schema: string;
|
|
108197
|
-
};
|
|
108198
|
-
issues?: {
|
|
108199
|
-
message: string;
|
|
108200
|
-
path?: (string | number)[];
|
|
108201
|
-
schema?: string;
|
|
108202
|
-
}[];
|
|
108203
|
-
retryable?: boolean;
|
|
108204
|
-
context?: unknown;
|
|
108205
|
-
};
|
|
108206
|
-
};
|
|
108207
|
-
};
|
|
108208
|
-
/** @description Forbidden */
|
|
108209
|
-
403: {
|
|
108210
|
-
headers: {
|
|
108211
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108212
|
-
"Retry-After"?: number;
|
|
108213
|
-
[name: string]: unknown;
|
|
108214
|
-
};
|
|
108215
|
-
content: {
|
|
108216
|
-
"application/json": {
|
|
108217
|
-
code: string;
|
|
108218
|
-
message: string;
|
|
108219
|
-
links?: {
|
|
108220
|
-
docs: string;
|
|
108221
|
-
schema: string;
|
|
108222
|
-
};
|
|
108223
|
-
issues?: {
|
|
108224
|
-
message: string;
|
|
108225
|
-
path?: (string | number)[];
|
|
108226
|
-
schema?: string;
|
|
108227
|
-
}[];
|
|
108228
|
-
retryable?: boolean;
|
|
108229
|
-
context?: unknown;
|
|
108230
|
-
};
|
|
108231
|
-
};
|
|
108232
|
-
};
|
|
108233
|
-
/** @description Not found */
|
|
108234
|
-
404: {
|
|
108235
|
-
headers: {
|
|
108236
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108237
|
-
"Retry-After"?: number;
|
|
108238
|
-
[name: string]: unknown;
|
|
108239
|
-
};
|
|
108240
|
-
content: {
|
|
108241
|
-
"application/json": {
|
|
108242
|
-
code: string;
|
|
108243
|
-
message: string;
|
|
108244
|
-
links?: {
|
|
108245
|
-
docs: string;
|
|
108246
|
-
schema: string;
|
|
108247
|
-
};
|
|
108248
|
-
issues?: {
|
|
108249
|
-
message: string;
|
|
108250
|
-
path?: (string | number)[];
|
|
108251
|
-
schema?: string;
|
|
108252
|
-
}[];
|
|
108253
|
-
retryable?: boolean;
|
|
108254
|
-
context?: unknown;
|
|
108255
|
-
};
|
|
108256
|
-
};
|
|
108257
|
-
};
|
|
108258
|
-
/** @description Conflict */
|
|
108259
|
-
409: {
|
|
108260
|
-
headers: {
|
|
108261
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108262
|
-
"Retry-After"?: number;
|
|
108263
|
-
[name: string]: unknown;
|
|
108264
|
-
};
|
|
108265
|
-
content: {
|
|
108266
|
-
"application/json": {
|
|
108267
|
-
code: string;
|
|
108268
|
-
message: string;
|
|
108269
|
-
links?: {
|
|
108270
|
-
docs: string;
|
|
108271
|
-
schema: string;
|
|
108272
|
-
};
|
|
108273
|
-
issues?: {
|
|
108274
|
-
message: string;
|
|
108275
|
-
path?: (string | number)[];
|
|
108276
|
-
schema?: string;
|
|
108277
|
-
}[];
|
|
108278
|
-
retryable?: boolean;
|
|
108279
|
-
context?: unknown;
|
|
108280
|
-
};
|
|
108281
|
-
};
|
|
108282
|
-
};
|
|
108283
|
-
/** @description Gone */
|
|
108284
|
-
410: {
|
|
108285
|
-
headers: {
|
|
108286
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108287
|
-
"Retry-After"?: number;
|
|
108288
|
-
[name: string]: unknown;
|
|
108289
|
-
};
|
|
108290
|
-
content: {
|
|
108291
|
-
"application/json": {
|
|
108292
|
-
code: string;
|
|
108293
|
-
message: string;
|
|
108294
|
-
links?: {
|
|
108295
|
-
docs: string;
|
|
108296
|
-
schema: string;
|
|
108297
|
-
};
|
|
108298
|
-
issues?: {
|
|
108299
|
-
message: string;
|
|
108300
|
-
path?: (string | number)[];
|
|
108301
|
-
schema?: string;
|
|
108302
|
-
}[];
|
|
108303
|
-
retryable?: boolean;
|
|
108304
|
-
context?: unknown;
|
|
108305
|
-
};
|
|
108306
|
-
};
|
|
108307
|
-
};
|
|
108308
|
-
/** @description Unprocessable content */
|
|
108309
|
-
422: {
|
|
108310
|
-
headers: {
|
|
108311
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108312
|
-
"Retry-After"?: number;
|
|
108313
|
-
[name: string]: unknown;
|
|
108314
|
-
};
|
|
108315
|
-
content: {
|
|
108316
|
-
"application/json": {
|
|
108317
|
-
code: string;
|
|
108318
|
-
message: string;
|
|
108319
|
-
links?: {
|
|
108320
|
-
docs: string;
|
|
108321
|
-
schema: string;
|
|
108322
|
-
};
|
|
108323
|
-
issues?: {
|
|
108324
|
-
message: string;
|
|
108325
|
-
path?: (string | number)[];
|
|
108326
|
-
schema?: string;
|
|
108327
|
-
}[];
|
|
108328
|
-
retryable?: boolean;
|
|
108329
|
-
context?: unknown;
|
|
108330
|
-
};
|
|
108331
|
-
};
|
|
108332
|
-
};
|
|
108333
|
-
/** @description Internal server error */
|
|
108334
|
-
500: {
|
|
108335
|
-
headers: {
|
|
108336
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108337
|
-
"Retry-After"?: number;
|
|
108338
|
-
[name: string]: unknown;
|
|
108339
|
-
};
|
|
108340
|
-
content: {
|
|
108341
|
-
"application/json": {
|
|
108342
|
-
code: string;
|
|
108343
|
-
message: string;
|
|
108344
|
-
links?: {
|
|
108345
|
-
docs: string;
|
|
108346
|
-
schema: string;
|
|
108347
|
-
};
|
|
108348
|
-
issues?: {
|
|
108349
|
-
message: string;
|
|
108350
|
-
path?: (string | number)[];
|
|
108351
|
-
schema?: string;
|
|
108352
|
-
}[];
|
|
108353
|
-
retryable?: boolean;
|
|
108354
|
-
context?: unknown;
|
|
108355
|
-
};
|
|
108356
|
-
};
|
|
108357
|
-
};
|
|
108358
|
-
/** @description Service unavailable */
|
|
108359
|
-
503: {
|
|
108360
|
-
headers: {
|
|
108361
|
-
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
108362
|
-
"Retry-After"?: number;
|
|
108363
|
-
[name: string]: unknown;
|
|
108364
|
-
};
|
|
108365
|
-
content: {
|
|
108366
|
-
"application/json": {
|
|
108367
|
-
code: string;
|
|
108368
|
-
message: string;
|
|
108369
|
-
links?: {
|
|
108370
|
-
docs: string;
|
|
108371
|
-
schema: string;
|
|
108372
|
-
};
|
|
108373
|
-
issues?: {
|
|
108374
|
-
message: string;
|
|
108375
|
-
path?: (string | number)[];
|
|
108376
|
-
schema?: string;
|
|
108377
|
-
}[];
|
|
108378
|
-
retryable?: boolean;
|
|
108379
|
-
context?: unknown;
|
|
108380
|
-
};
|
|
108381
|
-
};
|
|
108382
|
-
};
|
|
108383
|
-
};
|
|
108384
|
-
};
|
|
108385
108133
|
postStatementsByIdRefreshLayout: {
|
|
108386
108134
|
parameters: {
|
|
108387
108135
|
query?: never;
|