@vrplatform/api 1.3.1-stage.9 → 1.3.1-stage.94

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.
@@ -1239,7 +1239,7 @@ export interface paths {
1239
1239
  get?: never;
1240
1240
  put?: never;
1241
1241
  /**
1242
- * @description Send owner or vendor ACH details to the single eligible Ramp push-vendor flow for verification. This action requires ach-payment-methods:write rather than general contact write access. The server resolves the connection; clients do not select one. First use activates a flow that has never been configured, while an explicitly inactive flow remains unavailable. Raw routing and account numbers are write-only and are never stored by VRPlatform. The contact becomes ready only after Ramp confirms the account. Requested and processing payments remain bound to their scheduled destination, so an update affects future payments only. Owners can update only their own contact.
1242
+ * @description Send write-only owner or vendor ACH details to the single eligible Ramp vendor flow for verification. The server resolves the connection, which must have an active Ramp Vendor owner, and owners can update only their own contact.
1243
1243
  *
1244
1244
  * Required scope: ach-payment-methods:write
1245
1245
  */
@@ -3447,7 +3447,7 @@ export interface paths {
3447
3447
  /**
3448
3448
  * @description Batch post payments
3449
3449
  *
3450
- * Required scope: transactions:write
3450
+ * Required scope: transactions:deposits:write
3451
3451
  */
3452
3452
  post: operations["batchPayments"];
3453
3453
  delete?: never;
@@ -3716,7 +3716,7 @@ export interface paths {
3716
3716
  */
3717
3717
  get: operations["getListingsByIdOpeningBalance"];
3718
3718
  /**
3719
- * @description Update a listing opening balance. Setting an existing balance to zero can cross a statement-period boundary; books closing and direct owner-statement attachments still apply.
3719
+ * @description Update a listing opening balance. A balance may cross imported pre-cutover statement history, and zero may cross an ordinary statement-period boundary; books closing, direct statement attachments, and stored live statements still apply.
3720
3720
  *
3721
3721
  * Required scope: general-ledger:write
3722
3722
  */
@@ -5249,13 +5249,7 @@ export interface paths {
5249
5249
  path?: never;
5250
5250
  cookie?: never;
5251
5251
  };
5252
- /**
5253
- * @deprecated
5254
- * @description Deprecated synchronous manager-statement PDF export. Use POST /reports/manager-statements/detail/pdf.
5255
- *
5256
- * Required scope: reports:read, reports:export
5257
- */
5258
- get: operations["getManagerStatementReportDetailPdf"];
5252
+ get?: never;
5259
5253
  put?: never;
5260
5254
  /**
5261
5255
  * @description Queue a manager-statement detail PDF export. Download the result file after the operation completes.
@@ -5276,13 +5270,7 @@ export interface paths {
5276
5270
  path?: never;
5277
5271
  cookie?: never;
5278
5272
  };
5279
- /**
5280
- * @deprecated
5281
- * @description Deprecated synchronous manager-statements PDF export. Use POST /reports/manager-statements/pdf.
5282
- *
5283
- * Required scope: reports:read, reports:export
5284
- */
5285
- get: operations["getManagerStatementsReportPdf"];
5273
+ get?: never;
5286
5274
  put?: never;
5287
5275
  /**
5288
5276
  * @description Queue a manager-statements PDF export for up to 120 months. Download the result file after the operation completes.
@@ -5426,13 +5414,7 @@ export interface paths {
5426
5414
  path?: never;
5427
5415
  cookie?: never;
5428
5416
  };
5429
- /**
5430
- * @deprecated
5431
- * @description Deprecated synchronous owner statement summary detail PDF. Returns 404 when the selected layout no longer exists. Use POST on this endpoint.
5432
- *
5433
- * Required scope: statements:read, statements:export
5434
- */
5435
- get: operations["getOwnerStatementSummaryPerLayoutDetailsReportPdf"];
5417
+ get?: never;
5436
5418
  put?: never;
5437
5419
  /**
5438
5420
  * @description Queue an owner-summary PDF export. Download the result file after the operation completes.
@@ -5453,13 +5435,7 @@ export interface paths {
5453
5435
  path?: never;
5454
5436
  cookie?: never;
5455
5437
  };
5456
- /**
5457
- * @deprecated
5458
- * @description Deprecated synchronous owner statement summary PDF ZIP export. Returns 404 when the selected layout no longer exists. Use POST /reports/owner-statement-summaries-per-layout/pdf.
5459
- *
5460
- * Required scope: statements:read, statements:export
5461
- */
5462
- get: operations["getOwnerStatementSummariesPerLayoutReportPdfBatch"];
5438
+ get?: never;
5463
5439
  put?: never;
5464
5440
  /**
5465
5441
  * @description Queue an owner-summary PDF ZIP export. Download the result file after the operation completes.
@@ -6404,13 +6380,7 @@ export interface paths {
6404
6380
  path?: never;
6405
6381
  cookie?: never;
6406
6382
  };
6407
- /**
6408
- * @deprecated
6409
- * @description Deprecated synchronous owner-statement PDF export. Use POST /statements/pdf.
6410
- *
6411
- * Required scope: statements:read, statements:export
6412
- */
6413
- get: operations["getStatementsPdf"];
6383
+ get?: never;
6414
6384
  put?: never;
6415
6385
  /**
6416
6386
  * @description Queue an owner-statement PDF export. Download the result file after the operation completes.
@@ -6431,13 +6401,7 @@ export interface paths {
6431
6401
  path?: never;
6432
6402
  cookie?: never;
6433
6403
  };
6434
- /**
6435
- * @deprecated
6436
- * @description Deprecated synchronous owner-statement ZIP export. Use POST /statements/pdf/batch.
6437
- *
6438
- * Required scope: statements:read, statements:export
6439
- */
6440
- get: operations["getStatementsPdfBatch"];
6404
+ get?: never;
6441
6405
  put?: never;
6442
6406
  /**
6443
6407
  * @description Queue an owner-statement PDF ZIP export. Download the result file after the operation completes.
@@ -6486,7 +6450,7 @@ export interface paths {
6486
6450
  */
6487
6451
  get: operations["getStatementsById"];
6488
6452
  /**
6489
- * @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.
6453
+ * @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. Imported historical snapshots cannot move to draft; re-post the import to replace their data. 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.
6490
6454
  *
6491
6455
  * Required scope: statements:write
6492
6456
  */
@@ -7069,7 +7033,7 @@ export interface paths {
7069
7033
  get: operations["getTeams"];
7070
7034
  put?: never;
7071
7035
  /**
7072
- * @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /me/teams or GET /partner/teams instead of creating it again. Retrying a provisioning request that failed before completing is safe. migratedFromTenantId atomically links a new GL team to a non-GL VRI source managed by the same partner; it is rejected for non-GL targets, GL sources, and sources managed by another partner. Generated and explicit slugs are checked against the global tenant registry before the regional tenant is written. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation. An explicit General Ledger copyFromTeamId must use the target data region; a mismatch returns 400 before either tenant registry is written. useCentralDefaults explicitly opts into the published Control Plane bootstrap and cannot be combined with either copy source.
7036
+ * @description Create team. Partner teams billed directly by VRPlatform and property-manager teams billed directly by VRPlatform or managed by Ximplifi have their subscription created with the team, even while onboarding. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /me/teams or GET /partner/teams instead of creating it again. Retrying a provisioning request that failed before completing is safe. migratedFromTenantId atomically links a new GL team to a non-GL VRI source managed by the same partner; it is rejected for non-GL targets, GL sources, and sources managed by another partner. Generated and explicit slugs are checked against the global tenant registry before the regional tenant is written. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation. An explicit General Ledger copyFromTeamId must use the target data region; a mismatch returns 400 before either tenant registry is written. useCentralDefaults explicitly opts into the published Control Plane bootstrap and cannot be combined with either copy source.
7073
7037
  *
7074
7038
  * Required scope: teams:provision
7075
7039
  */
@@ -7159,9 +7123,9 @@ export interface paths {
7159
7123
  get: operations["getTransactions"];
7160
7124
  put?: never;
7161
7125
  /**
7162
- * @description Create a transaction. Journal entries post inline per line; creation into a books-closed month or a statement-locked listing period is rejected. The transaction uniqueRef and every line uniqueRef must be unique; duplicate line references are rejected before anything is inserted. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, create an upload with POST /transactions/attachments, PUT the raw file to uploadUrl, then pass the returned attachmentId in attachmentIds. Attachments are only supported for expense transactions.
7126
+ * @description Create a transaction. The transaction type requires its matching type-specific write scope. Setting payment also requires transactions:mark-paid. Journal entries post inline per line; creation into a books-closed month or a statement-locked listing period is rejected. The transaction uniqueRef and every line uniqueRef must be unique; duplicate line references are rejected before anything is inserted. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, create an upload with POST /transactions/attachments, PUT the raw file to uploadUrl, then pass the returned attachmentId in attachmentIds. Attachments are only supported for expense transactions.
7163
7127
  *
7164
- * Required scope: transactions:write
7128
+ * Required scope: transactions:read
7165
7129
  */
7166
7130
  post: operations["postTransactions"];
7167
7131
  delete?: never;
@@ -7182,7 +7146,7 @@ export interface paths {
7182
7146
  /**
7183
7147
  * @description Create a size-bound upload reference and authenticated regional raw PUT URL for an expense attachment up to 100,000,000 bytes. PUT the unmodified file body to uploadUrl with the declared Content-Type and Content-Length. After the PUT succeeds, pass the attachmentId returned here in attachmentIds when creating or updating an expense transaction. Retrying the same completed upload is idempotent.
7184
7148
  *
7185
- * Required scope: transactions:write
7149
+ * Required scope: transactions:expenses:write
7186
7150
  */
7187
7151
  post: operations["postTransactionsAttachments"];
7188
7152
  delete?: never;
@@ -7202,7 +7166,7 @@ export interface paths {
7202
7166
  /**
7203
7167
  * @description Stream the complete raw attachment body into regional storage using an issued upload reference. Content-Type and the stored byte size must exactly match the create-upload request, and Content-Length is required. The upload reference is single-file, team-scoped, valid for 24 hours, and safe to retry without overwriting a completed object.
7204
7168
  *
7205
- * Required scope: transactions:write
7169
+ * Required scope: transactions:expenses:write
7206
7170
  */
7207
7171
  put: operations["putTransactionsAttachmentsUploadsByUploadRef"];
7208
7172
  post?: never;
@@ -7223,7 +7187,7 @@ export interface paths {
7223
7187
  /**
7224
7188
  * @description Update attachment visibility. isOwnerAccessible controls whether owners can see the file on owner statement details.
7225
7189
  *
7226
- * Required scope: transactions:write
7190
+ * Required scope: transactions:expenses:write
7227
7191
  */
7228
7192
  put: operations["putTransactionsAttachmentsById"];
7229
7193
  post?: never;
@@ -7269,9 +7233,9 @@ export interface paths {
7269
7233
  get?: never;
7270
7234
  put?: never;
7271
7235
  /**
7272
- * @description Create or update up to 500 connection-scoped transactions. Each item uses the same type, party, link, payment, and lock rules as single transaction mutations. Items match existing transactions by id, uniqueRef, or sourceId. Concurrent retries with the same uniqueRef or sourceId are serialized, and duplicate transaction or line references return an item issue. createOnly rejects an existing uniqueRef unless it has the same source provenance, in which case the retry returns the existing transaction.
7236
+ * @description Create or update up to 500 connection-scoped transactions. Every requested and matched transaction requires its matching type-specific write scope; otherwise the whole batch is rejected before writes. Payment input also requires transactions:mark-paid. Each item uses the same type, party, link, payment, and lock rules as single transaction mutations. Items match existing transactions by id, uniqueRef, or sourceId. Concurrent retries with the same uniqueRef or sourceId are serialized, and duplicate transaction or line references return an item issue. createOnly rejects an existing uniqueRef unless it has the same source provenance, in which case the retry returns the existing transaction.
7273
7237
  *
7274
- * Required scope: transactions:write
7238
+ * Required scope: transactions:read
7275
7239
  */
7276
7240
  post: operations["postTransactionsBatch"];
7277
7241
  delete?: never;
@@ -7366,7 +7330,7 @@ export interface paths {
7366
7330
  /**
7367
7331
  * @description Create a recurring transaction template
7368
7332
  *
7369
- * Required scope: transactions:write
7333
+ * Required scope: transactions:expenses:write
7370
7334
  */
7371
7335
  post: operations["postTransactionsRecurringTemplates"];
7372
7336
  delete?: never;
@@ -7387,7 +7351,7 @@ export interface paths {
7387
7351
  /**
7388
7352
  * @description Preview a recurring transaction template pattern
7389
7353
  *
7390
- * Required scope: transactions:write
7354
+ * Required scope: transactions:expenses:write
7391
7355
  */
7392
7356
  post: operations["postTransactionsRecurringTemplatesPreview"];
7393
7357
  delete?: never;
@@ -7412,7 +7376,7 @@ export interface paths {
7412
7376
  /**
7413
7377
  * @description Update an recurring transaction template by ID
7414
7378
  *
7415
- * Required scope: transactions:write
7379
+ * Required scope: transactions:expenses:write
7416
7380
  */
7417
7381
  put: operations["putTransactionsRecurringTemplatesById"];
7418
7382
  post?: never;
@@ -7439,7 +7403,7 @@ export interface paths {
7439
7403
  /**
7440
7404
  * @description Queue recurring transaction instances for up to 366 explicit dates or all due dates. Use dryRun for immediate no-write results.
7441
7405
  *
7442
- * Required scope: transactions:write
7406
+ * Required scope: transactions:expenses:write
7443
7407
  */
7444
7408
  post: operations["postTransactionsRecurringTemplatesByIdRun"];
7445
7409
  delete?: never;
@@ -7462,9 +7426,9 @@ export interface paths {
7462
7426
  */
7463
7427
  get: operations["getTransactionsById"];
7464
7428
  /**
7465
- * @description Update a transaction by ID. Locks apply per line: lines whose journal entries are attached to an owner statement or fall into a books-closed month are locked while the remaining lines stay editable. Changing line account, assignment, listing, or reservation context can recompute a default or forced party. A bank-record match alone still permits deposit and expense description, line account, party, listing, reservation, and expense-markup changes. Amount, date, root bank account, line creation, and line deletion require unmatching first. Books-closed and statement locks still take precedence. After the first Ramp payment attempt, ordinary expense and payout mutations accept only description updates. A status-only archive or unarchive additionally requires durable Ramp bill archive or verified no-bill recovery evidence. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, pass attachmentIds to replace the attached set. Omit attachmentIds to keep current attachments. Attachments are only supported for expense transactions. A uniqueRef already used by another team transaction returns a structured user error.
7429
+ * @description Update a transaction by ID. The current and requested transaction types require their matching type-specific write scopes. Changing payment also requires transactions:mark-paid. Locks apply per line: lines whose journal entries are attached to an owner statement or fall into a books-closed month are locked while the remaining lines stay editable. Changing line account, assignment, listing, or reservation context can recompute a default or forced party. A bank-record match alone still permits deposit and expense description, line account, party, listing, reservation, and expense-markup changes. Amount, date, root bank account, line creation, and line deletion require unmatching first. Books-closed and statement locks still take precedence. After the first Ramp payment attempt, ordinary expense and payout mutations accept only description updates. A status-only archive or unarchive additionally requires durable Ramp bill archive or verified no-bill recovery evidence. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, pass attachmentIds to replace the attached set. Omit attachmentIds to keep current attachments. Attachments are only supported for expense transactions. A uniqueRef already used by another team transaction returns a structured user error.
7466
7430
  *
7467
- * Required scope: transactions:write
7431
+ * Required scope: transactions:read
7468
7432
  */
7469
7433
  put: operations["putTransactionsById"];
7470
7434
  post?: never;
@@ -7555,7 +7519,7 @@ export interface paths {
7555
7519
  /**
7556
7520
  * @description Archive a failed, returned, or canceled Ramp bill before archiving expense or payout accounting. Poll the returned `operationId` through `GET /operations/{id}`; paid provider payments cannot be archived.
7557
7521
  *
7558
- * Required scope: transactions:write, ach-payments:execute
7522
+ * Required scope: transactions:payouts:write, ach-payments:execute
7559
7523
  */
7560
7524
  post: operations["postTransactionsByIdProviderPaymentsByProviderPaymentIdArchive"];
7561
7525
  delete?: never;
@@ -7594,9 +7558,9 @@ export interface paths {
7594
7558
  };
7595
7559
  get?: never;
7596
7560
  /**
7597
- * @description Update a transaction line by ID. Account, assignment, listing, and reservation changes can recompute a default or forced party. A bank-record match alone permits description, account, party, listing, reservation, and expense-markup changes. This includes moving deposit lines between reservation and non-reservation items. Amount changes require unmatching first. Books-closed, attached-statement, and source or destination statement-period locks take precedence. A payout with a Requested, Processing, or Paid Ramp payment accepts only a line-description update until the provider attempt becomes terminal. See https://docs.vrplatform.app/guides/build/transactions#decision-table.
7561
+ * @description Update a transaction line by ID. The parent transaction requires its matching type-specific write scope. Account, assignment, listing, and reservation changes can recompute a default or forced party. A bank-record match alone permits description, account, party, listing, reservation, and expense-markup changes. This includes moving deposit lines between reservation and non-reservation items. Amount changes require unmatching first. Books-closed, attached-statement, and source or destination statement-period locks take precedence. A payout with a Requested, Processing, or Paid Ramp payment accepts only a line-description update until the provider attempt becomes terminal. See https://docs.vrplatform.app/guides/build/transactions#decision-table.
7598
7562
  *
7599
- * Required scope: transactions:write
7563
+ * Required scope: transactions:read
7600
7564
  */
7601
7565
  put: operations["putTransactionsByTransactionIdLinesById"];
7602
7566
  post?: never;
@@ -8131,7 +8095,7 @@ export interface operations {
8131
8095
  sourceId?: string | null;
8132
8096
  message: string;
8133
8097
  /** @enum {string} */
8134
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
8098
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
8135
8099
  context?: unknown;
8136
8100
  }[];
8137
8101
  };
@@ -13319,7 +13283,7 @@ export interface operations {
13319
13283
  hint: string | null;
13320
13284
  role: string | null;
13321
13285
  scope: string | null;
13322
- scopes: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
13286
+ scopes: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
13323
13287
  }[];
13324
13288
  pagination: {
13325
13289
  /** @default 100 */
@@ -13601,7 +13565,7 @@ export interface operations {
13601
13565
  hint: string | null;
13602
13566
  role: string | null;
13603
13567
  scope: string | null;
13604
- scopes: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
13568
+ scopes: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
13605
13569
  apiToken: string;
13606
13570
  };
13607
13571
  };
@@ -13865,7 +13829,7 @@ export interface operations {
13865
13829
  hint: string | null;
13866
13830
  role: string | null;
13867
13831
  scope: string | null;
13868
- scopes: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
13832
+ scopes: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
13869
13833
  apiToken: string;
13870
13834
  };
13871
13835
  };
@@ -16350,16 +16314,15 @@ export interface operations {
16350
16314
  };
16351
16315
  };
16352
16316
  };
16353
- /** @description Audit cursor expired */
16317
+ /** @description The requested position is older than retained history */
16354
16318
  410: {
16355
16319
  headers: {
16356
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
16357
- "Retry-After"?: number;
16358
16320
  [name: string]: unknown;
16359
16321
  };
16360
16322
  content: {
16361
16323
  "application/json": {
16362
- code: string;
16324
+ /** @constant */
16325
+ code: "AUDIT_CURSOR_EXPIRED";
16363
16326
  message: string;
16364
16327
  links?: {
16365
16328
  docs: string;
@@ -16371,7 +16334,15 @@ export interface operations {
16371
16334
  schema?: string;
16372
16335
  }[];
16373
16336
  retryable?: boolean;
16374
- context?: unknown;
16337
+ context: {
16338
+ dataRegion: ("ap" | "crunchy" | "eu" | "hostaway" | "us") | null;
16339
+ /**
16340
+ * Format: date-time
16341
+ * @description Timestamp string with date, time, milliseconds, and timezone.
16342
+ * @example 2024-01-15T12:30:00.000+00:00
16343
+ */
16344
+ earliestAvailableAt: string;
16345
+ };
16375
16346
  };
16376
16347
  };
16377
16348
  };
@@ -18886,7 +18857,7 @@ export interface operations {
18886
18857
  sourceId?: string | null;
18887
18858
  message: string;
18888
18859
  /** @enum {string} */
18889
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
18860
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
18890
18861
  context?: unknown;
18891
18862
  }[];
18892
18863
  };
@@ -30074,7 +30045,7 @@ export interface operations {
30074
30045
  sourceId?: string | null;
30075
30046
  message: string;
30076
30047
  /** @enum {string} */
30077
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
30048
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
30078
30049
  context?: unknown;
30079
30050
  }[];
30080
30051
  };
@@ -35156,16 +35127,15 @@ export interface operations {
35156
35127
  };
35157
35128
  };
35158
35129
  };
35159
- /** @description Bad request */
35130
+ /** @description The preview selection is invalid */
35160
35131
  400: {
35161
35132
  headers: {
35162
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
35163
- "Retry-After"?: number;
35164
35133
  [name: string]: unknown;
35165
35134
  };
35166
35135
  content: {
35167
35136
  "application/json": {
35168
- code: string;
35137
+ /** @constant */
35138
+ code: "BAD_REQUEST";
35169
35139
  message: string;
35170
35140
  links?: {
35171
35141
  docs: string;
@@ -35177,7 +35147,10 @@ export interface operations {
35177
35147
  schema?: string;
35178
35148
  }[];
35179
35149
  retryable?: boolean;
35180
- context?: unknown;
35150
+ context: {
35151
+ /** @enum {string} */
35152
+ reason: "bankAccountRequired" | "mappingResourceMismatch" | "presetConfigurationInvalid";
35153
+ };
35181
35154
  };
35182
35155
  };
35183
35156
  };
@@ -35231,16 +35204,15 @@ export interface operations {
35231
35204
  };
35232
35205
  };
35233
35206
  };
35234
- /** @description Not found */
35207
+ /** @description The upload or preset is unavailable */
35235
35208
  404: {
35236
35209
  headers: {
35237
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
35238
- "Retry-After"?: number;
35239
35210
  [name: string]: unknown;
35240
35211
  };
35241
35212
  content: {
35242
35213
  "application/json": {
35243
- code: string;
35214
+ /** @constant */
35215
+ code: "NOT_FOUND";
35244
35216
  message: string;
35245
35217
  links?: {
35246
35218
  docs: string;
@@ -35252,20 +35224,22 @@ export interface operations {
35252
35224
  schema?: string;
35253
35225
  }[];
35254
35226
  retryable?: boolean;
35255
- context?: unknown;
35227
+ context: {
35228
+ /** @enum {string} */
35229
+ reason: "presetNotFound" | "uploadUnavailable";
35230
+ };
35256
35231
  };
35257
35232
  };
35258
35233
  };
35259
- /** @description Conflict */
35234
+ /** @description The uploaded source does not match the selected preset */
35260
35235
  409: {
35261
35236
  headers: {
35262
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
35263
- "Retry-After"?: number;
35264
35237
  [name: string]: unknown;
35265
35238
  };
35266
35239
  content: {
35267
35240
  "application/json": {
35268
- code: string;
35241
+ /** @constant */
35242
+ code: "CONFLICT";
35269
35243
  message: string;
35270
35244
  links?: {
35271
35245
  docs: string;
@@ -35277,7 +35251,10 @@ export interface operations {
35277
35251
  schema?: string;
35278
35252
  }[];
35279
35253
  retryable?: boolean;
35280
- context?: unknown;
35254
+ context: {
35255
+ /** @enum {string} */
35256
+ reason: "presetSourceMismatch";
35257
+ };
35281
35258
  };
35282
35259
  };
35283
35260
  };
@@ -35306,6 +35283,33 @@ export interface operations {
35306
35283
  };
35307
35284
  };
35308
35285
  };
35286
+ /** @description The preview selection exceeds the supported size */
35287
+ 413: {
35288
+ headers: {
35289
+ [name: string]: unknown;
35290
+ };
35291
+ content: {
35292
+ "application/json": {
35293
+ /** @constant */
35294
+ code: "PAYLOAD_TOO_LARGE";
35295
+ message: string;
35296
+ links?: {
35297
+ docs: string;
35298
+ schema: string;
35299
+ };
35300
+ issues?: {
35301
+ message: string;
35302
+ path?: (string | number)[];
35303
+ schema?: string;
35304
+ }[];
35305
+ retryable?: boolean;
35306
+ context: {
35307
+ /** @enum {string} */
35308
+ reason: "selectionTooLarge";
35309
+ };
35310
+ };
35311
+ };
35312
+ };
35309
35313
  /** @description Unprocessable content */
35310
35314
  422: {
35311
35315
  headers: {
@@ -35404,7 +35408,7 @@ export interface operations {
35404
35408
  /** Format: uuid */
35405
35409
  id: string;
35406
35410
  /** @enum {string} */
35407
- status: "queued" | "started" | "completed" | "failed" | "canceled";
35411
+ status: "queued" | "running" | "completed" | "failed";
35408
35412
  result?: {
35409
35413
  logicalRecordCount: number;
35410
35414
  stateCounts: {
@@ -35942,8 +35946,10 @@ export interface operations {
35942
35946
  };
35943
35947
  };
35944
35948
  };
35945
- /** @constant */
35946
- code?: "csvPreviewFailed";
35949
+ failure: {
35950
+ code: ("csvBlankHeader" | "csvColumnLimitExceeded" | "csvDuplicateHeaders" | "csvFileTooLarge" | "csvInvalidEncoding" | "csvLogicalRecordTooLarge" | "csvNoRows" | "csvParsingFailed" | "csvRowLimitExceeded" | "csvSourceChanged" | "csvSourceUnavailable") | ("csvPreviewFailed" | "operation_failed");
35951
+ message: string;
35952
+ } | null;
35947
35953
  };
35948
35954
  };
35949
35955
  };
@@ -36022,16 +36028,15 @@ export interface operations {
36022
36028
  };
36023
36029
  };
36024
36030
  };
36025
- /** @description Not found */
36031
+ /** @description The CSV preview does not exist */
36026
36032
  404: {
36027
36033
  headers: {
36028
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
36029
- "Retry-After"?: number;
36030
36034
  [name: string]: unknown;
36031
36035
  };
36032
36036
  content: {
36033
36037
  "application/json": {
36034
- code: string;
36038
+ /** @constant */
36039
+ code: "NOT_FOUND";
36035
36040
  message: string;
36036
36041
  links?: {
36037
36042
  docs: string;
@@ -36043,7 +36048,10 @@ export interface operations {
36043
36048
  schema?: string;
36044
36049
  }[];
36045
36050
  retryable?: boolean;
36046
- context?: unknown;
36051
+ context: {
36052
+ /** @enum {string} */
36053
+ reason: "previewNotFound";
36054
+ };
36047
36055
  };
36048
36056
  };
36049
36057
  };
@@ -36072,16 +36080,15 @@ export interface operations {
36072
36080
  };
36073
36081
  };
36074
36082
  };
36075
- /** @description Gone */
36083
+ /** @description The CSV preview has expired */
36076
36084
  410: {
36077
36085
  headers: {
36078
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
36079
- "Retry-After"?: number;
36080
36086
  [name: string]: unknown;
36081
36087
  };
36082
36088
  content: {
36083
36089
  "application/json": {
36084
- code: string;
36090
+ /** @constant */
36091
+ code: "GONE";
36085
36092
  message: string;
36086
36093
  links?: {
36087
36094
  docs: string;
@@ -36093,7 +36100,10 @@ export interface operations {
36093
36100
  schema?: string;
36094
36101
  }[];
36095
36102
  retryable?: boolean;
36096
- context?: unknown;
36103
+ context: {
36104
+ /** @enum {string} */
36105
+ reason: "previewExpired";
36106
+ };
36097
36107
  };
36098
36108
  };
36099
36109
  };
@@ -36284,16 +36294,15 @@ export interface operations {
36284
36294
  };
36285
36295
  };
36286
36296
  };
36287
- /** @description Not found */
36297
+ /** @description The CSV preview does not exist */
36288
36298
  404: {
36289
36299
  headers: {
36290
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
36291
- "Retry-After"?: number;
36292
36300
  [name: string]: unknown;
36293
36301
  };
36294
36302
  content: {
36295
36303
  "application/json": {
36296
- code: string;
36304
+ /** @constant */
36305
+ code: "NOT_FOUND";
36297
36306
  message: string;
36298
36307
  links?: {
36299
36308
  docs: string;
@@ -36305,20 +36314,22 @@ export interface operations {
36305
36314
  schema?: string;
36306
36315
  }[];
36307
36316
  retryable?: boolean;
36308
- context?: unknown;
36317
+ context: {
36318
+ /** @enum {string} */
36319
+ reason: "previewNotFound";
36320
+ };
36309
36321
  };
36310
36322
  };
36311
36323
  };
36312
- /** @description Conflict */
36324
+ /** @description The preview cannot be confirmed in its current state */
36313
36325
  409: {
36314
36326
  headers: {
36315
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
36316
- "Retry-After"?: number;
36317
36327
  [name: string]: unknown;
36318
36328
  };
36319
36329
  content: {
36320
36330
  "application/json": {
36321
- code: string;
36331
+ /** @constant */
36332
+ code: "CONFLICT";
36322
36333
  message: string;
36323
36334
  links?: {
36324
36335
  docs: string;
@@ -36330,20 +36341,22 @@ export interface operations {
36330
36341
  schema?: string;
36331
36342
  }[];
36332
36343
  retryable?: boolean;
36333
- context?: unknown;
36344
+ context: {
36345
+ /** @enum {string} */
36346
+ reason: "previewBlockingIssues" | "previewNoImportableRecords" | "previewNotReady" | "previewStale";
36347
+ };
36334
36348
  };
36335
36349
  };
36336
36350
  };
36337
- /** @description Gone */
36351
+ /** @description The CSV preview has expired */
36338
36352
  410: {
36339
36353
  headers: {
36340
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
36341
- "Retry-After"?: number;
36342
36354
  [name: string]: unknown;
36343
36355
  };
36344
36356
  content: {
36345
36357
  "application/json": {
36346
- code: string;
36358
+ /** @constant */
36359
+ code: "GONE";
36347
36360
  message: string;
36348
36361
  links?: {
36349
36362
  docs: string;
@@ -36355,7 +36368,10 @@ export interface operations {
36355
36368
  schema?: string;
36356
36369
  }[];
36357
36370
  retryable?: boolean;
36358
- context?: unknown;
36371
+ context: {
36372
+ /** @enum {string} */
36373
+ reason: "previewExpired";
36374
+ };
36359
36375
  };
36360
36376
  };
36361
36377
  };
@@ -36969,16 +36985,15 @@ export interface operations {
36969
36985
  };
36970
36986
  };
36971
36987
  };
36972
- /** @description Bad request */
36988
+ /** @description The preview record cursor is invalid */
36973
36989
  400: {
36974
36990
  headers: {
36975
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
36976
- "Retry-After"?: number;
36977
36991
  [name: string]: unknown;
36978
36992
  };
36979
36993
  content: {
36980
36994
  "application/json": {
36981
- code: string;
36995
+ /** @constant */
36996
+ code: "BAD_REQUEST";
36982
36997
  message: string;
36983
36998
  links?: {
36984
36999
  docs: string;
@@ -36990,7 +37005,10 @@ export interface operations {
36990
37005
  schema?: string;
36991
37006
  }[];
36992
37007
  retryable?: boolean;
36993
- context?: unknown;
37008
+ context: {
37009
+ /** @enum {string} */
37010
+ reason: "previewRecordCursorInvalid";
37011
+ };
36994
37012
  };
36995
37013
  };
36996
37014
  };
@@ -37044,16 +37062,15 @@ export interface operations {
37044
37062
  };
37045
37063
  };
37046
37064
  };
37047
- /** @description Not found */
37065
+ /** @description The CSV preview does not exist */
37048
37066
  404: {
37049
37067
  headers: {
37050
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
37051
- "Retry-After"?: number;
37052
37068
  [name: string]: unknown;
37053
37069
  };
37054
37070
  content: {
37055
37071
  "application/json": {
37056
- code: string;
37072
+ /** @constant */
37073
+ code: "NOT_FOUND";
37057
37074
  message: string;
37058
37075
  links?: {
37059
37076
  docs: string;
@@ -37065,20 +37082,22 @@ export interface operations {
37065
37082
  schema?: string;
37066
37083
  }[];
37067
37084
  retryable?: boolean;
37068
- context?: unknown;
37085
+ context: {
37086
+ /** @enum {string} */
37087
+ reason: "previewNotFound";
37088
+ };
37069
37089
  };
37070
37090
  };
37071
37091
  };
37072
- /** @description Conflict */
37092
+ /** @description Preview records are not available yet */
37073
37093
  409: {
37074
37094
  headers: {
37075
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
37076
- "Retry-After"?: number;
37077
37095
  [name: string]: unknown;
37078
37096
  };
37079
37097
  content: {
37080
37098
  "application/json": {
37081
- code: string;
37099
+ /** @constant */
37100
+ code: "CONFLICT";
37082
37101
  message: string;
37083
37102
  links?: {
37084
37103
  docs: string;
@@ -37090,20 +37109,22 @@ export interface operations {
37090
37109
  schema?: string;
37091
37110
  }[];
37092
37111
  retryable?: boolean;
37093
- context?: unknown;
37112
+ context: {
37113
+ /** @enum {string} */
37114
+ reason: "previewRecordsUnavailable";
37115
+ };
37094
37116
  };
37095
37117
  };
37096
37118
  };
37097
- /** @description Gone */
37119
+ /** @description The CSV preview has expired */
37098
37120
  410: {
37099
37121
  headers: {
37100
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
37101
- "Retry-After"?: number;
37102
37122
  [name: string]: unknown;
37103
37123
  };
37104
37124
  content: {
37105
37125
  "application/json": {
37106
- code: string;
37126
+ /** @constant */
37127
+ code: "GONE";
37107
37128
  message: string;
37108
37129
  links?: {
37109
37130
  docs: string;
@@ -37115,7 +37136,10 @@ export interface operations {
37115
37136
  schema?: string;
37116
37137
  }[];
37117
37138
  retryable?: boolean;
37118
- context?: unknown;
37139
+ context: {
37140
+ /** @enum {string} */
37141
+ reason: "previewExpired";
37142
+ };
37119
37143
  };
37120
37144
  };
37121
37145
  };
@@ -37467,6 +37491,7 @@ export interface operations {
37467
37491
  content: {
37468
37492
  "application/json": {
37469
37493
  fileName: string;
37494
+ /** @description CSV byte length. The maximum is 100,000,000 bytes. */
37470
37495
  fileSize: number;
37471
37496
  /** @enum {string} */
37472
37497
  resource: "bankRecords" | "owners" | "expenses" | "vendors" | "deposits";
@@ -37639,6 +37664,33 @@ export interface operations {
37639
37664
  };
37640
37665
  };
37641
37666
  };
37667
+ /** @description The declared CSV file size exceeds the supported limit */
37668
+ 413: {
37669
+ headers: {
37670
+ [name: string]: unknown;
37671
+ };
37672
+ content: {
37673
+ "application/json": {
37674
+ /** @constant */
37675
+ code: "PAYLOAD_TOO_LARGE";
37676
+ message: string;
37677
+ links?: {
37678
+ docs: string;
37679
+ schema: string;
37680
+ };
37681
+ issues?: {
37682
+ message: string;
37683
+ path?: (string | number)[];
37684
+ schema?: string;
37685
+ }[];
37686
+ retryable?: boolean;
37687
+ context: {
37688
+ /** @enum {string} */
37689
+ reason: "uploadTooLarge";
37690
+ };
37691
+ };
37692
+ };
37693
+ };
37642
37694
  /** @description Unprocessable content */
37643
37695
  422: {
37644
37696
  headers: {
@@ -37764,16 +37816,15 @@ export interface operations {
37764
37816
  };
37765
37817
  };
37766
37818
  };
37767
- /** @description Bad request */
37819
+ /** @description The uploaded CSV source is invalid */
37768
37820
  400: {
37769
37821
  headers: {
37770
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
37771
- "Retry-After"?: number;
37772
37822
  [name: string]: unknown;
37773
37823
  };
37774
37824
  content: {
37775
37825
  "application/json": {
37776
- code: string;
37826
+ /** @constant */
37827
+ code: "BAD_REQUEST";
37777
37828
  message: string;
37778
37829
  links?: {
37779
37830
  docs: string;
@@ -37785,7 +37836,10 @@ export interface operations {
37785
37836
  schema?: string;
37786
37837
  }[];
37787
37838
  retryable?: boolean;
37788
- context?: unknown;
37839
+ context: {
37840
+ /** @enum {string} */
37841
+ reason: "csvBlankHeader" | "csvColumnLimitExceeded" | "csvDuplicateHeaders" | "csvInvalidEncoding" | "csvNoRows" | "csvParsingFailed";
37842
+ };
37789
37843
  };
37790
37844
  };
37791
37845
  };
@@ -37839,16 +37893,15 @@ export interface operations {
37839
37893
  };
37840
37894
  };
37841
37895
  };
37842
- /** @description Not found */
37896
+ /** @description The upload reference or uploaded source is unavailable */
37843
37897
  404: {
37844
37898
  headers: {
37845
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
37846
- "Retry-After"?: number;
37847
37899
  [name: string]: unknown;
37848
37900
  };
37849
37901
  content: {
37850
37902
  "application/json": {
37851
- code: string;
37903
+ /** @constant */
37904
+ code: "NOT_FOUND";
37852
37905
  message: string;
37853
37906
  links?: {
37854
37907
  docs: string;
@@ -37860,7 +37913,10 @@ export interface operations {
37860
37913
  schema?: string;
37861
37914
  }[];
37862
37915
  retryable?: boolean;
37863
- context?: unknown;
37916
+ context: {
37917
+ /** @enum {string} */
37918
+ reason: "uploadUnavailable";
37919
+ };
37864
37920
  };
37865
37921
  };
37866
37922
  };
@@ -38041,33 +38097,35 @@ export interface operations {
38041
38097
  };
38042
38098
  };
38043
38099
  };
38044
- /** @description Bad request */
38100
+ /** @description The upload request or CSV source is invalid */
38045
38101
  400: {
38046
- headers: {
38047
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38048
- "Retry-After"?: number;
38049
- [name: string]: unknown;
38050
- };
38051
- content: {
38052
- "application/json": {
38053
- code: string;
38054
- message: string;
38055
- links?: {
38056
- docs: string;
38057
- schema: string;
38058
- };
38059
- issues?: {
38060
- message: string;
38061
- path?: (string | number)[];
38062
- schema?: string;
38063
- }[];
38064
- retryable?: boolean;
38065
- context?: unknown;
38066
- };
38067
- };
38068
- };
38069
- /** @description Unauthorized */
38070
- 401: {
38102
+ headers: {
38103
+ [name: string]: unknown;
38104
+ };
38105
+ content: {
38106
+ "application/json": {
38107
+ /** @constant */
38108
+ code: "BAD_REQUEST";
38109
+ message: string;
38110
+ links?: {
38111
+ docs: string;
38112
+ schema: string;
38113
+ };
38114
+ issues?: {
38115
+ message: string;
38116
+ path?: (string | number)[];
38117
+ schema?: string;
38118
+ }[];
38119
+ retryable?: boolean;
38120
+ context: {
38121
+ /** @enum {string} */
38122
+ reason: "missingUploadBody" | "uploadContentTypeMismatch" | "uploadSizeMismatch" | "csvBlankHeader" | "csvColumnLimitExceeded" | "csvDuplicateHeaders" | "csvInvalidEncoding" | "csvNoRows" | "csvParsingFailed";
38123
+ };
38124
+ };
38125
+ };
38126
+ };
38127
+ /** @description Unauthorized */
38128
+ 401: {
38071
38129
  headers: {
38072
38130
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38073
38131
  "Retry-After"?: number;
@@ -38116,16 +38174,15 @@ export interface operations {
38116
38174
  };
38117
38175
  };
38118
38176
  };
38119
- /** @description Not found */
38177
+ /** @description The upload reference or uploaded source is unavailable */
38120
38178
  404: {
38121
38179
  headers: {
38122
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38123
- "Retry-After"?: number;
38124
38180
  [name: string]: unknown;
38125
38181
  };
38126
38182
  content: {
38127
38183
  "application/json": {
38128
- code: string;
38184
+ /** @constant */
38185
+ code: "NOT_FOUND";
38129
38186
  message: string;
38130
38187
  links?: {
38131
38188
  docs: string;
@@ -38137,20 +38194,22 @@ export interface operations {
38137
38194
  schema?: string;
38138
38195
  }[];
38139
38196
  retryable?: boolean;
38140
- context?: unknown;
38197
+ context: {
38198
+ /** @enum {string} */
38199
+ reason: "uploadUnavailable";
38200
+ };
38141
38201
  };
38142
38202
  };
38143
38203
  };
38144
- /** @description Conflict */
38204
+ /** @description The upload state conflicts with the declared upload */
38145
38205
  409: {
38146
38206
  headers: {
38147
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38148
- "Retry-After"?: number;
38149
38207
  [name: string]: unknown;
38150
38208
  };
38151
38209
  content: {
38152
38210
  "application/json": {
38153
- code: string;
38211
+ /** @constant */
38212
+ code: "CONFLICT";
38154
38213
  message: string;
38155
38214
  links?: {
38156
38215
  docs: string;
@@ -38162,7 +38221,10 @@ export interface operations {
38162
38221
  schema?: string;
38163
38222
  }[];
38164
38223
  retryable?: boolean;
38165
- context?: unknown;
38224
+ context: {
38225
+ /** @enum {string} */
38226
+ reason: "uploadConflict";
38227
+ };
38166
38228
  };
38167
38229
  };
38168
38230
  };
@@ -38289,7 +38351,7 @@ export interface operations {
38289
38351
  /** Format: uuid */
38290
38352
  id: string;
38291
38353
  /** @enum {string} */
38292
- status: "queued" | "started" | "completed" | "failed" | "canceled";
38354
+ status: "queued" | "running" | "completed" | "failed";
38293
38355
  outcome?: {
38294
38356
  created: number;
38295
38357
  updated: number;
@@ -38297,8 +38359,11 @@ export interface operations {
38297
38359
  failed: number;
38298
38360
  skipped: number;
38299
38361
  };
38300
- /** @enum {string} */
38301
- code?: "csvImportFailed" | "csvImportRecordFailed";
38362
+ failure: {
38363
+ /** @enum {string} */
38364
+ code: "csvImportFailed" | "csvImportRecordFailed" | "operation_failed";
38365
+ message: string;
38366
+ } | null;
38302
38367
  };
38303
38368
  };
38304
38369
  };
@@ -38377,16 +38442,15 @@ export interface operations {
38377
38442
  };
38378
38443
  };
38379
38444
  };
38380
- /** @description Not found */
38445
+ /** @description The CSV import does not exist */
38381
38446
  404: {
38382
38447
  headers: {
38383
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38384
- "Retry-After"?: number;
38385
38448
  [name: string]: unknown;
38386
38449
  };
38387
38450
  content: {
38388
38451
  "application/json": {
38389
- code: string;
38452
+ /** @constant */
38453
+ code: "NOT_FOUND";
38390
38454
  message: string;
38391
38455
  links?: {
38392
38456
  docs: string;
@@ -38398,7 +38462,10 @@ export interface operations {
38398
38462
  schema?: string;
38399
38463
  }[];
38400
38464
  retryable?: boolean;
38401
- context?: unknown;
38465
+ context: {
38466
+ /** @enum {string} */
38467
+ reason: "importNotFound";
38468
+ };
38402
38469
  };
38403
38470
  };
38404
38471
  };
@@ -38572,16 +38639,15 @@ export interface operations {
38572
38639
  };
38573
38640
  };
38574
38641
  };
38575
- /** @description Bad request */
38642
+ /** @description The import outcome cursor is invalid */
38576
38643
  400: {
38577
38644
  headers: {
38578
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38579
- "Retry-After"?: number;
38580
38645
  [name: string]: unknown;
38581
38646
  };
38582
38647
  content: {
38583
38648
  "application/json": {
38584
- code: string;
38649
+ /** @constant */
38650
+ code: "BAD_REQUEST";
38585
38651
  message: string;
38586
38652
  links?: {
38587
38653
  docs: string;
@@ -38593,7 +38659,10 @@ export interface operations {
38593
38659
  schema?: string;
38594
38660
  }[];
38595
38661
  retryable?: boolean;
38596
- context?: unknown;
38662
+ context: {
38663
+ /** @enum {string} */
38664
+ reason: "importOutcomeCursorInvalid";
38665
+ };
38597
38666
  };
38598
38667
  };
38599
38668
  };
@@ -38647,16 +38716,15 @@ export interface operations {
38647
38716
  };
38648
38717
  };
38649
38718
  };
38650
- /** @description Not found */
38719
+ /** @description The CSV import does not exist */
38651
38720
  404: {
38652
38721
  headers: {
38653
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38654
- "Retry-After"?: number;
38655
38722
  [name: string]: unknown;
38656
38723
  };
38657
38724
  content: {
38658
38725
  "application/json": {
38659
- code: string;
38726
+ /** @constant */
38727
+ code: "NOT_FOUND";
38660
38728
  message: string;
38661
38729
  links?: {
38662
38730
  docs: string;
@@ -38668,20 +38736,22 @@ export interface operations {
38668
38736
  schema?: string;
38669
38737
  }[];
38670
38738
  retryable?: boolean;
38671
- context?: unknown;
38739
+ context: {
38740
+ /** @enum {string} */
38741
+ reason: "importNotFound";
38742
+ };
38672
38743
  };
38673
38744
  };
38674
38745
  };
38675
- /** @description Conflict */
38746
+ /** @description Import outcomes are not available yet */
38676
38747
  409: {
38677
38748
  headers: {
38678
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38679
- "Retry-After"?: number;
38680
38749
  [name: string]: unknown;
38681
38750
  };
38682
38751
  content: {
38683
38752
  "application/json": {
38684
- code: string;
38753
+ /** @constant */
38754
+ code: "CONFLICT";
38685
38755
  message: string;
38686
38756
  links?: {
38687
38757
  docs: string;
@@ -38693,20 +38763,22 @@ export interface operations {
38693
38763
  schema?: string;
38694
38764
  }[];
38695
38765
  retryable?: boolean;
38696
- context?: unknown;
38766
+ context: {
38767
+ /** @enum {string} */
38768
+ reason: "importOutcomesUnavailable";
38769
+ };
38697
38770
  };
38698
38771
  };
38699
38772
  };
38700
- /** @description Gone */
38773
+ /** @description The CSV import outcomes have expired */
38701
38774
  410: {
38702
38775
  headers: {
38703
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
38704
- "Retry-After"?: number;
38705
38776
  [name: string]: unknown;
38706
38777
  };
38707
38778
  content: {
38708
38779
  "application/json": {
38709
- code: string;
38780
+ /** @constant */
38781
+ code: "GONE";
38710
38782
  message: string;
38711
38783
  links?: {
38712
38784
  docs: string;
@@ -38718,7 +38790,10 @@ export interface operations {
38718
38790
  schema?: string;
38719
38791
  }[];
38720
38792
  retryable?: boolean;
38721
- context?: unknown;
38793
+ context: {
38794
+ /** @enum {string} */
38795
+ reason: "importOutcomesExpired";
38796
+ };
38722
38797
  };
38723
38798
  };
38724
38799
  };
@@ -54396,7 +54471,7 @@ export interface operations {
54396
54471
  sourceId?: string | null;
54397
54472
  message: string;
54398
54473
  /** @enum {string} */
54399
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
54474
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
54400
54475
  context?: unknown;
54401
54476
  }[];
54402
54477
  };
@@ -55603,8 +55678,7 @@ export interface operations {
55603
55678
  artifactExpiresAt?: string;
55604
55679
  /** Format: date-time */
55605
55680
  artifactsCleanedAt?: string;
55606
- /** @constant */
55607
- errorCode?: "csvPreviewFailed";
55681
+ errorCode?: ("csvBlankHeader" | "csvColumnLimitExceeded" | "csvDuplicateHeaders" | "csvFileTooLarge" | "csvInvalidEncoding" | "csvLogicalRecordTooLarge" | "csvNoRows" | "csvParsingFailed" | "csvRowLimitExceeded" | "csvSourceChanged" | "csvSourceUnavailable") | ("csvPreviewFailed" | "operation_failed");
55608
55682
  /** Format: uuid */
55609
55683
  confirmationSyncId?: string;
55610
55684
  };
@@ -76716,7 +76790,7 @@ export interface operations {
76716
76790
  sourceId?: string | null;
76717
76791
  message: string;
76718
76792
  /** @enum {string} */
76719
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
76793
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
76720
76794
  context?: unknown;
76721
76795
  }[];
76722
76796
  };
@@ -78523,7 +78597,7 @@ export interface operations {
78523
78597
  sourceId?: string | null;
78524
78598
  message: string;
78525
78599
  /** @enum {string} */
78526
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
78600
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
78527
78601
  context?: unknown;
78528
78602
  }[];
78529
78603
  };
@@ -83928,8 +84002,8 @@ export interface operations {
83928
84002
  accessSource: "direct" | "partnerDerived";
83929
84003
  /** @enum {string} */
83930
84004
  role: "admin" | "user" | "owner" | "partner";
83931
- permissionBundles: string[];
83932
- permissions: string[];
84005
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
84006
+ permissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
83933
84007
  notifications: {
83934
84008
  ownerStatementInReview: boolean;
83935
84009
  ownerStatementPublished: boolean;
@@ -93475,7 +93549,7 @@ export interface operations {
93475
93549
  /** Format: email */
93476
93550
  email: string;
93477
93551
  secondaryEmails: string[];
93478
- permissionBundles: string[];
93552
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
93479
93553
  /** @enum {string} */
93480
93554
  managedTeamAccess: "all" | "assigned";
93481
93555
  /** @enum {string} */
@@ -93495,7 +93569,7 @@ export interface operations {
93495
93569
  id: string;
93496
93570
  name: string;
93497
93571
  };
93498
- permissionBundles: string[];
93572
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
93499
93573
  role?: string | null;
93500
93574
  status?: string | null;
93501
93575
  lastInvitedAt: string | null;
@@ -109434,23 +109508,42 @@ export interface operations {
109434
109508
  };
109435
109509
  };
109436
109510
  };
109437
- getManagerStatementReportDetailPdf: {
109511
+ queueManagerStatementReportDetailPdf: {
109438
109512
  parameters: {
109439
- query?: {
109440
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
109441
- startAt?: string;
109442
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. Treated as an exclusive upper bound (first day of the month after the range). */
109443
- endAt?: string;
109444
- /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
109445
- dateRange?: string;
109446
- /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
109447
- isDateRangeEndInclusive?: boolean;
109448
- };
109513
+ query?: never;
109449
109514
  header?: never;
109450
109515
  path?: never;
109451
109516
  cookie?: never;
109452
109517
  };
109453
- requestBody?: never;
109518
+ requestBody?: {
109519
+ content: {
109520
+ "application/json": {
109521
+ /**
109522
+ * Format: vrp-date-boundary
109523
+ * @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead.
109524
+ * @example 2024-01-15
109525
+ */
109526
+ startAt?: string;
109527
+ /**
109528
+ * Format: vrp-date-boundary
109529
+ * @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. Treated as an exclusive upper bound (first day of the month after the range).
109530
+ * @example 2024-01-15
109531
+ */
109532
+ endAt?: string;
109533
+ /**
109534
+ * Format: vrp-date-range
109535
+ * @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day.
109536
+ * @example 2024-01-01...2024-01-31
109537
+ */
109538
+ dateRange?: string;
109539
+ /**
109540
+ * @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`).
109541
+ * @default true
109542
+ */
109543
+ isDateRangeEndInclusive?: boolean;
109544
+ };
109545
+ };
109546
+ };
109454
109547
  responses: {
109455
109548
  /** @description Successful response */
109456
109549
  200: {
@@ -109459,8 +109552,20 @@ export interface operations {
109459
109552
  };
109460
109553
  content: {
109461
109554
  "application/json": {
109462
- url: string;
109463
- expIn: number;
109555
+ /** Format: uuid */
109556
+ operationId: string;
109557
+ /** @enum {string} */
109558
+ type: "ach-verification" | "bank-rule-run" | "calendar-block" | "calendar-unblock" | "connection-archive" | "connection-connect" | "connection-extract" | "connection-sync" | "csv-import" | "csv-import-preview" | "export" | "flow-run" | "historical-gl-import" | "historical-statement-import" | "listing-journal-refresh" | "plaid-initial-sync" | "pms-cutover" | "pms-cutover-preview" | "provider-payment" | "provider-payment-recovery" | "recurring-transaction-run" | "reservation-journal-refresh" | "team-delete" | "team-demo-data" | "team-duplicate" | "team-initialize" | "transaction-journal-refresh" | "vri-statement-import" | "vri-team-migration" | "webhook-test";
109559
+ /** @constant */
109560
+ status: "queued";
109561
+ resource: {
109562
+ /** @enum {string} */
109563
+ type: "bank-rule" | "connection" | "contact" | "file" | "flow" | "listing" | "recurring-transaction-template" | "statement" | "team" | "transaction" | "webhook";
109564
+ /** Format: uuid */
109565
+ id: string;
109566
+ /** @enum {string} */
109567
+ role: "source" | "target" | "result";
109568
+ } | null;
109464
109569
  };
109465
109570
  };
109466
109571
  };
@@ -109691,7 +109796,7 @@ export interface operations {
109691
109796
  };
109692
109797
  };
109693
109798
  };
109694
- queueManagerStatementReportDetailPdf: {
109799
+ queueManagerStatementsReportPdf: {
109695
109800
  parameters: {
109696
109801
  query?: never;
109697
109802
  header?: never;
@@ -109701,29 +109806,7 @@ export interface operations {
109701
109806
  requestBody?: {
109702
109807
  content: {
109703
109808
  "application/json": {
109704
- /**
109705
- * Format: vrp-date-boundary
109706
- * @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead.
109707
- * @example 2024-01-15
109708
- */
109709
- startAt?: string;
109710
- /**
109711
- * Format: vrp-date-boundary
109712
- * @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. Treated as an exclusive upper bound (first day of the month after the range).
109713
- * @example 2024-01-15
109714
- */
109715
- endAt?: string;
109716
- /**
109717
- * Format: vrp-date-range
109718
- * @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day.
109719
- * @example 2024-01-01...2024-01-31
109720
- */
109721
- dateRange?: string;
109722
- /**
109723
- * @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`).
109724
- * @default true
109725
- */
109726
- isDateRangeEndInclusive?: boolean;
109809
+ startAts: string[];
109727
109810
  };
109728
109811
  };
109729
109812
  };
@@ -109979,11 +110062,22 @@ export interface operations {
109979
110062
  };
109980
110063
  };
109981
110064
  };
109982
- getManagerStatementsReportPdf: {
110065
+ getOwnerStatementSummariesPerLayoutReport: {
109983
110066
  parameters: {
109984
- query: {
109985
- /** @description comma separated month start dates */
109986
- startAts: string;
110067
+ query?: {
110068
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
110069
+ startAt?: string;
110070
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
110071
+ endAt?: string;
110072
+ /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
110073
+ dateRange?: string;
110074
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
110075
+ isDateRangeEndInclusive?: boolean;
110076
+ /** @description comma separated listings */
110077
+ listingIds?: string;
110078
+ currency?: string;
110079
+ viewAs?: "owner" | "manager";
110080
+ search?: string;
109987
110081
  };
109988
110082
  header?: never;
109989
110083
  path?: never;
@@ -109998,649 +110092,121 @@ export interface operations {
109998
110092
  };
109999
110093
  content: {
110000
110094
  "application/json": {
110001
- url: string;
110002
- expIn: number;
110003
- };
110004
- };
110005
- };
110006
- /** @description Bad request */
110007
- 400: {
110008
- headers: {
110009
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110010
- "Retry-After"?: number;
110011
- [name: string]: unknown;
110012
- };
110013
- content: {
110014
- "application/json": {
110015
- code: string;
110016
- message: string;
110017
- links?: {
110018
- docs: string;
110019
- schema: string;
110020
- };
110021
- issues?: {
110022
- message: string;
110023
- path?: (string | number)[];
110024
- schema?: string;
110025
- }[];
110026
- retryable?: boolean;
110027
- context?: unknown;
110028
- };
110029
- };
110030
- };
110031
- /** @description Unauthorized */
110032
- 401: {
110033
- headers: {
110034
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110035
- "Retry-After"?: number;
110036
- [name: string]: unknown;
110037
- };
110038
- content: {
110039
- "application/json": {
110040
- code: string;
110041
- message: string;
110042
- links?: {
110043
- docs: string;
110044
- schema: string;
110045
- };
110046
- issues?: {
110047
- message: string;
110048
- path?: (string | number)[];
110049
- schema?: string;
110050
- }[];
110051
- retryable?: boolean;
110052
- context?: unknown;
110053
- };
110054
- };
110055
- };
110056
- /** @description Forbidden */
110057
- 403: {
110058
- headers: {
110059
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110060
- "Retry-After"?: number;
110061
- [name: string]: unknown;
110062
- };
110063
- content: {
110064
- "application/json": {
110065
- code: string;
110066
- message: string;
110067
- links?: {
110068
- docs: string;
110069
- schema: string;
110070
- };
110071
- issues?: {
110072
- message: string;
110073
- path?: (string | number)[];
110074
- schema?: string;
110075
- }[];
110076
- retryable?: boolean;
110077
- context?: unknown;
110078
- };
110079
- };
110080
- };
110081
- /** @description Not found */
110082
- 404: {
110083
- headers: {
110084
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110085
- "Retry-After"?: number;
110086
- [name: string]: unknown;
110087
- };
110088
- content: {
110089
- "application/json": {
110090
- code: string;
110091
- message: string;
110092
- links?: {
110093
- docs: string;
110094
- schema: string;
110095
- };
110096
- issues?: {
110097
- message: string;
110098
- path?: (string | number)[];
110099
- schema?: string;
110100
- }[];
110101
- retryable?: boolean;
110102
- context?: unknown;
110103
- };
110104
- };
110105
- };
110106
- /** @description Conflict */
110107
- 409: {
110108
- headers: {
110109
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110110
- "Retry-After"?: number;
110111
- [name: string]: unknown;
110112
- };
110113
- content: {
110114
- "application/json": {
110115
- code: string;
110116
- message: string;
110117
- links?: {
110118
- docs: string;
110119
- schema: string;
110120
- };
110121
- issues?: {
110122
- message: string;
110123
- path?: (string | number)[];
110124
- schema?: string;
110125
- }[];
110126
- retryable?: boolean;
110127
- context?: unknown;
110128
- };
110129
- };
110130
- };
110131
- /** @description Gone */
110132
- 410: {
110133
- headers: {
110134
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110135
- "Retry-After"?: number;
110136
- [name: string]: unknown;
110137
- };
110138
- content: {
110139
- "application/json": {
110140
- code: string;
110141
- message: string;
110142
- links?: {
110143
- docs: string;
110144
- schema: string;
110145
- };
110146
- issues?: {
110147
- message: string;
110148
- path?: (string | number)[];
110149
- schema?: string;
110150
- }[];
110151
- retryable?: boolean;
110152
- context?: unknown;
110153
- };
110154
- };
110155
- };
110156
- /** @description Unprocessable content */
110157
- 422: {
110158
- headers: {
110159
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110160
- "Retry-After"?: number;
110161
- [name: string]: unknown;
110162
- };
110163
- content: {
110164
- "application/json": {
110165
- code: string;
110166
- message: string;
110167
- links?: {
110168
- docs: string;
110169
- schema: string;
110170
- };
110171
- issues?: {
110172
- message: string;
110173
- path?: (string | number)[];
110174
- schema?: string;
110175
- }[];
110176
- retryable?: boolean;
110177
- context?: unknown;
110178
- };
110179
- };
110180
- };
110181
- /** @description Internal server error */
110182
- 500: {
110183
- headers: {
110184
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110185
- "Retry-After"?: number;
110186
- [name: string]: unknown;
110187
- };
110188
- content: {
110189
- "application/json": {
110190
- code: string;
110191
- message: string;
110192
- links?: {
110193
- docs: string;
110194
- schema: string;
110195
- };
110196
- issues?: {
110197
- message: string;
110198
- path?: (string | number)[];
110199
- schema?: string;
110200
- }[];
110201
- retryable?: boolean;
110202
- context?: unknown;
110203
- };
110204
- };
110205
- };
110206
- /** @description Service unavailable */
110207
- 503: {
110208
- headers: {
110209
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110210
- "Retry-After"?: number;
110211
- [name: string]: unknown;
110212
- };
110213
- content: {
110214
- "application/json": {
110215
- code: string;
110216
- message: string;
110217
- links?: {
110218
- docs: string;
110219
- schema: string;
110220
- };
110221
- issues?: {
110222
- message: string;
110223
- path?: (string | number)[];
110224
- schema?: string;
110225
- }[];
110226
- retryable?: boolean;
110227
- context?: unknown;
110228
- };
110229
- };
110230
- };
110231
- };
110232
- };
110233
- queueManagerStatementsReportPdf: {
110234
- parameters: {
110235
- query?: never;
110236
- header?: never;
110237
- path?: never;
110238
- cookie?: never;
110239
- };
110240
- requestBody?: {
110241
- content: {
110242
- "application/json": {
110243
- startAts: string[];
110244
- };
110245
- };
110246
- };
110247
- responses: {
110248
- /** @description Successful response */
110249
- 200: {
110250
- headers: {
110251
- [name: string]: unknown;
110252
- };
110253
- content: {
110254
- "application/json": {
110255
- /** Format: uuid */
110256
- operationId: string;
110257
- /** @enum {string} */
110258
- type: "ach-verification" | "bank-rule-run" | "calendar-block" | "calendar-unblock" | "connection-archive" | "connection-connect" | "connection-extract" | "connection-sync" | "csv-import" | "csv-import-preview" | "export" | "flow-run" | "historical-gl-import" | "historical-statement-import" | "listing-journal-refresh" | "plaid-initial-sync" | "pms-cutover" | "pms-cutover-preview" | "provider-payment" | "provider-payment-recovery" | "recurring-transaction-run" | "reservation-journal-refresh" | "team-delete" | "team-demo-data" | "team-duplicate" | "team-initialize" | "transaction-journal-refresh" | "vri-statement-import" | "vri-team-migration" | "webhook-test";
110259
- /** @constant */
110260
- status: "queued";
110261
- resource: {
110262
- /** @enum {string} */
110263
- type: "bank-rule" | "connection" | "contact" | "file" | "flow" | "listing" | "recurring-transaction-template" | "statement" | "team" | "transaction" | "webhook";
110264
- /** Format: uuid */
110265
- id: string;
110266
- /** @enum {string} */
110267
- role: "source" | "target" | "result";
110268
- } | null;
110269
- };
110270
- };
110271
- };
110272
- /** @description Bad request */
110273
- 400: {
110274
- headers: {
110275
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110276
- "Retry-After"?: number;
110277
- [name: string]: unknown;
110278
- };
110279
- content: {
110280
- "application/json": {
110281
- code: string;
110282
- message: string;
110283
- links?: {
110284
- docs: string;
110285
- schema: string;
110286
- };
110287
- issues?: {
110288
- message: string;
110289
- path?: (string | number)[];
110290
- schema?: string;
110291
- }[];
110292
- retryable?: boolean;
110293
- context?: unknown;
110294
- };
110295
- };
110296
- };
110297
- /** @description Unauthorized */
110298
- 401: {
110299
- headers: {
110300
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110301
- "Retry-After"?: number;
110302
- [name: string]: unknown;
110303
- };
110304
- content: {
110305
- "application/json": {
110306
- code: string;
110307
- message: string;
110308
- links?: {
110309
- docs: string;
110310
- schema: string;
110311
- };
110312
- issues?: {
110313
- message: string;
110314
- path?: (string | number)[];
110315
- schema?: string;
110316
- }[];
110317
- retryable?: boolean;
110318
- context?: unknown;
110319
- };
110320
- };
110321
- };
110322
- /** @description Forbidden */
110323
- 403: {
110324
- headers: {
110325
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110326
- "Retry-After"?: number;
110327
- [name: string]: unknown;
110328
- };
110329
- content: {
110330
- "application/json": {
110331
- code: string;
110332
- message: string;
110333
- links?: {
110334
- docs: string;
110335
- schema: string;
110336
- };
110337
- issues?: {
110338
- message: string;
110339
- path?: (string | number)[];
110340
- schema?: string;
110341
- }[];
110342
- retryable?: boolean;
110343
- context?: unknown;
110344
- };
110345
- };
110346
- };
110347
- /** @description Not found */
110348
- 404: {
110349
- headers: {
110350
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110351
- "Retry-After"?: number;
110352
- [name: string]: unknown;
110353
- };
110354
- content: {
110355
- "application/json": {
110356
- code: string;
110357
- message: string;
110358
- links?: {
110359
- docs: string;
110360
- schema: string;
110361
- };
110362
- issues?: {
110363
- message: string;
110364
- path?: (string | number)[];
110365
- schema?: string;
110366
- }[];
110367
- retryable?: boolean;
110368
- context?: unknown;
110369
- };
110370
- };
110371
- };
110372
- /** @description Conflict */
110373
- 409: {
110374
- headers: {
110375
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110376
- "Retry-After"?: number;
110377
- [name: string]: unknown;
110378
- };
110379
- content: {
110380
- "application/json": {
110381
- code: string;
110382
- message: string;
110383
- links?: {
110384
- docs: string;
110385
- schema: string;
110386
- };
110387
- issues?: {
110388
- message: string;
110389
- path?: (string | number)[];
110390
- schema?: string;
110391
- }[];
110392
- retryable?: boolean;
110393
- context?: unknown;
110394
- };
110395
- };
110396
- };
110397
- /** @description Gone */
110398
- 410: {
110399
- headers: {
110400
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110401
- "Retry-After"?: number;
110402
- [name: string]: unknown;
110403
- };
110404
- content: {
110405
- "application/json": {
110406
- code: string;
110407
- message: string;
110408
- links?: {
110409
- docs: string;
110410
- schema: string;
110411
- };
110412
- issues?: {
110413
- message: string;
110414
- path?: (string | number)[];
110415
- schema?: string;
110416
- }[];
110417
- retryable?: boolean;
110418
- context?: unknown;
110419
- };
110420
- };
110421
- };
110422
- /** @description Unprocessable content */
110423
- 422: {
110424
- headers: {
110425
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110426
- "Retry-After"?: number;
110427
- [name: string]: unknown;
110428
- };
110429
- content: {
110430
- "application/json": {
110431
- code: string;
110432
- message: string;
110433
- links?: {
110434
- docs: string;
110435
- schema: string;
110436
- };
110437
- issues?: {
110438
- message: string;
110439
- path?: (string | number)[];
110440
- schema?: string;
110441
- }[];
110442
- retryable?: boolean;
110443
- context?: unknown;
110444
- };
110445
- };
110446
- };
110447
- /** @description Internal server error */
110448
- 500: {
110449
- headers: {
110450
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110451
- "Retry-After"?: number;
110452
- [name: string]: unknown;
110453
- };
110454
- content: {
110455
- "application/json": {
110456
- code: string;
110457
- message: string;
110458
- links?: {
110459
- docs: string;
110460
- schema: string;
110461
- };
110462
- issues?: {
110463
- message: string;
110464
- path?: (string | number)[];
110465
- schema?: string;
110466
- }[];
110467
- retryable?: boolean;
110468
- context?: unknown;
110469
- };
110470
- };
110471
- };
110472
- /** @description Service unavailable */
110473
- 503: {
110474
- headers: {
110475
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
110476
- "Retry-After"?: number;
110477
- [name: string]: unknown;
110478
- };
110479
- content: {
110480
- "application/json": {
110481
- code: string;
110482
- message: string;
110483
- links?: {
110484
- docs: string;
110485
- schema: string;
110486
- };
110487
- issues?: {
110488
- message: string;
110489
- path?: (string | number)[];
110490
- schema?: string;
110491
- }[];
110492
- retryable?: boolean;
110493
- context?: unknown;
110494
- };
110495
- };
110496
- };
110497
- };
110498
- };
110499
- getOwnerStatementSummariesPerLayoutReport: {
110500
- parameters: {
110501
- query?: {
110502
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
110503
- startAt?: string;
110504
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
110505
- endAt?: string;
110506
- /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
110507
- dateRange?: string;
110508
- /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
110509
- isDateRangeEndInclusive?: boolean;
110510
- /** @description comma separated listings */
110511
- listingIds?: string;
110512
- currency?: string;
110513
- viewAs?: "owner" | "manager";
110514
- search?: string;
110515
- };
110516
- header?: never;
110517
- path?: never;
110518
- cookie?: never;
110519
- };
110520
- requestBody?: never;
110521
- responses: {
110522
- /** @description Successful response */
110523
- 200: {
110524
- headers: {
110525
- [name: string]: unknown;
110526
- };
110527
- content: {
110528
- "application/json": {
110529
- data: {
110530
- contact: {
110531
- contactId: string;
110532
- name?: string;
110533
- firstName?: string;
110534
- /** Format: email */
110535
- email?: string;
110536
- phone?: string;
110537
- };
110538
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
110539
- currency: string;
110540
- financials: {
110541
- /** @description Value in cents (100 = 1€) */
110542
- balanceStart: number;
110543
- /** @description Value in cents (100 = 1€) */
110544
- netRevenue: number;
110545
- /** @description Value in cents (100 = 1€) */
110546
- expenses: number;
110547
- /** @description Value in cents (100 = 1€) */
110548
- reserve: number;
110549
- /** @description Value in cents (100 = 1€) */
110550
- payouts: number;
110551
- /** @description Value in cents (100 = 1€) */
110552
- netIncome: number;
110553
- /** @description Value in cents (100 = 1€) */
110554
- currentBalance: number;
110555
- /** @description Value in cents (100 = 1€) */
110556
- balanceEnd: number;
110557
- };
110558
- drilldown?: {
110559
- /** @constant */
110560
- type: "journalEntryReport";
110561
- filter: {
110562
- /** @description comma separated journal entry ids */
110563
- ids?: string;
110564
- txnCode?: string;
110565
- published?: boolean;
110566
- /** @enum {string} */
110567
- status?: "active" | "inactive";
110568
- /** @enum {string} */
110569
- ledger?: "historical" | "trust" | "operating";
110570
- startAt?: string;
110571
- endAt?: string;
110572
- search?: string;
110573
- date?: string;
110574
- /** @description Amount in cents, also accepts ranges like 100...200 */
110575
- amount?: string;
110576
- /**
110577
- * @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`).
110578
- * @default true
110579
- */
110580
- isDateRangeEndInclusive: boolean;
110581
- /** @description comma separated reservation ids or "unmapped" */
110582
- reservationIds?: string;
110583
- /** @description comma separated transaction ids or "unmapped" */
110584
- transactionIds?: string;
110585
- /** @description comma separated owner statement ids or "unmapped" */
110586
- ownerStatementIds?: string;
110587
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
110588
- currency?: string;
110589
- excludeApAppendix?: boolean;
110590
- /** @description listing ids comma separated or "unmapped" */
110591
- listingIds?: string;
110592
- /**
110593
- * @description Controls listingIds filter expansion. withChildren includes direct child listings when a parent listing is selected; exact only matches the selected listing ids.
110594
- * @enum {string}
110595
- */
110596
- listingScope?: "exact" | "withChildren";
110597
- /** @description listing ownership period ids comma separated or "unmapped" */
110598
- listingOwnershipPeriodIds?: string;
110599
- /** @description account ids comma separated accounts or "unmapped" */
110600
- accountIds?: string;
110601
- /** @description comma separated account reservation line type ids */
110602
- accountReservationLineTypeIds?: string;
110603
- /** @description comma separated categories */
110604
- categoryIds?: string;
110605
- /** @description comma separated categories to exclude */
110606
- excludeCategoryIds?: string;
110607
- /** @description comma separated contacts */
110608
- contactIds?: string;
110609
- classifications?: string;
110610
- /** @enum {string} */
110611
- accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
110612
- /** @description comma separated journal entry types */
110613
- types?: string;
110614
- /** @description comma separated journal entry types to exclude */
110615
- excludeTypes?: string;
110616
- /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" | "payout" */
110617
- entityTypes?: string;
110618
- /** @description comma separated booking channel refs */
110619
- bookingChannels?: string;
110620
- /** @description comma separated trigger types "deferredRevenue" | "intercompany" | "rebalance" | "recurringFee" | "revenueRecognition" */
110621
- triggerTypes?: string;
110622
- /** @description comma separated journal entry trigger types to exclude */
110623
- excludeTriggerTypes?: string;
110624
- /** @description comma separated parties */
110625
- parties?: string;
110626
- /**
110627
- * @description Accounting attribution: owners affects owner-side balances and statements; manager affects manager-side accounting
110628
- * @enum {string}
110629
- */
110630
- party?: "owners" | "manager";
110631
- /** @description comma separated account assignment types "accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution" */
110632
- accountAssignmentTypes?: string;
110633
- /** @description comma separated manager statement section ids */
110634
- managerStatementSectionIds?: string;
110635
- recurringFee?: boolean;
110636
- /** @enum {string} */
110637
- openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance" | "openingTrialBalance";
110638
- };
110639
- /** @enum {string} */
110640
- measure?: "periodActivity" | "balance";
110641
- label?: string;
110642
- } | null;
110643
- }[];
110095
+ data: {
110096
+ contact: {
110097
+ contactId: string;
110098
+ name?: string;
110099
+ firstName?: string;
110100
+ /** Format: email */
110101
+ email?: string;
110102
+ phone?: string;
110103
+ };
110104
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
110105
+ currency: string;
110106
+ financials: {
110107
+ /** @description Value in cents (100 = 1€) */
110108
+ balanceStart: number;
110109
+ /** @description Value in cents (100 = 1€) */
110110
+ netRevenue: number;
110111
+ /** @description Value in cents (100 = 1€) */
110112
+ expenses: number;
110113
+ /** @description Value in cents (100 = 1€) */
110114
+ reserve: number;
110115
+ /** @description Value in cents (100 = 1€) */
110116
+ payouts: number;
110117
+ /** @description Value in cents (100 = 1€) */
110118
+ netIncome: number;
110119
+ /** @description Value in cents (100 = 1€) */
110120
+ currentBalance: number;
110121
+ /** @description Value in cents (100 = 1€) */
110122
+ balanceEnd: number;
110123
+ };
110124
+ drilldown?: {
110125
+ /** @constant */
110126
+ type: "journalEntryReport";
110127
+ filter: {
110128
+ /** @description comma separated journal entry ids */
110129
+ ids?: string;
110130
+ txnCode?: string;
110131
+ published?: boolean;
110132
+ /** @enum {string} */
110133
+ status?: "active" | "inactive";
110134
+ /** @enum {string} */
110135
+ ledger?: "historical" | "trust" | "operating";
110136
+ startAt?: string;
110137
+ endAt?: string;
110138
+ search?: string;
110139
+ date?: string;
110140
+ /** @description Amount in cents, also accepts ranges like 100...200 */
110141
+ amount?: string;
110142
+ /**
110143
+ * @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`).
110144
+ * @default true
110145
+ */
110146
+ isDateRangeEndInclusive: boolean;
110147
+ /** @description comma separated reservation ids or "unmapped" */
110148
+ reservationIds?: string;
110149
+ /** @description comma separated transaction ids or "unmapped" */
110150
+ transactionIds?: string;
110151
+ /** @description comma separated owner statement ids or "unmapped" */
110152
+ ownerStatementIds?: string;
110153
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
110154
+ currency?: string;
110155
+ excludeApAppendix?: boolean;
110156
+ /** @description listing ids comma separated or "unmapped" */
110157
+ listingIds?: string;
110158
+ /**
110159
+ * @description Controls listingIds filter expansion. withChildren includes direct child listings when a parent listing is selected; exact only matches the selected listing ids.
110160
+ * @enum {string}
110161
+ */
110162
+ listingScope?: "exact" | "withChildren";
110163
+ /** @description listing ownership period ids comma separated or "unmapped" */
110164
+ listingOwnershipPeriodIds?: string;
110165
+ /** @description account ids comma separated accounts or "unmapped" */
110166
+ accountIds?: string;
110167
+ /** @description comma separated account reservation line type ids */
110168
+ accountReservationLineTypeIds?: string;
110169
+ /** @description comma separated categories */
110170
+ categoryIds?: string;
110171
+ /** @description comma separated categories to exclude */
110172
+ excludeCategoryIds?: string;
110173
+ /** @description comma separated contacts */
110174
+ contactIds?: string;
110175
+ classifications?: string;
110176
+ /** @enum {string} */
110177
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
110178
+ /** @description comma separated journal entry types */
110179
+ types?: string;
110180
+ /** @description comma separated journal entry types to exclude */
110181
+ excludeTypes?: string;
110182
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" | "payout" */
110183
+ entityTypes?: string;
110184
+ /** @description comma separated booking channel refs */
110185
+ bookingChannels?: string;
110186
+ /** @description comma separated trigger types "deferredRevenue" | "intercompany" | "rebalance" | "recurringFee" | "revenueRecognition" */
110187
+ triggerTypes?: string;
110188
+ /** @description comma separated journal entry trigger types to exclude */
110189
+ excludeTriggerTypes?: string;
110190
+ /** @description comma separated parties */
110191
+ parties?: string;
110192
+ /**
110193
+ * @description Accounting attribution: owners affects owner-side balances and statements; manager affects manager-side accounting
110194
+ * @enum {string}
110195
+ */
110196
+ party?: "owners" | "manager";
110197
+ /** @description comma separated account assignment types "accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "openingBalance" | "payout_bankAccount" | "payout_distribution" */
110198
+ accountAssignmentTypes?: string;
110199
+ /** @description comma separated manager statement section ids */
110200
+ managerStatementSectionIds?: string;
110201
+ recurringFee?: boolean;
110202
+ /** @enum {string} */
110203
+ openingBalanceType?: "taxPayable" | "advancedDeposit" | "listingOpeningBalance" | "openingTrialBalance";
110204
+ };
110205
+ /** @enum {string} */
110206
+ measure?: "periodActivity" | "balance";
110207
+ label?: string;
110208
+ } | null;
110209
+ }[];
110644
110210
  };
110645
110211
  };
110646
110212
  };
@@ -114434,272 +114000,6 @@ export interface operations {
114434
114000
  };
114435
114001
  };
114436
114002
  };
114437
- getOwnerStatementSummaryPerLayoutDetailsReportPdf: {
114438
- parameters: {
114439
- query: {
114440
- view: "listing" | "month" | "reservation" | "bookingChannel";
114441
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
114442
- startAt?: string;
114443
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
114444
- endAt?: string;
114445
- /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
114446
- dateRange?: string;
114447
- /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
114448
- isDateRangeEndInclusive?: boolean;
114449
- /** @description comma separated listings */
114450
- listingIds?: string;
114451
- currency?: string;
114452
- viewAs?: "owner" | "manager";
114453
- layoutId?: string;
114454
- };
114455
- header?: never;
114456
- path: {
114457
- contactId: string;
114458
- };
114459
- cookie?: never;
114460
- };
114461
- requestBody?: never;
114462
- responses: {
114463
- /** @description Successful response */
114464
- 200: {
114465
- headers: {
114466
- [name: string]: unknown;
114467
- };
114468
- content: {
114469
- "application/json": {
114470
- contactId?: string;
114471
- url: string;
114472
- expIn: number;
114473
- };
114474
- };
114475
- };
114476
- /** @description Bad request */
114477
- 400: {
114478
- headers: {
114479
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114480
- "Retry-After"?: number;
114481
- [name: string]: unknown;
114482
- };
114483
- content: {
114484
- "application/json": {
114485
- code: string;
114486
- message: string;
114487
- links?: {
114488
- docs: string;
114489
- schema: string;
114490
- };
114491
- issues?: {
114492
- message: string;
114493
- path?: (string | number)[];
114494
- schema?: string;
114495
- }[];
114496
- retryable?: boolean;
114497
- context?: unknown;
114498
- };
114499
- };
114500
- };
114501
- /** @description Unauthorized */
114502
- 401: {
114503
- headers: {
114504
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114505
- "Retry-After"?: number;
114506
- [name: string]: unknown;
114507
- };
114508
- content: {
114509
- "application/json": {
114510
- code: string;
114511
- message: string;
114512
- links?: {
114513
- docs: string;
114514
- schema: string;
114515
- };
114516
- issues?: {
114517
- message: string;
114518
- path?: (string | number)[];
114519
- schema?: string;
114520
- }[];
114521
- retryable?: boolean;
114522
- context?: unknown;
114523
- };
114524
- };
114525
- };
114526
- /** @description Forbidden */
114527
- 403: {
114528
- headers: {
114529
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114530
- "Retry-After"?: number;
114531
- [name: string]: unknown;
114532
- };
114533
- content: {
114534
- "application/json": {
114535
- code: string;
114536
- message: string;
114537
- links?: {
114538
- docs: string;
114539
- schema: string;
114540
- };
114541
- issues?: {
114542
- message: string;
114543
- path?: (string | number)[];
114544
- schema?: string;
114545
- }[];
114546
- retryable?: boolean;
114547
- context?: unknown;
114548
- };
114549
- };
114550
- };
114551
- /** @description Not found */
114552
- 404: {
114553
- headers: {
114554
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114555
- "Retry-After"?: number;
114556
- [name: string]: unknown;
114557
- };
114558
- content: {
114559
- "application/json": {
114560
- code: string;
114561
- message: string;
114562
- links?: {
114563
- docs: string;
114564
- schema: string;
114565
- };
114566
- issues?: {
114567
- message: string;
114568
- path?: (string | number)[];
114569
- schema?: string;
114570
- }[];
114571
- retryable?: boolean;
114572
- context?: unknown;
114573
- };
114574
- };
114575
- };
114576
- /** @description Conflict */
114577
- 409: {
114578
- headers: {
114579
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114580
- "Retry-After"?: number;
114581
- [name: string]: unknown;
114582
- };
114583
- content: {
114584
- "application/json": {
114585
- code: string;
114586
- message: string;
114587
- links?: {
114588
- docs: string;
114589
- schema: string;
114590
- };
114591
- issues?: {
114592
- message: string;
114593
- path?: (string | number)[];
114594
- schema?: string;
114595
- }[];
114596
- retryable?: boolean;
114597
- context?: unknown;
114598
- };
114599
- };
114600
- };
114601
- /** @description Gone */
114602
- 410: {
114603
- headers: {
114604
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114605
- "Retry-After"?: number;
114606
- [name: string]: unknown;
114607
- };
114608
- content: {
114609
- "application/json": {
114610
- code: string;
114611
- message: string;
114612
- links?: {
114613
- docs: string;
114614
- schema: string;
114615
- };
114616
- issues?: {
114617
- message: string;
114618
- path?: (string | number)[];
114619
- schema?: string;
114620
- }[];
114621
- retryable?: boolean;
114622
- context?: unknown;
114623
- };
114624
- };
114625
- };
114626
- /** @description Unprocessable content */
114627
- 422: {
114628
- headers: {
114629
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114630
- "Retry-After"?: number;
114631
- [name: string]: unknown;
114632
- };
114633
- content: {
114634
- "application/json": {
114635
- code: string;
114636
- message: string;
114637
- links?: {
114638
- docs: string;
114639
- schema: string;
114640
- };
114641
- issues?: {
114642
- message: string;
114643
- path?: (string | number)[];
114644
- schema?: string;
114645
- }[];
114646
- retryable?: boolean;
114647
- context?: unknown;
114648
- };
114649
- };
114650
- };
114651
- /** @description Internal server error */
114652
- 500: {
114653
- headers: {
114654
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114655
- "Retry-After"?: number;
114656
- [name: string]: unknown;
114657
- };
114658
- content: {
114659
- "application/json": {
114660
- code: string;
114661
- message: string;
114662
- links?: {
114663
- docs: string;
114664
- schema: string;
114665
- };
114666
- issues?: {
114667
- message: string;
114668
- path?: (string | number)[];
114669
- schema?: string;
114670
- }[];
114671
- retryable?: boolean;
114672
- context?: unknown;
114673
- };
114674
- };
114675
- };
114676
- /** @description Service unavailable */
114677
- 503: {
114678
- headers: {
114679
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
114680
- "Retry-After"?: number;
114681
- [name: string]: unknown;
114682
- };
114683
- content: {
114684
- "application/json": {
114685
- code: string;
114686
- message: string;
114687
- links?: {
114688
- docs: string;
114689
- schema: string;
114690
- };
114691
- issues?: {
114692
- message: string;
114693
- path?: (string | number)[];
114694
- schema?: string;
114695
- }[];
114696
- retryable?: boolean;
114697
- context?: unknown;
114698
- };
114699
- };
114700
- };
114701
- };
114702
- };
114703
114003
  queueOwnerStatementSummaryPerLayoutDetailsReportPdf: {
114704
114004
  parameters: {
114705
114005
  query?: never;
@@ -115001,271 +114301,6 @@ export interface operations {
115001
114301
  };
115002
114302
  };
115003
114303
  };
115004
- getOwnerStatementSummariesPerLayoutReportPdfBatch: {
115005
- parameters: {
115006
- query: {
115007
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
115008
- startAt?: string;
115009
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
115010
- endAt?: string;
115011
- /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
115012
- dateRange?: string;
115013
- /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
115014
- isDateRangeEndInclusive?: boolean;
115015
- /** @description comma separated listings */
115016
- listingIds?: string;
115017
- currency?: string;
115018
- viewAs?: "owner" | "manager";
115019
- view: "listing" | "month" | "reservation" | "bookingChannel";
115020
- /** @description comma separated contacts */
115021
- contactIds?: string;
115022
- layoutId?: string;
115023
- };
115024
- header?: never;
115025
- path?: never;
115026
- cookie?: never;
115027
- };
115028
- requestBody?: never;
115029
- responses: {
115030
- /** @description Successful response */
115031
- 200: {
115032
- headers: {
115033
- [name: string]: unknown;
115034
- };
115035
- content: {
115036
- "application/json": {
115037
- url: string;
115038
- expIn: number;
115039
- };
115040
- };
115041
- };
115042
- /** @description Bad request */
115043
- 400: {
115044
- headers: {
115045
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115046
- "Retry-After"?: number;
115047
- [name: string]: unknown;
115048
- };
115049
- content: {
115050
- "application/json": {
115051
- code: string;
115052
- message: string;
115053
- links?: {
115054
- docs: string;
115055
- schema: string;
115056
- };
115057
- issues?: {
115058
- message: string;
115059
- path?: (string | number)[];
115060
- schema?: string;
115061
- }[];
115062
- retryable?: boolean;
115063
- context?: unknown;
115064
- };
115065
- };
115066
- };
115067
- /** @description Unauthorized */
115068
- 401: {
115069
- headers: {
115070
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115071
- "Retry-After"?: number;
115072
- [name: string]: unknown;
115073
- };
115074
- content: {
115075
- "application/json": {
115076
- code: string;
115077
- message: string;
115078
- links?: {
115079
- docs: string;
115080
- schema: string;
115081
- };
115082
- issues?: {
115083
- message: string;
115084
- path?: (string | number)[];
115085
- schema?: string;
115086
- }[];
115087
- retryable?: boolean;
115088
- context?: unknown;
115089
- };
115090
- };
115091
- };
115092
- /** @description Forbidden */
115093
- 403: {
115094
- headers: {
115095
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115096
- "Retry-After"?: number;
115097
- [name: string]: unknown;
115098
- };
115099
- content: {
115100
- "application/json": {
115101
- code: string;
115102
- message: string;
115103
- links?: {
115104
- docs: string;
115105
- schema: string;
115106
- };
115107
- issues?: {
115108
- message: string;
115109
- path?: (string | number)[];
115110
- schema?: string;
115111
- }[];
115112
- retryable?: boolean;
115113
- context?: unknown;
115114
- };
115115
- };
115116
- };
115117
- /** @description Not found */
115118
- 404: {
115119
- headers: {
115120
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115121
- "Retry-After"?: number;
115122
- [name: string]: unknown;
115123
- };
115124
- content: {
115125
- "application/json": {
115126
- code: string;
115127
- message: string;
115128
- links?: {
115129
- docs: string;
115130
- schema: string;
115131
- };
115132
- issues?: {
115133
- message: string;
115134
- path?: (string | number)[];
115135
- schema?: string;
115136
- }[];
115137
- retryable?: boolean;
115138
- context?: unknown;
115139
- };
115140
- };
115141
- };
115142
- /** @description Conflict */
115143
- 409: {
115144
- headers: {
115145
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115146
- "Retry-After"?: number;
115147
- [name: string]: unknown;
115148
- };
115149
- content: {
115150
- "application/json": {
115151
- code: string;
115152
- message: string;
115153
- links?: {
115154
- docs: string;
115155
- schema: string;
115156
- };
115157
- issues?: {
115158
- message: string;
115159
- path?: (string | number)[];
115160
- schema?: string;
115161
- }[];
115162
- retryable?: boolean;
115163
- context?: unknown;
115164
- };
115165
- };
115166
- };
115167
- /** @description Gone */
115168
- 410: {
115169
- headers: {
115170
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115171
- "Retry-After"?: number;
115172
- [name: string]: unknown;
115173
- };
115174
- content: {
115175
- "application/json": {
115176
- code: string;
115177
- message: string;
115178
- links?: {
115179
- docs: string;
115180
- schema: string;
115181
- };
115182
- issues?: {
115183
- message: string;
115184
- path?: (string | number)[];
115185
- schema?: string;
115186
- }[];
115187
- retryable?: boolean;
115188
- context?: unknown;
115189
- };
115190
- };
115191
- };
115192
- /** @description Unprocessable content */
115193
- 422: {
115194
- headers: {
115195
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115196
- "Retry-After"?: number;
115197
- [name: string]: unknown;
115198
- };
115199
- content: {
115200
- "application/json": {
115201
- code: string;
115202
- message: string;
115203
- links?: {
115204
- docs: string;
115205
- schema: string;
115206
- };
115207
- issues?: {
115208
- message: string;
115209
- path?: (string | number)[];
115210
- schema?: string;
115211
- }[];
115212
- retryable?: boolean;
115213
- context?: unknown;
115214
- };
115215
- };
115216
- };
115217
- /** @description Internal server error */
115218
- 500: {
115219
- headers: {
115220
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115221
- "Retry-After"?: number;
115222
- [name: string]: unknown;
115223
- };
115224
- content: {
115225
- "application/json": {
115226
- code: string;
115227
- message: string;
115228
- links?: {
115229
- docs: string;
115230
- schema: string;
115231
- };
115232
- issues?: {
115233
- message: string;
115234
- path?: (string | number)[];
115235
- schema?: string;
115236
- }[];
115237
- retryable?: boolean;
115238
- context?: unknown;
115239
- };
115240
- };
115241
- };
115242
- /** @description Service unavailable */
115243
- 503: {
115244
- headers: {
115245
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
115246
- "Retry-After"?: number;
115247
- [name: string]: unknown;
115248
- };
115249
- content: {
115250
- "application/json": {
115251
- code: string;
115252
- message: string;
115253
- links?: {
115254
- docs: string;
115255
- schema: string;
115256
- };
115257
- issues?: {
115258
- message: string;
115259
- path?: (string | number)[];
115260
- schema?: string;
115261
- }[];
115262
- retryable?: boolean;
115263
- context?: unknown;
115264
- };
115265
- };
115266
- };
115267
- };
115268
- };
115269
114304
  queueOwnerStatementSummariesPerLayoutReportPdfBatch: {
115270
114305
  parameters: {
115271
114306
  query?: never;
@@ -120452,6 +119487,7 @@ export interface operations {
120452
119487
  dateRange?: string;
120453
119488
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
120454
119489
  isDateRangeEndInclusive?: boolean;
119490
+ /** @description Comma-separated listing UUIDs. */
120455
119491
  listingId?: string;
120456
119492
  };
120457
119493
  header?: never;
@@ -122408,6 +121444,7 @@ export interface operations {
122408
121444
  dateRange?: string;
122409
121445
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
122410
121446
  isDateRangeEndInclusive?: boolean;
121447
+ /** @description Comma-separated listing UUIDs. */
122411
121448
  listingId?: string;
122412
121449
  };
122413
121450
  header?: never;
@@ -122681,6 +121718,7 @@ export interface operations {
122681
121718
  * @default true
122682
121719
  */
122683
121720
  isDateRangeEndInclusive?: boolean;
121721
+ /** @description Comma-separated listing UUIDs. */
122684
121722
  listingId?: string;
122685
121723
  };
122686
121724
  };
@@ -122946,6 +121984,7 @@ export interface operations {
122946
121984
  dateRange?: string;
122947
121985
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
122948
121986
  isDateRangeEndInclusive?: boolean;
121987
+ /** @description Comma-separated listing UUIDs. */
122949
121988
  listingId?: string;
122950
121989
  };
122951
121990
  header?: never;
@@ -123207,7 +122246,7 @@ export interface operations {
123207
122246
  listingScope?: "exact" | "withChildren";
123208
122247
  /** @description Date filter string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
123209
122248
  date?: string;
123210
- /** @description Choose which reservation date field the `date` filter applies to. */
122249
+ /** @description Choose which reservation date field the `date` filter applies to. Ignored when `date` is omitted. */
123211
122250
  dateField?: "bookedAt" | "cancelledAt" | "checkIn" | "checkOut" | "payment" | "intersection";
123212
122251
  search?: string;
123213
122252
  /** @description Filter by payment status. Prefix a status with ! to exclude it. */
@@ -124508,7 +123547,7 @@ export interface operations {
124508
123547
  sourceId?: string | null;
124509
123548
  message: string;
124510
123549
  /** @enum {string} */
124511
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
123550
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
124512
123551
  context?: unknown;
124513
123552
  }[];
124514
123553
  };
@@ -124755,7 +123794,7 @@ export interface operations {
124755
123794
  listingScope?: "exact" | "withChildren";
124756
123795
  /** @description Date filter string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD`. Single values expand to the full year, month, or day. */
124757
123796
  date?: string;
124758
- /** @description Choose which reservation date field the `date` filter applies to. */
123797
+ /** @description Choose which reservation date field the `date` filter applies to. Ignored when `date` is omitted. */
124759
123798
  dateField?: "bookedAt" | "cancelledAt" | "checkIn" | "checkOut" | "payment" | "intersection";
124760
123799
  search?: string;
124761
123800
  /** @description Filter by payment status. Prefix a status with ! to exclude it. */
@@ -125053,7 +124092,7 @@ export interface operations {
125053
124092
  */
125054
124093
  date?: string;
125055
124094
  /**
125056
- * @description Choose which reservation date field the `date` filter applies to.
124095
+ * @description Choose which reservation date field the `date` filter applies to. Ignored when `date` is omitted.
125057
124096
  * @enum {string}
125058
124097
  */
125059
124098
  dateField?: "bookedAt" | "cancelledAt" | "checkIn" | "checkOut" | "payment" | "intersection";
@@ -140648,319 +139687,12 @@ export interface operations {
140648
139687
  };
140649
139688
  };
140650
139689
  };
140651
- postStatementsPay: {
140652
- parameters: {
140653
- query?: {
140654
- /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
140655
- dryRun?: boolean;
140656
- };
140657
- header?: never;
140658
- path?: never;
140659
- cookie?: never;
140660
- };
140661
- requestBody?: {
140662
- content: {
140663
- "application/json": {
140664
- /** @description Payout date for every statement. */
140665
- date?: string | null;
140666
- statements: {
140667
- /** Format: uuid */
140668
- statementId: string;
140669
- /** @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. */
140670
- amount?: number | null;
140671
- idempotencyKey?: string;
140672
- /** @description Exactly one selection per ownership member. Missing or invalid selections fail; the API never substitutes a payment method. */
140673
- payouts: {
140674
- /** Format: uuid */
140675
- contactId: string;
140676
- /** @description The only ACH trigger. `null` records the payout without dispatching, even when the bank account is Ramp-backed. */
140677
- provider: "ramp" | null;
140678
- /**
140679
- * Format: uuid
140680
- * @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.
140681
- */
140682
- bankAccountId: string;
140683
- }[];
140684
- }[];
140685
- };
140686
- };
140687
- };
140688
- responses: {
140689
- /** @description Successful response */
140690
- 200: {
140691
- headers: {
140692
- [name: string]: unknown;
140693
- };
140694
- content: {
140695
- "application/json": {
140696
- operation: {
140697
- /** Format: uuid */
140698
- operationId: string;
140699
- /** @enum {string} */
140700
- type: "ach-verification" | "bank-rule-run" | "calendar-block" | "calendar-unblock" | "connection-archive" | "connection-connect" | "connection-extract" | "connection-sync" | "csv-import" | "csv-import-preview" | "export" | "flow-run" | "historical-gl-import" | "historical-statement-import" | "listing-journal-refresh" | "plaid-initial-sync" | "pms-cutover" | "pms-cutover-preview" | "provider-payment" | "provider-payment-recovery" | "recurring-transaction-run" | "reservation-journal-refresh" | "team-delete" | "team-demo-data" | "team-duplicate" | "team-initialize" | "transaction-journal-refresh" | "vri-statement-import" | "vri-team-migration" | "webhook-test";
140701
- /** @constant */
140702
- status: "queued";
140703
- resource: {
140704
- /** @enum {string} */
140705
- type: "bank-rule" | "connection" | "contact" | "file" | "flow" | "listing" | "recurring-transaction-template" | "statement" | "team" | "transaction" | "webhook";
140706
- /** Format: uuid */
140707
- id: string;
140708
- /** @enum {string} */
140709
- role: "source" | "target" | "result";
140710
- } | null;
140711
- } | null;
140712
- results: {
140713
- /** Format: uuid */
140714
- statementId: string;
140715
- /**
140716
- * @description `requested` dispatched at least one Ramp ACH payment, `recorded` booked payout transactions only, `skipped` rejected the complete statement.
140717
- * @enum {string}
140718
- */
140719
- status: "requested" | "recorded" | "skipped";
140720
- payouts: {
140721
- /** Format: uuid */
140722
- contactId: string;
140723
- provider: "ramp" | null;
140724
- /** @description Value in cents (100 = 1€) */
140725
- amount: number;
140726
- /** Format: uuid */
140727
- transactionId: string;
140728
- }[];
140729
- message: string | null;
140730
- }[];
140731
- };
140732
- };
140733
- };
140734
- /** @description Bad request */
140735
- 400: {
140736
- headers: {
140737
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140738
- "Retry-After"?: number;
140739
- [name: string]: unknown;
140740
- };
140741
- content: {
140742
- "application/json": {
140743
- code: string;
140744
- message: string;
140745
- links?: {
140746
- docs: string;
140747
- schema: string;
140748
- };
140749
- issues?: {
140750
- message: string;
140751
- path?: (string | number)[];
140752
- schema?: string;
140753
- }[];
140754
- retryable?: boolean;
140755
- context?: unknown;
140756
- };
140757
- };
140758
- };
140759
- /** @description Unauthorized */
140760
- 401: {
140761
- headers: {
140762
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140763
- "Retry-After"?: number;
140764
- [name: string]: unknown;
140765
- };
140766
- content: {
140767
- "application/json": {
140768
- code: string;
140769
- message: string;
140770
- links?: {
140771
- docs: string;
140772
- schema: string;
140773
- };
140774
- issues?: {
140775
- message: string;
140776
- path?: (string | number)[];
140777
- schema?: string;
140778
- }[];
140779
- retryable?: boolean;
140780
- context?: unknown;
140781
- };
140782
- };
140783
- };
140784
- /** @description Forbidden */
140785
- 403: {
140786
- headers: {
140787
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140788
- "Retry-After"?: number;
140789
- [name: string]: unknown;
140790
- };
140791
- content: {
140792
- "application/json": {
140793
- code: string;
140794
- message: string;
140795
- links?: {
140796
- docs: string;
140797
- schema: string;
140798
- };
140799
- issues?: {
140800
- message: string;
140801
- path?: (string | number)[];
140802
- schema?: string;
140803
- }[];
140804
- retryable?: boolean;
140805
- context?: unknown;
140806
- };
140807
- };
140808
- };
140809
- /** @description Not found */
140810
- 404: {
140811
- headers: {
140812
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140813
- "Retry-After"?: number;
140814
- [name: string]: unknown;
140815
- };
140816
- content: {
140817
- "application/json": {
140818
- code: string;
140819
- message: string;
140820
- links?: {
140821
- docs: string;
140822
- schema: string;
140823
- };
140824
- issues?: {
140825
- message: string;
140826
- path?: (string | number)[];
140827
- schema?: string;
140828
- }[];
140829
- retryable?: boolean;
140830
- context?: unknown;
140831
- };
140832
- };
140833
- };
140834
- /** @description Conflict */
140835
- 409: {
140836
- headers: {
140837
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140838
- "Retry-After"?: number;
140839
- [name: string]: unknown;
140840
- };
140841
- content: {
140842
- "application/json": {
140843
- code: string;
140844
- message: string;
140845
- links?: {
140846
- docs: string;
140847
- schema: string;
140848
- };
140849
- issues?: {
140850
- message: string;
140851
- path?: (string | number)[];
140852
- schema?: string;
140853
- }[];
140854
- retryable?: boolean;
140855
- context?: unknown;
140856
- };
140857
- };
140858
- };
140859
- /** @description Gone */
140860
- 410: {
140861
- headers: {
140862
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140863
- "Retry-After"?: number;
140864
- [name: string]: unknown;
140865
- };
140866
- content: {
140867
- "application/json": {
140868
- code: string;
140869
- message: string;
140870
- links?: {
140871
- docs: string;
140872
- schema: string;
140873
- };
140874
- issues?: {
140875
- message: string;
140876
- path?: (string | number)[];
140877
- schema?: string;
140878
- }[];
140879
- retryable?: boolean;
140880
- context?: unknown;
140881
- };
140882
- };
140883
- };
140884
- /** @description Unprocessable content */
140885
- 422: {
140886
- headers: {
140887
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140888
- "Retry-After"?: number;
140889
- [name: string]: unknown;
140890
- };
140891
- content: {
140892
- "application/json": {
140893
- code: string;
140894
- message: string;
140895
- links?: {
140896
- docs: string;
140897
- schema: string;
140898
- };
140899
- issues?: {
140900
- message: string;
140901
- path?: (string | number)[];
140902
- schema?: string;
140903
- }[];
140904
- retryable?: boolean;
140905
- context?: unknown;
140906
- };
140907
- };
140908
- };
140909
- /** @description Internal server error */
140910
- 500: {
140911
- headers: {
140912
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140913
- "Retry-After"?: number;
140914
- [name: string]: unknown;
140915
- };
140916
- content: {
140917
- "application/json": {
140918
- code: string;
140919
- message: string;
140920
- links?: {
140921
- docs: string;
140922
- schema: string;
140923
- };
140924
- issues?: {
140925
- message: string;
140926
- path?: (string | number)[];
140927
- schema?: string;
140928
- }[];
140929
- retryable?: boolean;
140930
- context?: unknown;
140931
- };
140932
- };
140933
- };
140934
- /** @description Service unavailable */
140935
- 503: {
140936
- headers: {
140937
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
140938
- "Retry-After"?: number;
140939
- [name: string]: unknown;
140940
- };
140941
- content: {
140942
- "application/json": {
140943
- code: string;
140944
- message: string;
140945
- links?: {
140946
- docs: string;
140947
- schema: string;
140948
- };
140949
- issues?: {
140950
- message: string;
140951
- path?: (string | number)[];
140952
- schema?: string;
140953
- }[];
140954
- retryable?: boolean;
140955
- context?: unknown;
140956
- };
140957
- };
140958
- };
140959
- };
140960
- };
140961
- postStatementsPayPreview: {
139690
+ postStatementsPay: {
140962
139691
  parameters: {
140963
- query?: never;
139692
+ query?: {
139693
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
139694
+ dryRun?: boolean;
139695
+ };
140964
139696
  header?: never;
140965
139697
  path?: never;
140966
139698
  cookie?: never;
@@ -140968,14 +139700,16 @@ export interface operations {
140968
139700
  requestBody?: {
140969
139701
  content: {
140970
139702
  "application/json": {
139703
+ /** @description Payout date for every statement. */
140971
139704
  date?: string | null;
140972
139705
  statements: {
140973
139706
  /** Format: uuid */
140974
139707
  statementId: string;
140975
- /** @description Signed override total. Omit to preview the full net income payout. */
139708
+ /** @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. */
140976
139709
  amount?: number | null;
140977
- /** @description Owner selections to validate. Omit to receive server-computed defaults per owner. */
140978
- payouts?: {
139710
+ idempotencyKey?: string;
139711
+ /** @description Exactly one selection per ownership member. Missing or invalid selections fail; the API never substitutes a payment method. */
139712
+ payouts: {
140979
139713
  /** Format: uuid */
140980
139714
  contactId: string;
140981
139715
  /** @description The only ACH trigger. `null` records the payout without dispatching, even when the bank account is Ramp-backed. */
@@ -140998,49 +139732,40 @@ export interface operations {
140998
139732
  };
140999
139733
  content: {
141000
139734
  "application/json": {
141001
- data: {
139735
+ operation: {
139736
+ /** Format: uuid */
139737
+ operationId: string;
139738
+ /** @enum {string} */
139739
+ type: "ach-verification" | "bank-rule-run" | "calendar-block" | "calendar-unblock" | "connection-archive" | "connection-connect" | "connection-extract" | "connection-sync" | "csv-import" | "csv-import-preview" | "export" | "flow-run" | "historical-gl-import" | "historical-statement-import" | "listing-journal-refresh" | "plaid-initial-sync" | "pms-cutover" | "pms-cutover-preview" | "provider-payment" | "provider-payment-recovery" | "recurring-transaction-run" | "reservation-journal-refresh" | "team-delete" | "team-demo-data" | "team-duplicate" | "team-initialize" | "transaction-journal-refresh" | "vri-statement-import" | "vri-team-migration" | "webhook-test";
139740
+ /** @constant */
139741
+ status: "queued";
139742
+ resource: {
139743
+ /** @enum {string} */
139744
+ type: "bank-rule" | "connection" | "contact" | "file" | "flow" | "listing" | "recurring-transaction-template" | "statement" | "team" | "transaction" | "webhook";
139745
+ /** Format: uuid */
139746
+ id: string;
139747
+ /** @enum {string} */
139748
+ role: "source" | "target" | "result";
139749
+ } | null;
139750
+ } | null;
139751
+ results: {
141002
139752
  /** Format: uuid */
141003
139753
  statementId: string;
141004
- ready: boolean;
141005
- connectionId: string | null;
141006
- /** @description Signed effective payout total: the explicit amount override, or the statement net income. */
141007
- amount: number;
141008
- owners: {
141009
- contactId: string | null;
141010
- /** @description Authoritative owner allocation after server rounding. */
139754
+ /**
139755
+ * @description `requested` dispatched at least one Ramp ACH payment, `recorded` booked payout transactions only, `skipped` rejected the complete statement.
139756
+ * @enum {string}
139757
+ */
139758
+ status: "requested" | "recorded" | "skipped";
139759
+ payouts: {
139760
+ /** Format: uuid */
139761
+ contactId: string;
139762
+ provider: "ramp" | null;
139763
+ /** @description Value in cents (100 = 1€) */
141011
139764
  amount: number;
141012
- defaultBankAccountId: string | null;
141013
- paymentMethod: {
141014
- /** @constant */
141015
- provider: "ramp";
141016
- connectionId: string | null;
141017
- last4: string | null;
141018
- /** @enum {string} */
141019
- status: "notConfigured" | "pending" | "ready" | "failed";
141020
- /** @description Safe failure detail from the latest Ramp ACH setup attempt. */
141021
- failureReason?: string | null;
141022
- } | null;
141023
- ready: boolean;
141024
- }[];
141025
- issues: {
141026
- /** @enum {string} */
141027
- code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "statementPeriodLocked" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable" | "rampCategoryAccountNotReady";
141028
- message: string;
141029
139765
  /** Format: uuid */
141030
- contactId?: string;
141031
- /** @description First date available for a statement-period-locked payout. */
141032
- openFrom?: string;
141033
- }[];
141034
- warnings: {
141035
- /** @constant */
141036
- code: "amountExceedsAvailableBalance";
141037
- /** @constant */
141038
- message: "Payout amount exceeds statement available balance";
141039
- /** @description Signed remaining statement balance before the requested payout: expected payment minus received payment. */
141040
- availableBalance: number;
141041
- /** @description Positive amount by which the requested payout exceeds the remaining statement balance. */
141042
- excessAmount: number;
139766
+ transactionId: string;
141043
139767
  }[];
139768
+ message: string | null;
141044
139769
  }[];
141045
139770
  };
141046
139771
  };
@@ -141272,22 +139997,38 @@ export interface operations {
141272
139997
  };
141273
139998
  };
141274
139999
  };
141275
- getStatementsPdf: {
140000
+ postStatementsPayPreview: {
141276
140001
  parameters: {
141277
- query: {
141278
- viewAs?: "owner" | "manager";
141279
- ownershipPeriodId: string;
141280
- /** @description Month string in format `YYYY-MM`. */
141281
- month: string;
141282
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
141283
- currency?: string;
141284
- contactId?: string;
141285
- };
140002
+ query?: never;
141286
140003
  header?: never;
141287
140004
  path?: never;
141288
140005
  cookie?: never;
141289
140006
  };
141290
- requestBody?: never;
140007
+ requestBody?: {
140008
+ content: {
140009
+ "application/json": {
140010
+ date?: string | null;
140011
+ statements: {
140012
+ /** Format: uuid */
140013
+ statementId: string;
140014
+ /** @description Signed override total. Omit to preview the full net income payout. */
140015
+ amount?: number | null;
140016
+ /** @description Owner selections to validate. Omit to receive server-computed defaults per owner. */
140017
+ payouts?: {
140018
+ /** Format: uuid */
140019
+ contactId: string;
140020
+ /** @description The only ACH trigger. `null` records the payout without dispatching, even when the bank account is Ramp-backed. */
140021
+ provider: "ramp" | null;
140022
+ /**
140023
+ * Format: uuid
140024
+ * @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.
140025
+ */
140026
+ bankAccountId: string;
140027
+ }[];
140028
+ }[];
140029
+ };
140030
+ };
140031
+ };
141291
140032
  responses: {
141292
140033
  /** @description Successful response */
141293
140034
  200: {
@@ -141297,9 +140038,48 @@ export interface operations {
141297
140038
  content: {
141298
140039
  "application/json": {
141299
140040
  data: {
141300
- url: string;
141301
- contactId: string;
141302
- expIn: number;
140041
+ /** Format: uuid */
140042
+ statementId: string;
140043
+ ready: boolean;
140044
+ connectionId: string | null;
140045
+ /** @description Signed effective payout total: the explicit amount override, or the statement net income. */
140046
+ amount: number;
140047
+ owners: {
140048
+ contactId: string | null;
140049
+ /** @description Authoritative owner allocation after server rounding. */
140050
+ amount: number;
140051
+ defaultBankAccountId: string | null;
140052
+ paymentMethod: {
140053
+ /** @constant */
140054
+ provider: "ramp";
140055
+ connectionId: string | null;
140056
+ last4: string | null;
140057
+ /** @enum {string} */
140058
+ status: "notConfigured" | "pending" | "ready" | "failed";
140059
+ /** @description Safe failure detail from the latest Ramp ACH setup attempt. */
140060
+ failureReason?: string | null;
140061
+ } | null;
140062
+ ready: boolean;
140063
+ }[];
140064
+ issues: {
140065
+ /** @enum {string} */
140066
+ code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "statementPeriodLocked" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable" | "rampCategoryAccountNotReady";
140067
+ message: string;
140068
+ /** Format: uuid */
140069
+ contactId?: string;
140070
+ /** @description First date available for a statement-period-locked payout. */
140071
+ openFrom?: string;
140072
+ }[];
140073
+ warnings: {
140074
+ /** @constant */
140075
+ code: "amountExceedsAvailableBalance";
140076
+ /** @constant */
140077
+ message: "Payout amount exceeds statement available balance";
140078
+ /** @description Signed remaining statement balance before the requested payout: expected payment minus received payment. */
140079
+ availableBalance: number;
140080
+ /** @description Positive amount by which the requested payout exceeds the remaining statement balance. */
140081
+ excessAmount: number;
140082
+ }[];
141303
140083
  }[];
141304
140084
  };
141305
140085
  };
@@ -141811,266 +140591,6 @@ export interface operations {
141811
140591
  };
141812
140592
  };
141813
140593
  };
141814
- getStatementsPdfBatch: {
141815
- parameters: {
141816
- query?: {
141817
- /** @description comma separated ownership periods */
141818
- ownershipPeriodIds?: string;
141819
- /** @description Month string in format `YYYY-MM`. */
141820
- month?: string;
141821
- listingId?: string;
141822
- /** @description Month string in format `YYYY-MM`. */
141823
- startMonth?: string;
141824
- /** @description Month string in format `YYYY-MM`. */
141825
- endMonth?: string;
141826
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
141827
- currency?: string;
141828
- };
141829
- header?: never;
141830
- path?: never;
141831
- cookie?: never;
141832
- };
141833
- requestBody?: never;
141834
- responses: {
141835
- /** @description Successful response */
141836
- 200: {
141837
- headers: {
141838
- [name: string]: unknown;
141839
- };
141840
- content: {
141841
- "application/json": {
141842
- url: string;
141843
- expIn: number;
141844
- };
141845
- };
141846
- };
141847
- /** @description Bad request */
141848
- 400: {
141849
- headers: {
141850
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
141851
- "Retry-After"?: number;
141852
- [name: string]: unknown;
141853
- };
141854
- content: {
141855
- "application/json": {
141856
- code: string;
141857
- message: string;
141858
- links?: {
141859
- docs: string;
141860
- schema: string;
141861
- };
141862
- issues?: {
141863
- message: string;
141864
- path?: (string | number)[];
141865
- schema?: string;
141866
- }[];
141867
- retryable?: boolean;
141868
- context?: unknown;
141869
- };
141870
- };
141871
- };
141872
- /** @description Unauthorized */
141873
- 401: {
141874
- headers: {
141875
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
141876
- "Retry-After"?: number;
141877
- [name: string]: unknown;
141878
- };
141879
- content: {
141880
- "application/json": {
141881
- code: string;
141882
- message: string;
141883
- links?: {
141884
- docs: string;
141885
- schema: string;
141886
- };
141887
- issues?: {
141888
- message: string;
141889
- path?: (string | number)[];
141890
- schema?: string;
141891
- }[];
141892
- retryable?: boolean;
141893
- context?: unknown;
141894
- };
141895
- };
141896
- };
141897
- /** @description Forbidden */
141898
- 403: {
141899
- headers: {
141900
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
141901
- "Retry-After"?: number;
141902
- [name: string]: unknown;
141903
- };
141904
- content: {
141905
- "application/json": {
141906
- code: string;
141907
- message: string;
141908
- links?: {
141909
- docs: string;
141910
- schema: string;
141911
- };
141912
- issues?: {
141913
- message: string;
141914
- path?: (string | number)[];
141915
- schema?: string;
141916
- }[];
141917
- retryable?: boolean;
141918
- context?: unknown;
141919
- };
141920
- };
141921
- };
141922
- /** @description Not found */
141923
- 404: {
141924
- headers: {
141925
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
141926
- "Retry-After"?: number;
141927
- [name: string]: unknown;
141928
- };
141929
- content: {
141930
- "application/json": {
141931
- code: string;
141932
- message: string;
141933
- links?: {
141934
- docs: string;
141935
- schema: string;
141936
- };
141937
- issues?: {
141938
- message: string;
141939
- path?: (string | number)[];
141940
- schema?: string;
141941
- }[];
141942
- retryable?: boolean;
141943
- context?: unknown;
141944
- };
141945
- };
141946
- };
141947
- /** @description Conflict */
141948
- 409: {
141949
- headers: {
141950
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
141951
- "Retry-After"?: number;
141952
- [name: string]: unknown;
141953
- };
141954
- content: {
141955
- "application/json": {
141956
- code: string;
141957
- message: string;
141958
- links?: {
141959
- docs: string;
141960
- schema: string;
141961
- };
141962
- issues?: {
141963
- message: string;
141964
- path?: (string | number)[];
141965
- schema?: string;
141966
- }[];
141967
- retryable?: boolean;
141968
- context?: unknown;
141969
- };
141970
- };
141971
- };
141972
- /** @description Gone */
141973
- 410: {
141974
- headers: {
141975
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
141976
- "Retry-After"?: number;
141977
- [name: string]: unknown;
141978
- };
141979
- content: {
141980
- "application/json": {
141981
- code: string;
141982
- message: string;
141983
- links?: {
141984
- docs: string;
141985
- schema: string;
141986
- };
141987
- issues?: {
141988
- message: string;
141989
- path?: (string | number)[];
141990
- schema?: string;
141991
- }[];
141992
- retryable?: boolean;
141993
- context?: unknown;
141994
- };
141995
- };
141996
- };
141997
- /** @description Unprocessable content */
141998
- 422: {
141999
- headers: {
142000
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142001
- "Retry-After"?: number;
142002
- [name: string]: unknown;
142003
- };
142004
- content: {
142005
- "application/json": {
142006
- code: string;
142007
- message: string;
142008
- links?: {
142009
- docs: string;
142010
- schema: string;
142011
- };
142012
- issues?: {
142013
- message: string;
142014
- path?: (string | number)[];
142015
- schema?: string;
142016
- }[];
142017
- retryable?: boolean;
142018
- context?: unknown;
142019
- };
142020
- };
142021
- };
142022
- /** @description Internal server error */
142023
- 500: {
142024
- headers: {
142025
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142026
- "Retry-After"?: number;
142027
- [name: string]: unknown;
142028
- };
142029
- content: {
142030
- "application/json": {
142031
- code: string;
142032
- message: string;
142033
- links?: {
142034
- docs: string;
142035
- schema: string;
142036
- };
142037
- issues?: {
142038
- message: string;
142039
- path?: (string | number)[];
142040
- schema?: string;
142041
- }[];
142042
- retryable?: boolean;
142043
- context?: unknown;
142044
- };
142045
- };
142046
- };
142047
- /** @description Service unavailable */
142048
- 503: {
142049
- headers: {
142050
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142051
- "Retry-After"?: number;
142052
- [name: string]: unknown;
142053
- };
142054
- content: {
142055
- "application/json": {
142056
- code: string;
142057
- message: string;
142058
- links?: {
142059
- docs: string;
142060
- schema: string;
142061
- };
142062
- issues?: {
142063
- message: string;
142064
- path?: (string | number)[];
142065
- schema?: string;
142066
- }[];
142067
- retryable?: boolean;
142068
- context?: unknown;
142069
- };
142070
- };
142071
- };
142072
- };
142073
- };
142074
140594
  postStatementsPdfBatch: {
142075
140595
  parameters: {
142076
140596
  query?: never;
@@ -153358,7 +151878,7 @@ export interface operations {
153358
151878
  /** Format: email */
153359
151879
  email: string;
153360
151880
  secondaryEmails: string[];
153361
- permissionBundles: string[];
151881
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
153362
151882
  /** @enum {string} */
153363
151883
  role: "admin" | "user";
153364
151884
  status: ("active" | "inactive" | "unconfirmed") | null;
@@ -153618,7 +152138,7 @@ export interface operations {
153618
152138
  content: {
153619
152139
  "application/json": {
153620
152140
  email: string;
153621
- permissionBundles?: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:accounting:v1" | "ui:owner-statements:v1" | "ui:reports-viewer:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
152141
+ permissionBundles?: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
153622
152142
  /** @enum {string} */
153623
152143
  role?: "admin" | "user";
153624
152144
  /** @default true */
@@ -153634,7 +152154,7 @@ export interface operations {
153634
152154
  };
153635
152155
  content: {
153636
152156
  "application/json": {
153637
- permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:accounting:v1" | "ui:owner-statements:v1" | "ui:reports-viewer:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
152157
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
153638
152158
  /** @enum {string} */
153639
152159
  role: "admin" | "user";
153640
152160
  /** Format: uuid */
@@ -153906,7 +152426,7 @@ export interface operations {
153906
152426
  /** Format: email */
153907
152427
  email: string;
153908
152428
  secondaryEmails: string[];
153909
- permissionBundles: string[];
152429
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
153910
152430
  /** @enum {string} */
153911
152431
  role: "admin" | "user";
153912
152432
  status: ("active" | "inactive" | "unconfirmed") | null;
@@ -154409,7 +152929,7 @@ export interface operations {
154409
152929
  requestBody?: {
154410
152930
  content: {
154411
152931
  "application/json": {
154412
- permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:accounting:v1" | "ui:owner-statements:v1" | "ui:reports-viewer:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
152932
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
154413
152933
  };
154414
152934
  };
154415
152935
  };
@@ -154423,7 +152943,7 @@ export interface operations {
154423
152943
  "application/json": {
154424
152944
  /** Format: uuid */
154425
152945
  userId: string;
154426
- permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:accounting:v1" | "ui:owner-statements:v1" | "ui:reports-viewer:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
152946
+ permissionBundles: ("ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1")[];
154427
152947
  };
154428
152948
  };
154429
152949
  };
@@ -154670,7 +153190,7 @@ export interface operations {
154670
153190
  };
154671
153191
  content: {
154672
153192
  "application/json": {
154673
- deniedPermissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
153193
+ deniedPermissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
154674
153194
  };
154675
153195
  };
154676
153196
  };
@@ -154911,7 +153431,7 @@ export interface operations {
154911
153431
  requestBody?: {
154912
153432
  content: {
154913
153433
  "application/json": {
154914
- deniedPermissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
153434
+ deniedPermissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
154915
153435
  };
154916
153436
  };
154917
153437
  };
@@ -154923,7 +153443,7 @@ export interface operations {
154923
153443
  };
154924
153444
  content: {
154925
153445
  "application/json": {
154926
- deniedPermissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
153446
+ deniedPermissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
154927
153447
  };
154928
153448
  };
154929
153449
  };
@@ -155172,10 +153692,10 @@ export interface operations {
155172
153692
  "application/json": {
155173
153693
  data: {
155174
153694
  /** @enum {string} */
155175
- name: "ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:accounting:v1" | "ui:owner-statements:v1" | "ui:reports-viewer:v1" | "ui:read-only:v1" | "ui:ach-payer:v1";
153695
+ name: "ui:team-admin:v1" | "ui:partner-admin:v1" | "ui:standard-member:v1" | "ui:operations:v1" | "ui:read-only:v1" | "ui:ach-payer:v1";
155176
153696
  title: string;
155177
153697
  description: string;
155178
- permissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
153698
+ permissions: ("self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
155179
153699
  }[];
155180
153700
  };
155181
153701
  };
@@ -155425,7 +153945,7 @@ export interface operations {
155425
153945
  "application/json": {
155426
153946
  data: {
155427
153947
  /** @enum {string} */
155428
- name: "self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay";
153948
+ name: "self:read" | "self:write" | "audit:read" | "operations:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "team-member-roles:manage" | "partner-access-policy:manage" | "api-tokens:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "integrations:read" | "integrations:write" | "integrations:execute" | "integrations:import" | "integrations:delete" | "sources:read" | "calendar:read" | "calendar:write" | "calendar:delete" | "files:read" | "files:write" | "files:delete" | "general-ledger:read" | "general-ledger:write" | "general-ledger:import" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:deposits:write" | "transactions:expenses:write" | "transactions:transfers:write" | "transactions:payouts:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:mark-paid" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:record-payout" | "statements:export" | "statement-layouts:read" | "statement-layouts:write" | "statement-layouts:delete" | "recurring-fees:read" | "recurring-fees:write" | "recurring-fees:delete" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "ach-payment-methods:write" | "ach-payments:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay";
155429
153949
  }[];
155430
153950
  };
155431
153951
  };
@@ -161933,7 +160453,7 @@ export interface operations {
161933
160453
  sourceId?: string | null;
161934
160454
  message: string;
161935
160455
  /** @enum {string} */
161936
- code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
160456
+ code?: "USER_ERROR" | "NOT_FOUND" | "FORBIDDEN" | "CONFLICT" | "AUDIT_CURSOR_EXPIRED" | "AUDIT_EVENT_REVISED" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_VALIDATION_ERROR" | "INTERNAL_ERROR" | "CONNECTION_RECONNECT_REQUIRED" | "INVALID_PLAID_CONNECT_MODE" | "PLAID_CONNECTION_NOT_FOUND" | "PLAID_CONNECT_IN_PROGRESS" | "PLAID_CONNECT_CONFIGURATION_CHANGED" | "PLAID_CONNECT_EXPIRED" | "PLAID_CONNECT_REQUIRES_NEW_LINK" | "PLAID_PROVIDER_UNAVAILABLE";
161937
160457
  context?: unknown;
161938
160458
  }[];
161939
160459
  };