@vrplatform/api 1.3.1-stage.5710 → 1.3.1-stage.5747
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.
|
@@ -3507,7 +3507,7 @@ export interface paths {
|
|
|
3507
3507
|
get?: never;
|
|
3508
3508
|
put?: never;
|
|
3509
3509
|
/**
|
|
3510
|
-
* @description Create a tenant-scoped Plaid Link session. Create mode forbids connectionId; update and replace require it. Create and replace request Transactions only so deposit and credit-card feeds remain eligible; update reuses the stored Item and omits product selection. Environment is optional for a new Item and defaults to production; reusable credentials retain their stored environment. Hostaway-region teams use the United States-only Plaid Dashboard hostaway customization; other teams use the default United States and Canada customization. The session owns environment and product selection after start. Link tokens are short-lived; complete the returned connectId before expiresAt. PLAID_CONNECT_REQUIRES_NEW_LINK returns the only valid restart mode and any required tenant-scoped connectionId in context. See https://docs.vrplatform.app/guides/build/banking.
|
|
3510
|
+
* @description Create a tenant-scoped Plaid Link session. Create mode forbids connectionId; update and replace require it. Create and replace request Transactions only so deposit and credit-card feeds remain eligible; update reuses the stored Item and omits product selection. Environment is optional for a new Item and defaults to production; reusable credentials retain their stored environment. Hostaway-region teams use the United States-only Plaid Dashboard hostaway customization and Hostaway client name; other teams use the default United States and Canada customization with the VRPlatform client name. The session owns environment and product selection after start. Link tokens are short-lived; complete the returned connectId before expiresAt. PLAID_CONNECT_REQUIRES_NEW_LINK returns the only valid restart mode and any required tenant-scoped connectionId in context. See https://docs.vrplatform.app/guides/build/banking.
|
|
3511
3511
|
*
|
|
3512
3512
|
* Required scope: bank-connections:manage
|
|
3513
3513
|
*/
|
|
@@ -4942,7 +4942,7 @@ export interface paths {
|
|
|
4942
4942
|
get?: never;
|
|
4943
4943
|
put?: never;
|
|
4944
4944
|
/**
|
|
4945
|
-
* @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`.
|
|
4945
|
+
* @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`.
|
|
4946
4946
|
*
|
|
4947
4947
|
* Required scope: statements:pay
|
|
4948
4948
|
*/
|
|
@@ -4963,7 +4963,7 @@ export interface paths {
|
|
|
4963
4963
|
get?: never;
|
|
4964
4964
|
put?: never;
|
|
4965
4965
|
/**
|
|
4966
|
-
* @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.
|
|
4966
|
+
* @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.
|
|
4967
4967
|
*
|
|
4968
4968
|
* Required scope: statements:read
|
|
4969
4969
|
*/
|
|
@@ -5051,7 +5051,7 @@ export interface paths {
|
|
|
5051
5051
|
*/
|
|
5052
5052
|
get: operations["getStatementsById"];
|
|
5053
5053
|
/**
|
|
5054
|
-
* @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.
|
|
5054
|
+
* @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.
|
|
5055
5055
|
*
|
|
5056
5056
|
* Required scope: statements:write
|
|
5057
5057
|
*/
|
|
@@ -106079,10 +106079,12 @@ export interface operations {
|
|
|
106079
106079
|
}[];
|
|
106080
106080
|
issues: {
|
|
106081
106081
|
/** @enum {string} */
|
|
106082
|
-
code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable" | "rampCategoryAccountNotReady";
|
|
106082
|
+
code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "statementPeriodLocked" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable" | "rampCategoryAccountNotReady";
|
|
106083
106083
|
message: string;
|
|
106084
106084
|
/** Format: uuid */
|
|
106085
106085
|
contactId?: string;
|
|
106086
|
+
/** @description First date available for a statement-period-locked payout. */
|
|
106087
|
+
openFrom?: string;
|
|
106086
106088
|
}[];
|
|
106087
106089
|
}[];
|
|
106088
106090
|
};
|