@vrplatform/api 1.3.1-stage.5167 → 1.3.1-stage.5180

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/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.5167",
6
+ "version": "1.3.1-stage.5180",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -4800,7 +4800,7 @@ export interface paths {
4800
4800
  get?: never;
4801
4801
  put?: never;
4802
4802
  /**
4803
- * @description Request selected Ramp owner payouts. Each statement succeeds or is skipped independently, so one blocked selection never rolls back successful requests. Only first payouts are supported: statements that already have a payout are skipped, and additional partial payments go through `POST /statements/{id}/pay`. An explicit amount overrides the full net income and therefore requires exactly one selection.
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 Ramp payout readiness per statement, owner, connection, and funding account without creating transactions.
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;
@@ -103428,18 +103407,27 @@ export interface operations {
103428
103407
  requestBody?: {
103429
103408
  content: {
103430
103409
  "application/json": {
103431
- /** @constant */
103432
- provider: "ramp";
103433
- selections: {
103410
+ /** @description Payout date for every statement. */
103411
+ date?: string | null;
103412
+ statements: {
103434
103413
  /** Format: uuid */
103435
103414
  statementId: string;
103436
- /** Format: uuid */
103437
- fundingAccountId?: string;
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;
103438
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
+ }[];
103439
103430
  }[];
103440
- date?: string | null;
103441
- amount?: number | null;
103442
- bankAccountId?: string | null;
103443
103431
  };
103444
103432
  };
103445
103433
  };
@@ -103454,10 +103442,21 @@ export interface operations {
103454
103442
  results: {
103455
103443
  /** Format: uuid */
103456
103444
  statementId: string;
103457
- /** @enum {string} */
103458
- status: "requested" | "skipped";
103459
- transactionIds: string[];
103460
- syncId: string | null;
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
+ }[];
103461
103460
  message: string | null;
103462
103461
  }[];
103463
103462
  };
@@ -103700,11 +103699,25 @@ export interface operations {
103700
103699
  requestBody?: {
103701
103700
  content: {
103702
103701
  "application/json": {
103703
- statementIds: string[];
103704
- /** Format: uuid */
103705
- connectionId?: string;
103706
- /** Format: uuid */
103707
- fundingAccountId?: string;
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
+ }[];
103708
103721
  };
103709
103722
  };
103710
103723
  };
