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