@vrplatform/api 1.3.1-stage.5718 → 1.3.1-stage.5760

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.5718",
6
+ "version": "1.3.1-stage.5760",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -4943,7 +4943,7 @@ export interface paths {
4943
4943
  get?: never;
4944
4944
  put?: never;
4945
4945
  /**
4946
- * @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 through the exact Ramp entity and source bank account imported for that bank account; missing or ambiguous routing, or a `payout_distribution` Category account without a completed current Ramp chart-of-accounts push, is rejected before payout creation. The first otherwise-valid Ramp payout activates a transfer flow whose status has never been configured; an explicitly inactive flow remains unavailable. `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`.
4946
+ * @description Execute owner statement payouts with one explicit selection per ownership member. Every selection books a payout transaction against its bank account. A statement-period-locked payout date skips the statement before accounting creation; preview the same request to retrieve the first available date. `provider: "ramp"` additionally dispatches an ACH payment through the exact Ramp entity and source bank account imported for that bank account; missing or ambiguous routing, or a `payout_distribution` Category account without a completed current Ramp chart-of-accounts push, is rejected before payout creation. The first otherwise-valid Ramp payout activates a transfer flow whose status has never been configured; an explicitly inactive flow remains unavailable. `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`.
4947
4947
  *
4948
4948
  * Required scope: statements:pay
4949
4949
  */
@@ -4964,7 +4964,7 @@ export interface paths {
4964
4964
  get?: never;
4965
4965
  put?: never;
4966
4966
  /**
4967
- * @description Preview owner statement payout plans without creating transactions. Returns authoritative per-owner allocations after server rounding, default bank accounts, ACH payment-method readiness, exact Ramp funding-source readiness, completed Ramp Category-account synchronization readiness, and typed blockers for the submitted owner selections. An unconfigured Ramp transfer flow is eligible but remains unchanged until payment. `POST /statements/pay` revalidates the same rules; the preview is advisory.
4967
+ * @description Preview owner statement payout plans without creating transactions. Returns authoritative per-owner allocations after server rounding, default bank accounts, ACH payment-method readiness, exact Ramp funding-source readiness, completed Ramp Category-account synchronization readiness, and typed blockers for the submitted owner selections and payout date. A statement-period-locked date returns `statementPeriodLocked` with `openFrom`. An unconfigured Ramp transfer flow is eligible but remains unchanged until payment. `POST /statements/pay` revalidates the same rules; the preview is advisory.
4968
4968
  *
4969
4969
  * Required scope: statements:read
4970
4970
  */
@@ -5052,7 +5052,7 @@ export interface paths {
5052
5052
  */
5053
5053
  get: operations["getStatementsById"];
5054
5054
  /**
5055
- * @description Update an owner statement status (draft, inReview, published). Moving to a finalized status attaches the period journal entries to the statement and locks writes that reference the same ownership period; moving back to draft detaches them again. Transitions are rejected when the statement has blocking issues, when a later statement for the period is already finalized, or when a prior month is still unfinalized. For scoped API credentials, both publishing and moving a published statement away from published require the statements:publish scope. Publishing can optionally email owners via emailDelivery. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements#status-transitions.
5055
+ * @description Update an owner statement status (draft, inReview, published). Moving to a finalized status attaches the period journal entries to the statement and locks writes that reference the same ownership period; moving back to draft detaches them again. Submitting the current status never rewrites journal attachments. If the cached detail is current, the request is accounting-read-only; otherwise it refreshes the statement projection. A published request with emailDelivery still schedules the requested owner delivery. Transitions are rejected when the statement has blocking issues, when a later statement for the period is already finalized, or when a prior month is still unfinalized. For scoped API credentials, both publishing and moving a published statement away from published require the statements:publish scope. Publishing can optionally email owners via emailDelivery. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements#status-transitions.
5056
5056
  *
5057
5057
  * Required scope: statements:write
5058
5058
  */
@@ -106080,10 +106080,12 @@ export interface operations {
106080
106080
  }[];
106081
106081
  issues: {
106082
106082
  /** @enum {string} */
106083
- code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable" | "rampCategoryAccountNotReady";
106083
+ code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "statementPeriodLocked" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable" | "rampCategoryAccountNotReady";
106084
106084
  message: string;
106085
106085
  /** Format: uuid */
106086
106086
  contactId?: string;
106087
+ /** @description First date available for a statement-period-locked payout. */
106088
+ openFrom?: string;
106087
106089
  }[];
106088
106090
  }[];
106089
106091
  };