@@ -103721,9 +103734,13 @@ export interface operations {
103721
103734
  statementId: string;
103722
103735
  ready: boolean;
103723
103736
  connectionId: string | null;
103724
- fundingAccountId: string | null;
103737
+ /** @description Signed effective payout total: the explicit amount override, or the statement net income. */
103738
+ amount: number;
103725
103739
  owners: {
103726
103740
  contactId: string | null;
103741
+ /** @description Authoritative owner allocation after server rounding. */
103742
+ amount: number;
103743
+ defaultBankAccountId: string | null;
103727
103744
  paymentMethod: {
103728
103745
  /** @constant */
103729
103746
  provider: "ramp";
@@ -103736,7 +103753,7 @@ export interface operations {
103736
103753
  }[];
103737
103754
  issues: {
103738
103755
  /** @enum {string} */
103739
- code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "fundingAccountNotFound" | "fundingAccountUnavailable" | "ownerMissing" | "ownerPaymentMethodNotReady";
103756
+ code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable";
103740
103757
  message: string;
103741
103758
  /** Format: uuid */
103742
103759
  contactId?: string;
@@ -108113,276 +108130,6 @@ export interface operations {
108113
108130
  };
108114
108131
  };
108115
108132
  };
108116
- postStatementsByIdPay: {
108117
- parameters: {
108118
- query?: {
108119
- /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
108120
- dryRun?: boolean;
108121
- };
108122
- header?: never;
108123
- path: {
108124
- id: string;
108125
- };
108126
- cookie?: never;
108127
- };
108128
- requestBody?: {
108129
- content: {
108130
- "application/json": {
108131
- provider: "ramp" | null;
108132
- date?: string | null;
108133
- amount?: number | null;
108134
- bankAccountId?: string | null;
108135
- fundingAccountId?: string | null;
108136
- idempotencyKey?: string;
108137
- };
108138
- };
108139
- };
108140
- responses: {
108141
- /** @description Successful response */
108142
- 200: {
108143
- headers: {
108144
- [name: string]: unknown;
108145
- };
108146
- content: {
108147
- "application/json": {
108148
- payouts: {
108149
- /** Format: uuid */
108150
- id: string;
108151
- uniqueRef?: string | null;
108152
- sourceId?: string | null;
108153
- }[];
108154
- transactionIds: string[];
108155
- syncId: string | null;
108156
- };
108157
- };
108158
- };
108159
- /** @description Bad request */
108160
- 400: {
108161
- headers: {
108162
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108163
- "Retry-After"?: number;
108164
- [name: string]: unknown;
108165
- };
108166
- content: {
108167
- "application/json": {
108168
- code: string;
108169
- message: string;
108170
- links?: {
108171
- docs: string;
108172
- schema: string;
108173
- };
108174
- issues?: {
108175
- message: string;
108176
- path?: (string | number)[];
108177
- schema?: string;
108178
- }[];
108179
- retryable?: boolean;
108180
- context?: unknown;
108181
- };
108182
- };
108183
- };
108184
- /** @description Unauthorized */
108185
- 401: {
108186
- headers: {
108187
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108188
- "Retry-After"?: number;
108189
- [name: string]: unknown;
108190
- };
108191
- content: {
108192
- "application/json": {
108193
- code: string;
108194
- message: string;
108195
- links?: {
108196
- docs: string;
108197
- schema: string;
108198
- };
108199
- issues?: {
108200
- message: string;
108201
- path?: (string | number)[];
108202
- schema?: string;
108203
- }[];
108204
- retryable?: boolean;
108205
- context?: unknown;
108206
- };
108207
- };
108208
- };
108209
- /** @description Forbidden */
108210
- 403: {
108211
- headers: {
108212
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108213
- "Retry-After"?: number;
108214
- [name: string]: unknown;
108215
- };
108216
- content: {
108217
- "application/json": {
108218
- code: string;
108219
- message: string;
108220
- links?: {
108221
- docs: string;
108222
- schema: string;
108223
- };
108224
- issues?: {
108225
- message: string;
108226
- path?: (string | number)[];
108227
- schema?: string;
108228
- }[];
108229
- retryable?: boolean;
108230
- context?: unknown;
108231
- };
108232
- };
108233
- };
108234
- /** @description Not found */
108235
- 404: {
108236
- headers: {
108237
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108238
- "Retry-After"?: number;
108239
- [name: string]: unknown;
108240
- };
108241
- content: {
108242
- "application/json": {
108243
- code: string;
108244
- message: string;
108245
- links?: {
108246
- docs: string;
108247
- schema: string;
108248
- };
108249
- issues?: {
108250
- message: string;
108251
- path?: (string | number)[];
108252
- schema?: string;
108253
- }[];
108254
- retryable?: boolean;
108255
- context?: unknown;
108256
- };
108257
- };
108258
- };
108259
- /** @description Conflict */
108260
- 409: {
108261
- headers: {
108262
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108263
- "Retry-After"?: number;
108264
- [name: string]: unknown;
108265
- };
108266
- content: {
108267
- "application/json": {
108268
- code: string;
108269
- message: string;
108270
- links?: {
108271
- docs: string;
108272
- schema: string;
108273
- };
108274
- issues?: {
108275
- message: string;
108276
- path?: (string | number)[];
108277
- schema?: string;
108278
- }[];
108279
- retryable?: boolean;
108280
- context?: unknown;
108281
- };
108282
- };
108283
- };
108284
- /** @description Gone */
108285
- 410: {
108286
- headers: {
108287
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108288
- "Retry-After"?: number;
108289
- [name: string]: unknown;
108290
- };
108291
- content: {
108292
- "application/json": {
108293
- code: string;
108294
- message: string;
108295
- links?: {
108296
- docs: string;
108297
- schema: string;
108298
- };
108299
- issues?: {
108300
- message: string;
108301
- path?: (string | number)[];
108302
- schema?: string;
108303
- }[];
108304
- retryable?: boolean;
108305
- context?: unknown;
108306
- };
108307
- };
108308
- };
108309
- /** @description Unprocessable content */
108310
- 422: {
108311
- headers: {
108312
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108313
- "Retry-After"?: number;
108314
- [name: string]: unknown;
108315
- };
108316
- content: {
108317
- "application/json": {
108318
- code: string;
108319
- message: string;
108320
- links?: {
108321
- docs: string;
108322
- schema: string;
108323
- };
108324
- issues?: {
108325
- message: string;
108326
- path?: (string | number)[];
108327
- schema?: string;
108328
- }[];
108329
- retryable?: boolean;
108330
- context?: unknown;
108331
- };
108332
- };
108333
- };
108334
- /** @description Internal server error */
108335
- 500: {
108336
- headers: {
108337
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108338
- "Retry-After"?: number;
108339
- [name: string]: unknown;
108340
- };
108341
- content: {
108342
- "application/json": {
108343
- code: string;
108344
- message: string;
108345
- links?: {
108346
- docs: string;
108347
- schema: string;
108348
- };
108349
- issues?: {
108350
- message: string;
108351
- path?: (string | number)[];
108352
- schema?: string;
108353
- }[];
108354
- retryable?: boolean;
108355
- context?: unknown;
108356
- };
108357
- };
108358
- };
108359
- /** @description Service unavailable */
108360
- 503: {
108361
- headers: {
108362
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
108363
- "Retry-After"?: number;
108364
- [name: string]: unknown;
108365
- };
108366
- content: {
108367
- "application/json": {
108368
- code: string;
108369
- message: string;
108370
- links?: {
108371
- docs: string;
108372
- schema: string;
108373
- };
108374
- issues?: {
108375
- message: string;
108376
- path?: (string | number)[];
108377
- schema?: string;
108378
- }[];
108379
- retryable?: boolean;
108380
- context?: unknown;
108381
- };
108382
- };
108383
- };
108384
- };
108385
- };
108386
108133
  postStatementsByIdRefreshLayout: {
108387
108134
  parameters: {
108388
108135
  query?: never;