@emilgroup/payment-sdk 1.13.1-beta.1 → 1.13.1-beta.11
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/.openapi-generator/FILES +3 -0
- package/README.md +2 -2
- package/api/bank-transaction-api.ts +131 -28
- package/base.ts +1 -1
- package/dist/api/bank-accounts-api.js +53 -20
- package/dist/api/bank-transaction-api.d.ts +84 -28
- package/dist/api/bank-transaction-api.js +164 -39
- package/dist/api/health-check-api.js +18 -5
- package/dist/api/payment-methods-api.js +32 -11
- package/dist/api/payment-reminders-api.js +39 -14
- package/dist/api/payment-setup-api.js +25 -8
- package/dist/api/payments-api.js +32 -11
- package/dist/api/refunds-api.js +32 -11
- package/dist/api/tenant-bank-account-api.js +46 -17
- package/dist/api/webhooks-api.js +18 -5
- package/dist/base.js +5 -5
- package/dist/common.d.ts +1 -1
- package/dist/common.js +2 -2
- package/dist/models/bank-transaction-class.d.ts +14 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/models/bank-transaction-class.ts +14 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/index.ts +3 -0
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/package.json +3 -3
- package/tsconfig.json +1 -0
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GenerateInvoiceMatchSuggestionsResponseClass } from '../models';
|
|
15
16
|
import { GetBankTransactionsResponseClass } from '../models';
|
|
16
17
|
import { ImportBankTransactionsResponseClass } from '../models';
|
|
17
18
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
@@ -24,20 +25,29 @@ import { UnlinkBankTransactionsResponseClass } from '../models';
|
|
|
24
25
|
* @export
|
|
25
26
|
*/
|
|
26
27
|
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
+
/**
|
|
29
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
30
|
+
* @summary Invoice Match Suggestion
|
|
31
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
32
|
+
* @param {string} [authorization] Bearer Token
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
generateInvoiceMatchSuggestion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
27
37
|
/**
|
|
28
38
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
29
39
|
* @summary Retrieve the bank transaction
|
|
30
40
|
* @param {string} code
|
|
31
41
|
* @param {string} [authorization] Bearer Token
|
|
32
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
42
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
33
43
|
* @param {*} [options] Override http request option.
|
|
34
44
|
* @throws {RequiredError}
|
|
35
45
|
*/
|
|
36
46
|
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
47
|
/**
|
|
38
|
-
* This will import bank transactions from a
|
|
48
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
39
49
|
* @summary Create the bank transactions
|
|
40
|
-
* @param {any} file
|
|
50
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
41
51
|
* @param {string} [authorization] Bearer Token
|
|
42
52
|
* @param {*} [options] Override http request option.
|
|
43
53
|
* @throws {RequiredError}
|
|
@@ -57,11 +67,11 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
57
67
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
58
68
|
* @summary List bank transactions
|
|
59
69
|
* @param {string} [authorization] Bearer Token
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
61
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
70
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
71
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
62
72
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
63
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
64
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
73
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
74
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
65
75
|
* @param {*} [options] Override http request option.
|
|
66
76
|
* @throws {RequiredError}
|
|
67
77
|
*/
|
|
@@ -82,20 +92,29 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
82
92
|
* @export
|
|
83
93
|
*/
|
|
84
94
|
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
95
|
+
/**
|
|
96
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
97
|
+
* @summary Invoice Match Suggestion
|
|
98
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
99
|
+
* @param {string} [authorization] Bearer Token
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>>;
|
|
85
104
|
/**
|
|
86
105
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
87
106
|
* @summary Retrieve the bank transaction
|
|
88
107
|
* @param {string} code
|
|
89
108
|
* @param {string} [authorization] Bearer Token
|
|
90
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
109
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
91
110
|
* @param {*} [options] Override http request option.
|
|
92
111
|
* @throws {RequiredError}
|
|
93
112
|
*/
|
|
94
113
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
|
|
95
114
|
/**
|
|
96
|
-
* This will import bank transactions from a
|
|
115
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
97
116
|
* @summary Create the bank transactions
|
|
98
|
-
* @param {any} file
|
|
117
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
99
118
|
* @param {string} [authorization] Bearer Token
|
|
100
119
|
* @param {*} [options] Override http request option.
|
|
101
120
|
* @throws {RequiredError}
|
|
@@ -115,11 +134,11 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
115
134
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
116
135
|
* @summary List bank transactions
|
|
117
136
|
* @param {string} [authorization] Bearer Token
|
|
118
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
119
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
137
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
138
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
120
139
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
121
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
122
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
140
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
141
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
123
142
|
* @param {*} [options] Override http request option.
|
|
124
143
|
* @throws {RequiredError}
|
|
125
144
|
*/
|
|
@@ -140,20 +159,29 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
140
159
|
* @export
|
|
141
160
|
*/
|
|
142
161
|
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
162
|
+
/**
|
|
163
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
164
|
+
* @summary Invoice Match Suggestion
|
|
165
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
166
|
+
* @param {string} [authorization] Bearer Token
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: any): AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>;
|
|
143
171
|
/**
|
|
144
172
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
145
173
|
* @summary Retrieve the bank transaction
|
|
146
174
|
* @param {string} code
|
|
147
175
|
* @param {string} [authorization] Bearer Token
|
|
148
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
176
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
149
177
|
* @param {*} [options] Override http request option.
|
|
150
178
|
* @throws {RequiredError}
|
|
151
179
|
*/
|
|
152
180
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
|
|
153
181
|
/**
|
|
154
|
-
* This will import bank transactions from a
|
|
182
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
155
183
|
* @summary Create the bank transactions
|
|
156
|
-
* @param {any} file
|
|
184
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
157
185
|
* @param {string} [authorization] Bearer Token
|
|
158
186
|
* @param {*} [options] Override http request option.
|
|
159
187
|
* @throws {RequiredError}
|
|
@@ -173,11 +201,11 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
173
201
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
174
202
|
* @summary List bank transactions
|
|
175
203
|
* @param {string} [authorization] Bearer Token
|
|
176
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
177
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
204
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
205
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
178
206
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
179
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
180
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
207
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
208
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
181
209
|
* @param {*} [options] Override http request option.
|
|
182
210
|
* @throws {RequiredError}
|
|
183
211
|
*/
|
|
@@ -193,6 +221,25 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
193
221
|
*/
|
|
194
222
|
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<UnlinkBankTransactionsResponseClass>;
|
|
195
223
|
};
|
|
224
|
+
/**
|
|
225
|
+
* Request parameters for generateInvoiceMatchSuggestion operation in BankTransactionApi.
|
|
226
|
+
* @export
|
|
227
|
+
* @interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest
|
|
228
|
+
*/
|
|
229
|
+
export interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest {
|
|
230
|
+
/**
|
|
231
|
+
* Code of the bank transaction to generate match suggestions for
|
|
232
|
+
* @type {string}
|
|
233
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
234
|
+
*/
|
|
235
|
+
readonly code: string;
|
|
236
|
+
/**
|
|
237
|
+
* Bearer Token
|
|
238
|
+
* @type {string}
|
|
239
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
240
|
+
*/
|
|
241
|
+
readonly authorization?: string;
|
|
242
|
+
}
|
|
196
243
|
/**
|
|
197
244
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
198
245
|
* @export
|
|
@@ -212,7 +259,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
212
259
|
*/
|
|
213
260
|
readonly authorization?: string;
|
|
214
261
|
/**
|
|
215
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
262
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
216
263
|
* @type {string}
|
|
217
264
|
* @memberof BankTransactionApiGetBankTransaction
|
|
218
265
|
*/
|
|
@@ -225,7 +272,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
225
272
|
*/
|
|
226
273
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
227
274
|
/**
|
|
228
|
-
*
|
|
275
|
+
* MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
229
276
|
* @type {any}
|
|
230
277
|
* @memberof BankTransactionApiImportBankTransactions
|
|
231
278
|
*/
|
|
@@ -275,13 +322,13 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
275
322
|
*/
|
|
276
323
|
readonly authorization?: string;
|
|
277
324
|
/**
|
|
278
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
325
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
279
326
|
* @type {string}
|
|
280
327
|
* @memberof BankTransactionApiListBankTransactions
|
|
281
328
|
*/
|
|
282
329
|
readonly filter?: string;
|
|
283
330
|
/**
|
|
284
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber,
|
|
331
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
285
332
|
* @type {string}
|
|
286
333
|
* @memberof BankTransactionApiListBankTransactions
|
|
287
334
|
*/
|
|
@@ -293,13 +340,13 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
293
340
|
*/
|
|
294
341
|
readonly search?: string;
|
|
295
342
|
/**
|
|
296
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
343
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
297
344
|
* @type {string}
|
|
298
345
|
* @memberof BankTransactionApiListBankTransactions
|
|
299
346
|
*/
|
|
300
347
|
readonly order?: string;
|
|
301
348
|
/**
|
|
302
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
349
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
303
350
|
* @type {string}
|
|
304
351
|
* @memberof BankTransactionApiListBankTransactions
|
|
305
352
|
*/
|
|
@@ -337,6 +384,15 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
337
384
|
* @extends {BaseAPI}
|
|
338
385
|
*/
|
|
339
386
|
export declare class BankTransactionApi extends BaseAPI {
|
|
387
|
+
/**
|
|
388
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
389
|
+
* @summary Invoice Match Suggestion
|
|
390
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
391
|
+
* @param {*} [options] Override http request option.
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
* @memberof BankTransactionApi
|
|
394
|
+
*/
|
|
395
|
+
generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateInvoiceMatchSuggestionsResponseClass, any>>;
|
|
340
396
|
/**
|
|
341
397
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
342
398
|
* @summary Retrieve the bank transaction
|
|
@@ -347,7 +403,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
347
403
|
*/
|
|
348
404
|
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
|
|
349
405
|
/**
|
|
350
|
-
* This will import bank transactions from a
|
|
406
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
351
407
|
* @summary Create the bank transactions
|
|
352
408
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
353
409
|
* @param {*} [options] Override http request option.
|