@vrplatform/api 1.3.1-stage.6437 → 1.3.1-stage.6449
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 +604 -20
- package/build/main/generated/v1.js.map +1 -1
- package/build/module/generated/v1.d.ts +604 -20
- package/build/module/generated/v1.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/v1.ts +604 -20
package/src/generated/v1.ts
CHANGED
|
@@ -546,7 +546,7 @@ export interface paths {
|
|
|
546
546
|
cookie?: never;
|
|
547
547
|
};
|
|
548
548
|
/**
|
|
549
|
-
* @description
|
|
549
|
+
* @description List bank records with optional reconciliation suggestions and bank-rule previews.
|
|
550
550
|
*
|
|
551
551
|
* Required scope: bank-records:read
|
|
552
552
|
*/
|
|
@@ -609,7 +609,7 @@ export interface paths {
|
|
|
609
609
|
cookie?: never;
|
|
610
610
|
};
|
|
611
611
|
/**
|
|
612
|
-
* @description Get a bank record
|
|
612
|
+
* @description Get a bank record with optional reconciliation suggestions and bank-rule previews.
|
|
613
613
|
*
|
|
614
614
|
* Required scope: bank-records:read
|
|
615
615
|
*/
|
|
@@ -6379,7 +6379,7 @@ export interface paths {
|
|
|
6379
6379
|
cookie?: never;
|
|
6380
6380
|
};
|
|
6381
6381
|
/**
|
|
6382
|
-
* @description
|
|
6382
|
+
* @description List transactions. Each row includes the latest Ramp provider attempt and server-owned payment and recovery action capabilities with disabled reasons.
|
|
6383
6383
|
*
|
|
6384
6384
|
* Required scope: transactions:read
|
|
6385
6385
|
*/
|
|
@@ -6677,13 +6677,13 @@ export interface paths {
|
|
|
6677
6677
|
cookie?: never;
|
|
6678
6678
|
};
|
|
6679
6679
|
/**
|
|
6680
|
-
* @description
|
|
6680
|
+
* @description Get a transaction. Ramp payout reads include the latest immutable provider attempt and server-owned payment and recovery action capabilities with disabled reasons.
|
|
6681
6681
|
*
|
|
6682
6682
|
* Required scope: transactions:read
|
|
6683
6683
|
*/
|
|
6684
6684
|
get: operations["getTransactionsById"];
|
|
6685
6685
|
/**
|
|
6686
|
-
* @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.
|
|
6686
|
+
* @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 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.
|
|
6687
6687
|
*
|
|
6688
6688
|
* Required scope: transactions:write
|
|
6689
6689
|
*/
|
|
@@ -6710,7 +6710,7 @@ export interface paths {
|
|
|
6710
6710
|
get?: never;
|
|
6711
6711
|
put?: never;
|
|
6712
6712
|
/**
|
|
6713
|
-
* @description Record an expense as paid manually, or request a Ramp ACH payment for an expense or payout. Manual recording requires transactions:mark-paid. Ramp requests additionally require ach-payments:execute and a fundingAccountId whose imported source provides the exact Ramp entity and bank account. Every outbound bill Category account must also have a completed current Ramp chart-of-accounts push. A
|
|
6713
|
+
* @description Record an expense as paid manually, or request a Ramp ACH payment for an expense or payout. Manual recording requires transactions:mark-paid. Ramp requests additionally require ach-payments:execute and a fundingAccountId whose imported source provides the exact Ramp entity and bank account. Every outbound bill Category account must also have a completed current Ramp chart-of-accounts push. A payout can be submitted to Ramp only once; failed or returned payouts must be archived and recreated.
|
|
6714
6714
|
*
|
|
6715
6715
|
* Required scope: transactions:mark-paid
|
|
6716
6716
|
*/
|
|
@@ -6753,7 +6753,8 @@ export interface paths {
|
|
|
6753
6753
|
put?: never;
|
|
6754
6754
|
post?: never;
|
|
6755
6755
|
/**
|
|
6756
|
-
* @
|
|
6756
|
+
* @deprecated
|
|
6757
|
+
* @description Deprecated compatibility endpoint. Provider payment history is permanent and cannot be unlinked.
|
|
6757
6758
|
*
|
|
6758
6759
|
* Required scope: transactions:mark-paid, ach-payments:execute
|
|
6759
6760
|
*/
|
|
@@ -6763,6 +6764,27 @@ export interface paths {
|
|
|
6763
6764
|
patch?: never;
|
|
6764
6765
|
trace?: never;
|
|
6765
6766
|
};
|
|
6767
|
+
"/transactions/{id}/provider-payments/{providerPaymentId}/archive": {
|
|
6768
|
+
parameters: {
|
|
6769
|
+
query?: never;
|
|
6770
|
+
header?: never;
|
|
6771
|
+
path?: never;
|
|
6772
|
+
cookie?: never;
|
|
6773
|
+
};
|
|
6774
|
+
get?: never;
|
|
6775
|
+
put?: never;
|
|
6776
|
+
/**
|
|
6777
|
+
* @description Archive a failed, returned, or canceled Ramp bill and then archive the payout accounting. Paid payouts cannot be archived. The provider mutation completes before journal entries are made inactive.
|
|
6778
|
+
*
|
|
6779
|
+
* Required scope: transactions:write, ach-payments:execute
|
|
6780
|
+
*/
|
|
6781
|
+
post: operations["postTransactionsByIdProviderPaymentsByProviderPaymentIdArchive"];
|
|
6782
|
+
delete?: never;
|
|
6783
|
+
options?: never;
|
|
6784
|
+
head?: never;
|
|
6785
|
+
patch?: never;
|
|
6786
|
+
trace?: never;
|
|
6787
|
+
};
|
|
6766
6788
|
"/transactions/{id}/provider-payments/{providerPaymentId}/cancel": {
|
|
6767
6789
|
parameters: {
|
|
6768
6790
|
query?: never;
|
|
@@ -6773,7 +6795,7 @@ export interface paths {
|
|
|
6773
6795
|
get?: never;
|
|
6774
6796
|
put?: never;
|
|
6775
6797
|
/**
|
|
6776
|
-
* @description Request cancellation of a requested or processing Ramp payment. Ramp
|
|
6798
|
+
* @description Request cancellation of a requested or processing Ramp payment. Ramp is authoritative about cancellation eligibility. archivePayout=true first validates local accounting, then archives the payout only after the Ramp bill archive is durable. archivePayout=false stops money movement without changing payout accounting.
|
|
6777
6799
|
*
|
|
6778
6800
|
* Required scope: transactions:mark-paid, ach-payments:execute
|
|
6779
6801
|
*/
|
|
@@ -10616,6 +10638,8 @@ export interface operations {
|
|
|
10616
10638
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
10617
10639
|
attachmentIds?: string[] | null;
|
|
10618
10640
|
recurringTemplateId?: string | null;
|
|
10641
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
10642
|
+
recreatedFromTransactionId?: string | null;
|
|
10619
10643
|
matchBankAccountLast4?: string | null;
|
|
10620
10644
|
id: string;
|
|
10621
10645
|
shortRef?: string | null;
|
|
@@ -14924,7 +14948,7 @@ export interface operations {
|
|
|
14924
14948
|
updatedFrom?: string;
|
|
14925
14949
|
/** @description Timestamp string with date, time, milliseconds, and timezone. */
|
|
14926
14950
|
updatedTo?: string;
|
|
14927
|
-
entityType?: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction";
|
|
14951
|
+
entityType?: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription";
|
|
14928
14952
|
entityId?: string;
|
|
14929
14953
|
actionId?: string;
|
|
14930
14954
|
actionCode?: string;
|
|
@@ -14936,7 +14960,7 @@ export interface operations {
|
|
|
14936
14960
|
/** @description Whether any public entity or journal-entry change exists */
|
|
14937
14961
|
hasChanges?: boolean;
|
|
14938
14962
|
/** @description Public subject participating in entityChanges */
|
|
14939
|
-
changedEntityType?: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction" | "paymentLine";
|
|
14963
|
+
changedEntityType?: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription" | "paymentLine";
|
|
14940
14964
|
/** @description Exact public registry path for changedEntityType */
|
|
14941
14965
|
changedPath?: string;
|
|
14942
14966
|
};
|
|
@@ -14998,7 +15022,7 @@ export interface operations {
|
|
|
14998
15022
|
};
|
|
14999
15023
|
rootEntity: {
|
|
15000
15024
|
/** @enum {string} */
|
|
15001
|
-
type: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction";
|
|
15025
|
+
type: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription";
|
|
15002
15026
|
/** Format: uuid */
|
|
15003
15027
|
id: string;
|
|
15004
15028
|
uniqueRef: string | null;
|
|
@@ -15007,7 +15031,7 @@ export interface operations {
|
|
|
15007
15031
|
entityChanges: {
|
|
15008
15032
|
entity: {
|
|
15009
15033
|
/** @enum {string} */
|
|
15010
|
-
type: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction" | "paymentLine";
|
|
15034
|
+
type: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription" | "paymentLine";
|
|
15011
15035
|
/** Format: uuid */
|
|
15012
15036
|
id: string;
|
|
15013
15037
|
uniqueRef: string | null;
|
|
@@ -15488,7 +15512,7 @@ export interface operations {
|
|
|
15488
15512
|
};
|
|
15489
15513
|
rootEntity: {
|
|
15490
15514
|
/** @enum {string} */
|
|
15491
|
-
type: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction";
|
|
15515
|
+
type: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription";
|
|
15492
15516
|
/** Format: uuid */
|
|
15493
15517
|
id: string;
|
|
15494
15518
|
uniqueRef: string | null;
|
|
@@ -15497,7 +15521,7 @@ export interface operations {
|
|
|
15497
15521
|
entityChanges: {
|
|
15498
15522
|
entity: {
|
|
15499
15523
|
/** @enum {string} */
|
|
15500
|
-
type: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction" | "paymentLine";
|
|
15524
|
+
type: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription" | "paymentLine";
|
|
15501
15525
|
/** Format: uuid */
|
|
15502
15526
|
id: string;
|
|
15503
15527
|
uniqueRef: string | null;
|
|
@@ -15751,7 +15775,7 @@ export interface operations {
|
|
|
15751
15775
|
causedBy: {
|
|
15752
15776
|
entity: {
|
|
15753
15777
|
/** @enum {string} */
|
|
15754
|
-
type: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction" | "paymentLine" | "journalEntry";
|
|
15778
|
+
type: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription" | "paymentLine" | "journalEntry";
|
|
15755
15779
|
/** Format: uuid */
|
|
15756
15780
|
id: string;
|
|
15757
15781
|
};
|
|
@@ -17131,6 +17155,7 @@ export interface operations {
|
|
|
17131
17155
|
reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
17132
17156
|
matchedByBankRule?: boolean;
|
|
17133
17157
|
includeBalanceRecords?: boolean;
|
|
17158
|
+
/** @description Include bank-rule suggestions; defaults to true when includeMatchingTransactions is set */
|
|
17134
17159
|
includeMatchingRules?: boolean;
|
|
17135
17160
|
/** @description Include matching transactions, optionally with max days offset */
|
|
17136
17161
|
includeMatchingTransactions?: string;
|
|
@@ -17246,7 +17271,37 @@ export interface operations {
|
|
|
17246
17271
|
recurringTemplate?: {
|
|
17247
17272
|
id: string;
|
|
17248
17273
|
} | null;
|
|
17274
|
+
/** @description Absolute difference in days from the bank record date */
|
|
17249
17275
|
dateOffset: number;
|
|
17276
|
+
/** @description Structured explanation for the transaction suggestion */
|
|
17277
|
+
matchDetails: {
|
|
17278
|
+
/** @description Whether another candidate has the same date offset */
|
|
17279
|
+
ambiguous: boolean;
|
|
17280
|
+
/** @description Candidate amount minus bank record amount, in cents; exact matches return zero */
|
|
17281
|
+
amountDifference: number;
|
|
17282
|
+
/** @description Transaction date used to evaluate the bank-record date window */
|
|
17283
|
+
matchingDate: string;
|
|
17284
|
+
/** @description Maximum eligible difference in days */
|
|
17285
|
+
maxDateOffset: number;
|
|
17286
|
+
/** @description Typed criteria satisfied by this candidate */
|
|
17287
|
+
reasons: ("exactAmount" | "sameBankAccount" | "bankAccountAssignedOnMatch" | "dateWithinWindow")[];
|
|
17288
|
+
};
|
|
17289
|
+
/** @description Unique listings referenced by the transaction lines */
|
|
17290
|
+
listings: {
|
|
17291
|
+
/** Format: uuid */
|
|
17292
|
+
id: string;
|
|
17293
|
+
name: string;
|
|
17294
|
+
uniqueRef?: string | null;
|
|
17295
|
+
shortRef?: string | null;
|
|
17296
|
+
}[];
|
|
17297
|
+
/** @description Unique reservations referenced by the transaction lines */
|
|
17298
|
+
reservations: {
|
|
17299
|
+
/** Format: uuid */
|
|
17300
|
+
id: string;
|
|
17301
|
+
confirmationCode?: string | null;
|
|
17302
|
+
uniqueRef?: string | null;
|
|
17303
|
+
shortRef?: string | null;
|
|
17304
|
+
}[];
|
|
17250
17305
|
}[] | null;
|
|
17251
17306
|
matchingRules?: {
|
|
17252
17307
|
rule: {
|
|
@@ -17330,9 +17385,45 @@ export interface operations {
|
|
|
17330
17385
|
connectionId?: string | null;
|
|
17331
17386
|
sourceId?: string | null;
|
|
17332
17387
|
recurringTemplateId?: string | null;
|
|
17388
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
17389
|
+
recreatedFromTransactionId?: string | null;
|
|
17333
17390
|
matchBankAccountLast4?: string | null;
|
|
17334
17391
|
};
|
|
17335
17392
|
};
|
|
17393
|
+
/** @description Structured explanation for the bank-rule suggestion */
|
|
17394
|
+
matchDetails: {
|
|
17395
|
+
/** @description Whether another matching rule has the same mode and priority */
|
|
17396
|
+
ambiguous: boolean;
|
|
17397
|
+
/** @description Whether the rule is limited to selected bank accounts */
|
|
17398
|
+
hasAccountScope: boolean;
|
|
17399
|
+
/** @description Whether the bank record satisfies the rule account scope */
|
|
17400
|
+
accountMatches: boolean;
|
|
17401
|
+
/** @description Whether deposit or expense direction matches the record */
|
|
17402
|
+
directionMatches: boolean;
|
|
17403
|
+
/**
|
|
17404
|
+
* @description Whether all or any configured conditions must match
|
|
17405
|
+
* @enum {string}
|
|
17406
|
+
*/
|
|
17407
|
+
matchMode: "all" | "any";
|
|
17408
|
+
/** @description Evaluation result for every configured condition */
|
|
17409
|
+
conditions: {
|
|
17410
|
+
condition: {
|
|
17411
|
+
/** @constant */
|
|
17412
|
+
type: "description";
|
|
17413
|
+
/** @enum {string} */
|
|
17414
|
+
operator: "contains" | "equals" | "startsWith";
|
|
17415
|
+
value: string;
|
|
17416
|
+
} | {
|
|
17417
|
+
/** @constant */
|
|
17418
|
+
type: "amount";
|
|
17419
|
+
/** @enum {string} */
|
|
17420
|
+
operator: ">" | ">=" | "=" | "<" | "<=";
|
|
17421
|
+
centValue: number;
|
|
17422
|
+
};
|
|
17423
|
+
/** @description Whether this individual condition matches */
|
|
17424
|
+
matches: boolean;
|
|
17425
|
+
}[];
|
|
17426
|
+
};
|
|
17336
17427
|
}[] | null;
|
|
17337
17428
|
currency?: string | null;
|
|
17338
17429
|
}[];
|
|
@@ -17892,6 +17983,7 @@ export interface operations {
|
|
|
17892
17983
|
reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
17893
17984
|
matchedByBankRule?: boolean;
|
|
17894
17985
|
includeBalanceRecords?: boolean;
|
|
17986
|
+
/** @description Include bank-rule suggestions; defaults to true when includeMatchingTransactions is set */
|
|
17895
17987
|
includeMatchingRules?: boolean;
|
|
17896
17988
|
/** @description Include matching transactions, optionally with max days offset */
|
|
17897
17989
|
includeMatchingTransactions?: string;
|
|
@@ -18147,6 +18239,7 @@ export interface operations {
|
|
|
18147
18239
|
getBankRecordsById: {
|
|
18148
18240
|
parameters: {
|
|
18149
18241
|
query?: {
|
|
18242
|
+
/** @description Include bank-rule suggestions; defaults to true when includeMatchingTransactions is set */
|
|
18150
18243
|
includeMatchingRules?: boolean;
|
|
18151
18244
|
/** @description Include matching transactions, optionally with max days offset */
|
|
18152
18245
|
includeMatchingTransactions?: string;
|
|
@@ -18256,7 +18349,37 @@ export interface operations {
|
|
|
18256
18349
|
recurringTemplate?: {
|
|
18257
18350
|
id: string;
|
|
18258
18351
|
} | null;
|
|
18352
|
+
/** @description Absolute difference in days from the bank record date */
|
|
18259
18353
|
dateOffset: number;
|
|
18354
|
+
/** @description Structured explanation for the transaction suggestion */
|
|
18355
|
+
matchDetails: {
|
|
18356
|
+
/** @description Whether another candidate has the same date offset */
|
|
18357
|
+
ambiguous: boolean;
|
|
18358
|
+
/** @description Candidate amount minus bank record amount, in cents; exact matches return zero */
|
|
18359
|
+
amountDifference: number;
|
|
18360
|
+
/** @description Transaction date used to evaluate the bank-record date window */
|
|
18361
|
+
matchingDate: string;
|
|
18362
|
+
/** @description Maximum eligible difference in days */
|
|
18363
|
+
maxDateOffset: number;
|
|
18364
|
+
/** @description Typed criteria satisfied by this candidate */
|
|
18365
|
+
reasons: ("exactAmount" | "sameBankAccount" | "bankAccountAssignedOnMatch" | "dateWithinWindow")[];
|
|
18366
|
+
};
|
|
18367
|
+
/** @description Unique listings referenced by the transaction lines */
|
|
18368
|
+
listings: {
|
|
18369
|
+
/** Format: uuid */
|
|
18370
|
+
id: string;
|
|
18371
|
+
name: string;
|
|
18372
|
+
uniqueRef?: string | null;
|
|
18373
|
+
shortRef?: string | null;
|
|
18374
|
+
}[];
|
|
18375
|
+
/** @description Unique reservations referenced by the transaction lines */
|
|
18376
|
+
reservations: {
|
|
18377
|
+
/** Format: uuid */
|
|
18378
|
+
id: string;
|
|
18379
|
+
confirmationCode?: string | null;
|
|
18380
|
+
uniqueRef?: string | null;
|
|
18381
|
+
shortRef?: string | null;
|
|
18382
|
+
}[];
|
|
18260
18383
|
}[] | null;
|
|
18261
18384
|
matchingRules?: {
|
|
18262
18385
|
rule: {
|
|
@@ -18340,9 +18463,45 @@ export interface operations {
|
|
|
18340
18463
|
connectionId?: string | null;
|
|
18341
18464
|
sourceId?: string | null;
|
|
18342
18465
|
recurringTemplateId?: string | null;
|
|
18466
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
18467
|
+
recreatedFromTransactionId?: string | null;
|
|
18343
18468
|
matchBankAccountLast4?: string | null;
|
|
18344
18469
|
};
|
|
18345
18470
|
};
|
|
18471
|
+
/** @description Structured explanation for the bank-rule suggestion */
|
|
18472
|
+
matchDetails: {
|
|
18473
|
+
/** @description Whether another matching rule has the same mode and priority */
|
|
18474
|
+
ambiguous: boolean;
|
|
18475
|
+
/** @description Whether the rule is limited to selected bank accounts */
|
|
18476
|
+
hasAccountScope: boolean;
|
|
18477
|
+
/** @description Whether the bank record satisfies the rule account scope */
|
|
18478
|
+
accountMatches: boolean;
|
|
18479
|
+
/** @description Whether deposit or expense direction matches the record */
|
|
18480
|
+
directionMatches: boolean;
|
|
18481
|
+
/**
|
|
18482
|
+
* @description Whether all or any configured conditions must match
|
|
18483
|
+
* @enum {string}
|
|
18484
|
+
*/
|
|
18485
|
+
matchMode: "all" | "any";
|
|
18486
|
+
/** @description Evaluation result for every configured condition */
|
|
18487
|
+
conditions: {
|
|
18488
|
+
condition: {
|
|
18489
|
+
/** @constant */
|
|
18490
|
+
type: "description";
|
|
18491
|
+
/** @enum {string} */
|
|
18492
|
+
operator: "contains" | "equals" | "startsWith";
|
|
18493
|
+
value: string;
|
|
18494
|
+
} | {
|
|
18495
|
+
/** @constant */
|
|
18496
|
+
type: "amount";
|
|
18497
|
+
/** @enum {string} */
|
|
18498
|
+
operator: ">" | ">=" | "=" | "<" | "<=";
|
|
18499
|
+
centValue: number;
|
|
18500
|
+
};
|
|
18501
|
+
/** @description Whether this individual condition matches */
|
|
18502
|
+
matches: boolean;
|
|
18503
|
+
}[];
|
|
18504
|
+
};
|
|
18346
18505
|
}[] | null;
|
|
18347
18506
|
currency?: string | null;
|
|
18348
18507
|
};
|
|
@@ -19993,6 +20152,8 @@ export interface operations {
|
|
|
19993
20152
|
connectionId?: string | null;
|
|
19994
20153
|
sourceId?: string | null;
|
|
19995
20154
|
recurringTemplateId?: string | null;
|
|
20155
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
20156
|
+
recreatedFromTransactionId?: string | null;
|
|
19996
20157
|
matchBankAccountLast4?: string | null;
|
|
19997
20158
|
};
|
|
19998
20159
|
}[];
|
|
@@ -21340,6 +21501,8 @@ export interface operations {
|
|
|
21340
21501
|
connectionId?: string | null;
|
|
21341
21502
|
sourceId?: string | null;
|
|
21342
21503
|
recurringTemplateId?: string | null;
|
|
21504
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
21505
|
+
recreatedFromTransactionId?: string | null;
|
|
21343
21506
|
matchBankAccountLast4?: string | null;
|
|
21344
21507
|
};
|
|
21345
21508
|
} | null;
|
|
@@ -34513,6 +34676,8 @@ export interface operations {
|
|
|
34513
34676
|
} | null;
|
|
34514
34677
|
sourceId?: string | null;
|
|
34515
34678
|
recurringTemplateId?: string | null;
|
|
34679
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
34680
|
+
recreatedFromTransactionId?: string | null;
|
|
34516
34681
|
matchBankAccountLast4?: string | null;
|
|
34517
34682
|
id?: string;
|
|
34518
34683
|
};
|
|
@@ -34725,6 +34890,8 @@ export interface operations {
|
|
|
34725
34890
|
} | null;
|
|
34726
34891
|
sourceId?: string | null;
|
|
34727
34892
|
recurringTemplateId?: string | null;
|
|
34893
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
34894
|
+
recreatedFromTransactionId?: string | null;
|
|
34728
34895
|
matchBankAccountLast4?: string | null;
|
|
34729
34896
|
id?: string;
|
|
34730
34897
|
};
|
|
@@ -78163,7 +78330,7 @@ export interface operations {
|
|
|
78163
78330
|
updatedFrom?: string;
|
|
78164
78331
|
/** @description Timestamp string with date, time, milliseconds, and timezone. */
|
|
78165
78332
|
updatedTo?: string;
|
|
78166
|
-
entityType?: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction";
|
|
78333
|
+
entityType?: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription";
|
|
78167
78334
|
entityId?: string;
|
|
78168
78335
|
actionId?: string;
|
|
78169
78336
|
actionCode?: string;
|
|
@@ -78175,7 +78342,7 @@ export interface operations {
|
|
|
78175
78342
|
/** @description Whether any public entity or journal-entry change exists */
|
|
78176
78343
|
hasChanges?: boolean;
|
|
78177
78344
|
/** @description Public subject participating in entityChanges */
|
|
78178
|
-
changedEntityType?: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction" | "paymentLine";
|
|
78345
|
+
changedEntityType?: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription" | "paymentLine";
|
|
78179
78346
|
/** @description Exact public registry path for changedEntityType */
|
|
78180
78347
|
changedPath?: string;
|
|
78181
78348
|
teamId?: string;
|
|
@@ -78241,7 +78408,7 @@ export interface operations {
|
|
|
78241
78408
|
};
|
|
78242
78409
|
rootEntity: {
|
|
78243
78410
|
/** @enum {string} */
|
|
78244
|
-
type: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction";
|
|
78411
|
+
type: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription";
|
|
78245
78412
|
/** Format: uuid */
|
|
78246
78413
|
id: string;
|
|
78247
78414
|
uniqueRef: string | null;
|
|
@@ -78250,7 +78417,7 @@ export interface operations {
|
|
|
78250
78417
|
entityChanges: {
|
|
78251
78418
|
entity: {
|
|
78252
78419
|
/** @enum {string} */
|
|
78253
|
-
type: "account" | "accountConnection" | "bankRecord" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "recurringFee" | "reservation" | "transaction" | "paymentLine";
|
|
78420
|
+
type: "account" | "accountConnection" | "apiToken" | "bankRecord" | "bankRule" | "connection" | "emailTemplate" | "flowMapping" | "flowSetting" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "ownerStatementLayout" | "ownerStatementLayoutListing" | "ownerUserAccess" | "recurringFee" | "recurringFeeListingSubscription" | "recurringTransactionTemplate" | "reservation" | "reservationLineMapping" | "taxRate" | "team" | "teamMember" | "transaction" | "webhookSubscription" | "paymentLine";
|
|
78254
78421
|
/** Format: uuid */
|
|
78255
78422
|
id: string;
|
|
78256
78423
|
uniqueRef: string | null;
|
|
@@ -112857,6 +113024,10 @@ export interface operations {
|
|
|
112857
113024
|
status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
|
|
112858
113025
|
/** @description Ramp bill status summary returned by the provider. */
|
|
112859
113026
|
providerStatus: string | null;
|
|
113027
|
+
/** @description Ramp Transfer API identifier when a transfer was observed. */
|
|
113028
|
+
providerTransferId: string | null;
|
|
113029
|
+
/** @description Raw Ramp Transfer API status used for lifecycle evidence. */
|
|
113030
|
+
providerTransferStatus: string | null;
|
|
112860
113031
|
externalRef: string | null;
|
|
112861
113032
|
/** @description Customer-friendly Ramp payment reference. */
|
|
112862
113033
|
paymentReference: string | null;
|
|
@@ -112870,6 +113041,8 @@ export interface operations {
|
|
|
112870
113041
|
initiatedAt: string | null;
|
|
112871
113042
|
/** @description Date and time Ramp marks the bill payment completed. */
|
|
112872
113043
|
completedAt: string | null;
|
|
113044
|
+
/** @description Date and time VRPlatform confirmed the Ramp bill archive. */
|
|
113045
|
+
billArchivedAt: string | null;
|
|
112873
113046
|
failureReason: string | null;
|
|
112874
113047
|
attemptId: string;
|
|
112875
113048
|
attempt: number;
|
|
@@ -115093,6 +115266,10 @@ export interface operations {
|
|
|
115093
115266
|
status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
|
|
115094
115267
|
/** @description Ramp bill status summary returned by the provider. */
|
|
115095
115268
|
providerStatus: string | null;
|
|
115269
|
+
/** @description Ramp Transfer API identifier when a transfer was observed. */
|
|
115270
|
+
providerTransferId: string | null;
|
|
115271
|
+
/** @description Raw Ramp Transfer API status used for lifecycle evidence. */
|
|
115272
|
+
providerTransferStatus: string | null;
|
|
115096
115273
|
externalRef: string | null;
|
|
115097
115274
|
/** @description Customer-friendly Ramp payment reference. */
|
|
115098
115275
|
paymentReference: string | null;
|
|
@@ -115106,6 +115283,8 @@ export interface operations {
|
|
|
115106
115283
|
initiatedAt: string | null;
|
|
115107
115284
|
/** @description Date and time Ramp marks the bill payment completed. */
|
|
115108
115285
|
completedAt: string | null;
|
|
115286
|
+
/** @description Date and time VRPlatform confirmed the Ramp bill archive. */
|
|
115287
|
+
billArchivedAt: string | null;
|
|
115109
115288
|
failureReason: string | null;
|
|
115110
115289
|
attemptId: string;
|
|
115111
115290
|
attempt: number;
|
|
@@ -120284,6 +120463,8 @@ export interface operations {
|
|
|
120284
120463
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
120285
120464
|
attachmentIds?: string[] | null;
|
|
120286
120465
|
recurringTemplateId?: string | null;
|
|
120466
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
120467
|
+
recreatedFromTransactionId?: string | null;
|
|
120287
120468
|
matchBankAccountLast4?: string | null;
|
|
120288
120469
|
id: string;
|
|
120289
120470
|
shortRef?: string | null;
|
|
@@ -122437,6 +122618,10 @@ export interface operations {
|
|
|
122437
122618
|
status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
|
|
122438
122619
|
/** @description Ramp bill status summary returned by the provider. */
|
|
122439
122620
|
providerStatus: string | null;
|
|
122621
|
+
/** @description Ramp Transfer API identifier when a transfer was observed. */
|
|
122622
|
+
providerTransferId: string | null;
|
|
122623
|
+
/** @description Raw Ramp Transfer API status used for lifecycle evidence. */
|
|
122624
|
+
providerTransferStatus: string | null;
|
|
122440
122625
|
externalRef: string | null;
|
|
122441
122626
|
/** @description Customer-friendly Ramp payment reference. */
|
|
122442
122627
|
paymentReference: string | null;
|
|
@@ -122450,6 +122635,8 @@ export interface operations {
|
|
|
122450
122635
|
initiatedAt: string | null;
|
|
122451
122636
|
/** @description Date and time Ramp marks the bill payment completed. */
|
|
122452
122637
|
completedAt: string | null;
|
|
122638
|
+
/** @description Date and time VRPlatform confirmed the Ramp bill archive. */
|
|
122639
|
+
billArchivedAt: string | null;
|
|
122453
122640
|
failureReason: string | null;
|
|
122454
122641
|
attemptId: string;
|
|
122455
122642
|
attempt: number;
|
|
@@ -138463,6 +138650,8 @@ export interface operations {
|
|
|
138463
138650
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
138464
138651
|
attachmentIds?: string[] | null;
|
|
138465
138652
|
recurringTemplateId?: string | null;
|
|
138653
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
138654
|
+
recreatedFromTransactionId?: string | null;
|
|
138466
138655
|
matchBankAccountLast4?: string | null;
|
|
138467
138656
|
id: string;
|
|
138468
138657
|
shortRef?: string | null;
|
|
@@ -138632,6 +138821,10 @@ export interface operations {
|
|
|
138632
138821
|
status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
|
|
138633
138822
|
/** @description Ramp bill status summary returned by the provider. */
|
|
138634
138823
|
providerStatus: string | null;
|
|
138824
|
+
/** @description Ramp Transfer API identifier when a transfer was observed. */
|
|
138825
|
+
providerTransferId: string | null;
|
|
138826
|
+
/** @description Raw Ramp Transfer API status used for lifecycle evidence. */
|
|
138827
|
+
providerTransferStatus: string | null;
|
|
138635
138828
|
externalRef: string | null;
|
|
138636
138829
|
/** @description Customer-friendly Ramp payment reference. */
|
|
138637
138830
|
paymentReference: string | null;
|
|
@@ -138645,6 +138838,8 @@ export interface operations {
|
|
|
138645
138838
|
initiatedAt: string | null;
|
|
138646
138839
|
/** @description Date and time Ramp marks the bill payment completed. */
|
|
138647
138840
|
completedAt: string | null;
|
|
138841
|
+
/** @description Date and time VRPlatform confirmed the Ramp bill archive. */
|
|
138842
|
+
billArchivedAt: string | null;
|
|
138648
138843
|
failureReason: string | null;
|
|
138649
138844
|
attemptId: string;
|
|
138650
138845
|
attempt: number;
|
|
@@ -138661,6 +138856,51 @@ export interface operations {
|
|
|
138661
138856
|
*/
|
|
138662
138857
|
updatedAt: string;
|
|
138663
138858
|
} | null;
|
|
138859
|
+
/** @description Server-owned Ramp payout recovery capabilities. Permissions remain independently enforced. */
|
|
138860
|
+
providerPaymentActions: {
|
|
138861
|
+
pay: {
|
|
138862
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
138863
|
+
available: boolean;
|
|
138864
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
138865
|
+
reason: string | null;
|
|
138866
|
+
};
|
|
138867
|
+
cancel: {
|
|
138868
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
138869
|
+
available: boolean;
|
|
138870
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
138871
|
+
reason: string | null;
|
|
138872
|
+
};
|
|
138873
|
+
cancelAndArchive: {
|
|
138874
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
138875
|
+
available: boolean;
|
|
138876
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
138877
|
+
reason: string | null;
|
|
138878
|
+
};
|
|
138879
|
+
cancelAndRecreate: {
|
|
138880
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
138881
|
+
available: boolean;
|
|
138882
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
138883
|
+
reason: string | null;
|
|
138884
|
+
};
|
|
138885
|
+
archive: {
|
|
138886
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
138887
|
+
available: boolean;
|
|
138888
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
138889
|
+
reason: string | null;
|
|
138890
|
+
};
|
|
138891
|
+
archiveAndRecreate: {
|
|
138892
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
138893
|
+
available: boolean;
|
|
138894
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
138895
|
+
reason: string | null;
|
|
138896
|
+
};
|
|
138897
|
+
unarchive: {
|
|
138898
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
138899
|
+
available: boolean;
|
|
138900
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
138901
|
+
reason: string | null;
|
|
138902
|
+
};
|
|
138903
|
+
};
|
|
138664
138904
|
}[];
|
|
138665
138905
|
pagination: {
|
|
138666
138906
|
/** @default 100 */
|
|
@@ -139011,6 +139251,8 @@ export interface operations {
|
|
|
139011
139251
|
connectionId?: string | null;
|
|
139012
139252
|
sourceId?: string | null;
|
|
139013
139253
|
recurringTemplateId?: string | null;
|
|
139254
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
139255
|
+
recreatedFromTransactionId?: string | null;
|
|
139014
139256
|
matchBankAccountLast4?: string | null;
|
|
139015
139257
|
};
|
|
139016
139258
|
};
|
|
@@ -139160,6 +139402,8 @@ export interface operations {
|
|
|
139160
139402
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
139161
139403
|
attachmentIds?: string[] | null;
|
|
139162
139404
|
recurringTemplateId?: string | null;
|
|
139405
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
139406
|
+
recreatedFromTransactionId?: string | null;
|
|
139163
139407
|
matchBankAccountLast4?: string | null;
|
|
139164
139408
|
id: string;
|
|
139165
139409
|
shortRef?: string | null;
|
|
@@ -140941,6 +141185,8 @@ export interface operations {
|
|
|
140941
141185
|
} | null;
|
|
140942
141186
|
sourceId?: string | null;
|
|
140943
141187
|
recurringTemplateId?: string | null;
|
|
141188
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
141189
|
+
recreatedFromTransactionId?: string | null;
|
|
140944
141190
|
matchBankAccountLast4?: string | null;
|
|
140945
141191
|
id?: string;
|
|
140946
141192
|
}[];
|
|
@@ -144520,6 +144766,8 @@ export interface operations {
|
|
|
144520
144766
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
144521
144767
|
attachmentIds?: string[] | null;
|
|
144522
144768
|
recurringTemplateId?: string | null;
|
|
144769
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
144770
|
+
recreatedFromTransactionId?: string | null;
|
|
144523
144771
|
matchBankAccountLast4?: string | null;
|
|
144524
144772
|
id: string;
|
|
144525
144773
|
shortRef?: string | null;
|
|
@@ -145061,6 +145309,8 @@ export interface operations {
|
|
|
145061
145309
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
145062
145310
|
attachmentIds?: string[] | null;
|
|
145063
145311
|
recurringTemplateId?: string | null;
|
|
145312
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
145313
|
+
recreatedFromTransactionId?: string | null;
|
|
145064
145314
|
matchBankAccountLast4?: string | null;
|
|
145065
145315
|
id: string;
|
|
145066
145316
|
shortRef?: string | null;
|
|
@@ -145230,6 +145480,10 @@ export interface operations {
|
|
|
145230
145480
|
status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
|
|
145231
145481
|
/** @description Ramp bill status summary returned by the provider. */
|
|
145232
145482
|
providerStatus: string | null;
|
|
145483
|
+
/** @description Ramp Transfer API identifier when a transfer was observed. */
|
|
145484
|
+
providerTransferId: string | null;
|
|
145485
|
+
/** @description Raw Ramp Transfer API status used for lifecycle evidence. */
|
|
145486
|
+
providerTransferStatus: string | null;
|
|
145233
145487
|
externalRef: string | null;
|
|
145234
145488
|
/** @description Customer-friendly Ramp payment reference. */
|
|
145235
145489
|
paymentReference: string | null;
|
|
@@ -145243,6 +145497,8 @@ export interface operations {
|
|
|
145243
145497
|
initiatedAt: string | null;
|
|
145244
145498
|
/** @description Date and time Ramp marks the bill payment completed. */
|
|
145245
145499
|
completedAt: string | null;
|
|
145500
|
+
/** @description Date and time VRPlatform confirmed the Ramp bill archive. */
|
|
145501
|
+
billArchivedAt: string | null;
|
|
145246
145502
|
failureReason: string | null;
|
|
145247
145503
|
attemptId: string;
|
|
145248
145504
|
attempt: number;
|
|
@@ -145259,6 +145515,51 @@ export interface operations {
|
|
|
145259
145515
|
*/
|
|
145260
145516
|
updatedAt: string;
|
|
145261
145517
|
} | null;
|
|
145518
|
+
/** @description Server-owned Ramp payout recovery capabilities. Permissions remain independently enforced. */
|
|
145519
|
+
providerPaymentActions: {
|
|
145520
|
+
pay: {
|
|
145521
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
145522
|
+
available: boolean;
|
|
145523
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
145524
|
+
reason: string | null;
|
|
145525
|
+
};
|
|
145526
|
+
cancel: {
|
|
145527
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
145528
|
+
available: boolean;
|
|
145529
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
145530
|
+
reason: string | null;
|
|
145531
|
+
};
|
|
145532
|
+
cancelAndArchive: {
|
|
145533
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
145534
|
+
available: boolean;
|
|
145535
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
145536
|
+
reason: string | null;
|
|
145537
|
+
};
|
|
145538
|
+
cancelAndRecreate: {
|
|
145539
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
145540
|
+
available: boolean;
|
|
145541
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
145542
|
+
reason: string | null;
|
|
145543
|
+
};
|
|
145544
|
+
archive: {
|
|
145545
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
145546
|
+
available: boolean;
|
|
145547
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
145548
|
+
reason: string | null;
|
|
145549
|
+
};
|
|
145550
|
+
archiveAndRecreate: {
|
|
145551
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
145552
|
+
available: boolean;
|
|
145553
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
145554
|
+
reason: string | null;
|
|
145555
|
+
};
|
|
145556
|
+
unarchive: {
|
|
145557
|
+
/** @description Whether current provider and accounting state allows the action. */
|
|
145558
|
+
available: boolean;
|
|
145559
|
+
/** @description Static disabled reason, or null when the action is available. */
|
|
145560
|
+
reason: string | null;
|
|
145561
|
+
};
|
|
145562
|
+
};
|
|
145262
145563
|
};
|
|
145263
145564
|
};
|
|
145264
145565
|
};
|
|
@@ -145822,6 +146123,8 @@ export interface operations {
|
|
|
145822
146123
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
145823
146124
|
attachmentIds?: string[] | null;
|
|
145824
146125
|
recurringTemplateId?: string | null;
|
|
146126
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
146127
|
+
recreatedFromTransactionId?: string | null;
|
|
145825
146128
|
matchBankAccountLast4?: string | null;
|
|
145826
146129
|
id: string;
|
|
145827
146130
|
shortRef?: string | null;
|
|
@@ -146509,6 +146812,10 @@ export interface operations {
|
|
|
146509
146812
|
status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
|
|
146510
146813
|
/** @description Ramp bill status summary returned by the provider. */
|
|
146511
146814
|
providerStatus: string | null;
|
|
146815
|
+
/** @description Ramp Transfer API identifier when a transfer was observed. */
|
|
146816
|
+
providerTransferId: string | null;
|
|
146817
|
+
/** @description Raw Ramp Transfer API status used for lifecycle evidence. */
|
|
146818
|
+
providerTransferStatus: string | null;
|
|
146512
146819
|
externalRef: string | null;
|
|
146513
146820
|
/** @description Customer-friendly Ramp payment reference. */
|
|
146514
146821
|
paymentReference: string | null;
|
|
@@ -146522,6 +146829,8 @@ export interface operations {
|
|
|
146522
146829
|
initiatedAt: string | null;
|
|
146523
146830
|
/** @description Date and time Ramp marks the bill payment completed. */
|
|
146524
146831
|
completedAt: string | null;
|
|
146832
|
+
/** @description Date and time VRPlatform confirmed the Ramp bill archive. */
|
|
146833
|
+
billArchivedAt: string | null;
|
|
146525
146834
|
failureReason: string | null;
|
|
146526
146835
|
attemptId: string;
|
|
146527
146836
|
attempt: number;
|
|
@@ -146800,6 +147109,10 @@ export interface operations {
|
|
|
146800
147109
|
status: "requested" | "processing" | "paid" | "failed" | "returned" | "canceled";
|
|
146801
147110
|
/** @description Ramp bill status summary returned by the provider. */
|
|
146802
147111
|
providerStatus: string | null;
|
|
147112
|
+
/** @description Ramp Transfer API identifier when a transfer was observed. */
|
|
147113
|
+
providerTransferId: string | null;
|
|
147114
|
+
/** @description Raw Ramp Transfer API status used for lifecycle evidence. */
|
|
147115
|
+
providerTransferStatus: string | null;
|
|
146803
147116
|
externalRef: string | null;
|
|
146804
147117
|
/** @description Customer-friendly Ramp payment reference. */
|
|
146805
147118
|
paymentReference: string | null;
|
|
@@ -146813,6 +147126,8 @@ export interface operations {
|
|
|
146813
147126
|
initiatedAt: string | null;
|
|
146814
147127
|
/** @description Date and time Ramp marks the bill payment completed. */
|
|
146815
147128
|
completedAt: string | null;
|
|
147129
|
+
/** @description Date and time VRPlatform confirmed the Ramp bill archive. */
|
|
147130
|
+
billArchivedAt: string | null;
|
|
146816
147131
|
failureReason: string | null;
|
|
146817
147132
|
attemptId: string;
|
|
146818
147133
|
attempt: number;
|
|
@@ -147312,7 +147627,7 @@ export interface operations {
|
|
|
147312
147627
|
};
|
|
147313
147628
|
};
|
|
147314
147629
|
};
|
|
147315
|
-
|
|
147630
|
+
postTransactionsByIdProviderPaymentsByProviderPaymentIdArchive: {
|
|
147316
147631
|
parameters: {
|
|
147317
147632
|
query?: never;
|
|
147318
147633
|
header?: never;
|
|
@@ -147339,6 +147654,273 @@ export interface operations {
|
|
|
147339
147654
|
providerPaymentId: string;
|
|
147340
147655
|
/** Format: uuid */
|
|
147341
147656
|
syncId: string;
|
|
147657
|
+
/** @enum {string} */
|
|
147658
|
+
operation: "cancel" | "archive";
|
|
147659
|
+
archivePayout: boolean;
|
|
147660
|
+
/** @constant */
|
|
147661
|
+
status: "requested";
|
|
147662
|
+
};
|
|
147663
|
+
};
|
|
147664
|
+
};
|
|
147665
|
+
/** @description Bad request */
|
|
147666
|
+
400: {
|
|
147667
|
+
headers: {
|
|
147668
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147669
|
+
"Retry-After"?: number;
|
|
147670
|
+
[name: string]: unknown;
|
|
147671
|
+
};
|
|
147672
|
+
content: {
|
|
147673
|
+
"application/json": {
|
|
147674
|
+
code: string;
|
|
147675
|
+
message: string;
|
|
147676
|
+
links?: {
|
|
147677
|
+
docs: string;
|
|
147678
|
+
schema: string;
|
|
147679
|
+
};
|
|
147680
|
+
issues?: {
|
|
147681
|
+
message: string;
|
|
147682
|
+
path?: (string | number)[];
|
|
147683
|
+
schema?: string;
|
|
147684
|
+
}[];
|
|
147685
|
+
retryable?: boolean;
|
|
147686
|
+
context?: unknown;
|
|
147687
|
+
};
|
|
147688
|
+
};
|
|
147689
|
+
};
|
|
147690
|
+
/** @description Unauthorized */
|
|
147691
|
+
401: {
|
|
147692
|
+
headers: {
|
|
147693
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147694
|
+
"Retry-After"?: number;
|
|
147695
|
+
[name: string]: unknown;
|
|
147696
|
+
};
|
|
147697
|
+
content: {
|
|
147698
|
+
"application/json": {
|
|
147699
|
+
code: string;
|
|
147700
|
+
message: string;
|
|
147701
|
+
links?: {
|
|
147702
|
+
docs: string;
|
|
147703
|
+
schema: string;
|
|
147704
|
+
};
|
|
147705
|
+
issues?: {
|
|
147706
|
+
message: string;
|
|
147707
|
+
path?: (string | number)[];
|
|
147708
|
+
schema?: string;
|
|
147709
|
+
}[];
|
|
147710
|
+
retryable?: boolean;
|
|
147711
|
+
context?: unknown;
|
|
147712
|
+
};
|
|
147713
|
+
};
|
|
147714
|
+
};
|
|
147715
|
+
/** @description Forbidden */
|
|
147716
|
+
403: {
|
|
147717
|
+
headers: {
|
|
147718
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147719
|
+
"Retry-After"?: number;
|
|
147720
|
+
[name: string]: unknown;
|
|
147721
|
+
};
|
|
147722
|
+
content: {
|
|
147723
|
+
"application/json": {
|
|
147724
|
+
code: string;
|
|
147725
|
+
message: string;
|
|
147726
|
+
links?: {
|
|
147727
|
+
docs: string;
|
|
147728
|
+
schema: string;
|
|
147729
|
+
};
|
|
147730
|
+
issues?: {
|
|
147731
|
+
message: string;
|
|
147732
|
+
path?: (string | number)[];
|
|
147733
|
+
schema?: string;
|
|
147734
|
+
}[];
|
|
147735
|
+
retryable?: boolean;
|
|
147736
|
+
context?: unknown;
|
|
147737
|
+
};
|
|
147738
|
+
};
|
|
147739
|
+
};
|
|
147740
|
+
/** @description Not found */
|
|
147741
|
+
404: {
|
|
147742
|
+
headers: {
|
|
147743
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147744
|
+
"Retry-After"?: number;
|
|
147745
|
+
[name: string]: unknown;
|
|
147746
|
+
};
|
|
147747
|
+
content: {
|
|
147748
|
+
"application/json": {
|
|
147749
|
+
code: string;
|
|
147750
|
+
message: string;
|
|
147751
|
+
links?: {
|
|
147752
|
+
docs: string;
|
|
147753
|
+
schema: string;
|
|
147754
|
+
};
|
|
147755
|
+
issues?: {
|
|
147756
|
+
message: string;
|
|
147757
|
+
path?: (string | number)[];
|
|
147758
|
+
schema?: string;
|
|
147759
|
+
}[];
|
|
147760
|
+
retryable?: boolean;
|
|
147761
|
+
context?: unknown;
|
|
147762
|
+
};
|
|
147763
|
+
};
|
|
147764
|
+
};
|
|
147765
|
+
/** @description Conflict */
|
|
147766
|
+
409: {
|
|
147767
|
+
headers: {
|
|
147768
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147769
|
+
"Retry-After"?: number;
|
|
147770
|
+
[name: string]: unknown;
|
|
147771
|
+
};
|
|
147772
|
+
content: {
|
|
147773
|
+
"application/json": {
|
|
147774
|
+
code: string;
|
|
147775
|
+
message: string;
|
|
147776
|
+
links?: {
|
|
147777
|
+
docs: string;
|
|
147778
|
+
schema: string;
|
|
147779
|
+
};
|
|
147780
|
+
issues?: {
|
|
147781
|
+
message: string;
|
|
147782
|
+
path?: (string | number)[];
|
|
147783
|
+
schema?: string;
|
|
147784
|
+
}[];
|
|
147785
|
+
retryable?: boolean;
|
|
147786
|
+
context?: unknown;
|
|
147787
|
+
};
|
|
147788
|
+
};
|
|
147789
|
+
};
|
|
147790
|
+
/** @description Gone */
|
|
147791
|
+
410: {
|
|
147792
|
+
headers: {
|
|
147793
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147794
|
+
"Retry-After"?: number;
|
|
147795
|
+
[name: string]: unknown;
|
|
147796
|
+
};
|
|
147797
|
+
content: {
|
|
147798
|
+
"application/json": {
|
|
147799
|
+
code: string;
|
|
147800
|
+
message: string;
|
|
147801
|
+
links?: {
|
|
147802
|
+
docs: string;
|
|
147803
|
+
schema: string;
|
|
147804
|
+
};
|
|
147805
|
+
issues?: {
|
|
147806
|
+
message: string;
|
|
147807
|
+
path?: (string | number)[];
|
|
147808
|
+
schema?: string;
|
|
147809
|
+
}[];
|
|
147810
|
+
retryable?: boolean;
|
|
147811
|
+
context?: unknown;
|
|
147812
|
+
};
|
|
147813
|
+
};
|
|
147814
|
+
};
|
|
147815
|
+
/** @description Unprocessable content */
|
|
147816
|
+
422: {
|
|
147817
|
+
headers: {
|
|
147818
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147819
|
+
"Retry-After"?: number;
|
|
147820
|
+
[name: string]: unknown;
|
|
147821
|
+
};
|
|
147822
|
+
content: {
|
|
147823
|
+
"application/json": {
|
|
147824
|
+
code: string;
|
|
147825
|
+
message: string;
|
|
147826
|
+
links?: {
|
|
147827
|
+
docs: string;
|
|
147828
|
+
schema: string;
|
|
147829
|
+
};
|
|
147830
|
+
issues?: {
|
|
147831
|
+
message: string;
|
|
147832
|
+
path?: (string | number)[];
|
|
147833
|
+
schema?: string;
|
|
147834
|
+
}[];
|
|
147835
|
+
retryable?: boolean;
|
|
147836
|
+
context?: unknown;
|
|
147837
|
+
};
|
|
147838
|
+
};
|
|
147839
|
+
};
|
|
147840
|
+
/** @description Internal server error */
|
|
147841
|
+
500: {
|
|
147842
|
+
headers: {
|
|
147843
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147844
|
+
"Retry-After"?: number;
|
|
147845
|
+
[name: string]: unknown;
|
|
147846
|
+
};
|
|
147847
|
+
content: {
|
|
147848
|
+
"application/json": {
|
|
147849
|
+
code: string;
|
|
147850
|
+
message: string;
|
|
147851
|
+
links?: {
|
|
147852
|
+
docs: string;
|
|
147853
|
+
schema: string;
|
|
147854
|
+
};
|
|
147855
|
+
issues?: {
|
|
147856
|
+
message: string;
|
|
147857
|
+
path?: (string | number)[];
|
|
147858
|
+
schema?: string;
|
|
147859
|
+
}[];
|
|
147860
|
+
retryable?: boolean;
|
|
147861
|
+
context?: unknown;
|
|
147862
|
+
};
|
|
147863
|
+
};
|
|
147864
|
+
};
|
|
147865
|
+
/** @description Service unavailable */
|
|
147866
|
+
503: {
|
|
147867
|
+
headers: {
|
|
147868
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
147869
|
+
"Retry-After"?: number;
|
|
147870
|
+
[name: string]: unknown;
|
|
147871
|
+
};
|
|
147872
|
+
content: {
|
|
147873
|
+
"application/json": {
|
|
147874
|
+
code: string;
|
|
147875
|
+
message: string;
|
|
147876
|
+
links?: {
|
|
147877
|
+
docs: string;
|
|
147878
|
+
schema: string;
|
|
147879
|
+
};
|
|
147880
|
+
issues?: {
|
|
147881
|
+
message: string;
|
|
147882
|
+
path?: (string | number)[];
|
|
147883
|
+
schema?: string;
|
|
147884
|
+
}[];
|
|
147885
|
+
retryable?: boolean;
|
|
147886
|
+
context?: unknown;
|
|
147887
|
+
};
|
|
147888
|
+
};
|
|
147889
|
+
};
|
|
147890
|
+
};
|
|
147891
|
+
};
|
|
147892
|
+
postTransactionsByIdProviderPaymentsByProviderPaymentIdCancel: {
|
|
147893
|
+
parameters: {
|
|
147894
|
+
query?: never;
|
|
147895
|
+
header?: never;
|
|
147896
|
+
path: {
|
|
147897
|
+
id: string;
|
|
147898
|
+
providerPaymentId: string;
|
|
147899
|
+
};
|
|
147900
|
+
cookie?: never;
|
|
147901
|
+
};
|
|
147902
|
+
requestBody?: {
|
|
147903
|
+
content: {
|
|
147904
|
+
"application/json": {
|
|
147905
|
+
archivePayout: boolean;
|
|
147906
|
+
};
|
|
147907
|
+
};
|
|
147908
|
+
};
|
|
147909
|
+
responses: {
|
|
147910
|
+
/** @description Successful response */
|
|
147911
|
+
200: {
|
|
147912
|
+
headers: {
|
|
147913
|
+
[name: string]: unknown;
|
|
147914
|
+
};
|
|
147915
|
+
content: {
|
|
147916
|
+
"application/json": {
|
|
147917
|
+
/** Format: uuid */
|
|
147918
|
+
providerPaymentId: string;
|
|
147919
|
+
/** Format: uuid */
|
|
147920
|
+
syncId: string;
|
|
147921
|
+
/** @enum {string} */
|
|
147922
|
+
operation: "cancel" | "archive";
|
|
147923
|
+
archivePayout: boolean;
|
|
147342
147924
|
/** @constant */
|
|
147343
147925
|
status: "requested";
|
|
147344
147926
|
};
|
|
@@ -147765,6 +148347,8 @@ export interface operations {
|
|
|
147765
148347
|
/** @description Expense attachment IDs returned as attachmentId by POST /transactions/attachments after PUT to uploadUrl succeeds. Only expense transactions support attachments. Omit to leave existing attachments unchanged on update; send an array to replace the attached set. */
|
|
147766
148348
|
attachmentIds?: string[] | null;
|
|
147767
148349
|
recurringTemplateId?: string | null;
|
|
148350
|
+
/** @description Archived payout replaced by this payout. The source and every other payout in its replacement chain must remain inactive. */
|
|
148351
|
+
recreatedFromTransactionId?: string | null;
|
|
147768
148352
|
matchBankAccountLast4?: string | null;
|
|
147769
148353
|
id: string;
|
|
147770
148354
|
shortRef?: string | null;
|