@vrplatform/api 1.3.1-stage.6489 → 1.3.1-stage.6496
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.
|
@@ -7251,7 +7251,7 @@ export interface paths {
|
|
|
7251
7251
|
get?: never;
|
|
7252
7252
|
put?: never;
|
|
7253
7253
|
/**
|
|
7254
|
-
* @description Archive a failed, returned, or canceled Ramp bill before archiving payout accounting. Poll the returned operationId through GET /operations/{id}
|
|
7254
|
+
* @description Archive a failed, returned, or canceled Ramp bill before archiving payout accounting. Poll the returned `operationId` through `GET /operations/{id}`; paid payouts cannot be archived.
|
|
7255
7255
|
*
|
|
7256
7256
|
* Required scope: transactions:write, ach-payments:execute
|
|
7257
7257
|
*/
|
|
@@ -7272,7 +7272,7 @@ export interface paths {
|
|
|
7272
7272
|
get?: never;
|
|
7273
7273
|
put?: never;
|
|
7274
7274
|
/**
|
|
7275
|
-
* @description Request cancellation of a requested or processing Ramp payment, optionally followed by payout accounting archive. Poll the returned operationId through GET /operations/{id}
|
|
7275
|
+
* @description Request cancellation of a requested or processing Ramp payment, optionally followed by payout accounting archive. Poll the returned `operationId` through `GET /operations/{id}`; Ramp remains authoritative about cancellation eligibility.
|
|
7276
7276
|
*
|
|
7277
7277
|
* Required scope: transactions:mark-paid, ach-payments:execute
|
|
7278
7278
|
*/
|
|
@@ -17632,9 +17632,13 @@ export interface operations {
|
|
|
17632
17632
|
reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
17633
17633
|
matchedByBankRule?: boolean;
|
|
17634
17634
|
includeBalanceRecords?: boolean;
|
|
17635
|
-
/** @description Include bank-rule suggestions; defaults to true
|
|
17635
|
+
/** @description Include bank-rule suggestions; defaults to true with the deprecated includeMatchingTransactions parameter */
|
|
17636
17636
|
includeMatchingRules?: boolean;
|
|
17637
|
-
/** @description Include
|
|
17637
|
+
/** @description Include ordered exact matching transaction sets */
|
|
17638
|
+
includeMatchingTransaction?: boolean;
|
|
17639
|
+
/** @description Maximum date offset for exact transaction suggestions; defaults to seven days. Multi-transaction sets remain limited to seven days. */
|
|
17640
|
+
matchingTransactionDaysOffset?: number;
|
|
17641
|
+
/** @description Deprecated: use includeMatchingTransaction and matchingTransactionDaysOffset. */
|
|
17638
17642
|
includeMatchingTransactions?: string;
|
|
17639
17643
|
hasMatchingTransactions?: boolean;
|
|
17640
17644
|
reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
|
|
@@ -17780,6 +17784,104 @@ export interface operations {
|
|
|
17780
17784
|
shortRef?: string | null;
|
|
17781
17785
|
}[];
|
|
17782
17786
|
}[] | null;
|
|
17787
|
+
/** @description Ordered exact transaction sets matching this bank record */
|
|
17788
|
+
matchingTransactionSets?: {
|
|
17789
|
+
/** @description Eligible transactions whose signed amounts form this set */
|
|
17790
|
+
transactions: {
|
|
17791
|
+
id: string;
|
|
17792
|
+
/** @enum {string} */
|
|
17793
|
+
status: "active" | "inactive";
|
|
17794
|
+
/** @description Value in cents (100 = 1€) */
|
|
17795
|
+
amount: number;
|
|
17796
|
+
account?: {
|
|
17797
|
+
id: string;
|
|
17798
|
+
name: string;
|
|
17799
|
+
uniqueRef?: string | null;
|
|
17800
|
+
/** @enum {string} */
|
|
17801
|
+
status: "active" | "inactive";
|
|
17802
|
+
} | null;
|
|
17803
|
+
date: string;
|
|
17804
|
+
description: string;
|
|
17805
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
17806
|
+
currency: string;
|
|
17807
|
+
/** @enum {string} */
|
|
17808
|
+
type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
|
|
17809
|
+
isOpeningBalance: boolean;
|
|
17810
|
+
contact?: {
|
|
17811
|
+
/** Format: uuid */
|
|
17812
|
+
id: string;
|
|
17813
|
+
name?: string | null;
|
|
17814
|
+
firstName?: string | null;
|
|
17815
|
+
uniqueRef?: string | null;
|
|
17816
|
+
shortRef?: string | null;
|
|
17817
|
+
email?: string | null;
|
|
17818
|
+
/** @enum {string} */
|
|
17819
|
+
type: "owner" | "vendor";
|
|
17820
|
+
} | null;
|
|
17821
|
+
connection?: {
|
|
17822
|
+
/** Format: uuid */
|
|
17823
|
+
id: string;
|
|
17824
|
+
name: string;
|
|
17825
|
+
/** @enum {string} */
|
|
17826
|
+
status: "active" | "inactive";
|
|
17827
|
+
uniqueRef?: string | null;
|
|
17828
|
+
appId: string;
|
|
17829
|
+
} | null;
|
|
17830
|
+
uniqueRef?: string | null;
|
|
17831
|
+
shortRef?: string | null;
|
|
17832
|
+
recurringTemplate?: {
|
|
17833
|
+
id: string;
|
|
17834
|
+
} | null;
|
|
17835
|
+
/** @description Absolute difference in days from the bank record date */
|
|
17836
|
+
dateOffset: number;
|
|
17837
|
+
/** @description Structured explanation for the transaction suggestion */
|
|
17838
|
+
matchDetails: {
|
|
17839
|
+
/** @description Whether another candidate has the same date offset */
|
|
17840
|
+
ambiguous: boolean;
|
|
17841
|
+
/** @description Candidate amount minus bank record amount, in cents; exact matches return zero */
|
|
17842
|
+
amountDifference: number;
|
|
17843
|
+
/** @description Transaction date used to evaluate the bank-record date window */
|
|
17844
|
+
matchingDate: string;
|
|
17845
|
+
/** @description Maximum eligible difference in days */
|
|
17846
|
+
maxDateOffset: number;
|
|
17847
|
+
/** @description Typed criteria satisfied by this candidate */
|
|
17848
|
+
reasons: ("exactAmount" | "sameBankAccount" | "bankAccountAssignedOnMatch" | "dateWithinWindow")[];
|
|
17849
|
+
};
|
|
17850
|
+
/** @description Unique listings referenced by the transaction lines */
|
|
17851
|
+
listings: {
|
|
17852
|
+
/** Format: uuid */
|
|
17853
|
+
id: string;
|
|
17854
|
+
name: string;
|
|
17855
|
+
uniqueRef?: string | null;
|
|
17856
|
+
shortRef?: string | null;
|
|
17857
|
+
}[];
|
|
17858
|
+
/** @description Unique reservations referenced by the transaction lines */
|
|
17859
|
+
reservations: {
|
|
17860
|
+
/** Format: uuid */
|
|
17861
|
+
id: string;
|
|
17862
|
+
confirmationCode?: string | null;
|
|
17863
|
+
uniqueRef?: string | null;
|
|
17864
|
+
shortRef?: string | null;
|
|
17865
|
+
}[];
|
|
17866
|
+
}[];
|
|
17867
|
+
/** @description Combined signed transaction amount in cents */
|
|
17868
|
+
combinedAmount: number;
|
|
17869
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
17870
|
+
currency: string;
|
|
17871
|
+
dateEvidence: {
|
|
17872
|
+
/** @description Sum of member date offsets used for deterministic ranking */
|
|
17873
|
+
totalDateOffset: number;
|
|
17874
|
+
/** @description Largest member date offset in the group */
|
|
17875
|
+
maxDateOffset: number;
|
|
17876
|
+
};
|
|
17877
|
+
matchDetails: {
|
|
17878
|
+
/** @description Whether another transaction set has the same member count and total date offset */
|
|
17879
|
+
ambiguous: boolean;
|
|
17880
|
+
/** @description Combined set amount minus bank record amount, in cents; exact suggestions return zero */
|
|
17881
|
+
amountDifference: number;
|
|
17882
|
+
reasons: ("exactAmount" | "sameCurrency" | "allTransactionsEligible" | "dateWithinWindow")[];
|
|
17883
|
+
};
|
|
17884
|
+
}[] | null;
|
|
17783
17885
|
matchingRules?: {
|
|
17784
17886
|
rule: {
|
|
17785
17887
|
/** Format: uuid */
|
|
@@ -18460,9 +18562,13 @@ export interface operations {
|
|
|
18460
18562
|
reconcileStatus?: "unpaid" | "underpaid" | "overpaid" | "paid";
|
|
18461
18563
|
matchedByBankRule?: boolean;
|
|
18462
18564
|
includeBalanceRecords?: boolean;
|
|
18463
|
-
/** @description Include bank-rule suggestions; defaults to true
|
|
18565
|
+
/** @description Include bank-rule suggestions; defaults to true with the deprecated includeMatchingTransactions parameter */
|
|
18464
18566
|
includeMatchingRules?: boolean;
|
|
18465
|
-
/** @description Include
|
|
18567
|
+
/** @description Include ordered exact matching transaction sets */
|
|
18568
|
+
includeMatchingTransaction?: boolean;
|
|
18569
|
+
/** @description Maximum date offset for exact transaction suggestions; defaults to seven days. Multi-transaction sets remain limited to seven days. */
|
|
18570
|
+
matchingTransactionDaysOffset?: number;
|
|
18571
|
+
/** @description Deprecated: use includeMatchingTransaction and matchingTransactionDaysOffset. */
|
|
18466
18572
|
includeMatchingTransactions?: string;
|
|
18467
18573
|
hasMatchingTransactions?: boolean;
|
|
18468
18574
|
reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
|
|
@@ -18716,9 +18822,13 @@ export interface operations {
|
|
|
18716
18822
|
getBankRecordsById: {
|
|
18717
18823
|
parameters: {
|
|
18718
18824
|
query?: {
|
|
18719
|
-
/** @description Include bank-rule suggestions; defaults to true
|
|
18825
|
+
/** @description Include bank-rule suggestions; defaults to true with the deprecated includeMatchingTransactions parameter */
|
|
18720
18826
|
includeMatchingRules?: boolean;
|
|
18721
|
-
/** @description Include
|
|
18827
|
+
/** @description Include ordered exact matching transaction sets */
|
|
18828
|
+
includeMatchingTransaction?: boolean;
|
|
18829
|
+
/** @description Maximum date offset for exact transaction suggestions; defaults to seven days. Multi-transaction sets remain limited to seven days. */
|
|
18830
|
+
matchingTransactionDaysOffset?: number;
|
|
18831
|
+
/** @description Deprecated: use includeMatchingTransaction and matchingTransactionDaysOffset. */
|
|
18722
18832
|
includeMatchingTransactions?: string;
|
|
18723
18833
|
};
|
|
18724
18834
|
header?: never;
|
|
@@ -18858,6 +18968,104 @@ export interface operations {
|
|
|
18858
18968
|
shortRef?: string | null;
|
|
18859
18969
|
}[];
|
|
18860
18970
|
}[] | null;
|
|
18971
|
+
/** @description Ordered exact transaction sets matching this bank record */
|
|
18972
|
+
matchingTransactionSets?: {
|
|
18973
|
+
/** @description Eligible transactions whose signed amounts form this set */
|
|
18974
|
+
transactions: {
|
|
18975
|
+
id: string;
|
|
18976
|
+
/** @enum {string} */
|
|
18977
|
+
status: "active" | "inactive";
|
|
18978
|
+
/** @description Value in cents (100 = 1€) */
|
|
18979
|
+
amount: number;
|
|
18980
|
+
account?: {
|
|
18981
|
+
id: string;
|
|
18982
|
+
name: string;
|
|
18983
|
+
uniqueRef?: string | null;
|
|
18984
|
+
/** @enum {string} */
|
|
18985
|
+
status: "active" | "inactive";
|
|
18986
|
+
} | null;
|
|
18987
|
+
date: string;
|
|
18988
|
+
description: string;
|
|
18989
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
18990
|
+
currency: string;
|
|
18991
|
+
/** @enum {string} */
|
|
18992
|
+
type: "deposit" | "expense" | "journalBatch" | "transfer" | "payout";
|
|
18993
|
+
isOpeningBalance: boolean;
|
|
18994
|
+
contact?: {
|
|
18995
|
+
/** Format: uuid */
|
|
18996
|
+
id: string;
|
|
18997
|
+
name?: string | null;
|
|
18998
|
+
firstName?: string | null;
|
|
18999
|
+
uniqueRef?: string | null;
|
|
19000
|
+
shortRef?: string | null;
|
|
19001
|
+
email?: string | null;
|
|
19002
|
+
/** @enum {string} */
|
|
19003
|
+
type: "owner" | "vendor";
|
|
19004
|
+
} | null;
|
|
19005
|
+
connection?: {
|
|
19006
|
+
/** Format: uuid */
|
|
19007
|
+
id: string;
|
|
19008
|
+
name: string;
|
|
19009
|
+
/** @enum {string} */
|
|
19010
|
+
status: "active" | "inactive";
|
|
19011
|
+
uniqueRef?: string | null;
|
|
19012
|
+
appId: string;
|
|
19013
|
+
} | null;
|
|
19014
|
+
uniqueRef?: string | null;
|
|
19015
|
+
shortRef?: string | null;
|
|
19016
|
+
recurringTemplate?: {
|
|
19017
|
+
id: string;
|
|
19018
|
+
} | null;
|
|
19019
|
+
/** @description Absolute difference in days from the bank record date */
|
|
19020
|
+
dateOffset: number;
|
|
19021
|
+
/** @description Structured explanation for the transaction suggestion */
|
|
19022
|
+
matchDetails: {
|
|
19023
|
+
/** @description Whether another candidate has the same date offset */
|
|
19024
|
+
ambiguous: boolean;
|
|
19025
|
+
/** @description Candidate amount minus bank record amount, in cents; exact matches return zero */
|
|
19026
|
+
amountDifference: number;
|
|
19027
|
+
/** @description Transaction date used to evaluate the bank-record date window */
|
|
19028
|
+
matchingDate: string;
|
|
19029
|
+
/** @description Maximum eligible difference in days */
|
|
19030
|
+
maxDateOffset: number;
|
|
19031
|
+
/** @description Typed criteria satisfied by this candidate */
|
|
19032
|
+
reasons: ("exactAmount" | "sameBankAccount" | "bankAccountAssignedOnMatch" | "dateWithinWindow")[];
|
|
19033
|
+
};
|
|
19034
|
+
/** @description Unique listings referenced by the transaction lines */
|
|
19035
|
+
listings: {
|
|
19036
|
+
/** Format: uuid */
|
|
19037
|
+
id: string;
|
|
19038
|
+
name: string;
|
|
19039
|
+
uniqueRef?: string | null;
|
|
19040
|
+
shortRef?: string | null;
|
|
19041
|
+
}[];
|
|
19042
|
+
/** @description Unique reservations referenced by the transaction lines */
|
|
19043
|
+
reservations: {
|
|
19044
|
+
/** Format: uuid */
|
|
19045
|
+
id: string;
|
|
19046
|
+
confirmationCode?: string | null;
|
|
19047
|
+
uniqueRef?: string | null;
|
|
19048
|
+
shortRef?: string | null;
|
|
19049
|
+
}[];
|
|
19050
|
+
}[];
|
|
19051
|
+
/** @description Combined signed transaction amount in cents */
|
|
19052
|
+
combinedAmount: number;
|
|
19053
|
+
/** @description Currency in ISO 4217 format, will be converted to lowercase */
|
|
19054
|
+
currency: string;
|
|
19055
|
+
dateEvidence: {
|
|
19056
|
+
/** @description Sum of member date offsets used for deterministic ranking */
|
|
19057
|
+
totalDateOffset: number;
|
|
19058
|
+
/** @description Largest member date offset in the group */
|
|
19059
|
+
maxDateOffset: number;
|
|
19060
|
+
};
|
|
19061
|
+
matchDetails: {
|
|
19062
|
+
/** @description Whether another transaction set has the same member count and total date offset */
|
|
19063
|
+
ambiguous: boolean;
|
|
19064
|
+
/** @description Combined set amount minus bank record amount, in cents; exact suggestions return zero */
|
|
19065
|
+
amountDifference: number;
|
|
19066
|
+
reasons: ("exactAmount" | "sameCurrency" | "allTransactionsEligible" | "dateWithinWindow")[];
|
|
19067
|
+
};
|
|
19068
|
+
}[] | null;
|
|
18861
19069
|
matchingRules?: {
|
|
18862
19070
|
rule: {
|
|
18863
19071
|
/** Format: uuid */
|