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